companyLocationDelete
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 company location.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyLocationId companyLocationId ID! required: The ID of the company location to delete.

Was this section helpful?

Anchor to section titled 'CompanyLocationDeletePayload returns'

CompanyLocationDeletePayload returns

Anchor to CompanyLocationDeletePayload.deletedCompanyLocationId deletedCompanyLocationId ID: The ID of the deleted company location.
Anchor to CompanyLocationDeletePayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyLocationDelete

Query Reference for MUTATION: companyLocationDelete

"mutation companyLocationDelete($companyLocationId: ID!) {\n  companyLocationDelete(companyLocationId: $companyLocationId) {\n    deletedCompanyLocationId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationDelete

"{\n  \"companyLocationId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: companyLocationDelete

""

Display Examples for MUTATION: companyLocationDelete

[]

companyLocationDeletemutation

Arguments

CompanyLocationDeletePayload returns

companyLocationDelete
mutation