API Integration

Canada Post

canadapostproduction-ready

Mailing and shipping for Personal and Business.

PickupShippingManifestRatingTracking

Connection Requirements

Field	Type	Description
username	string	The username field for carrier connection.
password	string	The password field for carrier connection.
customer_number	string	The customer_number field for carrier connection.
contract_id	string	The contract_id field for carrier connection.
language	string	The language field for carrier connection.
account_country_code	string	The account_country_code field for carrier connection.
metadata	object	The metadata field for carrier connection.
config	object	The config field for carrier connection.

Field	Type	Description
cost_center	string	Configuration option for cost_center.
label_type PDF_4x6PDF_8_5x11ZPL_4x6	string	Configuration option for label_type.
shipping_options	list	Configuration option for shipping_options.
shipping_services	list	Configuration option for shipping_services.
transmit_shipment_by_default	boolean	Configuration option for transmit_shipment_by_default.

Service Name	Service Code
DOM.RP	canadapost_regular_parcel
DOM.EP	canadapost_expedited_parcel
DOM.XP	canadapost_xpresspost
DOM.XP.CERT	canadapost_xpresspost_certified
DOM.PC	canadapost_priority
DOM.LIB	canadapost_library_books
USA.EP	canadapost_expedited_parcel_usa
USA.PW.ENV	canadapost_priority_worldwide_envelope_usa
USA.PW.PAK	canadapost_priority_worldwide_pak_usa
USA.PW.PARCEL	canadapost_priority_worldwide_parcel_usa
USA.SP.AIR	canadapost_small_packet_usa_air
USA.TP	canadapost_tracked_packet_usa
USA.TP.LVM	canadapost_tracked_packet_usa_lvm
USA.XP	canadapost_xpresspost_usa
INT.XP	canadapost_xpresspost_international
INT.IP.AIR	canadapost_international_parcel_air
INT.IP.SURF	canadapost_international_parcel_surface
INT.PW.ENV	canadapost_priority_worldwide_envelope_intl
INT.PW.PAK	canadapost_priority_worldwide_pak_intl
INT.PW.PARCEL	canadapost_priority_worldwide_parcel_intl
INT.SP.AIR	canadapost_small_packet_international_air
INT.SP.SURF	canadapost_small_packet_international_surface
INT.TP	canadapost_tracked_packet_international

Option	Code	Type
canadapost_signature	SO	boolean
canadapost_coverage	COV	float
canadapost_collect_on_delivery	COD	float
canadapost_proof_of_age_required_18	PA18	boolean
canadapost_proof_of_age_required_19	PA19	boolean
canadapost_card_for_pickup	HFP	boolean
canadapost_do_not_safe_drop	DNS	boolean
canadapost_leave_at_door	LAD	boolean
canadapost_deliver_to_post_office	D2PO	boolean
canadapost_return_at_senders_expense	RASE	boolean
canadapost_return_to_sender	RTS	boolean
canadapost_abandon	ABAN	boolean
canadapost_cost_center	cost-centre	string
canadapost_submit_shipment	transmit-shipment	boolean