Menu
orders
Query orders — supports a `where` predicate, `sort`, and `limit`/`offset` paging.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the orders action (under Orders).
- Fill in the fields below, then reference the result from later steps as
{{orders.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 Orders($where: String, $sort: [String!], $limit: Int, $offset: Int) {
orders(where: $where, sort: $sort, limit: $limit, offset: $offset) {
offset
count
total
exists
results {
customerId
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
anonymousId
customLineItems {
id
key
nameAllLocales
money
totalPrice
slug
quantity
state
taxCategory
taxCategoryRef
taxRate
taxedPrice
taxedPricePortions
perMethodTaxRate
discountedPricePerQuantity
custom
shippingDetails
priceMode
recurrenceInfo
}
totalPrice {
type
currencyCode
centAmount
fractionDigits
}
taxedPrice {
totalNet
totalGross
taxPortions
totalTax
}
discountOnTotalPrice {
discountedAmount
includedDiscounts
discountedNetAmount
discountedGrossAmount
}
shippingAddress {
id
streetName
streetNumber
additionalStreetInfo
postalCode
city
region
state
country
company
department
building
apartment
pOBox
additionalAddressInfo
externalId
key
phone
mobile
email
fax
title
salutation
firstName
lastName
custom
}
billingAddress {
id
streetName
streetNumber
additionalStreetInfo
postalCode
city
region
state
country
company
department
building
apartment
pOBox
additionalAddressInfo
externalId
key
phone
mobile
email
fax
title
salutation
firstName
lastName
custom
}
inventoryMode
taxMode
priceRoundingMode
taxRoundingMode
taxCalculationMode
customerGroup {
id
version
name
key
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
customerGroupRef {
typeId
id
}
country
shippingKey
shippingInfo {
shippingMethodName
price
shippingRate
taxRate
deliveries
discountedPrice
shippingMethodState
estimatedDelivery
shippingMethod
shippingMethodRef
taxCategory
taxCategoryRef
taxedPrice
}
discountCodes {
discountCodeRef
state
discountCode
}
directDiscounts {
id
value
target
}
refusedGifts {
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
}
refusedGiftsRefs {
typeId
id
}
paymentInfo {
payments
paymentRefs
}
locale
shippingRateInput {
type
}
origin
storeRef {
typeId
key
}
store {
id
version
key
nameAllLocales
languages
countries
productSelections
distributionChannelsRef
distributionChannels
supplyChannelsRef
supplyChannels
storefront
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
itemShippingAddresses {
id
streetName
streetNumber
additionalStreetInfo
postalCode
city
region
state
country
company
department
building
apartment
pOBox
additionalAddressInfo
externalId
key
phone
mobile
email
fax
title
salutation
firstName
lastName
custom
}
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
}
shipping {
shippingKey
shippingInfo
shippingAddress
shippingRateInput
shippingCustomFields
}
taxedShippingPrice {
totalNet
totalGross
taxPortions
totalTax
}
shippingMode
shippingCustomFields {
typeRef
type
}
placement
discountTypeCombination {
type
}
completedAt
orderNumber
orderState
stateRef {
typeId
id
}
state {
id
version
key
type
roles
nameAllLocales
descriptionAllLocales
builtIn
transitionsRef
transitions
initial
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
shipmentState
paymentState
syncInfo {
channelRef
channel
externalId
syncedAt
}
returnInfo {
items
returnTrackingId
returnDate
}
purchaseOrderNumber
lastMessageSequenceNumber
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
}
quoteRef {
typeId
id
}
quote {
customerRef
customer
customerGroupRef
customerGroup
customLineItems
totalPrice
taxedPrice
shippingAddress
billingAddress
itemShippingAddresses
inventoryMode
taxMode
priceRoundingMode
taxRoundingMode
taxCalculationMode
country
shippingInfo
paymentInfo
directDiscounts
shippingRateInput
storeRef
store
businessUnit
businessUnitRef
key
quoteState
stagedQuoteRef
stagedQuote
quoteRequestRef
quoteRequest
validTo
sellerComment
buyerComment
custom
stateRef
state
purchaseOrderNumber
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
recurringOrderRef {
typeId
id
}
recurringOrder {
key
recurringOrderState
cartRef
cart
startsAt
resumesAt
expiresAt
lastOrderAt
nextOrderAt
skipConfiguration
businessUnit
businessUnitRef
custom
stateRef
state
originOrderRef
originOrder
schedule
customerRef
customer
customerEmail
storeRef
store
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
custom {
typeRef
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.
{
"where": "string",
"sort": [
"string"
],
"limit": 0,
"offset": 0
}
Response
Read the result with {{orders.response.data.data.orders}}. If the API returns errors, the step fails and they are at {{orders.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?