Menu
createRecurringOrder
Create a new recurring order.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the createRecurringOrder action (under Create).
- Fill in the fields below, then reference the result from later steps as
{{createrecurringorder.response.data}}.
Query
This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.
mutation CreateRecurringOrder($draft: RecurringOrderDraft!) {
createRecurringOrder(draft: $draft) {
key
recurringOrderState
cartRef {
typeId
id
}
cart {
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
}
cartState
key
purchaseOrderNumber
lock {
createdAt
clientId
}
custom {
typeRef
type
}
deleteDaysAfterLastModification
totalLineItemQuantity
recurringPaymentConfiguration {
paymentStrategy
paymentAllocations
}
freezeStrategy
warnings {
code
message
}
id
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
startsAt
resumesAt
expiresAt
lastOrderAt
nextOrderAt
skipConfiguration {
type
}
businessUnit {
id
key
name
contactEmail
addresses {
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
}
defaultShippingAddress {
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
}
defaultBillingAddress {
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
}
defaultShippingAddressId
defaultBillingAddressId
shippingAddresses {
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
}
billingAddresses {
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
}
shippingAddressIds
billingAddressIds
status
storesRef {
typeId
key
}
stores {
id
version
key
nameAllLocales
languages
countries
productSelections
distributionChannelsRef
distributionChannels
supplyChannelsRef
supplyChannels
storefront
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
storeMode
unitType
associates {
associateRoleAssignments
customerRef
customer
}
associateMode
inheritedAssociates {
associateRoleAssignments
customerRef
customer
}
custom {
typeRef
type
}
parentUnitRef {
typeId
key
}
parentUnit
ancestors
inheritedStores {
store
storeRef
}
topLevelUnitRef {
typeId
key
}
topLevelUnit
approvalRuleMode
customerGroupAssignments {
customerGroupRef
customerGroup
}
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
businessUnitRef {
typeId
key
}
custom {
typeRef {
typeId
id
}
type {
key
nameAllLocales
descriptionAllLocales
resourceTypeIds
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
stateRef {
typeId
id
}
state {
id
version
key
type
roles
nameAllLocales {
locale
value
}
descriptionAllLocales {
locale
value
}
builtIn
transitionsRef {
typeId
id
}
transitions
initial
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
originOrderRef {
typeId
id
}
originOrder {
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
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
}
}
schedule {
type
}
customerRef {
typeId
id
}
customer {
id
customerNumber
email
addresses {
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
}
defaultShippingAddressId
defaultBillingAddressId
shippingAddressIds
billingAddressIds
isEmailVerified
customerGroupRef {
typeId
id
}
externalId
key
authenticationMode
firstName
lastName
middleName
title
locale
salutation
dateOfBirth
companyName
vatId
password
customerGroup {
id
version
name
key
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
defaultShippingAddress {
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
}
defaultBillingAddress {
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
}
shippingAddresses {
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
}
billingAddresses {
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
}
storesRef {
typeId
key
}
stores {
id
version
key
nameAllLocales
languages
countries
productSelections
distributionChannelsRef
distributionChannels
supplyChannelsRef
supplyChannels
storefront
createdAt
lastModifiedAt
custom
createdBy
lastModifiedBy
}
customerGroupAssignments {
customerGroupRef
customerGroup
}
custom {
typeRef
type
}
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
customerEmail
storeRef {
typeId
key
}
store {
id
version
key
nameAllLocales {
locale
value
}
languages
countries {
code
}
productSelections {
productSelectionRef
productSelection
active
}
distributionChannelsRef {
typeId
id
}
distributionChannels {
id
version
key
roles
nameAllLocales
descriptionAllLocales
address
geoLocation
createdAt
lastModifiedAt
reviewRatingStatistics
custom
createdBy
lastModifiedBy
}
supplyChannelsRef {
typeId
id
}
supplyChannels {
id
version
key
roles
nameAllLocales
descriptionAllLocales
address
geoLocation
createdAt
lastModifiedAt
reviewRatingStatistics
custom
createdBy
lastModifiedBy
}
storefront {
checkoutUrlTemplate
orderUrlTemplate
termsOfServiceUrl
privacyPolicyUrl
refundPolicyUrl
shippingPolicyUrl
cookiePolicyUrl
imprintUrl
faqUrl
contactUrl
}
createdAt
lastModifiedAt
custom {
typeRef
type
}
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
id
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef {
typeId
id
}
userRef {
typeId
id
}
associateRef {
typeId
id
}
attributedTo {
clientId
source
userRef
}
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef {
typeId
id
}
userRef {
typeId
id
}
associateRef {
typeId
id
}
attributedTo {
clientId
source
userRef
}
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"draft": {
"cart": {
"typeId": "string",
"id": "string",
"key": "string"
},
"cartVersion": "string",
"key": "string",
"custom": {
"typeId": "string",
"typeKey": "string",
"type": {
"typeId": "string",
"id": "string",
"key": "string"
},
"fields": [
"string"
]
},
"startsAt": "string",
"expiresAt": "string",
"state": {
"typeId": "string",
"id": "string",
"key": "string"
},
"recurringOrderState": "Active"
}
}
Response
Read the result with {{createrecurringorder.response.data.data.createRecurringOrder}}. If the API returns errors, the step fails and they are at {{createrecurringorder.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?