catalogDelete

Delete a catalog.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the catalogDelete action (under Catalog).
Fill in the fields below, then reference the result from later steps as {{catalogdelete.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 CatalogDelete($id: ID!, $deleteDependentResources: Boolean) {
  catalogDelete(id: $id, deleteDependentResources: $deleteDependentResources) {
    deletedId
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

idstringrequired

The ID of the catalog to delete.

deleteDependentResourcesboolean

Whether to also delete the price list and the publication owned by the catalog.

json

{
  "id": "string",
  "deleteDependentResources": false
}

Response

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

deletedIdstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?