Docs
Storefront API
Pickup options

Storefront Pickup Options

This API endpoint enables you to search for available pickup options near provided coordinates.

For info about API accounts, see API Accounts and OAuth Scopes.

For info about authenticating BigCommerce APIs, see Authentication and Example Requests.

Find Available Pickup Options

POST /pickup-options

Request

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.

Parameters

  • store_domain in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • searchArea    object

    Area where you are searching for pickup options.

  • items    array[object]

    Items you include in your search for pickup options.

example

{
"searchArea": {
"radius": {
"value": 25,
"unit": "KM"
},
"coordinates": {
"latitude": 37.7749,
"longitude": 122.4194
}
},
"items": [
{
"variantId": 24,
"quantity": 98
}
]
}

Response

The request has been successfully processed.

Body

object | application/json

  • results    array[object]

example

{
"results": [
{
"pickupOptions": [
{
"pickupMethod": {
"id": 1,
"locationId": 2,
"displayName": "Office Pickup!",
"collectionInstructions": "Bring your ID!",
"collectionTimeDescription": "Collect during our opening hours of 0900 - 1700"
},
"availableItems": [
{
"variantId": 55,
"quantity": 12
}
]
}
]
}
]
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get OrderFind Available Pickup Options