Anchor to section titled 'undefined'price
price
mutation
2024-07
Requires write access scope. Also: The user must have a permission to delete a price list.
Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.
Anchor to section titled 'Arguments'
Arguments
The ID of the price list to be deleted.
Was this section helpful?
Anchor to section titled 'PriceListDeletePayload returns'
PriceListDeletePayload returns
The ID of the deleted price list.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: priceListDelete
Query Reference for MUTATION: priceListDelete
"mutation priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: priceListDelete
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: priceListDelete
""
Display Examples for MUTATION: priceListDelete
[
{
"example": {
"type_name": "pricelistdelete",
"title": "Delete a price list",
"description": "Deleting a price list returns the ID of the deleted price list",
"query_string": "mutation priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n code\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/PriceList/294167858"
},
"response": {
"data": {
"priceListDelete": {
"deletedId": "gid://shopify/PriceList/294167858",
"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_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceListDelete($id: ID!) { priceListDelete(id: $id) { deletedId userErrors { field code message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/PriceList/294167858\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n code\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/PriceList/294167858\"\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 priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/PriceList/294167858\"\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 priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n code\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/PriceList/294167858\"\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 priceListDelete($id: ID!) {\n priceListDelete(id: $id) {\n deletedId\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/PriceList/294167858\",\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 be deleted.",
"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/294167858\"",
"typeKind": "MUTATION"
}
]
}
]