cartDiscounts

Query cart discounts — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the cartDiscounts action (under Cart).
Fill in the fields below, then reference the result from later steps as {{cartdiscounts.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 CartDiscounts($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  cartDiscounts(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      cartPredicate
      stackingMode
      isActive
      requiresDiscountCode
      key
      discountGroupRef {
        typeId
        id
      }
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      referenceRefs {
        typeId
        id
      }
      custom {
        typeRef
        type
      }
      validFrom
      validUntil
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      discountGroup {
        id
        version
        key
        sortOrder
        isActive
        nameAllLocales
        descriptionAllLocales
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      value {
        type
      }
      target {
        type
      }
      sortOrder
      recurringOrderScope {
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

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

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

cartPredicateobject

stackingModeobject

isActiveobject

requiresDiscountCodeobject

keyobject

discountGroupRefobject

nameAllLocalesobject

descriptionAllLocalesobject

referenceRefsobject

customobject

validFromobject

validUntilobject

storesRefobject

storesobject

discountGroupobject

valueobject

targetobject

sortOrderobject

recurringOrderScopeobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

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

Was this page helpful?