Canadapost Postescanada Ca Canada Post Rating API
41
AI ReadinessFoundational (D-)41/100
Agent-ready OpenAPI document · curated by JenticE CommerceShipping Logisticsbasic1 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Retrieve Canada Post shipping rates, services, prices, and transit times for a parcel via a single XML-based pricing endpoint.
Use for: Get a Canada Post shipping rate from Toronto to Vancouver for a 2 kg parcel, Compare Expedited Parcel and Xpresspost prices for the same shipment, Estimate transit time for a parcel shipped from Montreal to Halifax, Retrieve international rates from Canada to the United States
Not supported: Does not handle label printing, manifest creation, or parcel tracking - use for retrieving Canada Post rate quotes and service options only.
Jentic publishes the only available OpenAPI specification for Canada Post Rating API, keeping it validated and agent-ready. The Canada Post Rating Web Service returns shipping rates, available services, prices, and transit times for parcels moving within Canada and internationally. The single POST /rs/ship/price endpoint accepts an XML request describing origin and destination postal codes, parcel dimensions, weight, and optional service or contract identifiers, then returns priced service options for use in checkout and shipping-label workflows.
Install Jentic One Beta
Connect the Canada Post Rating API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Canada Post Rating API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcanadapost-postescanada.ca%2Fcanadapost" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcanadapost-postescanada.ca%2Fcanadapost" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Canada Post Rating API.
Quote Canada Post shipping rates for a parcel between two postal codes via /rs/ship/price
Compare service tiers such as Regular Parcel, Expedited Parcel, Xpresspost, and Priority for a single shipment
Return transit-time estimates alongside priced service options for delivery-date promises
Apply contract or commercial customer rates by passing a mailed-by or contract identifier in the request
Compute international rates by varying the destination country and postal code in the rating request
Use Cases
Patterns agents use Canada Post Rating API for, with concrete tasks.
★ Checkout Shipping Cost Calculator
E-commerce sites selling into Canada need to display real-time shipping costs at checkout. POST /rs/ship/price with the origin postal code, customer destination, and parcel weight returns priced service options that the cart can render as selectable shipping methods, including transit-time estimates customers see before paying.
POST /rs/ship/price with origin K1A 0B1 and destination V6B 4N7 for a 1.5 kg parcel and present the customer with Regular, Expedited, and Xpresspost options.
Multi-Carrier Rate Comparison
Shipping platforms route parcels to the cheapest or fastest carrier per shipment. Calling Canada Post's /rs/ship/price alongside FedEx, UPS, and other carrier rate endpoints lets a routing engine pick the best option per parcel and per service-level promise.
POST /rs/ship/price for the parcel, call equivalent FedEx and UPS rate endpoints, then select the carrier with the lowest priced service that meets the promised delivery date.
Commercial Contract Rate Quoting
High-volume shippers with Canada Post commercial contracts need contract-specific pricing rather than retail rates. The rating endpoint accepts mailed-by or contract identifiers in the request body to return rates negotiated under a commercial agreement.
POST /rs/ship/price with the contract's mailed-by identifier set, retrieve contract-specific pricing, and surface it on internal shipping dashboards.
AI Agent Shipping Workflows via Jentic
Through Jentic, an agent searches for 'get a Canada Post shipping rate', loads the input schema for /rs/ship/price, and executes the call without managing the Basic Auth credential. Jentic's vault holds the userid:password pair so it never enters the agent's prompt context.
Use the Jentic SDK to search 'get a Canada Post shipping rate', load the /rs/ship/price operation schema, and execute it with origin postal code, destination postal code, and parcel weight.
Key Endpoints
1 endpoints — jentic publishes the only available openapi specification for canada post rating api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/rs/ship/price
Get Canada Post shipping rates for a parcel
POST
/rs/ship/price
Get Canada Post shipping rates for a parcel
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Canada Post Rating API
- Foundational (D-)41/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility49
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
49
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
47%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Canada Post Rating API by hand means encoding your userid and password into HTTP Basic auth and building the XML rate request for the price route yourself. Through Jentic you install once, import Canada Post from the API Directory, store the credential once, and your agent calls it.
Permission scoping
This API exposes a single rate-quote operation that takes the shipment details in the request body, so the agent is scoped to that one operation. You choose the operations it may call, so it stays limited to retrieving rate quotes and nothing else.
Credential isolation
Your Canada Post userid and password are stored once, encrypted, by your own Jentic One instance and combined into the Basic Authorization header at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get a Canada Post shipping rate', and Jentic returns the POST /rs/ship/price operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Canada Post Rating API through Jentic.
Why is there no official OpenAPI spec for Canada Post Rating API?
Canada Post does not publish an OpenAPI specification - its developer portal documents the service in HTML and XSD form only. Jentic generates and maintains this spec so that AI agents and developers can call Canada Post Rating API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Canada Post Rating API use?
It uses HTTP Basic authentication with the userid:password pair issued by Canada Post in the developer portal. Through Jentic, the credential is stored in your Jentic One instance and injected into the Authorization header at execution time, so the raw secret never enters the agent's prompt context.
Does the API accept JSON requests?
No. The /rs/ship/price endpoint exchanges Canada Post's XML rating-service schema. Send the XML request body with the appropriate content type and parse the XML response. Jentic surfaces the operation's request shape so the agent can populate it correctly.
How do I quote a shipping rate through Jentic?
Run pip install jentic, then search 'get a Canada Post shipping rate' through the Jentic SDK. Jentic returns POST /rs/ship/price with its input schema. Provide origin postal code, destination postal code, and parcel weight, then execute the operation.
Are there separate test and production environments?
Yes. The OpenAPI spec lists two servers: production at https://soa-gw.canadapost.ca and development at https://ct.soa-gw.canadapost.ca. Use the development environment with test credentials before switching to production.
Can I retrieve transit times alongside prices?
Yes. The rating response includes a service-standard block per priced service that lists the expected transit days and the guaranteed delivery flag, which lets a shipping calculator render a delivery-date promise next to each option.
Can I limit what my agent is allowed to do with the Canada Post Rating API?
Yes. Because Jentic One is self-hosted, you decide which operations your agent may call, and this API exposes only a single rate-quote operation, POST /rs/ship/price, so the agent is scoped to retrieving shipping rates and service options and nothing else. Your Canada Post userid and password are stored once in your own instance and injected into the Basic Authorization header at execution time, so the agent never sees the raw credential. The rules you set decide the operations and credentials the agent can use, keeping it limited to pricing parcels between two postal codes.
GET STARTED