QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Update a shipper account's settings
patch
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Volume
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

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
integer

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
:
:
:
:
:
:
:
:
:
:
: