Get locations

get
/locations

Get carrier locations.

To ensure optimal testing and integration of the Get locations API, it is strongly recommended to use the production environment to get locations.

Contact sales to activate this feature.

slug
string
required

Courier slug

Allowed values:
upsevrifedexuspsyodelgls
country
string
required

Country in ISO 3166-1 alpha 3 code

street
string

Address line of address. Optional but recommended to improve the accuracy of your address

postal_code
string

Postal code of address. Either city or postal_code must be provided. Required for evri, ups

city
string

City of address. Either city or postal_code must be provided

state
string

State of address

count
number

Number of search result

>= 1<= 50
Default:
5
distance
string

Radius in kilometres used to determine the search boundaries for locations

distance_unit
string
Allowed values:
kmmi
Default:
km
filters
array

You can use the filters to filter out the location based on various conditions. For detailed filters see here

Simple Usage
filters[]=location_type:ups_customer_center

Multiple Key OR (location_type = ups_customer_center OR the_ups_store)
filters[]=location_type:ups_customer_center,the_ups_store

Multiple Condition AND (location_type = ups_customer_center AND business_classification = gift_shop)
filters[]=location_type:ups_customer_center&filters[]=business_classification:gift_shop

NOT operation (location_type NOT = ups_customer_center)
filters[]=!location_type:ups_customer_center

Content-Type
string
required

Content-Type

Default:
application/json
Example:
application/json
Auth
:
Parameters
:
:
:
:
:
:
:
:
:
:
: