Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
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.
The unique shipment ID. This ID is automatically generated when a new shipment is created.
Response
OK
Order ID
677
Shipment ID
767
Batch number of shipment
-2147483648 <= x <= 2147483647
6
Label reference
30
"Sample label 123"
Time of shipment creation (UTC format)
"2021-09-10T15:24:56Z"
Customer order number
1
"765637"
Retailer order number
1
"66367"
Purchase order number
1
"PO-576"
Tracking number for shipment
128
"1Z9999999999999988"
URL for tracking shipment
"https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988"
Status of shipment
1
"Shipped"
true: Shipment is acknowledged | false: Shipment is not acknowledged
true
true: Shipment has commercial invoice | Shipment does not have commercial invoice
true
Time of cancellation (UTC format)
null
Shipment weight
10
Shipment width
1
Shipment length
1
Shipment height
1
Shipment girth
Shipment volume
4
true: Shipment has valid packing slip | false: Shipment does not valid packing slip
true
true: Shipment has valid shipping label | false: Shipment does not valid valid shipping label
true
Identifier of the shipping provider
64
"shp_3a61e10243da49ab92f0e3861d5d256b"
Time of acknowledgement (UTC format)
"2022-08-10T15:24:56Z"
Time of shipment closure (UTC format)
null
Time of delivery (UTC format)
"2022-09-10T15:24:56Z"
Time of shipping (UTC format)
"2022-09-10T15:24:56Z"
Time of shipment update (UTC format)
"2022-09-10T15:25:56Z"
Time of shipment creation (UTC format)
"2022-09-10T15:24:56Z"
Signature criteria
required
, not_required
, adult
null
Invoice number
"RC123456"