<- Object

Object

OrderFulfillmentDeliveryDetailsBeta

Describes delivery details of an order fulfillment.

Link to section

Properties

Link to section

recipient

The contact information for the person to receive the fulfillment.

Show attributes

Link to section

schedule_type

string

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.

Show values

Link to section

placed_at

string

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

Link to section

deliver_at

string

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

Link to section

prep_time_duration

string

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

Link to section

delivery_window_duration

string

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

Link to section

note

string

Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API.

Max Length

550

Link to section

completed_at

string

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

Link to section

in_progress_at

string

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

Link to section

rejected_at

string

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

Link to section

ready_at

string

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

Link to section

delivered_at

string

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

Link to section

canceled_at

string

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

Link to section

cancel_reason

string

The delivery cancellation reason. Max length: 100 characters.

Max Length

100

Link to section

courier_pickup_at

string

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

Link to section

courier_pickup_window_duration

string

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

Link to section

is_no_contact_delivery

boolean

Whether the delivery is preferred to be no contact.

Link to section

dropoff_notes

string

A note to provide additional instructions about how to deliver the order.

Max Length

550

Link to section

courier_provider_name

string

The name of the courier provider.

Max Length

255

Link to section

courier_support_phone_number

string

The support phone number of the courier.

Max Length

Link to section

square_delivery_id

string

The identifier for the delivery created by Square.

Max Length

Link to section

external_delivery_id

string

The identifier for the delivery created by the third-party courier service.

Max Length

Link to section

managed_delivery

boolean

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.