Anchor to section titled 'undefined'price
price
mutation
Unstable
Requires write access scope. Also: The user must have a permission to update a price list.
Updates a price list. If you modify the currency, then any fixed prices set on the price list will be deleted.
Anchor to section titled 'Arguments'
Arguments
The ID of the price list to update.
The input data used to update the price list.
Was this section helpful?
Anchor to section titled 'PriceListUpdatePayload returns'
PriceListUpdatePayload returns
The updated price list.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: priceListUpdate
Query Reference for MUTATION: priceListUpdate
"mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n # PriceList fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: priceListUpdate
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"input\": {\n \"catalogId\": \"gid://shopify/<objectName>/10079785100\",\n \"currency\": \"AED\",\n \"name\": \"<your-name>\",\n \"parent\": {\n \"adjustment\": {\n \"type\": \"PERCENTAGE_DECREASE\",\n \"value\": 1.1\n },\n \"settings\": {\n \"compareAtMode\": \"ADJUSTED\"\n }\n }\n }\n}"Schema Reference for MUTATION: priceListUpdate
"input PriceListUpdateInput {\n catalogId: ID\n currency: CurrencyCode\n name: String\n parent: PriceListParentUpdateInput\n}\n\ninput PriceListParentUpdateInput {\n adjustment: PriceListAdjustmentInput!\n settings: PriceListAdjustmentSettingsInput\n}\n"Display Examples for MUTATION: priceListUpdate
[
{
"example": {
"type_name": "pricelistupdate",
"title": "Update a price list",
"description": "Set the existing price list's adjustment to be an increase of 10%.",
"query_string": "mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n id\n parent {\n adjustment {\n type\n value\n }\n }\n }\n userErrors {\n message\n field\n code\n }\n }\n}",
"variables": {
"id": "gid://shopify/PriceList/734173888",
"input": {
"parent": {
"adjustment": {
"value": 10,
"type": "PERCENTAGE_INCREASE"
}
}
}
},
"response": {
"data": {
"priceListUpdate": {
"priceList": {
"id": "gid://shopify/PriceList/734173888",
"parent": {
"adjustment": {
"type": "PERCENTAGE_INCREASE",
"value": 10
}
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/price_list_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) { priceListUpdate(id: $id, input: $input) { priceList { id parent { adjustment { type value } } } userErrors { message field code } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/PriceList/734173888\",\n \"input\": {\n \"parent\": {\n \"adjustment\": {\n \"value\": 10,\n \"type\": \"PERCENTAGE_INCREASE\"\n }\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n id\n parent {\n adjustment {\n type\n value\n }\n }\n }\n userErrors {\n message\n field\n code\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/PriceList/734173888\",\n \"input\": {\n \"parent\": {\n \"adjustment\": {\n \"value\": 10,\n \"type\": \"PERCENTAGE_INCREASE\"\n }\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n id\n parent {\n adjustment {\n type\n value\n }\n }\n }\n userErrors {\n message\n field\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/PriceList/734173888\",\n \"input\": {\n \"parent\": {\n \"adjustment\": {\n \"value\": 10,\n \"type\": \"PERCENTAGE_INCREASE\"\n }\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n id\n parent {\n adjustment {\n type\n value\n }\n }\n }\n userErrors {\n message\n field\n code\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/PriceList/734173888\",\n \"input\": {\n \"parent\": {\n \"adjustment\": {\n \"value\": 10,\n \"type\": \"PERCENTAGE_INCREASE\"\n }\n }\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {\n priceListUpdate(id: $id, input: $input) {\n priceList {\n id\n parent {\n adjustment {\n type\n value\n }\n }\n }\n userErrors {\n message\n field\n code\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/PriceList/734173888\",\n \"input\" => [\n \"parent\" => [\n \"adjustment\" => [\n \"value\" => 10,\n \"type\" => \"PERCENTAGE_INCREASE\",\n ],\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the price list to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/PriceList/734173888\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "input",
"description": "The input data used to update the price list.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceListUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "PriceListUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"parent\":{\"adjustment\":{\"value\":10,\"type\":\"PERCENTAGE_INCREASE\"}}}",
"typeKind": "MUTATION"
}
]
}
]