Trigger single order

Trigger order specified by order ID

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId

string

required

Order ID

Response

200

application/json

Request processed successfully

Order details after triggering order

responseStatus

string

Brief response status

message

string

Full response message

data

object

Order details

Show child attributes

data.order

object

Order details

Show child attributes

data.order.status

enum<string>

required

Order status

Available options:

SCHEDULED,

CANCELED,

SUCCESS,

SKIPPED,

RETRY,

SUBMITTED,

FAILED

data.order.totalAmount

integer

required

Total order price

data.order.currencyCode

string

required

Order currency code

data.order.scheduledDate

string

required

Date on which order is scheduled to be created

data.order.customer

object

required

Customer information

Show child attributes

data.order.customer.customerReferenceId

string

required

Customer reference ID

data.order.customer.locale

string

required

Customer locale (language_country)

data.order.customer.email

string

required

Customer's email address

data.order.customer.firstName

string

required

Customer's first name

data.order.customer.lastName

string

required

Customer's last name

data.order.customer.contactnumber

string

Customer's contact number

data.order.customer.middleName

string

Customer's middle name or initial

data.order.customer.segments

string[]

Customer's segments

data.order.customer.employeeId

string

Customer employee ID

data.order.customer.status

enum<string>

Customer status

Available options:

ACTIVE,

INACTIVE

data.order.customer.isDeleted

boolean

true: Customer is deleted<br />false: Customer is not deleted

data.order.customer.DeletedAt

string

If isDeleted=true, time at which the customer was deleted<br />If isDeleted=false, NULL

data.order.customer.createdAt

string

Time customer was created

data.order.customer.updatedAt

string

Most recent time customer was updated

data.order.customer.communicationPreference

object

Customer's communications preferences

Show child attributes

data.order.customer.communicationPreference.email

boolean

true: Customer agrees to be contacted via email<br />false: Customer does not want to be contacted via email

data.order.customer.communicationPreference.sms

boolean

true: Customer agrees to be contacted via text message<br />false: Customer does not want to be contacted via text message

data.order.shipTo

object

Ship-to address and phone details

Show child attributes

data.order.shipTo.name

object

required

Customer's name

Show child attributes

data.order.shipTo.name.firstName

string

required

Customer's first name

data.order.shipTo.name.lastName

string

required

Customer's last name

data.order.shipTo.name.middleName

string

Customer's middle name or initial

data.order.shipTo.streetAddress

object

required

Street address

Show child attributes

data.order.shipTo.streetAddress.street1

string

required

Street address field 1

data.order.shipTo.streetAddress.street2

string

Street address field 2

data.order.shipTo.city

string

required

City name

data.order.shipTo.state

string

required

State name

data.order.shipTo.postalCode

string

required

Postal code

data.order.shipTo.country

string

required

Country name

data.order.shipTo.phone

object

required

Customer's phone details

Show child attributes

data.order.shipTo.phone.number

string

required

Phone number

data.order.shipTo.phone.kind

string

Phone type

data.order.billTo

object

Bill-to address and phone details

Show child attributes

data.order.billTo.name

object

required

Customer's name

Show child attributes

data.order.billTo.name.firstName

string

required

Customer's first name

data.order.billTo.name.lastName

string

required

Customer's last name

data.order.billTo.name.middleName

string

Customer's middle name or initial

data.order.billTo.streetAddress

object

required

Street address

Show child attributes

data.order.billTo.streetAddress.street1

string

required

Street address field 1

data.order.billTo.streetAddress.street2

string

Street address field 2

data.order.billTo.city

string

required

City name

data.order.billTo.state

string

required

State name

data.order.billTo.postalCode

string

required

Postal code

data.order.billTo.country

string

required

Country name

data.order.billTo.phone

object

required

Customer's phone details

Show child attributes

data.order.billTo.phone.number

string

required

Phone number

data.order.billTo.phone.kind

string

Phone type

data.order.paymentDetails

object

Payment details

Show child attributes

data.order.paymentDetails.paymentIdentifier

object

required

Payment identifier details

Show child attributes

data.order.paymentDetails.paymentIdentifier.cardIdentifier

string

required

Last four digits of credit card number

data.order.paymentDetails.paymentIdentifier.expiryDate

string

required

Card expiration date

data.order.paymentDetails.paymentMethod

string

Payment method

data.order.paymentDetails.paymentKind

string

Payment type

data.order.isDeleted

boolean

true: Order is deleted<br />false: Order is not deleted

data.order.deletedAt

string

If isDeleted=true, time at which the order was deleted<br />If isDeleted=false, NULL

data.order.id

string

Order ID

data.order.totalTax

integer

Total tax on order

data.order.totalDiscount

integer

Total discount for order (amount, not percentage)

data.order.lineItems

object[]

Show child attributes

data.order.lineItems.lineItemId

integer

required

Line item ID

data.order.lineItems.subscription

object

Subscription details

Show child attributes

data.order.lineItems.subscription.plan

object

required

Subscription plan details

Show child attributes

data.order.lineItems.subscription.id

string

required

Subscription ID

data.order.lineItems.item

object

Item details

Show child attributes

data.order.lineItems.item.id

integer

required

Item ID

data.order.lineItems.item.sku

string

required

Item SKU

data.order.lineItems.item.quantity

integer

required

Number of items

data.order.lineItems.item.itemPrice

object

required

Item price details

Show child attributes

data.order.lineItems.item.weight

integer

Item weight amount

data.order.lineItems.item.weightUnit

string

Item weight unit

data.order.lineItems.item.title

string

Item name

data.order.lineItems.item.description

string

Item description

data.order.lineItems.item.tax

object

Tax details

Show child attributes

data.order.lineItems.shipping

object

Shipping details

Show child attributes

data.order.lineItems.shipping.shipmentCarrier

string

required

Shipment carrier

data.order.lineItems.shipping.shipmentMethod

string

required

Shipment method

data.order.lineItems.shipping.shipmentInstructions

string

required

Shipment instructions

data.order.lineItems.shipping.taxCode

string

required

Shipment tax code

data.order.lineItems.shipping.shippingAmount

integer

required

Shipping cost

data.order.lineItems.shipping.taxAmount

integer

required

Shipment tax amount (value, not percentage)

data.order.lineItems.shipping.currencyCode

string

required

Shipment currency code

data.order.lineItems.offer

object

Offer details

Show child attributes

data.order.lineItems.offer.id

string

required

Offer ID

data.order.lineItems.offer.source

enum<string>

Offer source

Available options:

PDP,

CART

data.order.lineItems.customAttributes

object

Custom attributes

Show child attributes

data.order.lineItems.customAttributes.storeId

string

Store ID

data.order.lineItems.customAttributes.associateId

integer

Associate ID

data.order.lineItems.customAttributes.trackingUrl

string

Tracking URL

data.order.createdAt

string

Time order was created

data.order.updatedAt

string

Most recent time order was updated

data.order.statusUpdatedAt

string

Most recent time order status was updated

data.order.Retry

object

Order retry details

Show child attributes

data.order.Retry.maxRetries

integer

Maximum number of retries

data.order.Retry.retryType

enum<string>

Retry type

Available options:

PAYMENT RETRY,

INTENTORY RETRY,

GENERIC RETRY

data.order.Retry.retryAfterDays

integer

Number of days after which to retry

data.order.Retry.retryCount

integer

Number of times to retry order

data.order.error

object

Order error details

Show child attributes

data.order.error.errorCode

string

Brief error code

data.order.error.errorMessage

string

Full error message