v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Locations

List Canada Post Locations

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

get/2024-09/locations/canada_post

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

country_alpha2string required

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

postal_codestring

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

citystring

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.

statestring

Two character representation of Canadian provinces - ISO 3166-2

latitudestring

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)

longitudestring

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)

tonightboolean

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

limitinteger

Maximum number of records to return. Default is 10.

line_1string

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.

bflfboolean

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

d2poboolean

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

Response

get post offices