Choose a version:

companyLocationDelete

mutation

Requires write_customers access scope or write_companies access scope. Also: The shop must have access to B2B. Some operations may require additional plan capabilities.

Deletes a company location.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to CompanyLocationDeletePayload returnsCompanyLocationDeletePayload returns

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

Was this section helpful?

Examples

companyLocationDelete reference

Mutation Reference

mutation companyLocationDelete($companyLocationId: ID!) {

companyLocationDelete(companyLocationId: $companyLocationId) {

deletedCompanyLocationId

userErrors {

field

message

}

Input

{

"companyLocationId": "gid://shopify/<objectName>/10079785100"

}