• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
OrderFulfillmentPickupDetails

Contains details necessary to fulfill a pickup order.

Properties

Name Description
recipient
OrderFulfillmentRecipient

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

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.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

schedule_type
string

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

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.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

prep_time_duration
string

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

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

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
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".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

expired_at
string

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

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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".

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

cancel_reason
string

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

Max Length 100
is_curbside_pickup
boolean

Beta

If true, indicates this pickup order is for curbside pickup, not in-store pickup.

curbside_pickup_details
OrderFulfillmentPickupDetailsCurbsidePickupDetails

Beta

Specific details for curbside pickup. Can only be populated if is_curbside_pickup is true.

Share Feedback

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