Object Index
You are viewing an old version of the API
FulfillmentShipmentDetails
BETA
Object Index
Contains the details necessary to fulfill a shipment order.
Properties
Name | Description |
---|---|
recipient
|
Information about the person to receive this shipment fulfillment. |
carrier
|
The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS). |
shipping_
|
A note with additional information for the shipping carrier. |
shipping_
|
A description of the type of shipping product purchased from the carrier (such as First Class, Priority, or Express). |
tracking_
|
The reference number provided by the carrier to track the shipment's progress. |
tracking_
|
A link to the tracking webpage on the carrier's website. |
placed_
|
Read only The timestamp indicating when the shipment was requested. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
in_
|
Read only The timestamp
indicating when this fulfillment was moved to the Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
packaged_
|
Read only The timestamp
indicating when this fulfillment was moved to the Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
expected_
|
The timestamp indicating when the shipment is expected to be delivered to the shipping carrier. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
shipped_
|
Read only The timestamp
indicating when this fulfillment was moved to the Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
canceled_
|
The timestamp indicating the shipment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
cancel_
|
A description of why the shipment was canceled. |
failed_
|
Read only The timestamp indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
failure_
|
A description of why the shipment failed to be completed. |