Find Available Pickup Options

Returns up to 10 available pickup options for the requested items around a radius of the provided search coordinates. The pickup options returned only include options where all requested items are available and can be picked up from a single location.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Request

This endpoint expects an object.

searchAreaobjectOptional

Area where you are searching for pickup options.

itemslist of objectsOptional

Items you include in your search for pickup options.

Response

The request has been successfully processed.

resultslist of objects

The MIME type of the response body.

This endpoint expects an object.

Area where you are searching for pickup options.

Items you include in your search for pickup options.

The request has been successfully processed.

$	curl -X POST https://your_store.example.com/api/storefront/pickup-options \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"results": [
3	{
4	"pickupOptions": [
5	{
6	"pickupMethod": {
7	"id": 1,
8	"locationId": 2,
9	"displayName": "Office Pickup!",
10	"collectionInstructions": "Bring your ID!",
11	"collectionTimeDescription": "Collect during our opening hours of 0900 - 1700"
12	},
13	"availableItems": [
14	{
15	"variantId": 55,
16	"quantity": 12
17	}
18	]
19	}
20	]
21	}
22	]
23	}

$	curl -X POST https://your_store.example.com/api/storefront/pickup-options \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"results": [
3	{
4	"pickupOptions": [
5	{
6	"pickupMethod": {
7	"id": 1,
8	"locationId": 2,
9	"displayName": "Office Pickup!",
10	"collectionInstructions": "Bring your ID!",
11	"collectionTimeDescription": "Collect during our opening hours of 0900 - 1700"
12	},
13	"availableItems": [
14	{
15	"variantId": 55,
16	"quantity": 12
17	}
18	]
19	}
20	]
21	}
22	]
23	}