Schedule order resource - Developer documentation

The ScheduleOrder object is a projected future order generated by the schedule system. Each schedule contains one or more orders that define when and what will be delivered to the customer. Schedule orders serve as a preview of upcoming orders before they are actually created and processed, containing information about the delivery date, items to be delivered, pricing, discounts, and whether the order has been skipped.

Search query fields

Field	Description	Type
id	The subscription identifier (accepts up to 20 subscription IDs)	string

Reference

string

required

Minimum string length: 1

customerId

string

required

Minimum string length: 1

currencyCode

string

required

Required string length: 3

skipped

boolean

required

date

string<date-time>

required

cycleIndex

integer

required

Required range: x >= 0

subtotal

number

required

Required range: x >= 0

deliveryPrice

number

required

Required range: x >= 0

items

ScheduleOrderItem · object[]

required

Minimum array length: 1

Show child attributes

items.id

string

required

Minimum string length: 1

items.title

string

required

Minimum string length: 1

items.subtitle

null | string

required

Minimum string length: 1

items.quantity

integer

required

Required range: x >= 1

items.price

number

required

Required range: x >= 0

items.totalPrice

number

required

Required range: x >= 0

items.variant

required

This field is expandable.

Minimum string length: 1

items.product

required

This field is expandable.

Minimum string length: 1

items.subscription

required

This field is expandable.

items.subscriptionItem

required

This field is expandable.

items.parentProductId

null | string

required

Minimum string length: 1

items.parentLineId

null | string

required

Minimum string length: 1

items.customAttributes

object[]

required

Show child attributes

items.customAttributes.key

string

required

Minimum string length: 1

items.customAttributes.value

string

required

Minimum string length: 1

discounts

ScheduleOrderDiscount · object[]

required

Show child attributes

discounts.id

string

required

Minimum string length: 1

discounts.title

string

required

Minimum string length: 1

discounts.target

required

Available options:

line

discounts.value

object

required

Option 1
Option 2

Show child attributes

discounts.value.type

enum<string>

required

Available options:

percentage

discounts.value.percentage

number

required

Required range: 0 <= x <= 100

discounts.entitledItems

object

required

Option 1
Option 2

Show child attributes

discounts.entitledItems.all

enum<boolean>

required

Available options:

true,

false

discounts.subscriptionId

null | string<uuid>

required

Core Resources

​Search query fields

​Reference

Search query fields

Reference