Anchor to section titled 'undefined'location
location
mutation
2024-10latest
Requires Any of shipping access scopes or manage user permission.
Disables local pickup for a location.
Anchor to section titled 'Arguments'
Arguments
The ID of the location to disable local pickup for.
Was this section helpful?
Anchor to section titled 'LocationLocalPickupDisablePayload returns'
LocationLocalPickupDisablePayload returns
The ID of the location for which local pickup was disabled.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: locationLocalPickupDisable
Query Reference for MUTATION: locationLocalPickupDisable
"mutation locationLocalPickupDisable($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: locationLocalPickupDisable
"{\n \"locationId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: locationLocalPickupDisable
""
Display Examples for MUTATION: locationLocalPickupDisable
[
{
"example": {
"type_name": "locationlocalpickupdisable",
"title": "Disable local pickup for a location",
"description": "Disable local pickup for a valid location.",
"query_string": "mutation disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n}",
"query_arguments": {
"locationId": "$locationId"
},
"variables": {
"locationId": "gid://shopify/Location/750123840"
},
"response": {
"data": {
"locationLocalPickupDisable": {
"locationId": "gid://shopify/Location/750123840",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/delivery/test/unit/graph_api/admin/delivery/mutations/location_local_pickup_disable_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation disableLocalPickup($locationId: ID!) { locationLocalPickupDisable(locationId: $locationId) { locationId userErrors { code field message } } }\",\n \"variables\": {\n \"locationId\": \"gid://shopify/Location/750123840\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"locationId\": \"gid://shopify/Location/750123840\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"locationId\": \"gid://shopify/Location/750123840\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"locationId\": \"gid://shopify/Location/750123840\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"locationId\" => \"gid://shopify/Location/750123840\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "locationId",
"description": "The ID of the location to disable local pickup for.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locationId",
"argValue": " \"gid://shopify/Location/750123840\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "locationlocalpickupdisable",
"title": "Disabling local pickup for an invalid location returns an error",
"description": "Disabling local pickup for an invalid location returns an error.",
"query_string": "mutation disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n}",
"query_arguments": {
"locationId": "$locationId"
},
"variables": {
"locationId": "gid://shopify/Location/123"
},
"response": {
"data": {
"locationLocalPickupDisable": {
"locationId": null,
"userErrors": [
{
"code": "ACTIVE_LOCATION_NOT_FOUND",
"field": [
"locationId"
],
"message": "Unable to find an active location for location ID 123"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/delivery/test/unit/graph_api/admin/delivery/mutations/location_local_pickup_disable_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation disableLocalPickup($locationId: ID!) { locationLocalPickupDisable(locationId: $locationId) { locationId userErrors { code field message } } }\",\n \"variables\": {\n \"locationId\": \"gid://shopify/Location/123\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"locationId\": \"gid://shopify/Location/123\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"locationId\": \"gid://shopify/Location/123\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"locationId\": \"gid://shopify/Location/123\"\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 disableLocalPickup($locationId: ID!) {\n locationLocalPickupDisable(locationId: $locationId) {\n locationId\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"locationId\" => \"gid://shopify/Location/123\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "locationId",
"description": "The ID of the location to disable local pickup for.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locationId",
"argValue": " \"gid://shopify/Location/123\"",
"typeKind": "MUTATION"
}
]
}
]