Anchor to companyLocationsDeletecompany
companyLocationsDelete
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Deletes a list of company locations.
Anchor to Arguments
Arguments
- Anchor to companyLocationIdscompany•
Location Ids [ID!]!required A list of IDs of company locations to delete.
Was this section helpful?
Anchor to CompanyLocationsDeletePayload returnsCompanyLocationsDeletePayload returns
- Anchor to deletedCompanyLocationIdsdeleted•
Company Location Ids A list of IDs of the deleted company locations.
- Anchor to userErrorsuser•
Errors [BusinessCustomer non-nullUser Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation companyLocationsDelete($companyLocationIds: [ID!]!) {
companyLocationsDelete(companyLocationIds: $companyLocationIds) {
deletedCompanyLocationIds
userErrors {
field
message
}
}
}
Input
{
"companyLocationIds": [
"gid://shopify/<objectName>/10079785100"
]
}
{
"companyLocationIds": [
"gid://shopify/<objectName>/10079785100"
]
}