XX (Development)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{mailed by customer}

your customer number*

{shipment id}

the appropriate shipment ID*

Accept

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

Content-Type

application/vnd.cpc.ncshipment-v4+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

non-contract-shipment-receipt

Complex

This is the top level of the XML response structure.

final-shipping-point

Simple

This is the Postal Code of the Post Office where the shipment is to be dropped off.

shipping-point-name

Simple

This is the descriptive name of the shipping point.

shipping-point-id

Simple

This is the Canada Post identification number of the shipping point.

mailed-by-customer

Simple

This is the 10-digit customer number of the mailed by customer.

cc-receipt-details

Complex

This structure contains details required for a credit card receipt.

merchant-name

Simple

Will have the value: “Canada Post”

merchant-url

Simple

Will have the value: “www.canadapost.ca”

name-on-card

Simple

The name on the default credit card stored by Canada Post.

auth-code

Simple

The authorization code received from the credit card issuer.

Date and time that the authorization was obtained.
The date and time are specified in standard XML date/time format: "YYYY-MM-DDThh:mm:ss" where:

• YYYY indicates the year
• MM indicates the month
• DD indicates the day
• T indicates the start of the required time section
• hh indicates the hour
• mm indicates the minute
• ss indicates the second

card-type

Simple

The type of card used for the purchase.

Must have one of the following values:
- MC
- VIS
- AME

charge-amount

Simple

The total amount charged to the credit card for the shipping service / label.

currency

Simple

The currency of the transaction: CAD

transaction-type

Simple

The type of credit card transaction: Sale

This is the Canada Post delivery service used for shipping the item.

May be any of:

base-amount

Simple

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

priced-options

Complex

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

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

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

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

adjustments

Complex

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

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

This is the adjustment code indicating which adjustment is applied to this shipment.

adjustment-amount

This is the total cost attributable to the adjustment.

pre-tax-amount

Simple

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

gst-amount

Simple

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

pst-amount

Simple

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

hst-amount

Simple

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

service-standard

Complex

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

am-delivery

Simple

{true, false}

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

guaranteed-delivery

Simple

{true, false}

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

expected-transit-time

Simple

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

expected-delivery-date

Simple

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 Canada Post’s calculation and your declaration.