Describes delivery details of an order fulfillment.
<- Object
Object
Describes delivery details of an order fulfillment.
Indicates the fulfillment delivery schedule type. If SCHEDULED
, then deliver_at
is required. If ASAP
, then prep_time_duration
is required. The default is SCHEDULED
.
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
The timestamp that represents the start of the delivery period. When the fulfillment schedule_type
is ASAP
, the field is automatically set to the current time plus the prep_time_duration
. Otherwise, the application can set this field while the fulfillment state
is PROPOSED
, RESERVED
, or PREPARED
(any time before the terminal state such as COMPLETED
, CANCELED
, and FAILED
).
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
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
The time period after the deliver_at
timestamp in which to deliver the order. Applications can set this field when the fulfillment state
is PROPOSED
, RESERVED
, or PREPARED
(any time before the terminal state such as COMPLETED
, CANCELED
, and FAILED
). 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
Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API.
The timestamp indicates when the seller completed the fulfillment. This field is automatically set when fulfillment state
changes to 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
Read only The timestamp indicates when the seller started processing the fulfillment. This field is automatically set when the fulfillment state
changes to RESERVED
. 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
Read only The timestamp indicating when the fulfillment was rejected. This field is automatically set when the fulfillment state
changes to FAILED
. 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
Read only The timestamp indicating when the seller marked the fulfillment as ready for courier pickup. This field is automatically set when the fulfillment state
changes to PREPARED. 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
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
Read only The timestamp indicating when the fulfillment was canceled. This field is automatically set when the fulfillment state
changes to 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
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
The period of time in which the order should be picked up by the courier after the courier_pickup_at
timestamp. The time 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
A note to provide additional instructions about how to deliver the order.
The identifier for the delivery created by the third-party courier service.