Anchor to section titled 'undefined'

companiesDelete
mutation

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

Anchor to section titled 'Arguments'

Arguments

Anchor to companyIds
companyIds
[ID!]!
required

A list of IDs of companies to delete.

Was this section helpful?
Anchor to section titled 'CompaniesDeletePayload returns'

CompaniesDeletePayload returns

Anchor to CompaniesDeletePayload.deletedCompanyIds
deletedCompanyIds
[ID!]

A list of IDs of the deleted companies.

Anchor to CompaniesDeletePayload.userErrors
userErrors
[BusinessCustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation companiesDelete($companyIds: [ID!]!) {
  companiesDelete(companyIds: $companyIds) {
    deletedCompanyIds
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "companyIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}