Messages and Code Tables

View a list of error messages

View code tables/abbreviations

Tracking scan events

Error messages

Error messages and mitigation strategies

In some cases, it will make sense to pass an error message directly to your end users. In other cases, you can choose to prevent an error message from appearing by putting a mitigation strategy in place, as described in the table below.

Please note that where messages have parameters (a number in curly brackets), the web service will substitute the appropriate value(s).

Code Description Meaning and Mitigation

AA001

The user id for the request has been deactivated. If you withdrew from the Developer Program, rejoin the program.

From the Developer Program website, select Join Now.

AA002

The username and password of the request do not match the endpoint.

E.g. development key against production endpoint or vice versa.

Merchant requests cannot be sent to the development environment.

AA003

The API key in the "Authorization" header does not match the mailed-by customer number in the request.

Verify your data.

AA004

You cannot mail on behalf of the requested customer.

AA005

Platform id not specified

The platform-id header variable is empty or not present in the URL. This should only be encountered during platform development coding.

AA006

Platform not authorized

The platform-id specified is incorrect or the merchant subsequently came to Canada Post and intentionally revoked permission for your platform to submit transactions on its behalf. The merchant could be asked to revalidate with Canada Post if they want to re-establish their relationship with the platform.

This error would also occur if the online owner of the platform key voluntarily withdrew from the Developer Program.

In rare cases, Canada Post may have deactivated the entire platform status due to fraud or misuse concerns.

AA007

Platform not active

You will receive this error if you have tried to use Get Merchant Registration Token while your application to become an approved e-commerce platform with Canada Post is still pending. You cannot use this service until Canada Post has approved your application.

In rare cases, Canada Post may have deactivated the entire platform status due to fraud or misuse concerns.

AA008

Unauthorized Platform

You will receive this error if you are attempting to use Get Merchant Registration Token service but have not applied to become an e-commerce platform with Canada Post. To apply, sign in to the Developer Program home page and select Become a Platform.

AA009

Key type not valid for platform-id

If a key other than a merchant key is being used to authenticate a transaction, the platform-id field must not be specified. Remove the platform-id field from the request even if you are a registered platform. Only requests done on behalf of a merchant can specify the platform-id.

AA010

Incorrectly configured platform request.

The platform-id in the header and the platform-id in the URL disagree. These values must match.

E00010

No Post Offices found

002

Duplicate Pin

The parcel identification number (PIN) or delivery notice card (DNC) number you provided in your request is a duplicate.

003

No Signature Image Available

You might receive this message if:

  • You are looking for a signature image for a service that does not support signature (such as U.S. and international services).
  • 45 days have passed since the signature image was captured.
  • A recipient requested suppression of their signature image from view.

004

No Pin History

No tracking results were found based on the parameters provided. Check your parameters and the order of the from and to dates.

006

Reference number, mailed from date, mailed to date and destination Postal Code are required fields for a reference number search.

Received only on reference number searches. Please provide all required fields.

007

No Delivery Information Available

008

Invalid Date

For summary reference searches, dates greater than 2 months old will result in a return of this error.

200

Success - As per specific service
(see individual service documentation).

Process the details in the message body.

202

The requested resource is not yet available. Please try again later. For example, after a Create Non-Contract Shipment request, a delay of approximately one second is required before you can retrieve the shipping label with a Get Artifact call.

Submit the same request at regular intervals (e.g. every second). For some types of actions, such as transmitting thousands of shipments, you may need to poll for a few minutes before the request is successful.

204

Success

No action required.
e.g., Delete was successful.

304

Success

Use the stored version of the data. (The resource has not been modified. Used in combination with ETag and If-None-Match headers).

400

Error
Code = "Server"

A request failed schema validation. The description contains a detailed message to help you troubleshoot. These errors should only occur during development and should be resolved before any application goes to production.

400

Error
Code = numeric

If the code is numeric, the error could either be corrected by an end-user, given a flexible UI, or could be corrected by the developer in the form of logical selections, filters or validations by the application in advance of sending the request.

401

Error

Correct the API key in the "Authorization" header.

403

Error

See Errors AA001, AA002, AA003, AA004

404

Not Found

The resource path is incorrect or the resource is no longer available. If received for a recently created resource, retry later.

406

Error

The interface version expected to be returned by the request (GET) is invalid or not supported. Change the "accept" header variable.

415

Error

The interface version declared in the request (POST) is invalid or not supported. Change the “content-type” header variable.

500

Error

Correct the XML schema error as per the detailed message.

1128

Value is a mandatory field for at least one of the options selected.

One of the specified <option-code> values requires an <option-amount> indicator. For example, Collect on Delivery (COD) and Insurance (COV) require amounts. You can identify options with this requirement by a Get Option call where the <qualifier-required> element is 'true'.

1156

Address Line 1 is a mandatory field.

Please include a value in address-line-1.

1157

City is mandatory when shipping to Canada or USA.

Please enter a city.

1159

Province is mandatory when shipping to Canada, and State is mandatory when shipping to USA.

Please enter a province.

1182

The transaction could not be authorized. Please update the credit card information.

Due to an issue with the default credit card on file with Canada Post, we are unable to authorize this transaction. This error will occur, for example, if the credit card has expired or has been reported stolen. Please sign in to the Canada Post website and edit your business profile to provide updated credit card information.

1184

The COD Method of Collection is a mandatory field when the COD option is selected.

The COD option requires the end user to indicate the method of collection for the COD order. See the code table for valid option-qualifier-2 values in Create Shipment.

1459

The Reason for Export code value is not valid (Note: As of April 2016, gift is no longer valid).

Enter a valid reason for export. The options are:
DOC = document
SAM = commercial sample
REP = repair or warranty
SOG = sale of goods
OTH = other (if you select OTH, you must also provide more details in the other-reason field).

1622

The expected-mailing-date must not be in the past.

The <expected-mailing-date> is used to calculate the delivery date. It should be either the current date or a date in the future when the mail will be deposited at Canada Post. You can remove this element from the request, in which case it will be assumed that the shipment is deposited on the same day as the electronic record is created. The system or user can also provide a future date.

1653

Method of payment “Account” is not available. Please select another method of payment.

To create an authorized return or a commercial shipping label you must be a commercial customer with a parcel agreement and have an account in good standing. If you are a Solutions for Small Business™ customer, returns web services are not available.

1711

Please select a different Method of Payment.

Valid methods of payment are by 'account' or 'creditcard'.

1718

The value exceeds the maximum threshold of {0}.

The amount of insurance requested in the <option-amount> must be reduced to the maximum value (as indicated in the error message) or less.

1719

The coverage amount cannot exceed the total value of your goods, up to the maximum allowable for the product and country.

If you want the maximum allowable coverage, set option-qualifier-1 to true and do not provide a value in option-amount.

Otherwise, adjust your option-amount value so it is less than or equal to the total value of your goods or the maximum allowable for product and country.

1722

The {0} option is invalid for the selected Service. Please change the options or select another service.

End users can select a number of options when using Delivery Services. However, not all shipping and mailing services offer the same set of options. You can set up the Get Service request in advance so you present only the allowable options for a given service.

1740

The Postal Code is invalid.

This message appears if the Postal Code provided in the <destination> group is invalid. Some Postal Codes have a valid format but do not exist as part of a valid street address. Postal Codes that generate this error must be corrected by the end user or in the source data store.

1743

The Customs Non Delivery Instruction cannot be 'Treat As Abandoned' if shipping an international parcel service with coverage.

Either the coverage option (COV) needs to be removed or the non-delivery option of 'ABAN' needs to be changed to one of the other valid options such as 'RASE' (Return at Sender's Expense).

2550

Contract number is not valid.

This error occurs when a rating request is made with a non-numeric value for the contract parameter in the query string. This value can be omitted to see information available to all customers.

2206

Contract Number is a required field.

For a Create Shipment request, a value for element <contract-id> within <settlement-info> must be provided. Behalf-of customers without a contract cannot use the Create Shipment request.

2550 The contract number is not valid. The contract-id you provided is not a valid contract number. Check your number and try again.

2561

This Customer Number and Contract Number combination is invalid.

For a Create Shipment request, the value in the mailed on behalf of customer in the URL does not have a valid relationship to the <contract-id> value in the body of the request.
For a Get Rates request, the <customer-number> and <contract-id> values in the body of the request do not have a valid relationship.
If the mailed by and behalf of customer numbers are the same, the error will be with the contract number.

2653

The Postal Code is not valid for the selected province. Please correct the Postal Code or select a different province.

In the <destination> group, the <prov-state> value does not agree with the province for the <postal-zip-code> value. One of these two elements needs to be changed to align with the other.

2683

The COD amount cannot exceed {0}.

The value in <option-amount> must be reduced.

Note: There is a $1,000 maximum (including shipping cost, if applicable) on COD shipments for Solutions for Small Business customers and a $5,000 maximum for commercial customers.

The maximum allowed collection amounts by method of collection are outlined in the Postal Guide.

2700

Total Customs Weight must not be greater than the item weight.

The value in the <weight> element within <parcel-characteristics> cannot be less than the sum of the product of <unit-weight> and <customs-number-of-units> within each <item>. If this occurs it suggests the list of items for customs is incorrect (too high) or the total weight is incorrect (too low).

7000

The selected service is not available for this country and contract combination.

The <service-code> and the <country-code> within <destination> need to be valid pairings. For example, the <country-code> must always be 'US' when the <service-code> begins with 'USA'. Likewise, 'US' or 'CA' cannot be the value in the <country-code> when the <service-code> begins with 'INT'.

Shipping to a U.S.A. Protectorate

When using Priority Worldwide to ship to a U.S.A. protectorate (such as Guam), the service code must begin with 'INT.PW' and the country code must be the protectorate country code (e.g. GU for Guam).

When using other shipping services to ship to protectorates, the service code must begin with ‘USA’, the country code 'US', and the <prov-state> must be the protectorate country code.

View U.S.A. protectorate codes.

7007

The weight value is invalid. The weight of each piece must be less than or equal to {0}.

Different shipping and mailing services have different maximum allowed weights. You can pre-determine the maximum allowed weight by calling Get Service for the service and checking the 'max' attribute of the <weight-restriction> element.

7008

Xpresspost-International should be used for the selected country rather than International Parcel Air.

The value in <service-code> is INT.XP.AIR however the value in the <country-code> within <destination> supports INT.XP instead.

7010

We are unable to provide you with a price at this time. Please try again later.

This error is returned along with an HTTP code of 202, which indicates that your application should sleep for a second and try the same request again. This message should not be presented to the end user.

7031

Please provide the conversion factor from the Canadian dollar (required when customs currency is not CAD)

When the <currency> within <customs> is not in Canadian dollars (CAD), you must include a conversion rate in <conversion-from-cad>. This value is then multiplied by the <customs-value-per-unit> to calculate the value in CAD.

7041

You can only include a maximum of 8 instances of the “item” element per shipment when using Small Packet service. Please reduce to 8 or change the shipping service.

In your Create Shipment request, reduce the number of “item” elements to 8 or fewer or choose a different shipping service.

7050

The {0} option requires the {1} option, please add the prerequisite or remove the option.

There are some options that can be applied to a shipment that require the presence of another option. You can use the Get Option call in advance to check the contents of the <prerequisite-options> group for options selected by end users or options available for a given service. Note that the Delivery Confirmation option (DC) is added automatically where available/included with the service.

7051

The {0} option conflicts with the {1} option, please remove one of the options.

There are some options that can be applied to a shipment that conflict with the presence of another option. You can use the Get Option call in advance to check the contents of the <conflicting-options> group from a Get Option call for options selected by end users or options available for a given service.

7088

Reason for export is invalid.

This message indicates either that:

  • the value provided in the "reason for export" field is not one of the allowed values, or
  • the "reason for export" is "OTH" (other) and the field "other reason" is not provided. The "other reason" field is required if the "reason for export" is "OTH".

7130

This product is not available for the current contract and country.

The <service-code> and the <country-code> within <destination> need to be valid pairings. For example, the <country-code> must always be 'US' when the <service-code> begins with 'USA'. Likewise, 'US' or 'CA' cannot be the value in the <country-code> when the <service-code> begins with 'INT'.

Shipping to a U.S.A. Protectorate

When using Priority Worldwide to ship to a U.S.A. protectorate (such as Guam), the service code must begin with 'INT.PW' and the country code must be the protectorate country code (e.g. GU for Guam).

When using other shipping services to ship to protectorates, the service code must begin with 'USA', the country code 'US', and the <prov-state> must be the protectorate country code.

7230

The Deliver to Post Office option is not allowed in Quick Ship mode because it requires complete recipient name and address information.

Do not use Quickship or do not use this option.

7266 Postal Code must be in format A9A or A9A9A9. Enter just the FSA (the first 3 characters of the postal code) or the full postal code in the format A9A9A9.

7272

The Promotional Code is invalid (does not exist or is not applicable to the selected service).

Please check your promo code to see when it expires and which service(s) it is valid for.

7282

At least one of Recipient Name or Company Name is required per Customs regulations.

Enter a name or a company-name in the destination structure.

7285 As you must provide a manifest when you induct Continuous Inbound Freight (CIF) shipments, you cannot set transmit-shipment to true for these shipments. In your Create Shipment request, remove the element <transmit-shipment>. Be sure to perform a Transmit Shipments call and complete the required steps to produce a manifest.
7289 The selected service is not valid for the specified customer and/or contract. You have chosen a shipping service that is not available to you. Please select a different shipping service.
7291 Shipment has not been transmitted; you must use Void Shipment. You cannot submit a Refund Shipment request for a shipment that you have not yet transmitted. Please use the Void Shipment service instead.
7292 A refund request has already been submitted for this shipment. Refunds take a few days to be processed. We have received your request for a refund. Once we have approved it, you will receive an email and your refund. You can check the status of your service ticket by signing in the Canada Post website.
7311 The pre-authorized amount does not match the calculated charges. The amount that you pre-authorized does not match our calculated charges. To ensure you pre-authorize the proper amount, always perform a Get Rates request with exactly the same parameters (contract, article, dimensions, options, etc.) before you call Create Shipment.
7312 No default Supplier Account is specified in your Canada Post profile. Please sign in to your Canada Post online profile and add a Supplier Account.
7313 Supplier Account payment can only be submitted by the account provider or an authorized user. This method of payment is reserved for suppliers. Please select another method of payment. If you are a provider, please contact Canada Post.
7314 Request ID already exists; it must be unique when provided. Please create a different customer-request-id that you have not used within the last 90 days.
7315 customer-request-id is mandatory on a request with pre-authorized payment. Please supply a customer-request-id. This element is mandatory because it is used as an audit trail.
7316 A pre-authorized payment is only valid with transmit-shipment = true and method of payment = SupplierAccount. As you are pre-authorizing this shipment using a Supplier Account, it must be a shipment where no manifest is required and paid by Supplier Account.
7317 The issuer of the default Supplier Account in your Canada Post online profile does not match the platform you are using. Please check your Canada Post online profile and verify the Supplier Account you have selected as default.
7322 The currency code is not a valid 3-digit ISO currency code. Enter a valid ISO currency code. For example, CAD or USD. Look up country codes.

8044

US State value is invalid.

The <country-code> within <destination> is US and the state is not a valid US state or protectorate.

8064

A shipment can only be void if it is in a PROCESSED or PRINTED state.

The shipment has already been transmitted. A refund must be requested.

8534

A valid destination country must be supplied.

The destination country must be provided; see Codes for valid values.

8716

This product requires a valid value for Non-Delivery Handling

For some delivery services, it is mandatory to make a declaration regarding what should be done with an undeliverable shipment. You will receive this error if the required declaration is not provided or is incorrect.

You can use the Get Service request in advance to determine the allowed values for a service. You need to apply one of the mandatory values in <option-code> as an <option> in the Create Shipment request. If a given service has only one valid value, you can use it as a default.

9105

A required query parameter was not provided in the request.

Add the required query parameter to the request.

9108

You have reached the maximum number of labels that can be printed (10,000); you must transmit before continuing.

A request to Create Shipment has been blocked because too many labels have been created that have not yet been transmitted. Make the Transmit Shipments request for one or more open groups before the next shipment is created.

9109

You have reached the maximum number of groups that can be open (50); you must transmit before continuing.

A request to Create Shipment has been blocked because a new <group-id> value has been provided but the maximum number of unique (untransmitted) groups has already been created. Make a Transmit Shipments request for one or more open groups before the next shipment is created.

9110

You have reached the maximum number of shipments in a group (5,000); you must transmit before continuing.

A request to Create Shipment has been blocked because the <group-id> specified already contains the maximum number of shipments allowed. Make a Transmit Shipments request for the group or change the <group-id> value for the Create Shipment request.

9111

No services are appropriate for the shipment of the defined parcel. Validate the parcel criteria against product specifications.

A Get Rates request was unable to return any price quotes because the shipment characteristics such as weight or dimensions were outside of the service selected or outside of all possible services. If a specific service was selected, remove the selection or choose a different service.

9112

The service {0} is not available for the specified country or customer/contract.

The <service-code> specified in the request is not suitable for the shipment characteristics such as the destination country. Use Discover Services for the specified country to find valid service codes.

9113

Please specify your customer number or customer number and contract number to receive a "commercial" rate quote. You can specify a "quote-type" of "counter" to get consumer rates without a customer or contract number.

A Get Rates request was made with <quote-type> omitted or with the value of “commercial” and without the <customer-number> element. For commercial quotes, a contract number should also be provided if one exists.

9114

To get "counter" rates, the elements of customer number and contract number should be omitted. If a "commercial" quote is desired, the quote-type element can be omitted or set to value of "commercial".

A Get Rates request was made with <quote-type> of “counter” and <customer-number> and/or <contract-id> elements were present. Remove the elements or change to “commercial” quote type.

9116

The "from" date cannot be a later date than the "to" date.

Make sure the "from" date is earlier than the "to" date.

9117

Option {0} has been improperly assigned a value or qualifier.

Some options require amounts or qualifiers, however most do not. (For example, Insurance (COV) requires an amount but the Signature does not.) You can use the Get Option call when creating options to see which services do and do not require amounts or qualifiers.

9118

Group id: {0} was not found for transmission. Please remove or correct.

Please remove or correct.

9119

Shipment id {0} was not found for exclusion; please remove or correct.

A Transmit Shipments request was made with a specific shipment exclusion request, however the specified shipment for exclusion does not exist. Remove the one <shipment-id> in error or remove the <excluded-shipments> block.

9120

The return service code is not valid.

A Create Shipment request was made which requested a return label to be produced at the same time as the outgoing label but the <return-spec> complex type had an invalid value for <service-code>. Get Service returns a true value for <allowed-as-return-service> for codes valid to be used in a return, e.g., DOM.EP, DOM.RP, DOM.XP, DOM.PC

9122

All groups in the transmit request were empty or all shipments were excluded; there was nothing to transmit.

A Get Groups call can be made to see what groups are candidates for transmit. It is possible that all groups are empty if a prior Transmit Shipments request was made.  Empty groups are only deleted by the system after 24 hours.

9128

Please set the appropriate customs defaults for a document.

If a document-only service is selected:

  • the <reason-for-export> must be "DOC"
  • the <other-reason> must be omitted
  • the <currency> must be CAD
  • the <conversion-from-cad> must be omitted
  • the <additional-customs-info> must be omitted
  • the <customs-number-of-units> must be 1
  • the <customs-description> must be "Document"
  • the SKU must be omitted
  • the <hs-tariff-code> must be omitted
  • the <unit-weight> must be .01
  • the <customs-value-per-unit> must be .01
  • the <country-of-origin> must be omitted
  • the <province-of-origin> must be omitted

9150

System error.

Unable to render a PDF due to a problem with the server. This error should not occur and would be the responsibility of Canada Post to correct.

9151

System error.

Unable to render a PDF due to a problem with the server. This error should not occur and would be the responsibility of Canada Post to correct.

9152

The customer number provided does not have the correct format.

This error is returned if the request has a mailed on behalf of customer part of the URL which is not numeric.

9153

The transmit process has not completed yet. Please try again later.

A Get Manifest request was made too soon after Create Shipment. A sleep time of 350 ms per shipment is recommended.

9155

System error.

Unable to render a PDF due to a problem with the server. This error should not occur and would be the responsibility of Canada Post to correct.

9159

No labels remain for this template.

A Retrieve Next Open Return Artifact request was made but the total number of labels defined in the template has already been retrieved. Issue another Create Open Return Template request for a new set of labels.

9162

Length, Height and Width are mandatory when the document flag is false.

Unless sending a document, values must be provided for length, width and height.

9164

You have reached the maximum number of open return templates ({0}); you may delete some templates that you are no longer using.

A Create Open Return Template request was made but the maximum allowed number of templates already exists. Templates that are no longer required can be deleted.

9165

You have reached the maximum number of unused open returns ({0}); you may delete some templates that you are no longer using or specify a lower limit for this new template (current limit is {1}).

There is a limit to the number of labels that can be requested by all open templates combined. A new request has been made that exceeds this limit.

9173

Commercial customers with a valid parcel agreement must use Contract Shipping services. If you are a commercial customer and you do not have a parcel agreement, please contact your sales representative or call 1-866-757-5480.

The customer number provided in the request belongs to a commercial customer. The Contract Shipping set of services must be used rather than the set in Non-Contract Shipping.

9174

To pay by credit card, a default payment card must be indicated on your Canada Post online profile. Please ensure an active card is stored as the default. Contract shippers may use “account” as an alternate method of payment.

(Create Shipment / Create Non-Contract Shipment)

This error appears when a Create Non-Contract Shipment request is made but no default credit card is on file with Canada Post. Please sign in to the Canada Post website and update your business profile to select or add a default credit card.

9174

The specified token-id is either invalid or has expired.

(Get Merchant Registration Info)

There is a 30-minute time limit for getting merchant information through a request by token-id. If you have an established merchant and would like current information about that merchant, use the service called Get Customer Information, which you can call at any time.

9182

The Message Type is invalid.

The message type must always be SO (for scheduled outage).

9183

Only one of the search parameters must be provided.

You can search using only one method.

9185

Limit and Date only apply to noManifest=true requests.

You need not provide Limit or Date on a search by group or manifest.

9186

One and only one of Shipping Point Id or requested-shipping-point must be provided.

The elements shipping-point-id and requested-shipping-point are mutually exclusive. Please provide one or the other.

9187

Requested Shipping Point is mandatory when CPC Pickup Indicator is provided.

If you have provided cpc-pickup-indicator, you must also provide requested-shipping-point.

9188

{0} is not a valid Shipping Point Id on the date of deposit. Use Find a Deposit Location on canadapost.ca to find valid site numbers.

Look up your site number using Find a Deposit Location.

9189

Fields Requested Shipping Point and Shipping Point Id are mutually exclusive.

Provide either requested-shipping-point or shipping-point-id, but not both.

9191 ZPL is a language for thermal printers. You can therefore only use it with 4x6 thermal paper. In your Create Shipment request, change the output-format element to 4x6 if you want to print thermal labels. If you want to print on plain paper, change the encoding element to pdf and keep the output-format at 8.5x11.
9192 3x5 return labels are not available anymore. Please use 4x6 on thermal printers. In your Create Authorized return request, change the output-format element to 4x6 if you want to print thermal labels. If you want to print on plain paper, change the encoding element to pdf and change the output-format to 8.5x11.

9196

Only one of from (date) and tracking PIN must be provided.

You can either search for shipments using a date range or a tracking PIN, but not both.

10028

Invalid Product Service ID specified.

The <service-code> value used to indicate the service for the shipment does not match any valid service codes. The Discover Services request will return valid service codes for a given destination.

10035

Invalid Country code specified in destination.

The <country-code> within <destination> is not a valid country code.

Server

Details of the schema error are described in the faultstring.

Please see the faultstring for more details about the schema error.

env:Client

The endpoint is incorrectly specified – correct and resubmit.

Please check your endpoint and try again.

Code tables and abbreviations

Service codes
<service-code>

Code Description

DOM.EP

Expedited Parcel

DOM.LIB

Library Materials

DOM.PC

Priority

DOM.RP

Regular Parcel

DOM.XP

Xpresspost

DOM.XP.CERT

Xpresspost Certified

INT.IP.AIR

International Parcel Air

INT.IP.SURF

International Parcel Surface

INT.PW.ENV

Priority Worldwide Envelope Int'l

INT.PW.PAK

Priority Worldwide pak Int'l

INT.PW.PARCEL

Priority Worldwide parcel Int'l

INT.SP.AIR

Small Packet International Air

INT.SP.SURF

Small Packet International Surface

INT.TP

Tracked Packet – International

INT.XP

Xpresspost International

USA.EP

Expedited Parcel USA

USA.PW.ENV

Priority Worldwide Envelope USA

USA.PW.PAK

Priority Worldwide pak USA

USA.PW.PARCEL

Priority Worldwide Parcel USA

USA.SP.AIR

Small Packet USA Air

USA.TP

Tracked Packet – USA

USA.TP.LVM

Tracked Packet – USA (LVM)
(large volume mailers)

Note: To use this option, it must be specified in your contract.

USA.XP

Xpresspost USA

Service Options

Service Features
<option-class> = FEAT
Delivery Instructions
<option-class> = DI
Non-Delivery Handling Codes
<option-class> = NDI

COD

COV

DC

SO

D2PO

PA18

PA19

HFP

DNS

LAD

RASE

ABAN

RTS

Option Details

Option Description Option Code Additional Required Elements Conflicting Options Prerequisite Options

Coverage

COV

<option-amount>
The amount of insurance coverage to be purchased.

DC

Collect on delivery

COD

<option-amount>
The base amount to collect on delivery (shipping costs may also be added by the system as described below in option-qualifier-1).

<option-qualifier-1>
  • true = option-amount includes shipping cost
  • false = option-amount does not include shipping cost

<option-qualifier-2>
Method of payment for COD. Valid values are:

  • CSH (cash)
  • CHQ (cheque)
  • MOCC (money order/certified cheque)

D2PO, LAD

DC

Delivery confirmation (system generated)

DC

Signature option

SO

LAD

DC

Deliver to Post Office
(requires qualifier)

D2PO

<option-qualifier-2>
The office ID of the destination Post Office (found in the Get Nearest Post Office response). See Deliver To Post Office documentation for all requirements.

under <destination>:

  • <name>
  • <address-details>
  • <client-voice-number>

under <notification>:

  • <email>
  • <on-delivery> must be set to true

HFP, COD, LAD, DNS

Do not safe drop

DNS

PA19, HFP, PA18, LAD, D2PO

Card for pickup

HFP

D2PO, DNS, LAD

Leave at door – do  not card

LAD

COD, PA18, HFP, DNS, SO, D2PO, PA19

Return at sender's expense

RASE

ABAN, RTS

Abandon

ABAN

RASE, RTS

Return to sender

RTS

RASE, ABAN

Proof of age required
(18 years)

PA18

PA19, LAD, DNS

SO

Proof of age required
(19 years)

PA19

PA18, LAD, DNS

SO

Parcel characteristics
Appear as Boolean elements in Create Shipment but as <option-code>in Get Shipment Price

Code Description

UP

<unpackaged>

CYL

<mailing tube>

OS

<oversized>

Methods of COD payment
<option-qualifier-2>

Code Description

CSH

Cash

CHQ

Cheque

MOCC

Money Order / Certified Cheque

Option information
<option-class>

Code Description

FEAT

Indicates that the option is a service feature.

DI

Indicates that the option is a delivery instruction.

NDI

Indicates that the option is an instruction in the case of unsuccessful delivery.

Adjustment codes
<adjustment-code>

Code Description

AUTDISC

Automation discount.

FUELSC

Fuel surcharge.

NCNTGST

Non-contiguous state fee (applies to Priority Worldwide products sent to Alaska and Hawaii).

V1DISC

Solutions for Small Business discount.

PROMODISC

Promotional discount (if the promo code is invalid or expired, the discount amount will show as zero under adjustment-cost).

PURFEE

Fee charged for using a label before it was paid for.

Reason for export
<reason-for-export>

Code Description

GIF

Gift

DOC

Document

SAM

Commercial sample

REP

Repair or warranty

SOG

Sale of goods

OTH

Other

Currency
<currency>

Code Description

CAD

Canadian currency

USD

United States currency

Credit card type
<card-type>

Code Description

MC

MasterCard

VIS

Visa

AME

American Express

Manifest time of creation
<manifest-time>

Code Description

HH

The 24-based hour

MM

The minutes

TZ

The time zone abbreviation (for the server)

Taxes
<gst> <pst> <hst>

Code Description

GST

Goods and Services Tax

PST

Provincial Sales Tax

HST

Harmonized Sales Tax

Parcel identification parameters
{pin number} {dnc number}

Code Description

PIN

Parcel Identification Number

DNC

Delivery Notice Card

Tracking type
<type>

Code Description

COD_PIN

The parcel identification number of an item shipped COD (collect on delivery).

REMIT_PIN

The parcel identification number of the remittance (payment) for an item that was shipped COD.

Extended country names for standard country codes

Code Country
AN Saba
AN Saint Eustatius
AN Curacao
AN Bonaire
AN Saint Maarten
CC Keeling Islands
CD Zaire
CN Tibet
ES Balearic Islands
ES Canary Islands
ES Spanish North African Terr
FK Malvinas
FR Corsica
GB Channel Islands
GB England
GB Northern Ireland
GB Scotland
GB Wales
GB Great Britain
IL Gaza
IT Sicily
KP North Korea
KR South Korea
MM Burma
NL Holland
PT Azores
PT Madiera
RS Vojvodina
ST Principe
TL East Timor
VA Vatican
VG Tortola
VI St Croix
VI St Thomas
WS Western Samoa
XZ Kosova

Standard country codes

Code Country
AC Ascension
AD Andorra
AE United Arab Emr
AF Afghanistan
AG Antigua/Barbuda
AI Anguilla
AL Albania
AM Armenia
AN Neth. Antilles
AO Angola
AQ Antarctica
AR Argentina
AS American Samoa
AT Austria
AU Australia
AW Aruba
AX Aland islands
AZ Azerbaijan
BA Bosnia-Herz
BB Barbados
BD Bangladesh
BE Belgium
BF Burkina Faso
BG Bulgaria
BH Bahrain
BI Burundi
BJ Benin
BL St Barthelemy
BM Bermuda
BN Brunei
BO Bolivia
BR Brazil
BS Bahamas
BT Bhutan
BV Bouvet Island
BW Botswana
BY Belarus
BZ Belize
CA Canada
CC Cocos Islands
CD Congo, Dem Rep
CF Central Afr Rep
CG Congo
CH Switzerland
CI Côte d'Ivoire
CK Cook Islands
CL Chile
CM Cameroon
CN China
CO Colombia
CR Costa Rica
CU Cuba
CV Cape Verde
CX Christmas Islnd
CY Cyprus
CZ Czech Republic
DE Germany
DJ Djibouti
DK Denmark
DM Dominica
DO Dominican Rep
DZ Algeria
EC Ecuador
EE Estonia
EG Egypt
EH Western Sahara
ER Eritrea
ES Spain
ET Ethiopia
FI Finland
FJ Fiji
FK Falkland Islnds
FM Micronesia
FO Faroe Islands
FR France
GA Gabon
GB United Kingdom
GD Grenada
GE Georgia
GF French Guiana
GG Guernsey
GH Ghana
GI Gibraltar
GL Greenland
GM Gambia
GN Guinea
GP Guadeloupe
GQ Equat Guinea
GR Greece
GS Georgia/Sandwch
GT Guatemala
GU Guam
GW Guinea-Bissau
GY Guyana
HK Hong Kong
HM Heard/McDonald
HN Honduras
HR Croatia
HT Haiti
HU Hungary
ID Indonesia
IE Ireland
IL Israel
IM Isle of Man
IN India
IO Br Ind Ocean Tr
IQ Iraq
IR Iran
IS Iceland
IT Italy
JE Jersey
JM Jamaica
JO Jordan
JP Japan
KE Kenya
KG Kyrgyzstan
KH Cambodia
KI Kiribati
KM Comoros
KN St Kitts/Nevis
KP Korea Dem Rep
KR Korea
KW Kuwait
KY Cayman Islands
KZ Kazakhstan
LA Lao
LB Lebanon
LC Saint Lucia
LI Liechtenstein
LK Sri Lanka
LR Liberia
LS Lesotho
LT Lithuania
LU Luxembourg
LV Latvia
LY Libya
MA Morocco
MC Monaco
MD Moldova
ME Montenegro
MF Saint Martin
MG Madagascar
MH Marshall Islnds
MK Macedonia
ML Mali
MM Myanmar
MN Mongolia
MO Macau
MP N.Mariana Islnd
MQ Martinique
MR Mauritania
MS Montserrat
MT Malta
MU Mauritius
MV Maldives
MW Malawi
MX Mexico
MY Malaysia
MZ Mozambique
NA Namibia
NC New Caledonia
NE Niger
NF Norfolk Island
NG Nigeria
NI Nicaragua
NL Netherlands
NO Norway
NP Nepal
NR Nauru
NU Niue
NZ New Zealand
OM Oman
PA Panama
PE Peru
PF Fr. Polynesia
PG Papua N Guinea
PH Philippines
PK Pakistan
PL Poland
PM St Pierre & Miq
PN Pitcairn
PR Puerto Rico
PS Palestine
PT Portugal
PW Palau
PY Paraguay
QA Qatar
RE Reunion
RO Romania
RS Serbia
RU Russia
RW Rwanda
SA Saudi Arabia
SB Solomon Islands
SC Seychelles
SD Sudan
SE Sweden
SG Singapore
SH Saint Helena
SI Slovenia
SJ Svalbard
SK Slovakia
SL Sierra Leone
SM San Marino
SN Senegal
SO Somalia
SR Suriname
ST S.Tome/Principe
SV El Salvador
SY Syria
SZ Swaziland
TA Tristan da Cunh
TC Turks & Caicos
TD Chad
TF Fr S.Territory
TG Togo
TH Thailand
TJ Tajikstan
TK Tokelau
TL Timor-Leste
TM Turkmenistan
TN Tunisia
TO Tonga
TR Turkey
TT Trinidad/Tobago
TV Tuvalu
TW Taiwan
TZ Tanzania
UA Ukraine
UG Uganda
UM US Minor Islnds
US United States
UY Uruguay
UZ Uzbekistan
VA Holy See
VC St Vincent/Gren
VE Venezuela
VG Br. Virgin Isl
VI US Virgin Isl
VN Vietnam
VU Vanuatu
WF Wallis & Futuna
WS Samoa
XZ Kosovo
YE Yemen
YT Mayotte
ZA South Africa
ZM Zambia
ZW Zimbabwe

Province codes

Province Code Province
AB Alberta
BC British Columbia
MB Manitoba
NB New Brunswick
NF Old code, use  NL
NL Newfoundland & Labr.
NS Nova Scotia
NT NW Territories
NU Nunavut
ON Ontario
PE Prince Edward Island
QC Quebec
SK Saskatchewan
YT Yukon Territory

State and protectorate codes

State Code State/Protectorate
AA Armed Forces America
AE Armed Forces Europe
AK Alaska
AL Alabama
AP Armed Forces Pacific
AR Arkansas
AS American Samoa
AZ Arizona
CA California
CO Colorado
CT Connecticut
DC District of Columbia
DE Delaware
FL Florida
FM Micronesia
GA Georgia
GU Guam
HI Hawaii
IA Iowa
ID Idaho
IL Illinois
IN Indiana
KS Kansas
KY Kentucky
LA Louisiana
MA Massachusetts
MD Maryland
ME Maine
MH Marshall Islands
MI Michigan
MN Minnesota
MO Missouri
MP North Mariana Isls.
MS Mississippi
MT Montana
NC North Carolina
ND North Dakota
NE Nebraska
NH New Hampshire
NJ New Jersey
NM New Mexico
NV Nevada
NY New York
OH Ohio
OK Oklahoma
OR Oregon
PA Pennsylvania
PR Puerto Rico
PW Palau
RI Rhode Island
SC South Carolina
SD South Dakota
TN Tennessee
TX Texas
UM Minor Outlying Isls.
UT Utah
VA Virginia
VI Virgin Islands
VT Vermont
WA Washington
WI Wisconsin
WV West Virginia
WY Wyoming

U.S.A. protectorate codes

Code Protectorate
AA Armed Forces America
AE Armed Forces Europe
AP Armed Forces Pacific
AS American Samoa
FM Micronesia
GU Guam
MH Marshall Islands
MP North Mariana Isls.
PR Puerto Rico
PW Palau
UM Minor Outlying Isls.
VI Virgin Islands

Tracking scan events

The following table lists the tracking scan events that you can receive in the response to requests to the Get Tracking Summary and Get Tracking Details web services.

<event-identifier> <event-type> <event-description>

20

Signature

Signature image recorded for Online viewing

100

Info

Item processed at postal facility

102

Info

Item processed at postal facility

104

Info

Item processed at postal facility

105

Info

Item processed at postal facility

106

Info

Item processed at airport

113

Info

Item arrived at partner facility

114

Info

Item departed partner facility

115

Info

Item transferred to partner

116

Info

Item transferred to partner

117

Info

Item on Hold. Documentation irregularity.

118

Info

Item held. Recipient outside partner service area

120

Info

Item on hold. Incorrect or incomplete address

121

Info

Item on hold. Refused or unclaimed by recipient

122

Induction

Item arrived at postal facility

123

Induction

Item processed at postal facility

124

Info

International item has left Canada

125

Info

Business closed for the day. Item on hold for second delivery attempt.

127

Info

Item held at customs

130

Info

International item released from Customs

136

Info

Item processed at postal facility

150

Info

Item no longer held. Item disposed of according to Canada Post Corporation Act

153

Info

Item arrived at postal facility

154

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

155

Info

Item processed at postal facility

156

Info

Final Notice; Item will be returned to sender if not collected within 10 days

157

Info

Collect on Delivery payment arrived and is being sent to the original sender

158

Out

OFD - COD Remittance

159

Info

Extreme weather conditions at delivery location; item delayed

160

Info

Item delayed due to Demonstrations affecting this  location

161

Info

Labour disruption affecting this location; item delayed

162

Info

Item delayed due to transportation delays beyond our control

163

Info

Major power outage affecting this location; item delayed

167

Attempted

International item being returned to sender. Insufficient international postage.

168

Attempted

International item being returned to sender. Does not meet product requirements.

169

Attempted

International item being returned to sender. Incorrect or missing shipping label

170

Info

Item Processed at Local Delivery Facility

171

Info

Item on hold at postal facility to verify address of recipient

172

Info

Canada Post processing error; item re-routed. Possible delay

173

Info

Customer addressing error found; attempting to correct. Possible delay

174

Out

Item out for delivery

175

Info

Item in transit

178

Induction

Item picked up and is being processed

179

Info

Item was sent to the Undeliverable Mail Office; please contact Customer Service.

190

Info

Retail transaction has been voided

200

Container

Item processed at postal facility

300

Dispatch

Item left postal facility

400

Incoming

Item arrived at postal facility

500

Out

Out for delivery

700

Not_cust

International item arrived in Canada and will be reviewed by Customs

900

From cust

International item released from Customs for processing by Canada Post

910

From cust

Item was released by Customs and is now with Canada Post for processing

1000

Transfer

Item arrived at postal facility

1100

Detention

Refused by Customs. Unacceptable sender info. Item being returned to sender

1300

Induction

Item arrived at postal facility

1301

Induction

Item accepted at the Post Office.

1302

Induction

Item accepted at the Post Office.

1303

Induction

Return item accepted at Post Office

1407

Attempted

Your item is now available for pick-up

1408

Delivered

Item successfully delivered. Contact customer service for copy of signature.

1409

Delivered

Item successfully delivered. Contact customer service for copy of signature.

1410

Attempted

Item arrived at postal facility. Item on hold at recipient's request.

1411

Attempted

Business closed for the day. Item on hold for second delivery attempt.

1412

Attempted

Item on hold at postal facility to verify address of recipient

1414

Attempted

Item arrived at postal facility. Item on hold.

1415

Attempted

Item being returned to Sender. Incomplete address.

1416

Attempted

Recipient not located at address provided. Item being returned to sender.

1417

Attempted

Item refused by recipient. Item being returned to sender.

1418

Attempted

Item being returned to Sender. Valid proof of age identification not provided.

1419

Attempted

Item was unclaimed by recipient. Item being returned to sender.

1420

Attempted

Item being returned to sender

1421

Delivered

Item successfully delivered to recipient's front door

1422

Delivered

Item successfully delivered to recipient's side door

1423

Delivered

Item successfully delivered to recipient's back door

1424

Delivered

Item successfully delivered at or in recipient's garage

1425

Delivered

Item successfully delivered to building superintendent or security agent

1426

Delivered

Item successfully delivered to recipient's parcel box

1427

Delivered

Item successfully delivered to recipient's safe drop location

1428

Delivered

Item successfully delivered to recipient's front door

1429

Delivered

Item successfully delivered to recipient's side door

1430

Delivered

Item successfully delivered to recipient's back door

1431

Delivered

Item successfully delivered at or in recipient's garage

1432

Delivered

Item successfully delivered to building superintendent or security agent

1433

Delivered

Item successfully delivered to recipient's parcel box

1434

Delivered

Item successfully delivered to recipient's safe drop location

1435

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1436

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1437

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1438

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1441

Delivered

Item delivered to recipient's community mailbox.

1442

Delivered

Item delivered to recipient's community mailbox.

1450

Attempted

Item arrived at the Undeliverable Mail Office. Please contact Cust Service

1479

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1480

Attempted

Item redirected to recipient's new address

1481

Attempted

Item refused by recipient. Item being returned to sender.

1482

Attempted

Item refused or unclaimed by recipient. Item being returned to sender.

1483

Attempted

Item cannot be delivered as addressed; sent to the Undeliverable Mail Office

1484

Attempted

Item arrived at postal facility. Item on hold.

1487

Attempted

Item returned to Canadian Customs for appeal of duties

1488

Attempted

Attempted delivery. Notice card left indicating where item can be picked up.

1490

Attempted

Item redirected to recipient's new address

1491

Attempted

Item refused by recipient. Item being returned to sender.

1492

Attempted

Item refused or unclaimed by recipient. Item being returned to sender.

1493

Attempted

Item cannot be delivered as addressed; sent to the Undeliverable Mail Office

1494

Attempted

Item arrived at postal facility. Item on hold.

1495

Attempted

Item returned to Canadian Customs for appeal of duties

1496

Delivered

Item successfully delivered

1497

Delivered

Item successfully delivered to recipient's safe drop location

1498

Delivered

Item successfully delivered

1499

Delivered

Item successfully delivered to recipient's safe drop location

1701

To_retail

Item available for pickup at Post Office

1703

To_retail

Item being prepared for transfer to Post Office

1704

To_retail

Item transferred to Post Office; being prepared for pickup.

2000

Signature

Recipient's name recorded for online viewing

2300

Induction

Item picked up by Canada Post

2407

Attempted

Your item is now available for pick-up

2410

Attempted

Item arrived at postal facility. Item on hold at recipient's request.

2411

Attempted

Business closed for the day. Item on hold for second delivery attempt.

2412

Attempted

Item on hold at postal facility to verify address of recipient

2414

Attempted

Item arrived at postal facility. Item on hold.

2500

Transfer_item

Item processed at postal facility

2600

Rts_label_proc

Item has been returned and is enroute to the Sender

2802

Attempted

International item was undeliverable. Item being returned to sender.

3000

Induction

Electonic information submitted by shipper.

3001

Induction

Item being returned to sender

3002

Induction

Authorized Return

4000

Info                            

International item mailed in origin country

4100

Info

International item processed in origin country

4202

Info_tid

International item has left the origin country and is en route to Canada

4310

Info_tid

International shipment has arrived in a foreign country

4311

Info_tid

Item has arrived in foreign country

4330

Item Presented to Import Customs

4400

Info

Item has been sent to customs in the destination country

4450

Info

Item returned to Post from Customs

4500

Info

International item released from Customs to Foreign Postal Administration

4550

Info

In Transit to Delivery Office

4600

Info

Item has been received at the delivery office in the destination country

4625

Info

Item is on hold at the delivery Office

4650

Info

Item cannot be delivered as addressed; sent to the Undeliverable Mail Office.

4700

Attempted

Item arrived at postal facility. Item on hold.

4900

Info

International item has arrived at transit destination

4950

Info

International item has been forwarded onwards to destination

5201

For_review

International item released from Customs for processing by Canada Post

5300

Delivered

Item successfully delivered to recipient's parcel box

8901

Info_tid

International item has left Canada

CC_ARRIVED_CONS1

Cc_info

Item arrived at the sortation plant in destination country

CC_ARRIVED_CONS2

Cc_info

Item arrived at the sortation plant in destination country

CC_ARRIVED_CONS3

Cc_info

Item arrived at the sortation plant

CC_DESPATCH1

Cc_info_w_tid

International shipment dispatched from Canada

CC_RELEASED_CUSTOMS1

Cc_pin_in_cont_trail

Item was released from Customs and is now with Canada Post for sortation

PR01_RECEIVED

Pr01_received

Shipment information received at originating postal facility

PR07_TRANSF_PROC

Pr07_transf_proc

Item transferred for processing