ShipmentSpecialServices Property
Contains the collection of special services offered.
Syntax
canadapostshipintl.getShipmentSpecialServices([callback]) canadapostshipintl.setShipmentSpecialServices( shipmentSpecialServices, [callback])
Default Value
0
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 the getShipmentSpecialServices([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setShipmentSpecialServices([callback]) 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
To request any of the special services offered by Canada Post in a request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x0000000008000000L | Return shipment |
0x0000800000000000L | Card for pickup |
0x0001000000000000L | Do not safe drop |
0x0004000000000000L | Return at sender's expense |
0x0008000000000000L | Return to sender |
0x0010000000000000L | Abandon |
Return Shipment
This indicates that a return shipment is requested. If you wish to have the return shipment go to a different address, you can set the ReturnAddress and ReturnContact properties.
Card for Pickup
When this is set, the package will be held at the post office and the recipient will be notified that their package is ready to be picked up. The recipient must show ID before they can pickup the package.
Do Not Safe Drop
Indicates that if no one is available to accept the package when delivery is attempted, a Delivery Notice Card is left and the recipient must pick up the package at the post office.
Return at Sender's Expense
This indicates that if unable to delivery the package, the package should be returned to the sender at the sender's expense.
Return to Sender
This indicates that if unable to delivery the package, the package should be returned to the sender.
Abandon
This indicates that if unable to delivery the package, the package should be abandoned.
Data Type
Long64