| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
Authorization token |
string |
Required |
| BillToType |
Bill To Type (S=shipper(default), C=consignee, 3=third party |
string |
Required Max length: 1 |
| AccountNumber |
Account number (leave blank and default account will be used) |
string |
Required Max length: 20 |
| PickupKeep | boolean |
Required |
|
| PickupAddressCode | string |
None. |
|
| PickupCompanyName | string |
Required |
|
| PickupAddress1 | string |
None. |
|
| PickupAddress2 | string |
None. |
|
| PickupAddress3 | string |
None. |
|
| PickupCityName | string |
Required |
|
| PickupStateProvID | string |
None. |
|
| PickupPostalCode | string |
None. |
|
| PickupCountryID | string |
Required |
|
| PickupPersonToSee | string |
None. |
|
| PickupPhoneNumber | string |
None. |
|
| PickupFaxNumber | string |
None. |
|
| PickupAfterHoursNumber | string |
None. |
|
| PickupEmailAddress | string |
None. |
|
| DropOff | boolean |
Required |
|
| PickupReadyDateTime |
Pickup ready date/time (yyyy-MM-dd HH:mm) (ignored if PickupReadyNow=true) |
string |
Required |
| PickupReadyNow |
True=shipment is ready now |
boolean |
Required |
| PickupInstructions |
Special instructions at pickup |
string |
None. |
| DeliveryKeep | boolean |
Required |
|
| DeliveryAddressCode | string |
None. |
|
| DeliveryCompanyName | string |
Required |
|
| DeliveryAddress1 | string |
None. |
|
| DeliveryAddress2 | string |
None. |
|
| DeliveryAddress3 | string |
None. |
|
| DeliveryCityName | string |
Required |
|
| DeliveryStateProvID | string |
None. |
|
| DeliveryPostalCode | string |
None. |
|
| DeliveryCountryID | string |
Required |
|
| DeliveryAttention | string |
None. |
|
| DeliveryPhoneNumber | string |
None. |
|
| DeliveryFaxNumber | string |
None. |
|
| DeliveryAfterHoursNumber | string |
None. |
|
| DeliveryEmailAddress | string |
None. |
|
| DeliverWhen | string |
Required |
|
| DeliveryRequestDateTime |
Requested delivery date/time (yyyy-MM-dd HH:mm) (ignored if DeliveryRequestAsap = true) |
string |
None. |
| DeliveryRequestAsap |
True = deliver as soon as possible, False=see DeliveryRequestDateTime |
boolean |
Required |
| DeliveryInstructions |
Special instructions at delivery |
string |
None. |
| HoldForPickup | boolean |
Required |
|
| ShipperName | string |
None. |
|
| ShipperPhone | string |
None. |
|
| ShipperEmail | string |
None. |
|
| DeclaredValue | decimal number |
None. |
|
| DeclaredValueCurrencyID | string |
None. |
|
| Pieces | integer |
Required |
|
| Weight | decimal number |
Required |
|
| DimWeight | decimal number |
None. |
|
| Length | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| Contents | string |
None. |
|
| Reference | string |
None. |
|
| OtherReference1 | string |
None. |
|
| OtherReference2 | string |
None. |
|
| OtherReference3 | string |
None. |
|
| OtherReference4 | string |
None. |
|
| OtherReference5 | string |
None. |
|
| OtherReference6 | string |
None. |
|
| OtherReference7 | string |
None. |
|
| OtherReference8 | string |
None. |
|
| ServiceGUID | string |
Required |
|
| NotifyShipperOrderAck | boolean |
Required |
|
| NotifyShipperOrderRouted | boolean |
Required |
|
| NotifyShipperDispatched | boolean |
Required |
|
| NotifyShipperPickedUp | boolean |
Required |
|
| NotifyShipperDepToAp | boolean |
Required |
|
| NotifyShipperObcCheckin | boolean |
Required |
|
| NotifyShipperDropped | boolean |
Required |
|
| NotifyShipperConfirmed | boolean |
Required |
|
| NotifyShipperDeparted | boolean |
Required |
|
| NotifyShipperArrived | boolean |
Required |
|
| NotifyShipperRecovered | boolean |
Required |
|
| NotifyShipperOutForDelivery | boolean |
Required |
|
| NotifyShipperDelivered | boolean |
Required |
|
| NotifyShipperOrigQdt | boolean |
Required |
|
| NotifyShipperChangeQdt | boolean |
Required |
|
| NotifyConseeOrderAck | boolean |
Required |
|
| NotifyConseeOrderRouted | boolean |
Required |
|
| NotifyConseeDispatched | boolean |
Required |
|
| NotifyConseePickedUp | boolean |
Required |
|
| NotifyConseeDepToAp | boolean |
Required |
|
| NotifyConseeObcCheckin | boolean |
Required |
|
| NotifyConseeDropped | boolean |
Required |
|
| NotifyConseeConfirmed | boolean |
Required |
|
| NotifyConseeDeparted | boolean |
Required |
|
| NotifyConseeArrived | boolean |
Required |
|
| NotifyConseeRecovered | boolean |
Required |
|
| NotifyConseeOutForDelivery | boolean |
Required |
|
| NotifyConseeDelivered | boolean |
Required |
|
| NotifyConseeOrigQdt | boolean |
Required |
|
| NotifyConseeChangeQdt | boolean |
Required |
|
| IsDangerousGoods | boolean |
Required |
|
| DgUNNumber | string |
None. |
|
| DgCommodityClass | string |
None. |
|
| DgDryIceWeight | decimal number |
None. |
|
| DgTransportationIndex | string |
None. |
|
| DgTransportationLimit | string |
None. |
|
| DgIsRadioactive | boolean |
Required |
|
| DgPackingGroup | string |
None. |
|
| DgQuantityAndPackType | string |
None. |
|
| DgPackingInst | string |
None. |
|
| DgAuthorization | string |
None. |
|
| DgHandlingInfo | string |
None. |
|
| DgEmergencyPhone | string |
None. |
|
| DgSignatory | string |
None. |
|
| DgProperName | string |
None. |
|
| DgDate |
DG - Date (yyyy-MM-dd) |
string |
None. |
| TextPhoneNumber | string |
None. |
|
| TextNotifyPickup | boolean |
Required |
|
| TextNotifyDelivery | boolean |
Required |
|
| PackagingTypeGUID_Outer | string |
None. |
|
| PackagingTypeGUID_Inner | string |
None. |
|
| Quantity | integer |
None. |
|
| DgGelPackCount | integer |
None. |
|
| CarrierToProvideDryIce | boolean |
Required |
|
| CarrierToProvideGelPack | boolean |
Required |
|
| PieceDetail | Collection of NewPieceItem |
None. |
|
| Documents | Collection of NewDocumentItem |
None. |