Choose a version:

companiesDelete

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 list of companies.

Anchor to Arguments

Arguments

Anchor to companyIdscompanyIds •[ID!]! required: A list of IDs of companies to delete.

Was this section helpful?

Anchor to CompaniesDeletePayload returnsCompaniesDeletePayload returns

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

Was this section helpful?

Examples

companiesDelete reference

Mutation Reference

mutation companiesDelete($companyIds: [ID!]!) {

companiesDelete(companyIds: $companyIds) {

deletedCompanyIds

userErrors {

field

message

}

Input

{

"companyIds": [

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

]

}