track_package
Track a package
Track any parcel by its tracking number. No account needed. Works for parcels shipped through this service with any carrier, and for most Canadian carrier numbers (Canada Post, UPS, FedEx, Purolator, Nationex, GLS). Returns the current status, the estimated or actual delivery date and the carrier's latest scans, plus a link to the full tracking page. Use this whenever someone asks where a parcel is.
输入参数langtracking_number必填
get_shipping_quote
Get a shipping quote
Get live shipping prices for one parcel from several carriers (Canada Post, UPS, FedEx and others). No account needed. Give the origin and destination postal or ZIP codes and the weight in kilograms (convert pounds and inches first); the box size is optional and a 30 x 20 x 10 cm box is assumed when it is missing. Returns up to 6 of the cheapest services with price and estimated transit time, and a link that opens the same quote on the website, where the label can be bought. Prices are the public rates at the moment of the quote. If the user is signed in, compare_shipping_rates returns their own account prices instead.
输入参数langwidth_cmheight_cmlength_cmto_postal必填weight_kg必填to_countryfrom_postal必填from_country
find_drop_off_points
Find drop-off and pick-up points
Find places near a Canadian postal code where a parcel can be dropped off or picked up. No account needed. Covers Canada Post outlets, FedEx locations, UniUni drop-off points and MesColis counters, nearest first, with the address, distance, what can be done there and a map link. Optionally limit the search to one network. Opening hours vary, so suggest checking the map link before going.
输入参数langnetworkpostal_code必填max_per_network
compare_shipping_rates
Compare shipping rates
Compare live shipping rates for one parcel across every carrier available on the SIGNED-IN account (Canada Post, Purolator, UPS, FedEx and others), at the prices of that account. Returns each carrier and service with its total price, currency and estimated transit days. Requires the user to connect their account; for someone without an account use get_shipping_quote, which needs no sign-in. Prices are live and account-specific; do not cache them.
输入参数width_cm必填height_cm必填length_cm必填to_postal必填weight_kg必填to_countryfrom_postal必填residentialfrom_country
track_parcel
Track a parcel
Look up the live status and checkpoint history of a parcel on the SIGNED-IN account by its tracking number. Returns the current status, estimated delivery date, the shipment id and the full checkpoint list. Requires the user to connect their account; to track any parcel without signing in, use track_package. Supplying the carrier is optional but makes the lookup faster.
输入参数carriertracking_number必填
list_shipments
List shipments
List shipments on the authenticated account, newest first. Supports paging and filtering by status (for example "Delivered" or "In Transit"). Use get_shipment for the full record of one shipment.
输入参数limitoffsetstatus
get_shipment
Get one shipment
Retrieve the full record of a single shipment by its ID, including addresses, carrier, service, cost and current status.
输入参数id必填
list_addresses
List saved addresses
List saved addresses from the account address book. Read-only — this server cannot create, change or delete addresses.
输入参数limitoffset