Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

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
0x0004000000000000L Return at sender's expense
0x0008000000000000L Return to sender
0x0010000000000000L Abandon

COD

When set, this will request that the amount specified in CODTotalAmount to be collected on delivery of the package, either in the form of cash, guaranteed funds, or by check, as specified in CODType.

This only applies for domestic shipments.

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

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0