companyLocationsDelete
mutation

Choose a version:

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?

Code examples for MUTATION: companyLocationsDelete

Query Reference for MUTATION: companyLocationsDelete

"mutation companyLocationsDelete($companyLocationIds: [ID!]!) {\n  companyLocationsDelete(companyLocationIds: $companyLocationIds) {\n    deletedCompanyLocationIds\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationsDelete

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

Schema Reference for MUTATION: companyLocationsDelete

""

Display Examples for MUTATION: companyLocationsDelete

[]

companyLocationsDeletemutation

Arguments

CompanyLocationsDeletePayload returns

companyLocationsDelete
mutation