OrderFulfillmentPickupDetails

August 15, 2019 ยท View on GitHub

Description

Contains details necessary to fulfill a pickup order.

Properties

NameTypeDescriptionNotes
recipientOrderFulfillmentRecipientInformation on the person meant to pick up this fulfillment from a physical location.[optional]
expiresAtStringThe 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]
autoCompleteDurationStringThe 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]
scheduleTypeStringThe schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See OrderFulfillmentPickupDetailsScheduleType for possible values[optional]
pickupAtStringThe 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]
pickupWindowDurationStringThe 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]
prepTimeDurationStringThe duration of time it takes to prepare this fulfillment. Must be in RFC3339 duration format, e.g., "P1W3D".[optional]
noteStringA note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale and set by the API.[optional]
placedAtStringThe timestamp indicating when the fulfillment was placed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
acceptedAtStringThe timestamp indicating when the fulfillment was accepted. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
rejectedAtStringThe timestamp indicating when the fulfillment was rejected. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
readyAtStringThe timestamp indicating when the fulfillment is marked as ready for pickup. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
expiredAtStringThe timestamp indicating when the fulfillment expired. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
pickedUpAtStringThe timestamp indicating when the fulfillment was picked up by the recipient. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".[optional]
canceledAtStringThe timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled.[optional]
cancelReasonStringA description of why the pickup was canceled. Max length: 100 characters.[optional]