| Field | Format | Valid Examples | Invalid Examples |
|---|---|---|---|
| Date | MM/dd/yyyy | 12/01/2025, 03/15/2026 | 2025-12-01, 12/1/2025, 12-01-2025 |
| Time | hh:mm | 08:00, 14:30 | 8:00, 8am, 0800 |
| US Postal Code | 5 or 9 digits | 60618, 60618-1234 | 6061, 60618 1234 |
| CA Postal Code | A1A 1A1 | H7S 1P4, M5H 2N2 | H7S1P4, h7s 1p4 |
| NMFC Number | 4–6 digits, optional sub-number | 100240, 100240-07 | 100, 100240-14 |
| Notification Email | Semicolon-delimited addresses | a@b.com;c@d.com | a@b.com, c@d.com |
Canadian Postal Code Rules:
- Space required between 3rd and 4th characters
- Cannot use letters: D, F, I, O, Q, U, W, Z
- Cannot start with: W, Z
- Case-insensitive but typically uppercase
Notification Email Rules:
- Maximum 5 email addresses per field
- Separate multiple addresses with semicolons (no spaces)
- Applies to
AckNotificationandAsnNotification
| Mode | Required Fields | Additional Requirements |
|---|---|---|
| LTL | • Origin (full address + appointment)• Destination (full address + appointment)• Items (min 1, max 200)• BolNumber• UnitOfWeight | • Items[].NmfcClass required• Max total weight: 20,000 lb (9,071 kg) • LocationType required on origin and destination |
| TL | • Stops (min 2 stops)• Items (min 1, max 200)• BolNumber• UnitOfWeight• EquipmentTypes | • Each stop requires full address + appointment • Items[].StopPickNumber and StopDropNumber required• Max total weight: 10,000 lb (4,536 kg) |
| PL (Partial Load) | All TL requirements PLUS: • Items[].NmfcClass | • Same stop and item structure as TL • Max total weight: 10,000 lb (4,536 kg) |
All enum values are uppercase unless noted otherwise.
| Field | Allowed Values |
|---|---|
| UnitOfWeight | LB, KG |
| CountryCode | US, CA |
| LocationType | BUSINESS, RESIDENTIAL, CONSTRUCTIONSITE, TRADESHOW |
| StopType (TL/PL) | PICK, DROP |
| HandlingUnitType | CORRUGATED, CRATES, DRUMS, FLOOR, GAYLORDS, PALLETS, ROLLS, SKIDS, BALES |
| PackageType | BAG, BOXES, BUNDLES, CANS, CARTONS, CASE, CRATE, DRUMS, EA, FIBERDRUMS, FLATRACK, KEGS, OTHER, PAILS, PALLETS, PIECES, REELS, ROLLS, TOTE, TUBES |
| PalletType | CORRUGATED, GAYLORD, METAL, PLASTIC, WOOD, OTHER |
| PalletUnit | INCH, CM |
| EquipmentTarps (TL/PL) | None, T4, T6, T8 |
Note: All enum values are case-sensitive. lb ≠ LB
Common equipment types for EquipmentTypes field:
| Type | Description |
|---|---|
van53 | Standard 53-foot dry van |
reefer53 | 53-foot refrigerated trailer |
flatbed53 | 53-foot flatbed |
stepdeck53 | 53-foot step deck |
van48 | 48-foot dry van |
flatbed48 | 48-foot flatbed |
stepdeck48 | 48-foot step deck |
poweronly | Power only (drop trailer) |
See the OpenAPI specification for the full list of equipment types.
Accessorials are additional services or conditions that may apply to a shipment based on equipment or location requirements. Implementation details such as which modes (LTL, TL, Partial) support a given accessorial and whether it is valid at origin (pickup) or destination (delivery) are defined in the OpenAPI specification.
LIFTGATEREQUIRED- Indicates a liftgate is required for loading or unloading.INSIDE[PICKUP/DELIVERY]- There are delivery requirements beyond the tailgate or dock for this location.HAZARDOUSMATERIALS- Shipment contains hazardous materials.LIMITEDACCESSFEE- Location has restricted or limited access.RESIDENTIAL[PICKUP/DELIVERY]- Location is at a residential location (instead of a business, construction site, etc).PROTECTFROMFREEZING- Freight requires freeze protection.EXTREMELENGTH- Freight exceeds standard length thresholds.
See the OpenAPI specification for the complete accessorials list.
| Field | Minimum | Maximum | Notes |
|---|---|---|---|
| Weight | 0 | — | Per item, in UnitOfWeight units |
| LTL total weight | — | 20,000 lb (9,071 kg) | Across all items |
| TL/PL total weight | — | 10,000 lb (4,536 kg) | Across all items |
| Items array | 1 | 200 | Per shipment |
| PackageQuantity | 0 | — | Per item |
| HandlingUnitQuantity | 0 | — | Per item |
| PalletQuantity | 0 | 12 | Per item |
| PalletHeight/Width/Length | 1 | 999 | Integer |
| StopNumber (TL/PL) | 1 | — | Must increment by 1 |
| EquipmentMinTemp | — | EquipmentMaxTemp | Fahrenheit, integer |
| EquipmentMaxTemp | EquipmentMinTemp | — | Fahrenheit, integer |
| Field | Min | Max | Notes |
|---|---|---|---|
| LocationName | 1 | 60 | Required |
| AddressLine1 | 1 | 55 | Required |
| AddressLine2 | 0 | 55 | Optional |
| City | 1 | 30 | Required |
| StateProvince | 5 | — | Required |
| PostalCode | 5 | — | Required |
| ContactName | 1 | 50 | Required |
| BolNumber | 2 | 40 | Required |
| ReferenceNumber | 2 | 40 | Per stop (TL/PL) |
| References[].Name | 2 | 40 | Custom reference name |
| References[].Value | 2 | 40 | Custom reference value |
| NmfcNumber | 4 | 6 | Plus optional sub-number |
| Description | 0 | 100 | Per item |
| CustomerNotes | 0 | 160 | |
| ShipmentNotes | 0 | 160 | |
| EquipmentNotes | 0 | 1000 | TL/PL only |
| AckNotification | 0 | 300 | Semicolon-delimited emails |
| AsnNotification | 0 | 300 | Semicolon-delimited emails |
| Rule | Requirement | Example |
|---|---|---|
| Start Number | Must be 1 | Stop 1, Stop 2, Stop 3 ✓ |
| Increment | Increase by 1 only | Stop 1, Stop 3 ✗ |
| First Stop | Must be PICK | Stop 1: PICK ✓ |
| Last Stop | Must be DROP | Last stop: DROP ✓ |
| Middle Stops | Can be PICK or DROP | Stop 2: PICK or DROP ✓ |
Items reference stops via StopPickNumber and StopDropNumber, which must match a valid StopNumber.
Blind shipments mask shipper identity from the carrier. When IsBlind: true, the following optional fields override what is shown on the BOL:
BlindLocationName,BlindAddressLine1,BlindAddressLine2BlindCity,BlindStateProvince,BlindPostalCode,BlindCountryCode
For complete field definitions, data types, and all enum values, refer to the OpenAPI specification.
This guide provides validation rules. The specification contains comprehensive schema details.