companiesDelete
mutation

Choose a version:

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?

Code examples for MUTATION: companiesDelete

Query Reference for MUTATION: companiesDelete

"mutation companiesDelete($companyIds: [ID!]!) {\n  companiesDelete(companyIds: $companyIds) {\n    deletedCompanyIds\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companiesDelete

"{\n  \"companyIds\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ]\n}"

Schema Reference for MUTATION: companiesDelete

""

Display Examples for MUTATION: companiesDelete

[]

companiesDeletemutation

Arguments

CompaniesDeletePayload returns

companiesDelete
mutation