Price Lists
Mutation
createPriceList — Returns PriceList
Scopes Required: create_pricelists
| Arguments | Type | Description |
|---|---|---|
|
name |
String |
The name of the new price list |
Example Mutation
mutation CreatePriceList($name: String) {
createPriceList(name: $name) {
id,
name,
allowHigherPrice,
allowDiscountingPromotions,
createdAt
}
}
# Example variables
{
"name": "<NAME>"
}Mutation
deletePriceList — Returns boolean
Scopes Required: delete_pricelists
| Arguments | Type | Description |
|---|---|---|
|
id |
The ID of the price list to delete |
Example Mutation
mutation DeletePriceList($id: ID!) {
deletePriceList(id: $id)
}
# Example variables
{
"id": "<ID>"
}Mutation
updatePriceList — Returns PriceList
Scopes Required: edit_pricelists
| Arguments | Type | Description |
|---|---|---|
|
id |
The ID of the price list to update |
|
|
name |
String |
The name of the price list |
|
items |
The items within the price list |
|
|
allowHigherPrice |
Boolean |
Whether to allow prices to be higher than the normal sell price |
|
allowDiscountingPromotions |
Boolean |
Whether the price list is should discount promotional pricing instead of everyday pricing |
Example Mutation
mutation UpdatePriceList($id: ID!) {
updatePriceList(id: $id) {
id,
name,
allowHigherPrice,
allowDiscountingPromotions,
createdAt
}
}
# Example variables
{
"id": "<ID>"
}