Accept

application/vnd.cpc.shipment-v8+xml (Note: */* in place of the header value will return an error)

Authorization

Basic {Base64 encoding of userid:password}

Accept-language

en-CA or fr-CA

shipment-price

Complex

This is the top level XML structure for the response.

service-code

Simple

(Character string – up to 32 characters)

Must be a valid code representing the Canada Post delivery service used for shipping the item. The most frequently used codes are listed below.

(Note: These delivery services and their codes can be discovered by calling the Get Rates or Discover Services web services described in Rating)

Contained within shipment-price.

This identifies the delivery service-code used for delivery of the shipment.

base-amount

Simple

(Numeric field of pattern 6.2 i.e. 999999.99)

Contained within shipment-price.

This is the base amount cost for shipping in $CAD.

priced-options

Complex

Contained within shipment-price.

This structure contains the list of options applied to this shipment and the associated price impact.

This will be absent if there are no options applied to the price of this shipment.

priced-option

Complex

Contained within priced-options.

May occur 1 … N times.

Each occurrence is a structure that represents a shipping option that applies to the shipment, and which may affect the price of the shipment.

option-code

Simple

(Character String – up to10 characters)

Contained within option.

This is the option code for an option applied to this shipment.

Option code examples are as follows

COD – Collect on delivery.
COV – Insurance coverage.
CYL – Mailing tube.
DC – Delivery confirmation.
PA18 – Proof of age 18 years.
PA19 – Proof of age 19 years.
SO – Signature option.
UP – Unpackaged.

option-price

Simple

(Numeric field of pattern 6.2 i.e. 999999.99)

Contained within option.

This is the total component of the price that is attributable to the option. Units are $CAD.

adjustments

Complex

Contained within price.

This structure contains the list of adjustments applied to this shipment and the associated price impact.

This will be absent if there are no adjustments applied to the price of this shipment.

adjustment

Complex

Contained within adjustments.

May occur 1 … N times.

This structure represents a shipping adjustment that applies to the shipment, and which may affect the price of the shipment.

adjustment-code

Simple

The code indicating which adjustment is applied to this shipment:

• AUTDISC – Automation discount
• FUELSC – Fuel surcharge
• V1DISC – Solutions for Small Business savings
• PROMODISC – Promotional discount (if the promo code is invalid or expired, the discount amount will show as zero under adjustment-amount)
• PLATFMDISC – Discount for using an e-commerce platform
• NEWREGDISC – Discount for joining the Developer Program
• ORIGSC – Service area adjustment (at origin)
• DESTSC – Service area adjustment (at destination)
• PURFEE – Fee charged for using a label before it was paid for (i.e., before performing Transmit Shipments)
• SAADJ – Service area adjustment (rate adjustment up or down for specific source and destination postal code combinations)

adjustment-amount

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within option.

This is the total cost attributable to the adjustment.

pre-tax-amount

Simple

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within shipment-price.

This is the pre-tax total amount of the shipment cost.

gst-amount

Simple

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within shipment-price.

This is the amount of the GST added to the base cost.

pst-amount

Simple

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within shipment-price.

This is the amount of the PST added to the base cost.

hst-amount

Simple

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within shipment-price.

This is the amount of the HST added to the base cost.

due-amount

Simple

(Numeric field of pattern 6.2 e.g. 999999.99)

Contained within shipment-price.

This is the total amount due for the shipment.

service-standard

Complex

Contained within shipment-price.

This structure represents the service standard to which this shipment will be delivered.

am-delivery

Simple

{true, false}

Contained within service-standard.

This indicates whether morning delivery is part of the service standard.

guaranteed-delivery

Simple

{true, false}

Contained within service-standard.

This indicates whether guaranteed delivery is part of the service standard.

expected-transmit-time

Simple

(Numeric 2-digit - e.g. pattern 99)

Contained within service-standard.

This indicates the number of days the package is expected to be in the mail stream from induction to delivery.

*Should be “expected-transit-time” due to a typo, it will be fixed in the next version

expected-delivery-date

Simple

(YYYY-MM-DD date format)

Contained within service-standard.

This indicates the estimated delivery date based from the creation date of the shipment or the expected mailing date provided in the “create” request if greater.

rated-weight

Simple

This indicates the actual weight or volumetric equivalent used to determine the base price, within the prescribed weight and size limits of the specific product, on the greater of actual weight or volumetric equivalent of actual weight.