Create or Update Loads
Queues up the creation or updates of existing loads.
Inputs are validated against the API schema immediately and errors are returned in the response, but specific load data is validated asynchronously (such as whether addresses can be geocoded). Subsequent calls to this API using the same externalId are used to update the already created load.
This API should be used to ensure that loads are kept in sync with any other source of truth your brokerage maintains such as your TMS. Load updates should be pushed to this API as soon as changes are made in other systems to avoid duplicate actions across systems, such as loads matched with multiple carriers. All loads should be synced to ensure loads are not orphaned if not updated in subsequent syncs. Load should be synced for up to three days after completion or cancellation. This API does not currently support other modes of transportation than full truckload freight. Ocean, Intermodal, Air, LTL, Tanker, etc. should be not be synced with this API.
Use Cases:
- Make a load available in the Convoy marketplace by creating a load marked with a postingStatus: AVAILABLE
- Update a load available in the Convoy marketplace by sending the updated information along with the externalId of the load
- Cancel a load in the Convoy marketplace, such as when they are canceled in your TMS, by sending the load along with a postingStatus: CANCELED
- Mark a load as already covered by a carrier outside not matched by Convoy by sending postingStatus: COVERED along with the externalId of the load.
Request
- Base URLhttps://demo-developer.convoy.com/broker
- AuthHTTP bearer
Headers
The Convoy API version
Request body
Example request
{
"loads": [
{
"postingRates": {
"maxBuyRateCents": 95000,
"autoAcceptRateCents": 75000
}
}
]
}Response
All or some loads were accepted for creation or updating. Each load is validated independently, so a 202 may include both accepted loads and loads rejected with per-load errors. Always inspect the errors field on each load rather than relying on the status code alone.
Changes
No recorded changes to this operation across all 1 revision of this API.