Non-Contract Shipping

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

Get Non-Contract Shipment Public Key Info – SOAP

Summary

Name:	Get Non-Contract Shipment Public Key Info
Reason to Call:	To retrieve the details on the public key including expiry date, QR code, public URL (un-authenticated URL)
Input:	REST: Invoke the link returned from a prior call. SOAP: Invoke the operation to get the public key info.
Output:	The public key including expiry date, QR code, public URL (un-authenticated URL)
Error Examples:	404 - Not Found
Typical Prior Call:	Create Non-Contract Shipment Get Non-Contract Shipment
Typical Next Call:	N/A
Version history:	Release notes

Call Details

WSDL:	ncshipment.wsdl
Endpoint (Development):	https://ct.soa-gw.canadapost.ca/rs/soap/ncshipment/v4
Namespace:	https://soa-gw.canadapost.ca/rs/soap/ncshipment/v4
Namespace:	http://www.canadapost.ca/ws/soap/ncshipment/v4
Operation:	GetNCShipmentPublicKeyInfo

SOAP Body

This section describes the XML input elements to this service.

Get Shipment Public Key Info – Request Elements
Element Name	Type	Required / Optional	Description
get-shipment-public-key-info-request	Complex	Required	This is the overall XML structure 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.
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 Shipments. The output of those services will include a shipment-id element.

Request – XML Diagram

N/A

Response Details

Response – Elements

The following table describes the XML elements in the response to Get Shipment Public Key Info.

Get Non-Contract Shipment Details - Response Elements
Element Name	Type	Description
get-non-contract-shipment-public-key-info-response	Complex	The top level XML element for the response. It will either contain the results of a successful completion or the error message structure.
non-contract-shipment-public-key-info	Complex	The XML structure containing the results of a successful completion of the service.
expiry-date	Simple	Same as in the REST response.
url	Simple	Same as in the REST response.
qr-code	Simple	Same as in the REST response.

Response – XML Diagram

N/A

Response – Possible Error Responses

No errors are expected for invocation of this link, but you will receive a 404 error if you invoke Get non-Contract Shipment Public Key Info more than 90 days after the link was provided.

Examples

Sample SOAP XML Request – Get Non-Contract Shipment Public Key Info


  
    

		POST https://soa-gw.canadapost.ca/rs/soap/ncshipment/v4

		<v4:get-non-contract-shipment-public-key-info-request>

          
            <mailed-by>9935250</mailed-by>

			<shipment-id>362741689769145988</shipment-id>
          
		</v4:get-non-contract-shipment-public-key-info-request>

Sample SOAP XML Response – Get Non-Contract Shipment Public Key Info


    	
	

      <tns:get-non-contract-shipment-public-key-info-response>
        
          <non-contract-shipment-public-key-info>
            
              <expiry-date>2023-08-18T23:59:59-04:00</expiry-date>

              <url>https://canadapost-postescanada.ca/printlabel-imprimeretiquette?key-cle=dad634626de14af5812803bfcf4633ea</url>

            
         </non-contract-shipment-public-key-info>
        
      </tns:get-non-contract-shipment-public-key-info-response>

Sign in

Resources