| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique user GUID assigned for security purposes |
string |
Required Max length: 36 |
| ShipmentNumber |
Unique shipment number used to reference shipment |
integer |
Required |
| PickupAddressCode |
An address code used to identify the pickup address |
string |
Max length: 15 |
| PickupCompanyName |
The name of the company at the pickup location |
string |
Max length: 50 |
| PickupAddress1 |
Address line 1 at the pickup location |
string |
Max length: 50 |
| PickupAddress2 |
Address line 2 at the pickup location |
string |
Max length: 50 |
| PickupAddress3 |
Address line 3 at the pickup location |
string |
Max length: 50 |
| PickupCityName |
The city name at the pickup location |
string |
Max length: 50 |
| PickupStateProvID |
The state or province at the pickup location |
string |
Max length: 3 |
| PickupPostalCode |
The postal code at the pickup location |
string |
Max length: 10 |
| PickupCountryID |
The country identifier at the pickup location |
string |
Max length: 2 |
| PickupPersonToSee |
The person to see at the pickup location |
string |
Max length: 50 |
| PickupPhoneNumber |
The phone number at the pickup location |
string |
Max length: 25 |
| PickupFaxNumber |
The fax number at the pickup location |
string |
Max length: 25 |
| PickupInstructions |
The pickup instructions at the pickup location |
string |
Max length: 500 |
| DeliveryAddressCode |
An address code used to identify the delivery address |
string |
Max length: 15 |
| DeliveryCompanyName |
The name of the company at the pickup location |
string |
Max length: 50 |
| DeliveryAddress1 |
The address line 1 at the delivery location |
string |
Max length: 50 |
| DeliveryAddress2 |
The address line 2 at the delivery location |
string |
Max length: 50 |
| DeliveryAddress3 |
The address line 3 at the delivery location |
string |
Max length: 50 |
| DeliveryCityName |
The name of the city at the delivery location |
string |
Max length: 50 |
| DeliveryStateProvID |
The state or province at the delivery location |
string |
Max length: 3 |
| DeliveryPostalCode |
The postal code at the delivery location |
string |
Max length: 10 |
| DeliveryCountryID |
The country ID at the delivery location (ie. US) |
string |
Max length: 2 |
| DeliveryAttention |
The attention to person at the delivery location |
string |
Max length: 50 |
| DeliveryPhoneNumber |
The phone number at the delivery location |
string |
Max length: 25 |
| DeliveryFaxNumber |
The fax number at the delivery location |
string |
Max length: 25 |
| DeliveryEmailAddress |
The email address at the delivery location |
string |
Max length: 100 |
| DeliveryInstructions |
The delivery instructions at the delivery location |
string |
Max length: 500 |
| Contents |
The description of the contents at of the shipment |
string |
Max length: 100 |
| Reference |
Customer specified reference value for the shipment |
string |
Max length: 50 |
| Pieces |
Number of pieces in the shipment |
integer |
Range: inclusive between 1 and 9999 |
| Weight |
Total actual weight of the shipment |
decimal number |
Range: inclusive between 0.5 and 99999 |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
Max length: 2 |
| Length |
Length of each piece in the shipment |
integer |
Range: inclusive between 1 and 9999 |
| Width |
Width of each piece in the shipment |
integer |
Range: inclusive between 1 and 9999 |
| Height |
Height of each piece in the shipment |
integer |
Range: inclusive between 1 and 9999 |
| SizeUOM |
Size unit of measure (IN,CM) |
string |
Max length: 2 |
| ReadyDate |
Date shipment will be ready for pickup (YYYY-MM-dd) |
string |
Max length: 10 |
| ReadyTime |
Time of day shipment will be ready for pickup (HH:mm) |
string |
Max length: 5 |
| RequestedDeliveryDate |
Requested delivery Date (YYYY-MM-dd) |
string |
Max length: 10 |
| RequestedDeliveryTime |
Requested delivery Time (HH:mm) |
string |
Max length: 5 |
| DeclaredValue |
Declared value of shipment |
decimal number |
Range: inclusive between 1 and 999999 |
| DeclaredValueCurrencyID |
Current of declared value (ie. USD) |
string |
Max length: 3 |
| OtherReference1 |
Custom reference value |
string |
Max length: 50 |
| OtherReference2 |
Custom reference value |
string |
Max length: 50 |