Branches
Get Branches
Query carrier branches for a given carrier and country. Filters allow searching by zipcode, locality, state, geolocation, etc. type is the search type: 1, 2, or 3.
get/branches/{carrier}/{country_code}
Path parameters
carrierstring required
Example:estafeta
Carrier name.
country_codestring required
Example:MX
Two-digit country code.
Query parameters
zipcodestring
Example:06100
Zipcode value to filter.
branchType1 | 2 | 3 | 4
Example:1
Branch type filter (By default returns all branch types).
| ID | Branch type |
|---|---|
| 1 | Post Office |
| 2 | Warehouse |
| 3 | Third Party |
| 4 | Lockers |
localitystring
Example:Cuauhtemoc
Locality filter.
statestring
Example:Ciudad de Mexico
State filter.
type1 | 2 | 3
Example:1
Available branches by location (origin/destination)
| ID | Location |
|---|---|
| 1 | Origin |
| 2 | Destination |
| 3 | Origin and Destination |
latitudenumber float
Example:48.833841
Latitude for geolocation search.
longitudenumber float
Example:2.316922
Longitude for geolocation search.
addressstring
Example:Av. Insurgentes Sur 2357, CDMX
Full address filter.
allBranchboolean
If true, returns all branches.
Response
Successful response
Example response
{
"data": [
{
"branch_id": "LNT",
"branch_code": "LNT",
"branch_type": 1,
"reference": "RMX - DR GALVEZ",
"address": {
"city": "Alvaro Obregon",
"state": "CX",
"number": "2357",
"street": "Av. Insurgentes Sur",
"country": "MX",
"delivery": true,
"latitude": "19.34265",
"locality": "Alvaro Obregon",
"admission": true,
"longitude": "-99.189674",
"postalCode": "01000",
"address": "Av. Insurgentes Sur 2357, Alvaro Obregon, 01000, CDMX"
}
}
]
}