latestSwagger 2.02026-08-1274120326.8 KB
3a995f316cda
CoverageGuideConnect
Add or update loads for Coverage Guide Connect
This endpoint allows permissioned users to send data programmatically to SONAR for Coverage Guide analysis. Data will be validated, enriched with market intelligence, and displayed in the Coverage Guide UI.
IMPORTANT: Currently supports domestic USA lanes only. All origin and destination locations must be within the United States. International lane support may be added in future releases.
For more information about getting access to this endpoint, please reach out to our Customer Success team (cs@gosonar.com).
This endpoint handles the following input fields:
- load_id: Unique identifier for the load, required
- origin_zip: Origin zip code (must be at least 3 characters), required
- destination_zip: Destination zip code (must be at least 3 characters), required
- equipment_type: Equipment type (VAN, REEFER, or FLATBED), required
- segment: Segment identifier for grouping lanes, optional
- consignee_name: Consignee name, required
- input_miles: Distance in miles, optional
- my_rate: Customer's rate in dollars, optional
- order_tender_datetime: When the order was tendered, required
- scheduled_pickup_datetime: Scheduled pickup date/time, required
- scheduled_delivery_datetime: Scheduled delivery date/time, required
- cargo_description: Description of cargo, optional
- number_of_pickups: Number of pickup stops, optional
- number_of_drops: Number of delivery stops, optional
- number_of_stops: Total number of stops, optional
- full_partial: Full or partial truckload, optional
- equipment_detail: Detailed equipment specifications, optional
- hazmat: Whether cargo is hazardous material, optional
The endpoint also accepts any additional custom fields you want to send - they will be stored for future use.
Here are the output fields returned in a successful call:
- total_loads: Total number of loads in request
- successful_loads: Number of loads successfully processed
- failed_loads: Number of loads that failed validation/processing
- errors: List of errors for failed loads (if any)
post/coverage_guide/org/loads
Headers
x-api-versionstring
Request body
Example request
{
"loads": [
{
"load_id": "100001",
"origin_zip": "60601",
"destination_zip": "30303",
"equipment_type": "VAN",
"segment": "midwest",
"consignee_name": "ABC Distribution",
"input_miles": 716,
"my_rate": 1800.5,
"order_tender_datetime": "2023-12-20T20:25:43.515Z",
"scheduled_pickup_datetime": "2023-12-21T08:00:00.000Z",
"scheduled_delivery_datetime": "2023-12-22T17:00:00.000Z",
"cargo_description": "Building materials",
"number_of_pickups": 1,
"number_of_drops": 1,
"number_of_stops": 2,
"full_partial": "FULL",
"equipment_detail": "53ft dry van"
}
]
}Response
OK