OrderFulfillmentPickupDetails Object

Name	Description
`recipient OrderFulfillmentRecipient`	Information about the person to pick up this fulfillment from a physical location.
`expires_at string`	The timestamp indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed. Examples for January 25th, 2020 6:25: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 is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D"). If not set, this pickup fulfillment remains 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 RFC 3339 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:25: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 RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants. Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S
`prep_time_duration string`	The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D"). Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S
`note string`	A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API. Max Length 500
`placed_at string`	Read only The timestamp indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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 indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). Examples for January 25th, 2020 6:25: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. The maximum length: 100 characters. Max Length 100
`is_curbside_pickup boolean` Beta	If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.
`curbside_pickup_details OrderFulfillmentPickupDetailsCurbsidePickupDetails` Beta	Specific details for curbside pickup. These details can only be populated if `is_curbside_pickup` is set to `true`.


          
  
  
            recipient
          


        

        
    
      OrderFulfillmentRecipient

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

The timestamp indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set up to 7 days in the future. If expires_at is not set, this pickup fulfillment is automatically accepted when placed.

Examples for January 25th, 2020 6:25: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 is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, "P1W3D"). If not set, this pickup fulfillment remains 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.

The timestamp that represents the start of the pickup window. Must be in RFC 3339 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:25: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 RFC 3339 duration format, e.g., "P1W3D". Can be used as an informational guideline for merchants.

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


          
  
  
            prep_time_duration
          


        

        
    string

The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, "P1W3D").

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

A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.

Max Length 500

Read only The timestamp indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

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

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

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

Read only The timestamp indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

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

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

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

Read only The timestamp indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Examples for January 25th, 2020 6:25: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. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Examples for January 25th, 2020 6:25: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 indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").

Examples for January 25th, 2020 6:25: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. The maximum length: 100 characters.

Max Length 100


          
  
  
            is_curbside_pickup
          


        

        
    boolean

Beta

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


          
  
  
            curbside_pickup_details
          


        

        
    
      OrderFulfillmentPickupDetailsCurbsidePickupDetails

Beta

Specific details for curbside pickup. These details can only be populated if is_curbside_pickup is set to true.

Object Index

You are viewing an old version of the API

All Versions

OrderFulfillmentPickupDetails

Properties

Object Index You are viewing an old version of the API 2022-11-16 Version 2022-11-16 All Versions OrderFulfillmentPickupDetails

Properties

Object Index

You are viewing an old version of the API

All Versions

OrderFulfillmentPickupDetails