Find nearby drop point locations

GET

/drop_points/locations

const url = 'https://example.com/drop_points/locations?radius=example&latitude=example&longitude=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/drop_points/locations?radius=example&latitude=example&longitude=example'

Parameters

Query Parameters

radius

required

string

latitude

required

string

longitude

required

string

sku

Any of:

string
null

string

page_size

Any of:

string
null

string

Responses

200

application/json

Array<object>

object

required

string

drop_point_id

required

Any of:

string
null

string

external_id

required

Any of:

string
null

string

name

required

Any of:

string
null

string

shipping_address

required

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

billing_address

required

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

opening_hours

required

object

monday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

tuesday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

wednesday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

thursday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

friday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

saturday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

sunday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

opening_hours_notes

required

Any of:

string
null

string

created_at

required

Any of:

string
null

string

updated_at

required

Any of:

string
null

string

deleted_at

required

Any of:

string
null

string

billing_email

required

Any of:

string
null

string

shipping_email

required

Any of:

string
null

string

settings

required

object

acceptable_skus

required

Any of:

Array<string>
null

Array<string>

unlisted

required

When true the location is excluded from the public nearby search (and so from the map), but still resolves by barcode — scanning its QR code on site works as normal.

boolean

review_state

required

Whether this location is publicly visible. Only approved locations appear in the nearby search, resolve by barcode, or accept scans. No owner-facing route can write this field.

string

Allowed values: approved pending rejected

barcodes

required

Array<string>

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

drop_point_fk

required

Any of:

string
null

string

address

required

Deprecated: renamed to shipping_address (with billing_address added).

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

volatile_distance

required

Any of:

number
string

number

Example

[
  {
    "shipping_address": {
      "latitude": "Infinity",
      "longitude": "Infinity"
    },
    "billing_address": {
      "latitude": "Infinity",
      "longitude": "Infinity"
    },
    "review_state": "approved",
    "latitude": "Infinity",
    "longitude": "Infinity",
    "address": {
      "latitude": "Infinity",
      "longitude": "Infinity"
    },
    "volatile_distance": "Infinity"
  }
]