Reference · built on requestConnectorShipping & logistics

Canada Post

Rating, shipping, manifests, tracking, returns, and pickups from the Canada Post Developer Portal APIs.

Request accessPricing ↗

About

Canada Post is Canada's postal operator. Its Developer Portal lists Rating, Shipping, Tracking, Returns, Pickup, Post Office Services, Customer Information Services, Service Information, and AddressComplete APIs. Shipping creates shipments, retrieves labels and receipts, voids shipments, requests refunds, and transmits manifests. Tracking returns summaries and details by PIN, by delivery notice card number, or by reference. Every call carries an OAuth 2.0 bearer token issued to an app you register on the portal.

With Fibric, an operator follows each Canadian parcel from manifest to delivery, proposes the customer notice when a PIN stalls, and drafts the authorized return label when a customer asks to send something back.

This is a reference listing. It documents what Fibric would read from Canada Post and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Tracking summaries and details by PIN (GET /pins/{pinNumber}/summaries and /details), by DNC number, or by reference
  • Delivery confirmation certificates via POST /create-certificate
  • Shipping costs between two points at various speeds of service via POST /prices, with service and option lookups
  • Shipment details, price, receipt, and QR code for shipments created under your customer number
  • Manifest status and documents after shipments are transmitted
  • Contract numbers, authorized payers, and methods of payment from Customer Information Services
  • Scheduled web service outages from Service Information

Proposed actions

  • Target capability: propose a shipment (POST shipments) and return its label artifact for review
  • Target capability: propose voiding a shipment (DELETE shipments) or a refund request for one already transmitted
  • Target capability: propose transmitting shipments as a manifest (POST manifests) at the end of the day
  • Target capability: propose an authorized or open return label through the Returns API
  • Target capability: propose a pickup request through the Pickup API after checking availability

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Write carrier status back to the order

    Poll tracking summaries for open PINs and propose the order status change and customer note when the event changes.

    With Tracking Sync

  • Produce the delivery certificate for a dispute

    When a customer claims non-delivery, propose a delivery confirmation certificate request and attach the result to the case.

    With Delivery Dispute

  • Draft the return label

    For an approved return, propose the authorized return label with the customer's address and the service you allow.

    With Returns Triage

Requirements

  • A Canada Post business profile with a customer number, or registration for one, before creating apps
  • An app on the Developer Portal; its API Secret is displayed only once at creation
  • A subscription to each API under the default-plan or priority plan
  • Test apps for development, since they use static or stubbed data and do not trigger billing
Authentication
OAuth 2.0 client credentials: POST /oauth2/token with the app's client_id and client_secret in the X-IBM-Client-Id and X-IBM-Client-Secret headers, returning a Bearer token with an expires_in value.

Limits

  • Rate limits are set per subscription plan and per API; the portal shows them to signed-in users
  • Test apps return stubbed data, so checks against real parcels need a production app
  • No webhook is documented for Tracking; status is fetched by PIN, DNC, or reference
  • Shipping paths are scoped by mailed-by and mail-on-behalf-of (mobo) customer numbers

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Canada Post ↗

Questions and answers

How does authentication work for Canada Post APIs?
Every operation requires an OAuth 2.0 Bearer token. Request it from /oauth2/token with grant_type=client_credentials and a scope, sending your client_id and client_secret in the X-IBM-Client-Id and X-IBM-Client-Secret headers. Credentials belong to an app you create on the Developer Portal.
Is there a sandbox?
Yes. Apps are created as test or production. Test apps use static or stubbed data and do not trigger billing. Production apps run against real data and generate real keys. Register each organization if you hold several customer numbers.
Can Fibric track a parcel without the PIN?
Yes. Tracking accepts a delivery notice card (DNC) number or a reference through GET /refs/summaries, in addition to the PIN endpoints. Details and a delivery confirmation certificate are available per PIN.
Ask about Canada Post

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with Canada Post through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy