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
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
object | application/json
searchAreaobject
Area where you are searching for pickup options.
itemsarray[object]
Items you include in your search for pickup options.
example
Response
The request has been successfully processed.
Body
object | application/json
resultsarray[object]
example
Did you find what you were looking for?