POST
/
v1
/
retailers
/
{retailer_pk}
/
orders

Authorizations

Authorization
string
header
required

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

Path Parameters

retailer_pk
number
required

Body

application/json
ordered_at
string
required

Time of order finalization (UTC format)

purchase_order_number
string
required

Purchase order number

Minimum length: 1
acknowledged_at
string | null

Time of order acknowledgement (UTC format)

allow_shipping_label_generation
boolean

true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels

backorder_acknowledged_at
string | null

Time of backorder acknowledgement (UTC format)

backordered_until
string | null

Time till when product or order is backordered (UTC format)

bill_to
object
brand
object
brand_identifier
string | null

Vendor identifier

Maximum length: 64
canceled_at
string | null

Time of order cancellation (UTC format)

connection_id
integer

A numeric connection ID

connection_shipping_provider_account
object
currency
object
customer_order_number
string | null

Customer order number

Maximum length: 64
fill_time
string | null

Fill time

fulfilled_at
string | null

Time of order fulfillment (UTC format)

gift_fee
string | null

Gift fee (if applicable)

is_gift
boolean

true: Order is a gift <br /> false: Order is not a gift

is_priority
boolean

true: Priority order <br /> false: Not a priority order

is_replacement
boolean

true: order is a replacement <br /> false: order is not a replacement

on_hold_at
string | null

Time of when order got placed on hold (UTC format)

on_hold_until
string | null

Date till when the order will be on hold

pickup_on
string | null

Time of when order was picked up (UTC format)

priority_user
object
requested_shipping_method
object
requested_shipping_method_id
integer

ID of the requested shipping method

retailer
object
retailer_order_number
string

Retailer order number

Minimum length: 1
return_to
object
ship_from
object
ship_to
object
shipping_charged
string

Shipped charged

shipping_method
object
signature
enum<string> | null

Represents whether signature is required

Available options:
required,
not_required,
adult
sold_to
object

Response

201 - application/json
ordered_at
string
required

Time of order finalization (UTC format)

purchase_order_number
string
required

Purchase order number

Minimum length: 1
acknowledged_at
string | null

Time of order acknowledgement (UTC format)

allow_shipping_label_generation
boolean

true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels

attachments
object[]
backorder_acknowledged_at
string | null

Time of backorder acknowledgement (UTC format)

backordered_until
string | null

Time till when product or order is backordered (UTC format)

bill_to
object
brand
object
brand_identifier
string | null

Vendor identifier

Maximum length: 64
brands
object[]
canceled_at
string | null

Time of order cancellation (UTC format)

cancels
object[]
closed_at
string

Time of complete order fulfillment (UTC format)

connection_id
integer

A numeric connection ID

connection_shipping_provider_account
object
credits
object[]
currency
object
customer_order_number
string | null

Customer order number

Maximum length: 64
envelopes
object[]
fill_time
string | null

Fill time

fulfill_by
string

Time when order will be completely fulfilled (UTC format)

fulfilled_at
string | null

Time of order fulfillment (UTC format)

gift_fee
string | null

Gift fee (if applicable)

gift_message
string

Gift message

id
integer

Order ID

invoice_count
integer

Invoice count

invoices
object[]
is_acknowledged
boolean

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

is_gift
boolean

true: Order is a gift <br /> false: Order is not a gift

is_on_hold
boolean

true: Order is on hold <br /> false: Order is not on hold

is_priority
boolean

true: Priority order <br /> false: Not a priority order

is_replacement
boolean

true: order is a replacement <br /> false: order is not a replacement

memos
object[]
memos_count
integer

Total memos

metadata
object[]
on_hold_at
string | null

Time of when order got placed on hold (UTC format)

on_hold_until
string | null

Date till when the order will be on hold

order_batches
object[]
order_lines
object[]
pickup_on
string | null

Time of when order was picked up (UTC format)

priority_user
object
received_at
string

Time of when order was received (UTC format)

requested_shipping_method
object
requested_shipping_method_id
integer

ID of the requested shipping method

retailer
object
retailer_order_number
string

Retailer order number

Minimum length: 1
return_to
object
rmas
object[]
ship_from
object
ship_to
object
shipment_count
integer

Shipment count

shipments
object[]
shipping_charged
string

Shipped charged

shipping_method
object
signature
enum<string> | null

Represents whether signature is required

Available options:
required,
not_required,
adult
sold_to
object
status
string

Order status

Minimum length: 1
subtotal_charged
string

Subtotal amount excluding shipping

tags
object[]
unread_memos_count
integer

Number of unread memos

updated_at
string

Time of order update (UTC format)