Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 3.88 KB

OrderPickupDetails.md

File metadata and controls

29 lines (24 loc) · 3.88 KB

OrderPickupDetails

Properties

Name Type Description Notes
accepted_at datetime, none_type [optional] [readonly]
auto_complete_duration str, none_type The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, 'P1W3D'). [optional]
cancel_reason str, none_type A description of why the pickup was canceled. [optional]
expires_at datetime Indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed. [optional]
schedule_type str The schedule type of the pickup fulfillment. [optional] if omitted the server will use the default value of "scheduled"
pickup_at datetime The timestamp that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. [optional]
pickup_window_duration str The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants. [optional]
prep_time_duration str The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D"). [optional]
note str A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API. [optional]
placed_at datetime Indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
rejected_at datetime Indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
ready_at datetime Indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
expired_at datetime Indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
picked_up_at datetime Indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
canceled_at datetime Indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). [optional]
is_curbside_pickup bool If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. [optional]
curbside_pickup_details OrderPickupDetailsCurbsidePickupDetails [optional]
recipient OrderPickupDetailsRecipient [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]