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.
Courier slug
Country in ISO 3166-1 alpha 3 code
Address line of address. Optional but recommended to improve the accuracy of your address
Postal code of address. Either city or postal_code must be provided. Required for evri, ups
City of address. Either city or postal_code must be provided
State of address
Number of search result
Radius in kilometres used to determine the search boundaries for locations
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
Get locations
Meta data object.
Code of Meta
Message of Meta
Details of Meta
Whether this request will be retryable or not
The array contains locations object information. Please refer to location object for details.
Drop off link of the carrier
{ "meta": { "code": 200, "message": "OK", "details": [] }, "data": { "locations": [ { "location_id": "103753", "name": "THE UPS STORE", "distance": 0.1, "distance_unit": "km", "phone": "2128100834", "services": [ "Direct To Retail", "Retail to Retail", "PUDO", "Early Pickup Delivery Time", "DCO DCR intercept accepted", "Accepts Restricted Articles", "Accepts Mobile Barcodes", "Accepts No Box No Label" ], "address": { "street": "33 PARK PL", "postal_code": "10007-2485", "city": "NEW YORK", "state": "NY", "country": "USA", "longitude": -74.0095291, "latitude": 40.71355056 }, "business_hours": [ { "day_of_week": "Mon", "open_time": "08:30", "close_time": "19:00" }, { "day_of_week": "Tue", "open_time": "08:30", "close_time": "19:00" }, { "day_of_week": "Wed", "open_time": "08:30", "close_time": "19:00" }, { "day_of_week": "Thu", "open_time": "08:30", "close_time": "19:00" }, { "day_of_week": "Fri", "open_time": "08:30", "close_time": "19:00" }, { "day_of_week": "Sat", "open_time": "10:00", "close_time": "17:00" }, { "day_of_week": "Sun", "open_time": "11:00", "close_time": "16:00" } ], "location_type": "the_ups_store", "business_classification": "pack_and_ship", "instructions": null }, { "location_id": "25361", "name": "SELF SERVICE DROP BOX", "distance": 0.2, "distance_unit": "km", "phone": "1-800-PICKUPS", "services": [], "address": { "street": "225 BROADWAY", "postal_code": "10007", "city": "NEW YORK", "state": "NY", "country": "USA", "longitude": -74.0079956, "latitude": 40.71196746 }, "business_hours": [], "location_type": "ups_drop_box", "business_classification": null, "instructions": "Location is between Barclay and Vesey St. Enter the building and go to the back of the lobby. The Drop Box is located on the left side by the stairs." }, { "location_id": "77083", "name": "THE UPS STORE", "distance": 0.4, "distance_unit": "km", "phone": "2124069010", "services": [ "Direct To Retail", "Retail to Retail", "PUDO", "Early Pickup Delivery Time", "DCO DCR intercept accepted", "Accepts Restricted Articles", "Accepts Mobile Barcodes", "Accepts No Box No Label" ], "address": { "street": "82 NASSAU ST", "postal_code": "10038-3703", "city": "NEW YORK", "state": "NY", "country": "USA", "longitude": -74.0080795, "latitude": 40.70974731 }, "business_hours": [ { "day_of_week": "Mon", "open_time": "08:30", "close_time": "19:30" }, { "day_of_week": "Tue", "open_time": "08:30", "close_time": "19:30" }, { "day_of_week": "Wed", "open_time": "08:30", "close_time": "19:30" }, { "day_of_week": "Thu", "open_time": "08:30", "close_time": "19:30" }, { "day_of_week": "Fri", "open_time": "08:30", "close_time": "19:30" }, { "day_of_week": "Sat", "open_time": "12:00", "close_time": "15:00" }, { "day_of_week": "Sun", "open_time": "11:00", "close_time": "16:00" } ], "location_type": "the_ups_store", "business_classification": "pack_and_ship", "instructions": null }, { "location_id": "28262", "name": "SELF SERVICE DROP BOX", "distance": 0.4, "distance_unit": "km", "phone": "1-800-PICKUPS", "services": [], "address": { "street": "26 FEDERAL PLZ", "postal_code": "10278", "city": "NEW YORK", "state": "NY", "country": "USA", "longitude": -74.0033187, "latitude": 40.71445846 }, "business_hours": [], "location_type": "ups_drop_box", "business_classification": null, "drop_off_link": "https://www.ups.com/dropoff", "instructions": "THE UPS DROP BOX IS LOCATED IN THE LOBBY TO THE RIGHT, ACCROSS FROM THE STORE." }, { "location_id": "15087", "name": "SELF SERVICE DROP BOX", "distance": 0.5, "distance_unit": "km", "phone": "1-800-PICKUPS", "services": [], "address": { "street": "160 BROADWAY", "postal_code": "10038", "city": "NEW YORK", "state": "NY", "country": "USA", "longitude": -74.010231, "latitude": 40.70951843 }, "business_hours": [], "location_type": "ups_drop_box", "business_classification": null, "instructions": "The letter box is located in the lobby of the building." } ], "drop_off_link": "https://www.ups.com/dropoff" } }