BigCommerce
Management API
Pickup Options

Pickup Options V3

This API provides a way to search for available pickup options near provided coordinates.

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.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

object | application/json
  • search_area
    object
    required

    Area where you are searching for pickup options.

  • items
    array[object]
    required

    Items you include in your search for pickup options.

example

Response

The request has been successfully processed.

Body

object | application/json
  • results
    array[object]

example

Did you find what you were looking for?