Object Index
You are viewing an old version of the API
OrderFulfillmentPickupDetails
Object Index
Contains details necessary to fulfill a pickup order.
Properties
| Name | Description |
|---|---|
recipient
|
Information on the person meant to pick up this fulfillment from a physical location. |
expires_at
|
The timestamp indicating when this fulfillment
will expire if it is not accepted. Must be in RFC 3339 format
e.g., "2016-09-04T23:59:33.123Z". Expiration time can only be set up to 7
days in the future. If 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 |
auto_complete_duration
|
The duration of time after which an open and accepted pickup fulfillment
will automatically move to the If not set, this pickup fulfillment will remain accepted until it is canceled or completed. Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S |
schedule_type
|
The schedule type of the pickup fulfillment. Defaults to |
pickup_at
|
The timestamp that represents the start of the pickup window.
Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".
For fulfillments with the schedule type 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 |
pickup_window_duration
|
The window of time in which the order should be picked up after the 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 |
prep_time_duration
|
The duration of time it takes to prepare this fulfillment. Must be in RFC3339 duration format, e.g., "P1W3D". Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S |
note
|
A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale and set by the API. |
placed_at
|
Read only The timestamp indicating when the fulfillment was placed. 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 |
accepted_at
|
Read only The timestamp indicating when the fulfillment was accepted. 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 |
rejected_at
|
Read only The timestamp indicating when the fulfillment was rejected. 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 |
ready_at
|
Read only The timestamp indicating when the fulfillment is marked as ready for pickup. 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 |
expired_at
|
Read only The timestamp indicating when the fulfillment expired. 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 |
picked_up_at
|
Read only The timestamp indicating when the fulfillment was picked up by the recipient. 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
|
Read only The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled. 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
|
A description of why the pickup was canceled. Max length: 100 characters. |
is_curbside_pickup
Beta
|
If true, indicates this pickup order is for curbside pickup, not in-store pickup. |
curbside_pickup_details
Beta
|
Specific details for curbside pickup. Can only be populated if |