OrderRequestV3 Properties |
[This is preliminary documentation and is subject to change.]
The OrderRequestV3 type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | AdditionalOptions |
A list of optional key value pairs for future or custom properties.
|
| BillingAccount |
A valid Purolator account number is required for all collect and 3rd party orders.
|
| BillingAccountAddress |
The billing address
|
| BillingOption |
Billing Option (Prepaid, Collect, 3rdParty).
|
| ClearanceAddress |
The name and address of the person for whom the order is clearing.
|
| Credentials |
Login credentials for validation.
|
| Currency |
The currency used for DeclaredValue (USD or CAD).
|
| DeclaredValue |
A value declared for insurance that is in excess of the base value amount. The maximum allowable declared value for insurance is $5000.00 per shipment.
|
| Items |
The customs items in the order.
|
| LabelType |
The type of label returned (None, ZPL, ZPL300, ZPLIMAGES, ZPL300IMAGES, Image, PDF)
|
| Note |
A client-assigned reference number that appears on the shipping label generated for each package in this order.
|
| OrderNumber |
Unique order number. Each order must have a unique order number that identifies it.
|
| Packages |
The packages in the order.
|
| PartnerAddress |
The name and address of the partner.
|
| PartnerID |
A unique number that the client uses to identify on which shipper's behalf this order is being sent if the client is shipping for multiple shippers under the same ClientID.
|
| PONumber |
Purchase order number. Each order can have a purchase order number.
|
| PreventUpdates |
PreventUpdates without changing signature
|
| Ref1 |
Customer reference number.
|
| Ref2 |
Customer reference number.
|
| Ref3 |
Customer reference number.
|
| Ref4 |
Customer reference number.
|
| Ref5 |
Customer reference number.
|
| ShipDate |
The date the order will ship.
|
| ShipFromAddress |
The return address on the shipping label
|
| ShipMethod |
Ship method.
|
| ShipperClearanceAddress |
The name and address of the shipper for whom the order is clearing.
|
| ShipToAddress |
The address to which the order is being shipped.
|
| SpecialServices |
Special Services
|
See Also