| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system generated user identifier |
string |
Required Max length: 36 |
| ShipmentNumber |
System assigned shipment number to update |
integer |
Required |
| PickupAddressCode |
Address code used to identify address |
string |
Max length: 20 |
| PickupCompanyName |
Company name at pickup address |
string |
Required Max length: 50 |
| PickupAddress1 |
First line of street address |
string |
Max length: 50 |
| PickupAddress2 |
Second line of street address |
string |
Max length: 50 |
| PickupAddress3 |
Third line of street address |
string |
Max length: 50 |
| PickupCityName |
City name at pickup address |
string |
Required Max length: 50 |
| PickupStateProvID |
State or province code at pickup address |
string |
Max length: 3 |
| PickupPostalCode |
Postal code at pickup address |
string |
Max length: 10 |
| PickupCountryID |
Country ID at pickup address (ie. US) |
string |
Required Max length: 10 |
| PickupPersonToSee |
Name of person to see at pickup address |
string |
Max length: 50 |
| PickupPhoneNumber |
Phone number at pickup address |
string |
Max length: 25 |
| PickupInstructions |
Special instructions at pickup |
string |
Max length: 500 |
| DeliveryAddressCode |
Address code used to identify delivery address |
string |
Max length: 20 |
| DeliveryCompanyName |
Company name at delivery address |
string |
Max length: 50 |
| DeliveryAddress1 |
First address line at delivery address |
string |
Max length: 50 |
| DeliveryAddress2 |
Second address line at delivery address |
string |
Max length: 50 |
| DeliveryAddress3 |
Third address line at delivery address |
string |
Max length: 50 |
| DeliveryCityName |
City name at delivery address |
string |
Max length: 50 |
| DeliveryStateProvID |
State or province code at delivery address |
string |
Max length: 3 |
| DeliveryPostalCode |
Postal code at delivery address |
string |
Max length: 10 |
| DeliveryCountryID |
Country code at delivery address (ie. US) |
string |
Max length: 2 |
| DeliveryAttention |
Attention person at delivery address |
string |
Max length: 50 |
| DeliveryPhoneNumber |
Phone number at delivery address |
string |
Max length: 25 |
| DeliveryEmailAddress |
Email address at delivery address |
string |
Max length: 100 |
| DeliveryInstructions |
Special instructions at delivery |
string |
Max length: 500 |
| ReadyDate |
The date the shipment is ready in pickup timezone (yyyy-MM-dd) |
string |
Required Max length: 10 |
| ReadyTime |
The time the shipment is ready in pickup timezone (HH:mm) |
string |
Required Max length: 5 |