Object Index
You are viewing an old version of the API
OrderFulfillmentDeliveryDetails
BETA
Object Index
Describes delivery details of an order fulfillment.
Properties
Name | Description |
---|---|
recipient
|
The contact information for the person to receive the fulfillment. |
schedule_
|
Indicates the fulfillment delivery schedule type. If |
placed_
|
Read only The timestamp indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Must be in RFC 3339 timestamp format, e.g., "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 |
deliver_
|
The timestamp
that represents the start of the delivery period.
When the fulfillment 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 |
prep_
|
The duration of time it takes to prepare and deliver this fulfillment. The timestamp must be in RFC 3339 format (for example, "P1W3D"). 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 |
delivery_
|
The time period after 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 |
note
|
Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API. |
completed_
|
The timestamp
indicates when the seller completed the fulfillment.
This field is automatically set when fulfillment 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
indicates when the seller started processing the fulfillment.
This field is automatically set when the fulfillment 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 |
rejected_
|
Read only The timestamp
indicating when the fulfillment was rejected. This field is
automatically set when the fulfillment 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 |
ready_
|
Read only The timestamp
indicating when the seller marked the fulfillment as ready for
courier pickup. This field is automatically set when the fulfillment 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 |
delivered_
|
Read only The timestamp indicating when the fulfillment was delivered to the recipient. 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 |
canceled_
|
Read only The timestamp
indicating when the fulfillment was canceled. This field is automatically
set when the fulfillment 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_
|
The delivery cancellation reason. Max length: 100 characters. |
courier_
|
The timestamp indicating when an order can be picked up by the courier for delivery. 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 |
courier_
|
The period of time in which the order should be picked up by the courier after 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 |
is_
|
Whether the delivery is preferred to be no contact. |
dropoff_
|
A note to provide additional instructions about how to deliver the order. |
courier_
|
The name of the courier provider. |
courier_
|
The support phone number of the courier. |
square_
|
The identifier for the delivery created by Square. |
external_
|
The identifier for the delivery created by the third-party courier service. |
managed_
|
The flag to indicate the delivery is managed by a third party (ie DoorDash), which means we may not receive all recipient information for PII purposes. |