Find Available Pickup Options

POST

https://api.bigcommerce.com/stores/:store_hash/v3/pickup/options

POST

/stores/:store_hash/v3/pickup/options

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/pickup/options \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "search_area": {
    "radius": {
      "value": 10,
      "unit": "KM"
    }
  },
  "items": [
    {
      "variant_id": 24,
      "quantity": 98
    }
  ]
}'

200Successful

{
  "results": [
    {
      "pickup_options": [
        {
          "pickup_method": {
            "id": 1,
            "location_id": 2,
            "display_name": "Office Pickup!",
            "collection_instructions": "Bring your ID!",
            "collection_time_description": "Collect during our opening hours of 0900 - 1700"
          },
          "available_items": [
            {
              "variant_id": 55,
              "quantity": 12
            }
          ]
        }
      ]
    }
  ]
}

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.

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 an object.

search_areaobjectRequired

Area where you are searching for pickup options.

itemslist of objectsRequired

Items you include in your search for pickup options.

Response

The request has been successfully processed.

resultslist of objectsOptional