Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 3.84 KB

OrderFulfillmentPickupDetails.md

File metadata and controls

27 lines (22 loc) · 3.84 KB
Raw

SquareConnect.OrderFulfillmentPickupDetails

Description

Contains details necessary to fulfill a pickup order.

Properties

Name Type Description Notes
recipient OrderFulfillmentRecipient Information on the person meant to pick up this fulfillment from a physical location. [optional]
expires_at String 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 `expires_at` is not set, this pickup fulfillment will be automatically accepted when placed. [optional]
auto_complete_duration String The duration of time after which an open and accepted pickup fulfillment will automatically move to the `COMPLETED` state. Must be in RFC3339 duration format e.g., "P1W3D". If not set, this pickup fulfillment will remain accepted until it is canceled or completed. [optional]
schedule_type String The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See OrderFulfillmentPickupDetailsScheduleType for possible values [optional]
pickup_at String 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 `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. [optional]
pickup_window_duration String The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants. [optional]
prep_time_duration String The duration of time it takes to prepare this fulfillment. Must be in RFC3339 duration format, e.g., "P1W3D". [optional]
note String A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale and set by the API. [optional]
placed_at String The timestamp indicating when the fulfillment was placed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
accepted_at String The timestamp indicating when the fulfillment was accepted. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
rejected_at String The timestamp indicating when the fulfillment was rejected. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
ready_at String The timestamp indicating when the fulfillment is marked as ready for pickup. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
expired_at String The timestamp indicating when the fulfillment expired. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
picked_up_at String The timestamp indicating when the fulfillment was picked up by the recipient. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". [optional]
canceled_at String The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled. [optional]
cancel_reason String A description of why the pickup was canceled. Max length: 100 characters. [optional]