Get shipments for an order

Retrieve all shipments related to a specific order.

Authorizations

Authorization · string · header · required

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

Path Parameters

retailer_id · integer · 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.

id · integer · required

The unique order ID. This ID is generated when a new order is created.

Response

200 - application/json

Shipments for the order

purchase_order_number · string · required

Purchase order number assigned by the retailer

Minimum length: 1

Example:

"PO-45678"

retailer_order_number · string · required

Retailer's internal order number

Minimum length: 1

Example:

"RET-89012"

ordered_at · string · required

Date and time when the order was placed

Example:

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

id · integer

Unique identifier for the shipment record

Example:

12345

customer_order_number · string | null

Customer's order reference number

Maximum length: 64

Example:

"CUST-00123"

brand_identifier · string | null

Identifier used to specify the brand associated with the shipment

Maximum length: 64

Example:

"BRD-001"

retailer · string

Name of the retailer

Example:

"Retailer X"

brand · string

Primary brand involved in the order

Example:

"Brand A"

brands · string

Comma-separated list of brands in the order

Example:

"Brand A, Brand B"

connection_id · integer

Unique identifier for the platform connection

Example:

101

shipping_method · string

Shipping method used for the order

Example:

"FedEx Ground"

requested_shipping_method_id · integer

ID of the requested shipping method

Example:

5

requested_shipping_method · string

Requested shipping method name

Example:

"UPS 2nd Day Air"

shipment_count · integer

Total number of shipments associated with this order

Example:

3

invoice_count · integer

Total number of invoices associated with the order

Example:

2

bill_to · string

Billing recipient

Example:

"Acme Corp"

sold_to · string

Customer entity who made the purchase

Example:

"Acme Corp"

ship_to · string

Shipping destination

Example:

"123 Warehouse Ave"

ship_from · string

Shipping origin

Example:

"456 Supplier Rd"

return_to · string

Return shipping address

Example:

"789 Return Ln"

allow_shipping_label_generation · boolean

Indicates if the platform allows label generation

Example:

true

subtotal_charged · string

Subtotal charged for the order

Example:

"99.99"

shipping_charged · string

Shipping charges applied to the order

Example:

"10.00"

is_gift · boolean

Indicates if the shipment is a gift

Example:

false

gift_fee · string | null

Fee associated with gift wrapping

Example:

"5.00"

is_replacement · boolean

Indicates if this shipment is a replacement

Example:

false

locale_subtotal_charged · string

Subtotal charged in local currency

Example:

"89.99"

status · string

Current status of the shipment

Minimum length: 1

Example:

"processing"

locale_currency · string

Local currency code

Example:

"EUR"

currency · string

Currency code of the transaction

Example:

"USD"

is_acknowledged · boolean

Whether the shipment has been acknowledged

Example:

true

acknowledged_at · string | null

When the shipment was acknowledged

Example:

"2024-03-16T08:00:00.000Z"

fulfill_by · string

Deadline to fulfill the shipment

Example:

"2024-03-20T00:00:00.000Z"

fulfilled_at · string | null

Time the order was fulfilled

Example:

"2024-03-19T08:00:00.000Z"

closed_at · string

When the shipment was closed

Example:

"2024-03-21T08:00:00.000Z"

received_at · string

Date the shipment was received

Example:

"2024-03-22T08:00:00.000Z"

is_on_hold · boolean

Whether the shipment is on hold

Example:

false

pickup_on · string | null

Scheduled pickup date

Example:

"2024-03-25T00:00:00.000Z"

on_hold_at · string | null

Timestamp when the shipment was put on hold

Example:

"2024-03-24T08:00:00.000Z"

on_hold_until · string | null

Date until which the shipment is on hold

Example:

"2024-03-30T00:00:00.000Z"

backordered_until · string | null

Date until backorder is expected

Example:

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

backorder_acknowledged_at · string | null

Date backorder was acknowledged

Example:

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

canceled_at · string | null

Date and time the shipment was canceled

Example:

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

updated_at · string | null

Timestamp of the last update

Example:

"2024-04-01T12:00:00.000Z"

order_lines · string

List of order lines in the shipment

Example:

"[...]"

cancels · string

Information about canceled items

Example:

"[...]"

shipments · string

Shipment information

Example:

"[...]"

attachments · string

Associated documents

Example:

"[...]"

memos · string

List of memos attached to the order

Example:

"Memo 1"

memos_count · string

Count of memos attached to the order

Example:

1

unread_memos_count · string

Count of unread memos

Example:

0

tags · string

Tags associated with the shipment

Example:

"Priority"

gift_message · string

Gift message included with the order

Example:

"Happy Birthday!"

fill_time · string | null

Estimated fill time for the order

Example:

"48.00"

invoices · string

Invoice details

Example:

"[...]"

signature · enum<string> | null

Signature requirements for the delivery

Available options:

required,

not_required,

adult

Example:

"required"

rmas · string

Return merchandise authorizations

Example:

"[...]"

credits · string

Credit notes issued for the order

Example:

"[...]"

order_batches · string

Batches associated with the order

Example:

"[...]"

metadata · string

Additional metadata related to the order

Example:

"[...]"

connection_shipping_provider_account · string

Shipping provider account associated with the connection

Example:

"USPS-Conn-01"

is_priority · boolean

Indicates whether the order is prioritized

Example:

true

priority_user · string

User who prioritized the order

Example:

"[e-mail]"

envelopes · string

Envelope details for the order

Example:

"Envelope A"

platform_account_transactions · string

Related platform account transactions

Example:

"[...]"