| Name | Description | Type | Additional information |
|---|---|---|---|
| PickupSchedule |
Date/time window when the freight will be available for pickup |
Schedule |
Required |
| PickupAddress |
Location where the freight should be picked up |
Address |
Required |
| DeliveryAddress |
Location where the freight will be delivered |
Address |
None. |
| TotalBills |
Total number of freight bills that will be picked up |
integer |
Required Range: inclusive between 1 and 500 |
| TotalUnits |
Total number of handling units that will be picked up |
integer |
Required Range: inclusive between 1 and 500 |
| TotalWeight |
Total weight in pounds that will be picked up |
decimal number |
Required Range: inclusive between 1 and 999999 |
| Description |
General description of the freight to be picked up. Please review prohibited articles and restricted articles in the rules tariff. |
string |
None. |
| HazmatTotals |
Total weight by hazard class of any hazardous material to be picked up. Please review prohibited articles and restricted articles in the rules tariff. |
Collection of PickupHazmat |
None. |
| SpecialInstructions |
Any special instructions related to the pickup |
string |
None. |
| EmailConfirmation |
If provided, an email confirmation will be sent to this email address. For multiple addresses, separate them with a semicolon (;). |
string |
Matching regular expression pattern: ^[\w\&\+\-\.]+@([\w\d-]+\.)+[\w]{2,}(\;|$)+$ |
| TestFlag |
When true, the pickup will be cancelled immediately after being created, and a driver will not be dispatched. |
boolean |
None. |