discountCodes

Query discount codes — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the discountCodes action (under Discount).
Fill in the fields below, then reference the result from later steps as {{discountcodes.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 DiscountCodes($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  discountCodes(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      code
      key
      isActive
      maxApplications
      maxApplicationsPerCustomer
      cartPredicate
      applicationVersion
      groups
      cartDiscounts {
        cartPredicate
        stackingMode
        isActive
        requiresDiscountCode
        key
        discountGroupRef
        nameAllLocales
        descriptionAllLocales
        referenceRefs
        custom
        validFrom
        validUntil
        storesRef
        stores
        discountGroup
        value
        target
        sortOrder
        recurringOrderScope
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      validFrom
      validUntil
      referenceRefs {
        typeId
        id
      }
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      custom {
        typeRef
        type
      }
      applicationCount
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      cartDiscountRefs {
        typeId
        id
      }
      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 {{discountcodes.response.data.data.discountCodes}}. If the API returns errors, the step fails and they are at {{discountcodes.response.data.errors}}.

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

codeobject

keyobject

isActiveobject

maxApplicationsobject

maxApplicationsPerCustomerobject

cartPredicateobject

applicationVersionobject

groupsobject

cartDiscountsobject

validFromobject

validUntilobject

referenceRefsobject

nameAllLocalesobject

descriptionAllLocalesobject

customobject

applicationCountobject

storesRefobject

storesobject

cartDiscountRefsobject

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?