Object Index / Definition

You are viewing an old version of the API
Order​Fulfillment​Pickup​Details

Contains details necessary to fulfill a pickup order

Properties

Name Description
accepted_at
string

Read only The timestamp indicating when the fulfillment was accepted. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

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.

cancel_reason
string

A description of why the pickup was canceled. Max length: 100 characters.

Max Length 100
canceled_at
string

Read only The timestamp in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled.

expired_at
string

Read only The timestamp indicating when the fulfillment expired. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

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.

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.

Max Length 500
picked_up_at
string

Read only The timestamp indicating when the fulfillment was picked up by the recipient. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

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.

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.

placed_at
string

Read only The timestamp indicating when the fulfillment was placed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

prep_time_duration
string

The duration of time it takes to prepare this fulfillment. Must be in RFC3339 duration format, e.g., "P1W3D".

ready_at
string

Read only The timestamp indicating when the fulfillment is marked as ready for pickup. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

recipient
Order​Fulfillment​Recipient

Information on the person meant to pick up this fulfillment from a physical location.

rejected_at
string

Read only The timestamp indicating when the fulfillment was rejected. In RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".

schedule_type
string

The schedule type of the pickup fulfillment. Defaults to SCHEDULED.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?