Anchor to section titled 'undefined'

locationDelete
mutation

Requires write_locations access scope.

Deletes a location.

Anchor to section titled 'Arguments'

Arguments

Anchor to locationId
locationId
ID!
required

The ID of a location to delete.

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

LocationDeletePayload returns

Anchor to LocationDeletePayload.deletedLocationId
deletedLocationId
ID

The ID of the location that was deleted.

Anchor to LocationDeletePayload.locationDeleteUserErrors
locationDeleteUserErrors
[LocationDeleteUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
  }
}
Hide code
Response
JSON
{
  "locationDelete": {
    "deletedLocationId": "gid://shopify/Location/658095763"
  }
}