ShipmentSpecialServices Property
Contains the collection of special services offered.
Syntax
ezship.getShipmentSpecialServices([callback]) ezship.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 FedEx in a ship 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 | FedEx | UPS | USPS | Canada Post | |
0x00000001L | Broker Select | X | ||||
0x00000002L | Call Before Delivery | X | ||||
0x00000004L | COD | X | X | |||
0x00000008L | Custom Delivery Window | X | ||||
0x00000010L | Dangerous Goods | X | ||||
0x00000020L | Do Not Break Down PAllets | X | ||||
0x00000040L | Do Not Stack Pallets | X | ||||
0x00000080L | Dry Ice | X | ||||
0x00000100L | East Coast Special | X | ||||
0x00000200L | Electronic Trade Documents | X | ||||
0x00000400L | Email Notification | X | ||||
0x00000800L | Extreme Length | X | ||||
0x00001000L | Food | X | ||||
0x00002000L | Freight Guarantee | X | ||||
0x00004000L | Future Day | X | ||||
0x00008000L | Hold At Location | X | X | X | ||
0x00010000L | International Controlled Export Service | X | ||||
0x00020000L | Home Delivery Premium | X | ||||
0x00040000L | Inside Delivery | X | ||||
0x00080000L | Inside Pickup | X | ||||
0x00100000L | Liftgate Delivery | X | X | |||
0x00200000L | Liftgate Pickup | X | X | |||
0x00400000L | Limited Access Delivery | X | ||||
0x00800000L | Limited Access Pickup | X | ||||
0x01000000L | Pending Shipment | X | ||||
0x02000000L | Poison | X | ||||
0x04000000L | Protection From Freezing | X | ||||
0x08000000L | Return Shipment | X | X | X | ||
0x10000000L | Saturday Delivery | X | X | |||
0x20000000L | Saturday Pickup | X | ||||
0x40000000L | Top Load | X | ||||
0x80000000L | Restricted Delivery | X | ||||
0x0000000100000000L | Return Receipt | X | ||||
0x0000000200000000L | Certificate Of Mailing | X | ||||
0x0000000400000000L | Sunday and Holiday Delivery | X | ||||
0x0000000800000000L | No Weekend | X | ||||
0x0000001000000000L | Registered Mail | X | ||||
0x0000002000000000L | Premium Service (Sunday/Holiday) | X | ||||
0x0000004000000000L | Commercial | X | ||||
0x0000008000000000L | Delivery Confirmation | X | ||||
0x0000010000000000L | International Traffic in Arms Regulations | X | ||||
0x0000020000000000L | Return of Document | X | ||||
0x0000040000000000L | Import Control | X | ||||
0x0000080000000000L | Commercial Invoice Removal | X | ||||
0x0000100000000000L | Exchange Forward | X | ||||
0x0000200000000000L | Carbon Neutral | X | ||||
0x0000400000000000L | Dropoff at UPS Facility | X |
Data Type
Long64