Anchor to section titled 'undefined'

locationAdd
mutation

Requires write_locations access scope.

Adds a new location.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
LocationAddInput!
required

The properties of the location to add.

Was this section helpful?
Anchor to section titled 'LocationAddPayload returns'

LocationAddPayload returns

Anchor to LocationAddPayload.location
location
Location

The location that was added.

Anchor to LocationAddPayload.userErrors
userErrors
[LocationAddUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
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
    }
  }
}
Hide code
Response
JSON
{
  "locationAdd": {
    "location": {
      "id": "gid://shopify/Location/1072404544",
      "name": "New York Warehouses",
      "address": {
        "address1": "101 Liberty Street",
        "provinceCode": "NY",
        "countryCode": "US",
        "zip": "10006"
      },
      "fulfillsOnlineOrders": true
    }
  }
}