Add items to single order

Add items to 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

id

string

required

Order ID

Example:

"606f01f441b8fc0008529916"

Body

application/json

Add items to order

lineItems

object[]

Line items to add to order

Details of item to be added to order

Show child attributes

lineItems.subscriptionId

string

Subscription ID

Example:

"6256610bc312410009b7390b"

lineItems.item

object

Item details

Show child attributes

lineItems.item.id

integer

required

Item ID

Example:

1000000006

lineItems.item.sku

string

required

Item SKU

Example:

"MOBO-X570"

lineItems.item.quantity

integer

required

Number of items

Example:

1

lineItems.item.itemPrice

object

required

Item price details

Show child attributes

lineItems.item.itemPrice.price

integer

required

Item price

Example:

100

lineItems.item.itemPrice.currencyCode

string

required

Item currency code

Example:

"USD"

lineItems.item.weight

integer

Item weight amount

Example:

10

lineItems.item.weightUnit

string

Item weight unit

Example:

"lb"

lineItems.item.title

string

Item name

Example:

"Vitamin"

lineItems.item.description

string

Item description

Example:

"Vitamin C"

lineItems.item.tax

object

Tax details

Show child attributes

lineItems.item.tax.taxCode

string

required

Tax code

Example:

"FR020000"

lineItems.item.tax.taxAmount

integer

required

Tax amount (value, not percentage)

Example:

10

lineItems.item.tax.currencyCode

string

required

Tax currency code

Example:

"USD"

lineItems.shipping

object

Shipping details

Show child attributes

lineItems.shipping.shipmentCarrier

string

required

Shipment carrier

Example:

"USPS"

lineItems.shipping.shipmentMethod

string

required

Shipment method

Example:

"Ground"

lineItems.shipping.shipmentInstructions

string

required

Shipment instructions

Example:

"Please leave the package in the box"

lineItems.shipping.taxCode

string

required

Shipment tax code

Example:

"SHP020000"

lineItems.shipping.shippingAmount

integer

required

Shipping cost

Example:

10

lineItems.shipping.taxAmount

integer

required

Shipment tax amount (value, not percentage)

Example:

1

lineItems.shipping.currencyCode

string

required

Shipment currency code

Example:

"USD"

Response

200

application/json

Request processed successfully

Order details after adding items to order

responseStatus

string

Brief response status

Example:

"OK"

message

string

Full response message

Example:

"Request processed successfully"

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

Example:

"SCHEDULED"

data.order.totalAmount

integer

required

Total order price

Example:

100

data.order.currencyCode

string

required

Order currency code

Example:

"USD"

data.order.scheduledDate

string

required

Date on which order is scheduled to be created

Example:

"2019-01-01T00:00:00.000Z"

data.order.customer

object

required

Customer information

Show child attributes

data.order.customer.customerReferenceId

string

required

Customer reference ID

Example:

"12345"

data.order.customer.locale

string

required

Customer locale (language_country)

Example:

"en_US"

data.order.customer.email

string

required

Customer's email address

Example:

"[e-mail]"

data.order.customer.firstName

string

required

Customer's first name

Example:

"Pat"

data.order.customer.lastName

string

required

Customer's last name

Example:

"Kake"

data.order.customer.contactnumber

string

Customer's contact number

Example:

"5555551234"

data.order.customer.middleName

string

Customer's middle name or initial

Example:

"E"

data.order.customer.segments

string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

data.order.customer.employeeId

string

Customer employee ID

Example:

"345"

data.order.customer.status

enum<string>

Customer status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

data.order.customer.isDeleted

boolean

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

Example:

false

data.order.customer.DeletedAt

string

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

Example:

"2021-01-01T00:00:00.000Z"

data.order.customer.createdAt

string

Time customer was created

Example:

"2019-10-12T21:35:05.756Z"

data.order.customer.updatedAt

string

Most recent time customer was updated

Example:

"2021-10-14T05:40:55.997Z"

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

Example:

true

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

Example:

true

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

Example:

"Pat"

data.order.shipTo.name.lastName

string

required

Customer's last name

Example:

"Kake"

data.order.shipTo.name.middleName

string

Customer's middle name or initial

Example:

"E"

data.order.shipTo.streetAddress

object

required

Street address

Show child attributes

data.order.shipTo.streetAddress.street1

string

required

Street address field 1

Example:

"123 Main St"

data.order.shipTo.streetAddress.street2

string

Street address field 2

Example:

"Suite 100"

data.order.shipTo.city

string

required

City name

Example:

"Boston"

data.order.shipTo.state

string

required

State name

Example:

"MA"

data.order.shipTo.postalCode

string

required

Postal code

Example:

"02127"

data.order.shipTo.country

string

required

Country name

Example:

"US"

data.order.shipTo.phone

object

required

Customer's phone details

Show child attributes

data.order.shipTo.phone.number

string

required

Phone number

Example:

"5555551234"

data.order.shipTo.phone.kind

string

Phone type

Example:

"home"

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

Example:

"Pat"

data.order.billTo.name.lastName

string

required

Customer's last name

Example:

"Kake"

data.order.billTo.name.middleName

string

Customer's middle name or initial

Example:

"E"

data.order.billTo.streetAddress

object

required

Street address

Show child attributes

data.order.billTo.streetAddress.street1

string

required

Street address field 1

Example:

"123 Main St"

data.order.billTo.streetAddress.street2

string

Street address field 2

Example:

"Suite 100"

data.order.billTo.city

string

required

City name

Example:

"Boston"

data.order.billTo.state

string

required

State name

Example:

"MA"

data.order.billTo.postalCode

string

required

Postal code

Example:

"02127"

data.order.billTo.country

string

required

Country name

Example:

"US"

data.order.billTo.phone

object

required

Customer's phone details

Show child attributes

data.order.billTo.phone.number

string

required

Phone number

Example:

"5555551234"

data.order.billTo.phone.kind

string

Phone type

Example:

"home"

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

Example:

"1234"

data.order.paymentDetails.paymentIdentifier.expiryDate

string

required

Card expiration date

Example:

"12/20"

data.order.paymentDetails.paymentMethod

string

Payment method

Example:

"credit_card"

data.order.paymentDetails.paymentKind

string

Payment type

Example:

"Visa"

data.order.isDeleted

boolean

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

Example:

false

data.order.deletedAt

string

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

Example:

"2019-01-01T00:00:00.000Z"

data.order.id

string

Order ID

Example:

"6384462ab645220008a4358a"

data.order.totalTax

integer

Total tax on order

Example:

10

data.order.totalDiscount

integer

Total discount for order (amount, not percentage)

Example:

10

data.order.lineItems

object[]

Item details

Show child attributes

data.order.lineItems.lineItemId

integer

required

Line item ID

Example:

1

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

Example:

"6256610bc312410009b7390b"

data.order.lineItems.item

object

Item details

Show child attributes

data.order.lineItems.item.id

integer

required

Item ID

Example:

1000000006

data.order.lineItems.item.sku

string

required

Item SKU

Example:

"MOBO-X570"

data.order.lineItems.item.quantity

integer

required

Number of items

Example:

1

data.order.lineItems.item.itemPrice

object

required

Item price details

Show child attributes

data.order.lineItems.item.weight

integer

Item weight amount

Example:

10

data.order.lineItems.item.weightUnit

string

Item weight unit

Example:

"lb"

data.order.lineItems.item.title

string

Item name

Example:

"Vitamin"

data.order.lineItems.item.description

string

Item description

Example:

"Vitamin C"

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

Example:

"USPS"

data.order.lineItems.shipping.shipmentMethod

string

required

Shipment method

Example:

"Ground"

data.order.lineItems.shipping.shipmentInstructions

string

required

Shipment instructions

Example:

"Please leave the package in the box"

data.order.lineItems.shipping.taxCode

string

required

Shipment tax code

Example:

"SHP020000"

data.order.lineItems.shipping.shippingAmount

integer

required

Shipping cost

Example:

10

data.order.lineItems.shipping.taxAmount

integer

required

Shipment tax amount (value, not percentage)

Example:

1

data.order.lineItems.shipping.currencyCode

string

required

Shipment currency code

Example:

"USD"

data.order.lineItems.offer

object

Offer details

Show child attributes

data.order.lineItems.offer.id

string

required

Offer ID

Example:

"SUB-E10717"

data.order.lineItems.offer.source

enum<string>

Offer source

Available options:

PDP,

CART

Example:

"PDP"

data.order.lineItems.customAttributes

object

Custom attributes

Show child attributes

data.order.lineItems.customAttributes.storeId

string

Store ID

Example:

"60cb07fc20387b000821c5c3"

data.order.lineItems.customAttributes.associateId

integer

Associate ID

Example:

1

data.order.lineItems.customAttributes.trackingUrl

string

Tracking URL

Example:

"609436d21baded0008945b05"

data.order.createdAt

string

Time order was created

Example:

"2021-10-12T21:35:05.756Z"

data.order.updatedAt

string

Most recent time order was updated

Example:

"2021-10-14T05:40:55.997Z"

data.order.statusUpdatedAt

string

Most recent time order status was updated

Example:

"2021-10-14T10:24:36.468Z"

data.order.Retry

object

Order retry details

Show child attributes

data.order.Retry.maxRetries

integer

Maximum number of retries

Example:

3

data.order.Retry.retryType

enum<string>

Retry type

Available options:

PAYMENT RETRY,

INTENTORY RETRY,

GENERIC RETRY

Example:

"PAYMENT RETRY"

data.order.Retry.retryAfterDays

integer

Number of days after which to retry

Example:

1

data.order.Retry.retryCount

integer

Number of times to retry order

Example:

2

data.order.error

object

Order error details

Show child attributes

data.order.error.errorCode

string

Brief error code

Example:

"ORDER_NOT_FOUND"

data.order.error.errorMessage

string

Full error message

Example:

"The order is not found"