Create Pickups | BigCommerce Developer Center

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.

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

pickup_itemslist of objectsRequired

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.

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.

order_idintegerOptional>=1

ID of order.

pickup_method_idintegerOptional>=1

ID of pickup method.

Response

The request has been successfully processed.

datalist of objects

metaobject

Errors

422

Unprocessable Entity Error

1	curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/orders/pickups \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"pickup_items": [
7	{
8	"order_product_id": 4,
9	"quantity": 5
10	}
11	],
12	"ready_at": "\'1660555844\' or \'2022-06-11T00:00:20Z\'"
13	}
14	]'

1	{
2	"data": [
3	{
4	"created_at": "2022-08-12T04:15:19.150539Z",
5	"id": 1,
6	"order_id": 103,
7	"pickup_items": [
8	{
9	"collected_at": "2022-08-12T04:15:19.150539Z",
10	"id": 3,
11	"order_product_id": 4,
12	"quantity": 5,
13	"status": "COLLECTED"
14	}
15	],
16	"pickup_method_id": 2,
17	"ready_at": "2022-08-15T09:30:44Z",
18	"updated_at": "2022-08-12T04:15:19.150539Z"
19	}
20	],
21	"meta": {}
22	}