shoppingLists

Query shopping lists — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the shoppingLists action (under Shopping).
Fill in the fields below, then reference the result from later steps as {{shoppinglists.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 ShoppingLists($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  shoppingLists(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      key
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      slugAllLocales {
        locale
        value
      }
      customerRef {
        typeId
        id
      }
      customer {
        id
        customerNumber
        email
        addresses
        defaultShippingAddressId
        defaultBillingAddressId
        shippingAddressIds
        billingAddressIds
        isEmailVerified
        customerGroupRef
        externalId
        key
        authenticationMode
        firstName
        lastName
        middleName
        title
        locale
        salutation
        dateOfBirth
        companyName
        vatId
        password
        customerGroup
        defaultShippingAddress
        defaultBillingAddress
        shippingAddresses
        billingAddresses
        storesRef
        stores
        customerGroupAssignments
        custom
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      businessUnit {
        id
        key
        name
        contactEmail
        addresses
        defaultShippingAddress
        defaultBillingAddress
        defaultShippingAddressId
        defaultBillingAddressId
        shippingAddresses
        billingAddresses
        shippingAddressIds
        billingAddressIds
        status
        storesRef
        stores
        storeMode
        unitType
        associates
        associateMode
        inheritedAssociates
        custom
        parentUnitRef
        parentUnit
        ancestors
        inheritedStores
        topLevelUnitRef
        topLevelUnit
        approvalRuleMode
        customerGroupAssignments
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      businessUnitRef {
        typeId
        key
      }
      storeRef {
        typeId
        key
      }
      store {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      anonymousId
      lineItems {
        id
        key
        productId
        published
        variantId
        productTypeRef
        productType
        quantity
        addedAt
        nameAllLocales
        deactivatedAt
        custom
        productSlugAllLocales
        variant
      }
      textLineItems {
        id
        key
        nameAllLocales
        descriptionAllLocales
        quantity
        custom
        addedAt
      }
      custom {
        typeRef
        type
      }
      deleteDaysAfterLastModification
      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 {{shoppinglists.response.data.data.shoppingLists}}. If the API returns errors, the step fails and they are at {{shoppinglists.response.data.errors}}.

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

keyobject

nameAllLocalesobject

descriptionAllLocalesobject

slugAllLocalesobject

customerRefobject

customerobject

businessUnitobject

businessUnitRefobject

storeRefobject

storeobject

anonymousIdobject

lineItemsobject

textLineItemsobject

customobject

deleteDaysAfterLastModificationobject

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?