• the tracking PIN of the shipping label
• the final shipping point
• an XML structure with the original shipping input information that was used to create the shipment, and
• the group-id that the original shipment was created under.

get-shipment-details-request

complex

required

This is the top level XML element for the request input information.

mailed-by

simple

required

(1-10 digit numeric)

The 10-digit customer number of the mailed-by customer.

If the number provided has fewer than 10 digits, the system will add leading zeros.

mobo

simple

optional

(1-10 digit numeric)

The 10-digit customer number of the mailed-on-behalf-of customer.

If this element is missing, it will default to the mailed-by customer number.

If the number provided has fewer than 10 digits, the system will add leading zeros.

locale

simple

optional

Indicates your language preference for receiving error messages.

EN = English
FR = French

If no value is provided, the default language is English.

shipment-id

simple

required

(Alphanumeric String – up to 32 letters/digits)

An identification number representing the existing shipment for which information is being requested.

Note: Retrieve the shipment-id provided by previous calls to Create Shipment or Get Shipment. The output of those services will include a shipment-id element.

get-shipment-details-response

complex

The top level XML element for the response.

It will either contain the results of a successful completion, or the error structure.

shipment-details

complex

The XML element/structure containing the results of a successful completion of the service.

customer-request-id

simple

Your unique transaction ID, if you supplied it in your request.

shipment-status

Valid values are:

• created
• transmitted
• suspended

Indicates the current status of the shipment.

final-shipping-point

simple

This element is used for pricing purposes.

If you provided a requested-shipping-point element in your Create Shipment request, this is the Postal Code of the Canada Post facility that is closest to your pickup location.

If you provided a shipping-point-id in your Create Shipment request, this is the Postal Code of the deposit location you chose.

shipping-point-id

Simple

If you chose to deposit your shipments, this element contains the site number of the Canada Post facility you selected.

cpc-pickup-indicator

Simple

{true}

Returned if you requested your shipments be picked up.

tracking-pin

simple

This is the tracking parcel identification number (PIN) for the shipment. The tracking PIN can be used as input to other web service calls such as Get Tracking Details.

The Canada Post Purchase Order number; only applicable and returned on a shipment where no manifest is required for proof of payment.

destination

complex

This element contains either one of the following:

• The address of the mail recipient (for regular shipments)
• The address of the Post Office where the shipment will be delivered to (for shipments sent using the Deliver to Post Office option)

recipient

complex

This element appears in the response only if you selected the Deliver to Post Office (D2PO) option when you created the shipment. It contains the mail recipient’s address that you provided in the destination element in your request.

return-spec

Complex

This structure is identical to the corresponding structure in the request input to Create Shipment.

refund-request-info

Complex

This structure is present only if a refund request was submitted for this shipment.

service-ticket-date

Simple

Date when the refund request was submitted.

service-ticket-id

Simple

Service ticket number assigned to the refund request. Please use this number in any communications with Canada Post about the refund request.