Choose a version:

companyDelete

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.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to CompanyDeletePayload returnsCompanyDeletePayload returns

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

Was this section helpful?

Examples

companyDelete reference

Mutation Reference

mutation companyDelete($id: ID!) {

companyDelete(id: $id) {

deletedCompanyId

userErrors {

field

message

}

Input

{

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

}