Create Pickups

POST

https://api.bigcommerce.com/stores/:store_hash/v3/orders/pickups

POST

/stores/:store_hash/v3/orders/pickups

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/orders/pickups \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "pickup_method_id": 2,
    "order_id": 103,
    "ready_at": "'\''1660555844'\'' or '\''2022-06-11T00:00:20Z'\''",
    "pickup_items": [
      {
        "order_product_id": 4,
        "quantity": 5
      }
    ]
  }
]'

{
  "data": [
    {
      "id": 1,
      "pickup_method_id": 2,
      "order_id": 103,
      "ready_at": "2022-08-15T09:30:44Z",
      "created_at": "2022-08-12T04:15:19.150539Z",
      "updated_at": "2022-08-12T04:15:19.150539Z",
      "pickup_items": [
        {
          "id": 3,
          "order_product_id": 4,
          "quantity": 5,
          "status": "COLLECTED",
          "collected_at": "2022-08-12T04:15:19.150539Z"
        }
      ]
    }
  ],
  "meta": {}
}

Creates one or many pickups.

This is a batch operation that can create up to 100 pickup objects in one request.

Limits

Limit of creating 100 pickup objects per POST request.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Fulfillment	read-only	`store_order_fulfillment_read_only`
Order Fulfillment	modify	`store_order_fulfillment_manage`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects a list of objects.

pickup_method_idintegerRequired>=1

ID of pickup method.

order_idintegerRequired>=1

ID of order.

ready_atstringRequired

Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970) ISO-8601: Represents the time in ISO format.

pickup_itemslist of objectsRequired

collected_atstringOptional

Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970). ISO-8601: Represents the time in ISO format. If this value is not supplied, the pickup item collected_at property will be null.

Response

The request has been successfully processed.

datalist of objectsOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error