TransmitShipments Method

Submits the shipment information and retrieve the manifest for the specified GroupId.

Syntax

canadapostship.transmitShipments([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This will transmit the shipment information for the specified GroupId and print the manifest for that shipment.

If you wish to get the manifest for more than one group, you can specify more than one group ID in a comma separated list in the GroupId property.

The following properties must be set before making a call to TransmitShipments:

• ExcludedShipments (Optional)
• GroupId (Required)
• ManifestFile (Required)
• SenderAddress (Required)

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
2. Call TransmitShipments with the GroupId for the shipment.
3. Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostContractId is set).