| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system generated user identifier |
string |
Required |
| BillToType |
Bill to account type (S=shipper, C=consignee, 3=third party) |
string |
Required |
| ShipperAccountNumber |
Shipper account number |
string |
Required Max length: 20 |
| ConsigneeAccountNumber |
Consignee account number |
string |
Max length: 20 |
| ThirdPartyAccountNumber |
Third party account number |
string |
Max length: 20 |
| ShipperName |
Name of person shipping |
string |
Required Max length: 50 |
| ShipperPhone |
Phone number of shipper |
string |
Max length: 25 |
| ShipperFax |
Fax number of shipper |
string |
Max length: 25 |
| ShipperEmail |
Email address of shipper |
string |
Max length: 100 |
| PickupAddressCode |
Pickup address code |
string |
Max length: 15 |
| PickupCompanyName |
Company name at pickup |
string |
Required Max length: 50 |
| PickupAddress1 |
Address line 1 at pickup |
string |
Max length: 50 |
| PickupAddress2 |
Address line 2 at pickup |
string |
Max length: 50 |
| PickupAddress3 |
Address line 3 at pickup |
string |
Max length: 50 |
| PickupCityName |
City name at pickup |
string |
Required Max length: 50 |
| PickupStateProvID |
State or province ID at pickup |
string |
Max length: 3 |
| PickupPostalCode |
Postal code at pickup |
string |
Max length: 10 |
| PickupCountryID |
Country ID at pickup (ie. US) |
string |
Required Max length: 2 |
| PickupPersonToSee |
Person to see at pickup |
string |
Max length: 50 |
| PickupPhoneNumber |
Phone number at pickup |
string |
Max length: 25 |
| PickupFaxNumber |
Fax number at pickup |
string |
Max length: 25 |
| PickupInstructions |
Special instructions at pickup |
string |
Max length: 500 |
| DeliveryAddressCode |
Code that identifies delivery address |
string |
Max length: 15 |
| DeliveryCompanyName |
Company name at delivery address |
string |
Required Max length: 50 |
| DeliveryAddress1 |
Address line 1 at delivery address |
string |
Max length: 50 |
| DeliveryAddress2 |
Address line 2 at delivery address |
string |
Max length: 50 |
| DeliveryAddress3 |
Address line 3 at delivery address |
string |
Max length: 50 |
| DeliveryCityName |
City name at delivery address |
string |
Required Max length: 50 |
| DeliveryStateProvID |
State or province ID at delivery address |
string |
Max length: 3 |
| DeliveryPostalCode |
Postal code at delivery address |
string |
Max length: 10 |
| DeliveryCountryID |
Country code at delivery (ie. US) |
string |
Required Max length: 2 |
| DeliveryAttention |
Attention person at delivery address |
string |
Max length: 50 |
| DeliveryPhoneNumber |
Phone number at delivery |
string |
Max length: 25 |
| DeliveryFaxNumber |
Fax number at delivery |
string |
Max length: 25 |
| DeliveryEmailAddress |
Email address at delivery |
string |
Max length: 100 |
| DeliveryInstructions |
Special instructions at delivery |
string |
Max length: 500 |
| Contents |
Contents of shipment |
string |
Max length: 100 |
| Reference |
Main reference value |
string |
Max length: 50 |
| Pieces |
Number of pieces |
integer |
Required |
| Weight |
Total weight of shipment |
decimal number |
Required |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
Required |
| Length |
Length of each piece in shipment |
integer |
None. |
| Width |
Width of each piece in shipment |
integer |
None. |
| Height |
Height of each piece in shipment |
integer |
None. |
| SizeUOM |
Size unit of measure (IN,CM) |
string |
Required |
| ServiceCode |
Code of the service requested for shipment |
string |
Required |
| ReadyDate |
Date that shipment will be ready for pickup (yyyy-MM-dd format) |
string |
Required Max length: 10 |
| ReadyTime |
Time that shipment will be ready for pickup (HH:mm format) |
string |
Required Max length: 5 |
| RequestedDeliveryDate |
Optional requested delivery date (yyyy-MM-dd format) |
string |
Max length: 10 |
| RequestedDeliveryTime |
Optional requested delivery time (HH:mm format) |
string |
Max length: 5 |
| DeclaredValue |
Delcared value of the shipment |
decimal number |
None. |
| DeclaredValueCurrencyID |
Currency of the declared value (ie. USD) |
string |
Max length: 3 |
| OtherReferenceTypeID1 |
Number that identifies the type of reference field specified in OtherReference1 field |
integer |
None. |
| OtherReferenceTypeID2 |
Number that identifies the type of reference field specified in OtherReference2 field |
integer |
None. |
| OtherReferenceTypeID3 |
Number that identifies the type of reference field specified in OtherReference3 field |
integer |
None. |
| OtherReferenceTypeID4 |
Number that identifies the type of reference field specified in OtherReference4 field |
integer |
None. |
| OtherReferenceTypeID5 |
Number that identifies the type of reference field specified in OtherReference5 field |
integer |
None. |
| OtherReferenceTypeID6 |
Number that identifies the type of reference field specified in OtherReference6 field |
integer |
None. |
| OtherReferenceTypeID7 |
Number that identifies the type of reference field specified in OtherReference7 field |
integer |
None. |
| OtherReferenceTypeID8 |
Number that identifies the type of reference field specified in OtherReference8 field |
integer |
None. |
| OtherReference1 |
Other reference value |
string |
Max length: 50 |
| OtherReference2 |
Other reference value |
string |
Max length: 50 |
| OtherReference3 |
Other reference value |
string |
Max length: 50 |
| OtherReference4 |
Other reference value |
string |
Max length: 50 |
| OtherReference5 |
Other reference value |
string |
Max length: 50 |
| OtherReference6 |
Other reference value |
string |
Max length: 50 |
| OtherReference7 |
Other reference value |
string |
Max length: 50 |
| OtherReference8 |
Other reference value |
string |
Max length: 50 |
| TrackingNumber |
The pre-printed or pre-assigned tracking number for this shipment |
string |
Max length: 20 |
| IsDangerousGoods |
Shipment is dangerous goods (true, false) |
boolean |
None. |
| IsRadioactive |
Shipment is radioactive (true, false)? |
boolean |
None. |
| DgUNNumber |
UN # for dangerous goods |
string |
None. |
| DgCommodityClass |
Commodity class for dangerous goods |
string |
None. |
| DgProperName |
Commodity proper name for dangerous goods |
string |
None. |
| DgDryIceWeight |
Weight of the dry ice |
decimal number |
None. |
| DgGelPackCount |
Number of gel packs |
integer |
None. |
| CarrierToProvideDryIce |
Carrier to provide dry ice (true=carrier provides, false=shipper provides) |
boolean |
None. |
| CarrierToProvideGelPack |
Carrier to provide gel pack (true=carrier provides, false=shipper provides) |
boolean |
None. |
| PackagingTypeCode |
Type of outer packaging (see code list) |
string |
None. |
| PackagingTypeCodeInner |
Type of inner packaging (see code list) |
string |
None. |
| Quantity |
Quantity in piece |
integer |
None. |
| PieceDetail |
Contains the detail information regarding a piece (use only when multiple piece shipment) |
Collection of PieceItem |
None. |
| Notes |
Contains any miscellanous notes that should be associated with the order |
Collection of Note |
None. |
| OrderSource |
Source of Shipment. Anoop Meethal : 28 Aug 2024 : Modify Shipper API to include 'OrderSource' Parameter |
string |
Max length: 1 |
| Commodity |
Source of Shipment. Anoop Meethal : 30 Aug 2024 : 56089 : Modify Shipper API to include 'Commodity' Parameter |
string |
Max length: 100 |