Skip to content

Files

Latest commit

 

History

History
30 lines (24 loc) · 4.11 KB

OrderFulfillmentPickupDetails.md

File metadata and controls

30 lines (24 loc) · 4.11 KB

OrderFulfillmentPickupDetails

squareconnect.models.order_fulfillment_pickup_details

Description

Contains details necessary to fulfill a pickup order.

Properties

Name Type Description Notes
recipient OrderFulfillmentRecipient The recipient of this pickup fulfillment. [optional]
expires_at str The expiry timestamp in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This timestamp indicates when the pickup fulfillment will expire if it is not accepted by the merchant. Expiration time can only be set up to 7 days in the future. If not set, this pickup fulfillment will be automatically accepted when placed. [optional]
auto_complete_duration str The auto completion duration in RFC3339 duration format, e.g., "P1W3D". If set, an open and accepted pickup fulfillment will automatically move to the `COMPLETED` state after this period of time. If not set, this pickup fulfillment will remain accepted until it is canceled or completed. [optional]
schedule_type str The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See OrderFulfillmentPickupDetailsScheduleType for possible values [optional]
pickup_at str The pickup timestamp in RFC3339 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. This represents the start of the pickup window. [optional]
pickup_window_duration str The pickup window duration in RFC3339 duration format, e.g., "P1W3D". This duration represents the window of time for which the order should be picked up after the `pickup_at` time. Can be used as an informational guideline for merchants. [optional]
prep_time_duration str The preparation time duration in RFC3339 duration format, e.g., "P1W3D". This duration indicates how long it takes the merchant to prepare this fulfillment. [optional]
note str A general note about the pickup fulfillment. Notes are useful for providing additional instructions and are displayed in Square apps. [optional]
placed_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was placed. [optional]
accepted_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was accepted by the merchant. [optional]
rejected_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was rejected. [optional]
ready_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the merchant set the fulfillment as ready for pickup. [optional]
expired_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment expired. [optional]
picked_up_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was picked up by the recipient. [optional]
canceled_at str The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled by the merchant or buyer. [optional]
cancel_reason str A description of why the pickup was canceled. Max length is 100 characters. [optional]

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