Object Index / Definition

You are viewing an old version of the API
OrderFulfillmentShipmentDetails

Beta

Contains details necessary to fulfill a shipment order.

Properties

Name Description
recipient
OrderFulfillmentRecipient

Information on the person meant to receive this shipment fulfillment.

carrier
string

The shipping carrier being used to ship this fulfillment e.g. UPS, FedEx, USPS, etc.

Max Length 50
shipping_note
string

A note with additional information for the shipping carrier.

Max Length 500
shipping_type
string

A description of the type of shipping product purchased from the carrier. e.g. First Class, Priority, Express

Max Length 50
tracking_number
string

The reference number provided by the carrier to track the shipment's progress.

Max Length 100
tracking_url
string

A link to the tracking webpage on the carrier's website.

Max Length 2000
placed_at
string

The timestamp indicating when the shipment was requested. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

in_progress_at
string

The timestamp indicating when this fulfillment was moved to the RESERVED state. Indicates that preparation of this shipment has begun. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

packaged_at
string

The timestamp indicating when this fulfillment was moved to the PREPARED state. Indicates that the fulfillment is packaged. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

expected_shipped_at
string

The timestamp indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

shipped_at
string

The timestamp indicating when this fulfillment was moved to the COMPLETEDstate. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

canceled_at
string

The timestamp indicating the shipment was canceled. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

cancel_reason
string

A description of why the shipment was canceled.

Max Length 100
failed_at
string

The timestamp indicating when the shipment failed to be completed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

failure_reason
string

A description of why the shipment failed to be completed.

Max Length 100

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?