Menu
recurringOrders
Query recurring orders (subscriptions) with a `where` predicate and paging.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the recurringOrders action (under Recurring).
- Fill in the fields below, then reference the result from later steps as
{{recurringorders.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.
query RecurringOrders($where: String, $sort: [String!], $limit: Int, $offset: Int) {
recurringOrders(where: $where, sort: $sort, limit: $limit, offset: $offset) {
offset
count
total
exists
results {
key
recurringOrderState
cartRef {
typeId
id
}
cart {
customerId
customer
customerEmail
anonymousId
customLineItems
totalPrice
taxedPrice
discountOnTotalPrice
shippingAddress
billingAddress
inventoryMode
taxMode
priceRoundingMode
taxRoundingMode
taxCalculationMode
customerGroup
customerGroupRef
country
shippingKey
shippingInfo
discountCodes
directDiscounts
refusedGifts
refusedGiftsRefs
paymentInfo
locale
shippingRateInput
origin
storeRef
store
itemShippingAddresses
businessUnit
businessUnitRef
shipping
taxedShippingPrice
shippingMode
shippingCustomFields
placement
discountTypeCombination
cartState
key
purchaseOrderNumber
lock
custom
deleteDaysAfterLastModification
totalLineItemQuantity
recurringPaymentConfiguration
freezeStrategy
warnings
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
startsAt
resumesAt
expiresAt
lastOrderAt
nextOrderAt
skipConfiguration {
type
}
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
}
custom {
typeRef
type
}
stateRef {
typeId
id
}
state {
id
version
key
type
roles
nameAllLocales
descriptionAllLocales
builtIn
transitionsRef
transitions
initial
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
originOrderRef {
typeId
id
}
originOrder {
customerId
customer
customerEmail
anonymousId
customLineItems
totalPrice
taxedPrice
discountOnTotalPrice
shippingAddress
billingAddress
inventoryMode
taxMode
priceRoundingMode
taxRoundingMode
taxCalculationMode
customerGroup
customerGroupRef
country
shippingKey
shippingInfo
discountCodes
directDiscounts
refusedGifts
refusedGiftsRefs
paymentInfo
locale
shippingRateInput
origin
storeRef
store
itemShippingAddresses
businessUnit
businessUnitRef
shipping
taxedShippingPrice
shippingMode
shippingCustomFields
placement
discountTypeCombination
completedAt
orderNumber
orderState
stateRef
state
shipmentState
paymentState
syncInfo
returnInfo
purchaseOrderNumber
lastMessageSequenceNumber
cartRef
cart
quoteRef
quote
recurringOrderRef
recurringOrder
custom
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
schedule {
type
}
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
}
customerEmail
storeRef {
typeId
key
}
store {
id
version
key
nameAllLocales
languages
countries
productSelections
distributionChannelsRef
distributionChannels
supplyChannelsRef
supplyChannels
storefront
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
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.
{
"where": "string",
"sort": [
"string"
],
"limit": 0,
"offset": 0
}
Response
Read the result with {{recurringorders.response.data.data.recurringOrders}}. If the API returns errors, the step fails and they are at {{recurringorders.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?