Anchor to section titled 'undefined'

companyLocationsDelete
mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Deletes a list of company locations.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyLocationIds
companyLocationIds
[ID!]!
required

A list of IDs of company locations to delete.

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

CompanyLocationsDeletePayload returns

Anchor to CompanyLocationsDeletePayload.deletedCompanyLocationIds
deletedCompanyLocationIds
[ID!]

A list of IDs of the deleted company locations.

Anchor to CompanyLocationsDeletePayload.userErrors
userErrors
[BusinessCustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation companyLocationsDelete($companyLocationIds: [ID!]!) {
  companyLocationsDelete(companyLocationIds: $companyLocationIds) {
    deletedCompanyLocationIds
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "companyLocationIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}