Acknowledge backorders

Acknowledge pending backorders

Authorizations

Authorization · string · header · required

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

Path Parameters

retailer_id · number · required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Body

application/json

purchase_order_number · string · required

Purchase order number assigned by the retailer.

Minimum length: 1

Example:

"PO-45678"

ordered_at · string<date-time> · required

Date and time when the order was placed.

Example:

"2024-03-15T08:00:00Z"

customer_order_number · string | null

Customer's original reference number for the order.

Maximum length: 64

Example:

"CUST-20230401-XYZ"

retailer_order_number · string

Internal retailer system reference number.

Minimum length: 1

Example:

"RET-89012"

brand_identifier · string | null

Identifier used to associate the order with a specific brand.

Maximum length: 64

Example:

"BRD-001"

connection_id · integer

Unique identifier for the retailer-brand platform connection.

Example:

101

requested_shipping_method_id · integer

ID corresponding to the requested shipping method.

Example:

5

allow_shipping_label_generation · boolean

Indicates whether the system allows generation of shipping labels for this order.

Example:

true

shipping_charged · string<decimal>

Shipping fees charged to the customer.

Example:

"10.00"

is_gift · boolean

Whether the order was marked as a gift.

Example:

false

gift_fee · string<decimal> | null

Fee charged for gift wrapping or gift services.

Example:

"5.00"

is_replacement · boolean

Whether the order was created as a replacement.

Example:

false

acknowledged_at · string<date-time> | null

Date and time when the order was acknowledged.

Example:

"2024-03-16T09:00:00Z"

fulfilled_at · string<date-time> | null

Date and time when the order was fulfilled.

Example:

"2024-03-17T10:00:00Z"

pickup_on · string<date> | null

Scheduled pickup date for the order, if applicable.

Example:

"2024-03-18"

on_hold_at · string<date-time> | null

Date and time when the order was placed on hold.

Example:

"2024-03-19T11:00:00Z"

on_hold_until · string<date> | null

Date until which the order remains on hold.

Example:

"2024-03-25"

backordered_until · string<date-time> | null

Expected date when a backordered item will be available.

Example:

"2024-04-01T08:00:00Z"

backorder_acknowledged_at · string<date-time> | null

Date and time when the backorder status was acknowledged.

Example:

"2024-03-28T08:00:00Z"

canceled_at · string<date-time> | null

Date and time when the order was canceled.

Example:

"2024-03-29T08:00:00Z"

fill_time · string<decimal> | null

Estimated time in hours to fill the order.

Example:

"48.00"

signature · enum<string> | null

Signature requirement for order delivery.

Available options:

required,

not_required,

adult

Example:

"required"

is_priority · boolean

Indicates whether the order is prioritized for fulfillment.

Example:

true

Response

201 - application/json

Ok

purchase_order_number · string · required

Purchase order number

Minimum length: 1

Example:

"1234-100000"

ordered_at · string<date-time> · required

Time of order finalization (UTC format)

Example:

"2017-08-01T12:00:00Z"

id · integer

Order ID

Example:

1016

customer_order_number · string | null

Customer order number

Maximum length: 64

Example:

"100000"

retailer_order_number · string

Retailer order number

Minimum length: 1

Example:

"1225466845"

brand_identifier · string | null

Vendor identifier

Maximum length: 64

Example:

"423432322"

retailer · object

Show child attributes

brand · object

Show child attributes

brands · object[]

Show child attributes

connection_id · integer

A numeric connection ID

Example:

10

shipping_method · object

Show child attributes

requested_shipping_method_id · integer

ID of the requested shipping method

Example:

768

requested_shipping_method · object

Show child attributes

shipment_count · integer

Shipment count

Example:

1

invoice_count · integer

Invoice count

Example:

1

bill_to · object

Show child attributes

sold_to · object

Show child attributes

ship_to · object

Show child attributes

ship_from · object

Show child attributes

return_to · object

Show child attributes

allow_shipping_label_generation · boolean

true: Automatically generates shipping labels based on the carrier | false: Does not support generation of shipping labels

Example:

true

subtotal_charged · string

Subtotal amount excluding shipping

Example:

"25.96"

shipping_charged · string<decimal>

Shipped charged

Example:

"2.99"

is_gift · boolean

true: Order is a gift | false: Order is not a gift

Example:

false

gift_fee · string<decimal> | null

Gift fee (if applicable)

Example:

null

is_replacement · boolean

true: order is a replacement | false: order is not a replacement

Example:

false

status · string

Order status

Minimum length: 1

Example:

"open"

currency · object

Show child attributes

is_acknowledged · boolean

true: Order is acknowledged | false: Order is not acknowledged

Example:

false

acknowledged_at · string<date-time> | null

Time of order acknowledgement (UTC format)

Example:

"2022-08-01T12:00:00Z"

fulfill_by · string

Time when order will be completely fulfilled (UTC format)

Example:

"2022-12-19T03:59:59Z"

fulfilled_at · string<date-time> | null

Time of order fulfillment (UTC format)

Example:

null

closed_at · string<date-time>

Time of complete order fulfillment (UTC format)

Example:

null

received_at · string<date-time>

Time of when order was received (UTC format)

Example:

null

is_on_hold · boolean

true: Order is on hold | false: Order is not on hold

Example:

false

pickup_on · string<date> | null

Time of when order was picked up (UTC format)

Example:

null

on_hold_at · string<date-time> | null

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

Example:

null

on_hold_until · string<date> | null

Date till when the order will be on hold

Example:

null

backordered_until · string<date-time> | null

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

Example:

null

backorder_acknowledged_at · string<date-time> | null

Time of backorder acknowledgement (UTC format)

Example:

null

canceled_at · string<date-time> | null

Time of order cancellation (UTC format)

Example:

null

updated_at · string<date-time>

Time of order update (UTC format)

Example:

"2022-08-03T17:45:11Z"

order_lines · object[]

Show child attributes

cancels · object[]

Show child attributes

shipments · object[]

Show child attributes

attachments · object[]

Show child attributes

memos · object[]

Show child attributes

memos_count · integer

Total memos

Example:

1

unread_memos_count · integer

Number of unread memos

Example:

0

tags · object[]

Show child attributes

gift_message · string

Gift message

Example:

"Gift"

fill_time · string<decimal> | null

Fill time

Example:

null

invoices · object[]

Show child attributes

signature · enum<string> | null

Represents whether signature is required

Available options:

required,

not_required,

adult

Example:

null

rmas · object[]

Show child attributes

credits · object[]

Show child attributes

order_batches · object[]

Show child attributes

metadata · object[]

Show child attributes

connection_shipping_provider_account · object

Show child attributes

is_priority · boolean

true: Priority order | false: Not a priority order

Example:

false

priority_user · object

Show child attributes

envelopes · object[]

Show child attributes