Book a Shipment
POST/api/v3/shipments/{Id}/BookBooks an existing quote on the specified shipment.
Reference the table below, as well as the supplied examples to see the different ways to use this endpoint.
| Attribute | Type | Description |
|---|---|---|
Dispatch |
bool | Defaults to false. When true, the shipment will be moved to Dispatched status in Banyan. |
SubmitPickupRequest |
bool | Defaults to false. When true, a dispatch request will be sent to the carrier. |
DispatchOverride |
bool | Defaults to false. When true, if the dispatch request fails, the shipment will still move to dispatched status. |
Request
Path Params
Id
integer
required
The Id of the entity the request relates to.
Body Params application/json
No schema defined
Example
Not configured
Request samples
Responses
Success(200)
Bad request(400)
Unauthorized(401)
Forbidden(403)
Not Found(404)
Client Error(422)
Too Many Requests(429)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
Not configured
Last modified: 2 months ago