Anchor to companiesDeletecompanies
companiesDelete
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Deletes a list of companies.
Anchor to Arguments
Arguments
- Anchor to companyIdscompany•
Ids [ID!]!required A list of IDs of companies to delete.
Was this section helpful?
Anchor to CompaniesDeletePayload returnsCompaniesDeletePayload returns
- Anchor to deletedCompanyIdsdeleted•
Company Ids A list of IDs of the deleted companies.
- Anchor to userErrorsuser•
Errors [BusinessCustomer non-nullUser Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation companiesDelete($companyIds: [ID!]!) {
companiesDelete(companyIds: $companyIds) {
deletedCompanyIds
userErrors {
field
message
}
}
}
Input
{
"companyIds": [
"gid://shopify/<objectName>/10079785100"
]
}
{
"companyIds": [
"gid://shopify/<objectName>/10079785100"
]
}