Anchor to section titled 'undefined'location
location
mutation
Unstable
Requires write access scope or write access scope. Also: write: access scope is required to modify merchant-managed locations. write: apps can edit the locations associated with their fulfillment services if they have this scope. Only the app that created the fulfillment service can edit its associated location.
Edits an existing location.
As of the 2023-10 API version, apps can change the name and address of their fulfillment service locations.
Anchor to section titled 'Arguments'
Arguments
The ID of a location to edit.
The updated properties for the location.
Was this section helpful?
Anchor to section titled 'LocationEditPayload returns'
LocationEditPayload returns
The location that was edited.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: locationEdit
Query Reference for MUTATION: locationEdit
"mutation locationEdit($id: ID!, $input: LocationEditInput!) {\n locationEdit(id: $id, input: $input) {\n location {\n # Location fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: locationEdit
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"input\": {\n \"address\": {\n \"address1\": \"<your-address1>\",\n \"address2\": \"<your-address2>\",\n \"city\": \"<your-city>\",\n \"countryCode\": \"AC\",\n \"phone\": \"<your-phone>\",\n \"provinceCode\": \"<your-provinceCode>\",\n \"zip\": \"<your-zip>\"\n },\n \"fulfillsOnlineOrders\": true,\n \"metafields\": [\n {\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"name\": \"<your-name>\"\n }\n}"Schema Reference for MUTATION: locationEdit
"input LocationEditInput {\n address: LocationEditAddressInput\n fulfillsOnlineOrders: Boolean\n metafields: [MetafieldInput!]\n name: String\n}\n\ninput LocationEditAddressInput {\n address1: String\n address2: String\n city: String\n countryCode: CountryCode\n phone: String\n provinceCode: String\n zip: String\n}\n\ninput MetafieldInput {\n description: String\n id: ID\n key: String\n namespace: String\n type: String\n value: String\n}\n"Display Examples for MUTATION: locationEdit
[
{
"example": {
"type_name": "locationedit",
"title": "Create a new metafield and update another on an existing location",
"description": "Create a new metafield `my_field.delivery_type` and update an\nexisting metafield `global.store_hours` on a specific\nlocation.\n\n\nAlternatively, refer to the\n[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsset) mutation\nto create and/or update metafields on location resources.\n",
"query_string": "mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {\n locationEdit(input: $input, id: $ownerId) {\n location {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n}",
"variables": {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "delivery_type",
"type": "single_line_text_field",
"value": "local"
},
{
"id": "gid://shopify/Metafield/1069228945",
"value": "Open from 7am to 10pm"
}
]
},
"ownerId": "gid://shopify/Location/346779380"
},
"response": {
"data": {
"locationEdit": {
"location": {
"id": "gid://shopify/Location/346779380",
"metafields": {
"edges": [
{
"node": {
"id": "gid://shopify/Metafield/1069228945",
"namespace": "global",
"key": "store_hours",
"value": "Open from 7am to 10pm"
}
},
{
"node": {
"id": "gid://shopify/Metafield/1069228946",
"namespace": "my_field",
"key": "delivery_type",
"value": "local"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"location": "/components/shop_identity/test/unit/graph_api/admin/mutations/location_edit_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) { locationEdit(input: $input, id: $ownerId) { location { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }\",\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_type\",\n \"type\": \"single_line_text_field\",\n \"value\": \"local\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069228945\",\n \"value\": \"Open from 7am to 10pm\"\n }\n ]\n },\n \"ownerId\": \"gid://shopify/Location/346779380\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {\n locationEdit(input: $input, id: $ownerId) {\n location {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_type\",\n \"type\": \"single_line_text_field\",\n \"value\": \"local\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069228945\",\n \"value\": \"Open from 7am to 10pm\"\n }\n ]\n },\n \"ownerId\": \"gid://shopify/Location/346779380\"\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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {\n locationEdit(input: $input, id: $ownerId) {\n location {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"metafields\": [{\"namespace\"=>\"my_field\", \"key\"=>\"delivery_type\", \"type\"=>\"single_line_text_field\", \"value\"=>\"local\"}, {\"id\"=>\"gid://shopify/Metafield/1069228945\", \"value\"=>\"Open from 7am to 10pm\"}]\n },\n \"ownerId\": \"gid://shopify/Location/346779380\"\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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {\n locationEdit(input: $input, id: $ownerId) {\n location {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_type\",\n \"type\": \"single_line_text_field\",\n \"value\": \"local\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069228945\",\n \"value\": \"Open from 7am to 10pm\"\n }\n ]\n },\n \"ownerId\": \"gid://shopify/Location/346779380\"\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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {\n locationEdit(input: $input, id: $ownerId) {\n location {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"metafields\" => [{\"namespace\"=>\"my_field\", \"key\"=>\"delivery_type\", \"type\"=>\"single_line_text_field\", \"value\"=>\"local\"}, {\"id\"=>\"gid://shopify/Metafield/1069228945\", \"value\"=>\"Open from 7am to 10pm\"}],\n ],\n \"ownerId\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The updated properties for the location.",
"type": {
"kind": "INPUT_OBJECT",
"name": "LocationEditInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "LocationEditInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"metafields\":[{\"namespace\":\"my_field\",\"key\":\"delivery_type\",\"type\":\"single_line_text_field\",\"value\":\"local\"},{\"id\":\"gid://shopify/Metafield/1069228945\",\"value\":\"Open from 7am to 10pm\"}]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "locationedit",
"title": "Edit a location and return the location ID",
"description": "Edit a location's name, address and fulfillsOnlineOrders status",
"query_string": "mutation locationEdit {\n locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\n }\n }\n}",
"query_arguments": {
"id": "gid://shopify/Location/346779380",
"input": {
"name": "Shipping Warehouse",
"address": {
"address1": "290 Bremner Blvd",
"city": "Toronto",
"zip": "M5V 3L9",
"provinceCode": "ON",
"countryCode": "CA"
},
"fulfillsOnlineOrders": false
}
},
"response": {
"data": {
"locationEdit": {
"location": {
"id": "gid://shopify/Location/346779380",
"name": "Shipping Warehouse",
"address": {
"address1": "290 Bremner Blvd",
"provinceCode": "ON",
"countryCode": "CA",
"zip": "M5V 3L9"
},
"fulfillsOnlineOrders": false
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/shop_identity/test/unit/graph_api/admin/mutations/location_edit_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 locationEdit { locationEdit(id: \\\"gid://shopify/Location/346779380\\\", input: {name: \\\"Shipping Warehouse\\\", address: {address1: \\\"290 Bremner Blvd\\\", city: \\\"Toronto\\\", zip: \\\"M5V 3L9\\\", provinceCode: \\\"ON\\\", countryCode: CA}, fulfillsOnlineOrders: false}) { location { id name address { address1 provinceCode countryCode zip } fulfillsOnlineOrders } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation locationEdit {\n locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\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 locationEdit {\n locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `mutation locationEdit {\n locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\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 locationEdit {\n locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
}
]