Skip to main content
GET
Search pickup points

Authorizations

api-key
string
header
required

Query Parameters

countryCode
string

ISO 3166-1 country code. Required unless lat/lng are given.

Required string length: 2
postalCode
string

Postal code. Required unless lat/lng are given.

lat
number
lng
number
city
string
street
string
state
string
types
enum<string>[]

Restrict the search to these kinds of pickup point. Repeat the parameter for multiple values. Omit it to search every kind.

These filter values are broader than the type a point is returned with: PICKUP_DROPOFF_POINT matches points of type SERVICE_POINT and POST_OFFICE, and MAILBOX_POBOX matches type MAILBOX.

Available options:
PARCEL_LOCKER,
PICKUP_DROPOFF_POINT,
MAILBOX_POBOX
maxResults
integer
Required range: 1 <= x <= 100
maxDistanceKm
number

Search radius in kilometers. Omit for the carrier default.

Response

Pickup points near the searched location

points
object[]
totalFound
integer

Points found near the searched location. Higher than the number returned when maxResults truncated the list.

Example:

12