Docs
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

Parameters

  • store_hash 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

  • 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

{
"search_area": {
"coordinates": {
"latitude": 37.7749,
"longitude": 122.4194
},
"radius": {
"value": 10,
"unit": "KM"
}
},
"items": [
{
"variant_id": 24,
"quantity": 98
}
]
}

Response

The request has been successfully processed.

Body

object | application/json

  • results    array[object]

example

{
"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
}
]
}
]
}
]
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Delete Pickup MethodsFind Available Pickup Options