API ReferenceDocs
API Reference
Dashboard

List Canada Post Locations

get
https://public-api.easyship.com/2024-09/locations/canada_post

Retrieve Canada Post locations.

This endpoint routes requests to the Canada Post Get Nearest Post Office API. For further information, kindly look into the Canada Post API documentation available at https://www.canadapost-postescanada.ca/info/mc/business/productsservices/developers/services/findpostoffice/nearestpostoffice.jsf

Required authorization scope: public.location:read

Query Params
integer
≥ 1

Page number to fetch, default: 1

integer
1 to 100

Number of records per page to fetch, default: 20

string
required

Country code: Alpha-2 format (ISO 3166-1).

string
≤ 10

A unique location code used by postal services to sort and deliver mail.

string
≤ 50

If Postal Code is not specified, both State and City should be provided to obtain meaningful information. For larger municipalities all of State, City and Line_1 may be required.

string
≤ 50

Two character representation of Canadian provinces - ISO 3166-2

string
≤ 10

If you use longitude and latitude to define the location, both longitude and latitude must be present and all other search fields (postalCode, state, city, and line_1) should be omitted. (If any of these other search fields are present, they will be ignored)

string
≤ 10

If you use longitude and latitude to define the location, both longitude and latitude must be present and all other search fields (postalCode, state, city, and line_1) should be omitted. (If any of these other search fields are present, they will be ignored)

boolean

Indicates whether to return only post offices that are open tonight.

integer
1 to 50

Maximum number of records to return. Default is 10.

string
≤ 100

Street Name only—without the house or apartment number (a search with house or apartment number will not be successful). Street Name can be a multi-part name with embedded spaces.

boolean

Indicates whether to return only post offices that accept the Box Free Label delivery of parcels.

boolean

Indicates whether to return a list of Post Offices that accept the Deliver to Post Office delivery of parcels.

Responses

Updated 7 months ago

Language
Credentials
Bearer
token
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago