Contract Shipping

Code Samples for Contract Shipping: Java (.zip) | PHP (.zip) | C# (.zip)

Get Manifest Details – SOAP

Summary

Name:	Get Manifest Details
Reason to Call:	To retrieve information found on the hardcopy manifest such as total cost of the manifest.
Input:	Customer number; manifest-id; locale (optional)
Output:	The total shipping costs for all shipments in the manifest and the credit card or Supplier Account receipt information if applicable.
Error Example:	Invalid manifest-id (e.g. manifest does not exist)
Typical Prior Call:	Transmit Shipments
Typical Next Call:	Get Artifact (if that service has not already been called)
Version history:	Release notes

Get Manifest Details – Summary of Service

Call Details

WSDL:	manifest.wsdl
Endpoint (Development):	https://ct.soa-gw.canadapost.ca/rs/soap/manifest/v8
Endpoint (Production):	https://soa-gw.canadapost.ca/rs/soap/manifest/v8
Namespace:	http://www.canadapost.ca/ws/soap/manifest/v8
Operation:	GetManifestDetails

SOAP Body

This section describes the XML input elements to this service. For the hierarchical structure, see the XML diagram.

Get Manifest Details – Request Elements
Element Name	Type	Required / Optional	Description
get-manifest-details-request	complex	required	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.
manifest-id	simple	required	(Alphanumeric String – up to 32 letters/digits) An identification number representing the existing manifest for which information is being requested. Note: Retrieve the manifest-id provided by previous calls to Transmit Shipments or Get Manifests. The output of those services will include a shipment-id element.

Request – XML Diagram

Get Manifest Details – Structure of the XML Request

Response Details

Response – Elements

The following table describes the XML elements in the response to Get Manifest Details. For the hierarchy of the response, see the
XML diagram.

Get Manifest Details – Response Elements
Element Name	Type	Description
get-manifest-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.
manifest-details	complex	The XML structure containing the results of a successful completion of the service.
po-number	simple	The purchase order number used for billing and displayed on the manifest.
final-shipping-point	simple	The Postal Code of the Post Office where the shipment is to be dropped off.
shipping-point-name	simple	The descriptive name of the final shipping point.
shipping-point-id	simple	The Canada Post identification number of the final shipping point.
cpc-pickup-indicator	Simple	{true} Returned if you specified that your mail is picked up by Canada Post at your site. Only supplied when true.
mailed-by-customer	simple	The 10-digit customer number of the mailed-by-customer.
mailed-on-behalf-of	simple	The 10-digit customer number of the mailed-on-behalf-of customer.
paid-by-customer	simple	The 10-digit customer number of the customer who is paying for the shipment. This is often the same as the mailed-on-half-of customer number.
customer-reference	simple	The reference number you defined and provided in the transmit request.
manifest-date	simple	(YYYY-MM-DD) The date the manifest was generated. Note: This also appears as shipment on the printed manifest.
manifest-time	simple	(HH:MM TZ) The time when the manifest was generated.
contract-id	simple	The contract number that was used (if a specific contract was used) for pricing this manifest, if applicable (i.e. if you are using a service not on your contract, contract-id is not required)
method-of-payment	simple	This indicates your method of payment.
cc-receipt-details	complex	This structure will be provided if the manifest was paid for by credit card through the Transmit Shipments request. This structure contains the elements required for a hardcopy 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.
auth-timestamp	simple	The date and time that the credit card company authorized the transaction.
card-type	simple	The type of credit card used for the purchase.
currency	simple	The currency of the transaction: CAD
transaction-type	simple	Will have the value: "Sale"
supplier-account-receipt-details	complex	This structure will be provided if the manifest was paid for by Supplier Account in the Transmit Shipments request. This structure is not returned in the sandbox environment.
merchant-name	Simple	Contained within supplier-account-receipt-details. Will have the value: "Canada Post"
merchant-url	Simple	Contained within supplier-account-receipt-details. Will have the value: "www.canadapost.ca"
auth-code	Simple	Contained within supplier-account-receipt-details. The authorization code received from the supplier.
auth-timestamp	Simple	Contained within supplier-account-receipt-details. The date and time the supplier authorized the transaction.
supplier-id	Simple	Contained within supplier-account-receipt-details. The supplier that authorized the transaction. Values are: FP = FrancoTyp Postalia NE = Neopost PB = Pitney Bowes
charge-amount	Simple	Contained within supplier-account-receipt-details. The total amount charged to the account.
currency	Simple	Contained within supplier-account-receipt-details. The currency of the transaction; always CAD.
transaction-type	Simple	Contained within supplier-account-receipt-details. Will have the value: "Sale".
manifest-pricing-info	complex	Contains the information about the total pricing of all items on the manifest.
base-cost	simple	The total base cost for all shipments on the manifest.
automation-discount	complex	The automation discount total for all shipments on the manifest.
options-and-surcharges	simple	The options and surcharges total for all shipments on the manifest.
gst	simple	The GST total for all shipments on the manifest.
pst	simple	The PST total for all shipments on the manifest.
hst	simple	The HST total for all shipments on the manifest.
total-due-cpc	simple	The total due to Canada Post for all shipments on the manifest.
manifest-address	complex	The elements within manifest-address are identical to the elements described under manifest-address in request elements for Transmit Shipments. These include manifest-name, address-details, address-line-1, address-line-2, city, prov-state, country-code and postal-zip-code.

Response – XML Diagram

Get Manifest Details – Structure of the XML Response

View full-size image

Response – Possible Error Responses

You will receive a 404 error if you invoke Get Manifest Details more than 90 days after the manifest was created, or invoke it for an empty manifest (see Transmit Shipments for details).

The response to error conditions for this web service follows the standard SOAP error response approach used for all Canada Post web services. For more information, see SOAP Fundamentals of Canada Post Web Services.

Examples

Sample SOAP XML Request – Get Manifest Details


  

		<get-manifest-details-request>
	
		<mailed-by>1111111</mailed-by>

		<manifest-id>347891314723499921</manifest-id>

	
		</get-manifest-details-request>

Sample SOAP XML Response – Get Manifest Details


  	

		<get-manifest-details-response>
	
		<manifest-details>
	
		<po-number>D906369782</po-number>

		<final-shipping-point>J4W4T0</final-shipping-point>

		<shipping-point-name>BP BROSSARD</shipping-point-name>

		<shipping-point-id>0192</shipping-point-id>

		<mailed-by-customer>0001111111</mailed-by-customer>

		<mailed-on-behalf-of>0001111111</mailed-on-behalf-of>

		<paid-by-customer>0001111111</paid-by-customer>

		<manifest-date>2011-09-20</manifest-date>

		<manifest-time>14:10 EDT</manifest-time>

		<contract-id>0012345678</contract-id>

		<method-of-payment>account</method-of-payment>

		<manifest-pricing-info>
	
		<base-cost>25.84</base-cost>

		<automation-discount>0</automation-discount>

		<options-and-surcharges>17.58</options-and-surcharges>

		<gst>0.00</gst>

		<pst>0</pst>

		<hst>5.64</hst>

		<total-due-cpc>49.06</total-due-cpc>

	
		</manifest-pricing-info>

		<manifest-address>
	
		<manifest-company>Canada Post Corporation</manifest-company>

		<phone-number>555-555-5555</phone-number>

		<address-details>
	
		<address-line-1>2701 Riverside Drive</address-line-1>

		<city>Ottawa</city>

		<prov-state>ON</prov-state>

		<postal-zip-code>K1A0B1</postal-zip-code>

	
		</address-details>

	
		</manifest-address>

	
		</manifest-details>

	
		</get-manifest-details-response>

Sign in

Resources