Anchor to section titled 'undefined'location
location
mutation
2024-07
Requires write access scope.
Adds a new location.
Anchor to section titled 'Arguments'
Arguments
The properties of the location to add.
Was this section helpful?
Anchor to section titled 'LocationAddPayload returns'
LocationAddPayload returns
The location that was added.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: locationAdd
Query Reference for MUTATION: locationAdd
"mutation locationAdd($input: LocationAddInput!) {\n locationAdd(input: $input) {\n location {\n # Location fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: locationAdd
"{\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: locationAdd
"input LocationAddInput {\n address: LocationAddAddressInput!\n fulfillsOnlineOrders: Boolean\n metafields: [MetafieldInput!]\n name: String!\n}\n\ninput LocationAddAddressInput {\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: locationAdd
[
{
"example": {
"type_name": "locationadd",
"title": "Add a location and return the location ID",
"description": "Add a new location with a specified name, address and fulfillsOnlineOrders status.",
"query_string": "mutation {\n locationAdd(input: {name: \"New York Warehouses\", address: {address1: \"101 Liberty Street\", city: \"New York\", provinceCode: \"NY\", countryCode: US, zip: \"10006\"}, fulfillsOnlineOrders: true}) {\n location {\n id\n name\n address {\n address1\n provinceCode\n countryCode\n zip\n }\n fulfillsOnlineOrders\n }\n }\n}",
"query_arguments": {
"name": "New York Warehouses",
"address": {
"address1": "101 Liberty Street",
"city": "New York",
"provinceCode": "NY",
"countryCode": "US",
"zip": "10006"
},
"fulfillsOnlineOrders": true
},
"response": {
"data": {
"locationAdd": {
"location": {
"id": "gid://shopify/Location/1072404544",
"name": "New York Warehouses",
"address": {
"address1": "101 Liberty Street",
"provinceCode": "NY",
"countryCode": "US",
"zip": "10006"
},
"fulfillsOnlineOrders": true
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/shop_identity/test/unit/graph_api/admin/mutations/location_add_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 { locationAdd(input: {name: \\\"New York Warehouses\\\", address: {address1: \\\"101 Liberty Street\\\", city: \\\"New York\\\", provinceCode: \\\"NY\\\", countryCode: US, zip: \\\"10006\\\"}, fulfillsOnlineOrders: true}) { 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 {\n locationAdd(input: {name: \"New York Warehouses\", address: {address1: \"101 Liberty Street\", city: \"New York\", provinceCode: \"NY\", countryCode: US, zip: \"10006\"}, fulfillsOnlineOrders: true}) {\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 {\n locationAdd(input: {name: \"New York Warehouses\", address: {address1: \"101 Liberty Street\", city: \"New York\", provinceCode: \"NY\", countryCode: US, zip: \"10006\"}, fulfillsOnlineOrders: true}) {\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 {\n locationAdd(input: {name: \"New York Warehouses\", address: {address1: \"101 Liberty Street\", city: \"New York\", provinceCode: \"NY\", countryCode: US, zip: \"10006\"}, fulfillsOnlineOrders: true}) {\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 {\n locationAdd(input: {name: \"New York Warehouses\", address: {address1: \"101 Liberty Street\", city: \"New York\", provinceCode: \"NY\", countryCode: US, zip: \"10006\"}, fulfillsOnlineOrders: true}) {\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": []
},
{
"example": {
"type_name": "locationadd",
"title": "Create a new metafield on a new location",
"description": "Create a new metafield `my_field.delivery_type` on a new\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 createLocationMetafields($input: LocationAddInput!) {\n locationAdd(input: $input) {\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"
}
],
"name": "Warehouse",
"address": {
"countryCode": "CA"
}
}
},
"response": {
"data": {
"locationAdd": {
"location": {
"id": "gid://shopify/Location/1072404543",
"metafields": {
"edges": [
{
"node": {
"id": "gid://shopify/Metafield/1069228996",
"namespace": "my_field",
"key": "delivery_type",
"value": "local"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"location": "/components/shop_identity/test/unit/graph_api/admin/mutations/location_add_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"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 createLocationMetafields($input: LocationAddInput!) { locationAdd(input: $input) { 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 \"name\": \"Warehouse\",\n \"address\": {\n \"countryCode\": \"CA\"\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createLocationMetafields($input: LocationAddInput!) {\n locationAdd(input: $input) {\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 \"name\": \"Warehouse\",\n \"address\": {\n \"countryCode\": \"CA\"\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 createLocationMetafields($input: LocationAddInput!) {\n locationAdd(input: $input) {\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\"}],\n \"name\": \"Warehouse\",\n \"address\": {\n \"countryCode\": \"CA\"\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 createLocationMetafields($input: LocationAddInput!) {\n locationAdd(input: $input) {\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 \"name\": \"Warehouse\",\n \"address\": {\n \"countryCode\": \"CA\"\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 createLocationMetafields($input: LocationAddInput!) {\n locationAdd(input: $input) {\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\"}],\n \"name\" => \"Warehouse\",\n \"address\" => [\n \"countryCode\" => \"CA\",\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties of the location to add.",
"type": {
"kind": "INPUT_OBJECT",
"name": "LocationAddInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "LocationAddInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"metafields\":[{\"namespace\":\"my_field\",\"key\":\"delivery_type\",\"type\":\"single_line_text_field\",\"value\":\"local\"}],\"name\":\"Warehouse\",\"address\":{\"countryCode\":\"CA\"}}",
"typeKind": "MUTATION"
}
]
}
]