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.

Arguments

Anchor to companyLocationIdscompanyLocationIds • [ID!]!required: A list of IDs of company locations to delete.

Was this section helpful?

Anchor to CompanyLocationsDeletePayload returnsCompanyLocationsDeletePayload returns

Anchor to deletedCompanyLocationIdsdeletedCompanyLocationIds • [ID!]: A list of IDs of the deleted company locations.
Anchor to userErrorsuserErrors • [BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation companyLocationsDelete($companyLocationIds: [ID!]!) {
2  companyLocationsDelete(companyLocationIds: $companyLocationIds) {
3    deletedCompanyLocationIds
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "companyLocationIds": [
3    "gid://shopify/<objectName>/10079785100"
4  ]
5}

{
  "companyLocationIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}