Square.Connect.Model.OrderFulfillmentPickupDetails
August 15, 2019 ยท View on GitHub
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] |
| ExpiresAt | 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] |
| AutoCompleteDuration | 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] |
| ScheduleType | string | The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See OrderFulfillmentPickupDetailsScheduleType for possible values | [optional] |
| PickupAt | 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] |
| PickupWindowDuration | 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] |
| PrepTimeDuration | 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] |
| PlacedAt | string | The timestamp indicating when the fulfillment was placed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| AcceptedAt | string | The timestamp indicating when the fulfillment was accepted. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| RejectedAt | string | The timestamp indicating when the fulfillment was rejected. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| ReadyAt | 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] |
| ExpiredAt | string | The timestamp indicating when the fulfillment expired. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| PickedUpAt | 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] |
| CanceledAt | string | The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled. | [optional] |
| CancelReason | string | A description of why the pickup was canceled. Max length: 100 characters. | [optional] |