Anchor to section titled 'undefined'location
location
mutation
2024-07
Requires Any of shipping access scopes or manage user permission.
Enables local pickup for a location.
Anchor to section titled 'Arguments'
Arguments
The settings required to enable local pickup for a location.
Was this section helpful?
Anchor to section titled 'LocationLocalPickupEnablePayload returns'
LocationLocalPickupEnablePayload returns
The local pickup settings that were enabled.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: locationLocalPickupEnable
Query Reference for MUTATION: locationLocalPickupEnable
"mutation locationLocalPickupEnable($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n # DeliveryLocalPickupSettings fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: locationLocalPickupEnable
"{\n \"localPickupSettings\": {\n \"instructions\": \"<your-instructions>\",\n \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n \"pickupTime\": \"FIVE_OR_MORE_DAYS\"\n }\n}"Schema Reference for MUTATION: locationLocalPickupEnable
"input DeliveryLocationLocalPickupEnableInput {\n instructions: String\n locationId: ID!\n pickupTime: DeliveryLocalPickupTime!\n}\n"Display Examples for MUTATION: locationLocalPickupEnable
[
{
"example": {
"type_name": "locationlocalpickupenable",
"title": "Enable local pickup for a location",
"description": "Enable local pickup for a location with a pickup time and instructions.",
"query_string": "mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n}",
"query_arguments": {
"localPickupSettings": "$localPickupSettings"
},
"variables": {
"localPickupSettings": {
"locationId": "gid://shopify/Location/530388139",
"pickupTime": "TWENTY_FOUR_HOURS",
"instructions": "Use side door."
}
},
"response": {
"data": {
"locationLocalPickupEnable": {
"localPickupSettings": {
"pickupTime": "TWENTY_FOUR_HOURS",
"instructions": "Use side door."
},
"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_enable_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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { message field } } }\",\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"localPickupSettings\" => [\n \"locationId\" => \"gid://shopify/Location/530388139\",\n \"pickupTime\" => \"TWENTY_FOUR_HOURS\",\n \"instructions\" => \"Use side door.\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "localPickupSettings",
"description": "The settings required to enable local pickup for a location.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DeliveryLocationLocalPickupEnableInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DeliveryLocationLocalPickupEnableInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "localPickupSettings",
"argValue": " {\"locationId\":\"gid://shopify/Location/530388139\",\"pickupTime\":\"TWENTY_FOUR_HOURS\",\"instructions\":\"Use side door.\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "locationlocalpickupenable",
"title": "Enabling local pickup for an invalid location returns an error",
"description": "Enabling local pickup for an invalid location returns an error.",
"query_string": "mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"query_arguments": {
"localPickupSettings": "$localPickupSettings"
},
"variables": {
"localPickupSettings": {
"locationId": "gid://shopify/Location/123",
"pickupTime": "TWENTY_FOUR_HOURS",
"instructions": "Use side door."
}
},
"response": {
"data": {
"locationLocalPickupEnable": {
"localPickupSettings": null,
"userErrors": [
{
"code": "ACTIVE_LOCATION_NOT_FOUND",
"field": [
"localPickupSettings"
],
"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_enable_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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { code field message } } }\",\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"localPickupSettings\" => [\n \"locationId\" => \"gid://shopify/Location/123\",\n \"pickupTime\" => \"TWENTY_FOUR_HOURS\",\n \"instructions\" => \"Use side door.\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "localPickupSettings",
"description": "The settings required to enable local pickup for a location.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DeliveryLocationLocalPickupEnableInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DeliveryLocationLocalPickupEnableInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "localPickupSettings",
"argValue": " {\"locationId\":\"gid://shopify/Location/123\",\"pickupTime\":\"TWENTY_FOUR_HOURS\",\"instructions\":\"Use side door.\"}",
"typeKind": "MUTATION"
}
]
}
]