younifyd
Menu

deleteVariant

Delete a variant (requires its current version).

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the deleteVariant action (under Delete).
  3. Fill in the fields below, then reference the result from later steps as {{deletevariant.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 DeleteVariant($id: String, $key: String, $version: Long!) {
  deleteVariant(id: $id, key: $key, version: $version) {
    variant {
      productRef {
        typeId
        id
      }
      product {
        id
        key
        version
        productTypeRef
        productType
        masterData
        skus
        createdAt
        lastModifiedAt
        stateRef
        state
        priceMode
        taxCategoryRef
        taxCategory
        reviewRatingStatistics
        createdBy
        lastModifiedBy
      }
      variantId
      key
      current {
        sku
        images
        assets
      }
      staged {
        sku
        images
        assets
      }
      published
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    warnings {
      code
      message
    }
  }
}

Variables

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

idstring

Queries with specified ID

keystring

Queries with specified key

versionstringrequired
json
{
  "version": "string",
  "id": "string",
  "key": "string"
}

Response

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

variantobject
productRefobject2 fields
productobject17 fields
variantIdnumber
keystring
currentobject3 fields
stagedobject3 fields
publishedboolean
idstring
versionstring
createdAtstring
lastModifiedAtstring
createdByobject8 fields
lastModifiedByobject8 fields
warningsarray<object>
codeobject
messageobject

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

deleteVariant — Commercetools — Documentation