Shipments
Consolidation of import endpoints
In version 2 of our web services, there are seperate endpoints for importing to each status and seperate endpoints for synchronous and asynchronous rating.
With version 3, we have simplified this into 1 endpoint. Using enums and boolean values you can control which type of shipment you create, which status it will be created in and if you want a response immediately or if you want to wait for rating to complete.
| Attribute | Type | Description |
|---|---|---|
WaitForRates |
bool | When true, a response will be returned when the rating engine is complete. Setting to false will return a response immediately. |
ImportAsStatus |
string | This allows you to specify which status the shipment will be imported as. |
IsEzRate |
bool | When true, the shipment will be created as an EZ Rate with minimal data. EZ Rates require less data and are useful for quick zip to zip rates. |
ShouldRunRates |
bool | In most cases this should be true (default). When importing in a booked status, it can be set to false, and manual quote data must be passed. |
Support for new product enhancements
Please reach out to your account manager to learn more about these services.
| Attribute | Type | Description |
|---|---|---|
pullMarketRates |
bool | When true, the market rates for this shipment will be provided by Greenscreens.ai. Access intelligent, AI-driven predictive Truckload pricing to protect your bottom line. |
requestCarbonService |
bool | When creating and rating a shipment, the system will request a carbon footprint calculation and estimate for the cost of offset. If the shipment is going to booked or further status, the offset will be purchased if the user has permission to do so. If false (default), no additional processing occurs. |
Handling Units
Handling units are useful for building out more complext shipments. For example, 1 pallet (handling unit) with 20 boxes (products) and 2 boxes (handling unit) with several loose items.
| Attribute | Type | Description |
|---|---|---|
HandlingUnits |
array | The handling units containing the products. For shipments that cannot utilize handling units, supply a single handling unit with 0 for quantity, and None for package type, and the shipment will not create handling units. |
Last modified: 2 months ago