companiesDelete

Deletes a list of companies.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companiesDelete action (under Companies).
Fill in the fields below, then reference the result from later steps as {{companiesdelete.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CompaniesDelete($companyIds: [ID!]!) {
  companiesDelete(companyIds: $companyIds) {
    deletedCompanyIds
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

companyIdsarray<string>required

A list of IDs of companies to delete.

json

{
  "companyIds": [
    "string"
  ]
}

Response

Read the result with {{companiesdelete.response.data.data.companiesDelete}}. If the API returns errors, the step fails and they are at {{companiesdelete.response.data.errors}}.

deletedCompanyIdsarray<string>

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?