ShipmentSpecialServices Property
Contains the collection of special services offered.
Syntax
__property __int64 ShipmentSpecialServices = {read=FShipmentSpecialServices, write=FSetShipmentSpecialServices, default=0};
Default Value
0
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 |
0x0000000000000004L | COD |
0x0000000008000000L | Return shipment |
0x0000800000000000L | Card for pickup |
0x0001000000000000L | Do not safe drop |
0x0002000000000000L | Deliver to post office |
0x0004000000000000L | Return at sender's expense |
0x0008000000000000L | Return to sender |
0x0010000000000000L | Abandon |
COD
When set, this will request that the amount specified in PackageCODAmount to be collected on delivery of the package, either in the form of cash, guaranteed funds, or by check, as specified in CODType. After making a call to GetPackageLabel, the COD label will stored in PackageCODLabel, unless PackageCODFile has been set, in which case the label will be saved to the path specified. Note that the label will be in PDF format.
If you want Canada Post to automatically add the postage amount to the CODTotalAmount, you can set the CODIncludePostage configuration setting to True. Also if you wish to have the COD payment returned to a different address than specified in SenderAddress you may specify the address to be printed on the COD return label using the following configuration settings:
- CODRecipientCompany
- CODRecipientName
- CODRecipientAddress1
- CODRecipientAddress2
- CODRecipientCity
- CODRecipientProvince
- CODRecipientPostalCode
Deliver to post office
When this is set, the package will be delivered directly to the Post Office specified by D2POOfficeId and the recipient will be notified that the package is ready to be picked up. When set, the following must also be set:
This only applies when using the ServiceType is set to stCanadaExpeditedParcel or stCanadaXpresspost.
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