Get Branches

get

https://queries-test.envia.com/branches/{carrier}/{country_code}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

carrier

string

required

Carrier name.

country_code

string

required

Two-digit country code.

Query Params

zipcode

string

Zipcode value to filter.

branchType

number

enum

Branch type filter (By default returns all branch types).

ID	Branch type
1	Post Office
2	Warehouse
3	Third Party
4	Lockers

Allowed:

locality

string

Locality filter.

state

string

State filter.

type

number

enum

Defaults to 1

Available branches by location (origin/destination)

ID	Location
1	Origin
2	Destination
3	Origin and Destination

Allowed:

latitude

float

Latitude for geolocation search.

longitude

float

Longitude for geolocation search.

address

string

Full address filter.

allBranch

boolean

If true, returns all branches.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response