variantProjections

Query product-projection variants by SKU/key.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the variantProjections action (under Variant).
Fill in the fields below, then reference the result from later steps as {{variantprojections.response.data}}.

Query

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

graphql

query VariantProjections($where: String, $sort: [String!], $limit: Int, $offset: Int, $staged: Boolean!, $productId: String, $localeProjection: [Locale!], $includeNames: [String!], $excludeNames: [String!]) {
  variantProjections(
    where: $where
    sort: $sort
    limit: $limit
    offset: $offset
    staged: $staged
    productId: $productId
    localeProjection: $localeProjection
    includeNames: $includeNames
    excludeNames: $excludeNames
  ) {
    offset
    count
    total
    exists
    results {
      id
      staged
      default
      variantId
      version
      createdAt
      productRef {
        typeId
        id
      }
      key
      sku
      images {
        url
        dimensions
        label
      }
      assets {
        id
        key
        sources
        nameAllLocales
        descriptionAllLocales
        tags
        custom
      }
      nameAllLocales {
        locale
        value
      }
      slugAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
    }
  }
}

Variables

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

wherestring

sortarray<string>

limitnumber

offsetnumber

stagedbooleanrequired

If true, queries staged projections. If false (default), queries current (published) projections.

productIdstring

Filters variant projections by product ID

localeProjectionarray<string>

Filters localized fields (name, slug, description, attribute labels) to the specified locales

includeNamesarray<string>

The names of the attributes to include. If neither `includeNames` nor `excludeNames` are provided, then all attributes are returned.

excludeNamesarray<string>

The names of the attributes to exclude. If neither `includeNames` nor `excludeNames` are provided, then all attributes are returned.

json

{
  "staged": false,
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0,
  "productId": "string",
  "localeProjection": [
    "string"
  ],
  "includeNames": [
    "string"
  ],
  "excludeNames": [
    "string"
  ]
}

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

idobject

stagedobject

defaultobject

variantIdobject

versionobject

createdAtobject

productRefobject

keyobject

skuobject

imagesobject

assetsobject

nameAllLocalesobject

slugAllLocalesobject

descriptionAllLocalesobject

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

Was this page helpful?