- Version 3
- Authentication
- Shipments
- Creating
- Updating
- Retrieving
- Booking
- Canceling
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Recommended Workflow
- Additional Offerings
- Changelog
- Exports and Webhooks
Book a Shipment
POST
/api/v3/shipments/{Id}/Book
Books 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
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
Body Params application/json
Example
{
"quoteId": 0,
"acceptInsurance": true,
"acceptCarbonService": true,
"dispatch": true,
"submitPickupRequest": true,
"dispatchOverride": true,
"proNumber": "string",
"emailBol": true,
"bolEmailAddress": "string"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.integration.banyantechnology.com/api/v3/shipments//Book' \
--header 'Content-Type: application/json' \
--data-raw '{
"quoteId": 0,
"acceptInsurance": true,
"acceptCarbonService": true,
"dispatch": true,
"submitPickupRequest": true,
"dispatchOverride": true,
"proNumber": "string",
"emailBol": true,
"bolEmailAddress": "string"
}'Responses
🟢200Success
application/json
Body
Example
{
"loadId": 0,
"status": "Pending",
"client": {
"clientId": 0,
"clientName": "string",
"clientRefNumber": "string"
},
"awardedQuotePricing": {
"raw": 0,
"carrier": 0,
"customer": 0
},
"quotes": [
{
"quoteId": 0,
"carrierName": "string",
"carrierId": 0,
"scac": "string",
"thirdPartyName": "string",
"thirdPartyScac": "string",
"serviceId": "string",
"rawPrice": {
"netPrice": 0,
"freightCharge": 0,
"discountAmount": 0,
"fuelSurcharge": 0,
"minimum": 0,
"grossCharge": 0,
"tariff": 0,
"interline": 0,
"accessorialCharges": 0,
"otherCharges": 0,
"charges": [
{
"name": "string",
"amount": 0,
"code": "string"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 0,
"freightCharge": 0,
"discountAmount": 0,
"fuelSurcharge": 0,
"minimum": 0,
"grossCharge": 0,
"tariff": 0,
"interline": 0,
"accessorialCharges": 0,
"otherCharges": 0,
"charges": [
{
"name": "string",
"amount": 0,
"code": "string"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 0,
"freightCharge": 0,
"discountAmount": 0,
"fuelSurcharge": 0,
"minimum": 0,
"grossCharge": 0,
"tariff": 0,
"interline": 0,
"accessorialCharges": 0,
"otherCharges": 0,
"charges": [
{
"name": "string",
"amount": 0,
"code": "string"
}
],
"markup": 0
},
"transitTime": 0,
"quoteNumber": "string",
"carrierPerson": "string",
"carrierNote": "string",
"dateStamp": "2019-08-24T14:15:22Z",
"interline": true,
"accepted": true,
"currencyType": "USDollar",
"service": "string",
"insuranceDetails": {
"price": 0,
"confirmation": "string",
"insuranceNote": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"deductible": "string",
"termsAndConditions": "string",
"vendorCode": "string"
},
"accountNumber": "string"
}
],
"notes": [
{
"description": "string",
"noteTypeId": 0,
"userName": "string",
"dateStamp": "2019-08-24T14:15:22Z"
}
],
"manifestId": "string",
"bolNumber": "string",
"customerPo": "string",
"invoiceId": "string",
"billingId": "string",
"incoTermId": 0,
"pickupNumber": "string",
"shipperConfirmationNumber": "string",
"consigneeConfirmationNumber": "string",
"estimatedPickup": "2019-08-24T14:15:22Z",
"actualPickup": "2019-08-24T14:15:22Z",
"estimatedDelivery": "2019-08-24T14:15:22Z",
"actualDelivery": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"shipType": "Shipper",
"payType": "Collect",
"exportReason": "string",
"internationalTerm": "string",
"shipperLocation": {
"companyName": "string",
"locationName": "string",
"einNumber": "string",
"note": "string",
"contactMethods": {
"phoneNumber": "string",
"extension": "string",
"faxNumber": "string",
"email": "string"
},
"contactPerson": {
"firstName": "string",
"lastName": "string"
},
"address": {
"lineOne": "string",
"lineTwo": "string",
"city": "string",
"stateOrProvince": "string",
"zipCode": "string",
"country": "string"
},
"vendorId": "string",
"distributionCenterReferenceNumber": "string",
"dock": {
"name": "string",
"note": "string",
"confirmationNumber": "string",
"openTime": "2019-08-24T14:15:22Z",
"accessTime": "2019-08-24T14:15:22Z",
"closeTime": "2019-08-24T14:15:22Z",
"isFirstComeFirstServe": true,
"limitedAccessType": "Airport"
}
},
"consigneeLocation": {
"companyName": "string",
"locationName": "string",
"einNumber": "string",
"note": "string",
"contactMethods": {
"phoneNumber": "string",
"extension": "string",
"faxNumber": "string",
"email": "string"
},
"contactPerson": {
"firstName": "string",
"lastName": "string"
},
"address": {
"lineOne": "string",
"lineTwo": "string",
"city": "string",
"stateOrProvince": "string",
"zipCode": "string",
"country": "string"
},
"vendorId": "string",
"distributionCenterReferenceNumber": "string",
"dock": {
"name": "string",
"note": "string",
"confirmationNumber": "string",
"openTime": "2019-08-24T14:15:22Z",
"accessTime": "2019-08-24T14:15:22Z",
"closeTime": "2019-08-24T14:15:22Z",
"isFirstComeFirstServe": true,
"limitedAccessType": "Airport"
}
},
"billTo": {
"name": "string",
"contactMethods": {
"phoneNumber": "string",
"extension": "string",
"faxNumber": "string",
"email": "string"
},
"note": "string",
"address": {
"lineOne": "string",
"lineTwo": "string",
"city": "string",
"stateOrProvince": "string",
"zipCode": "string",
"country": "string"
}
},
"packageInfo": {
"routeNumber": "string",
"cod": 0,
"declaredLiability": 0
},
"shipmentServices": [
{
"serviceMode": "Standard Parcel Service",
"quantity": 1,
"packageType": "ACC",
"equipmentType": "16ft Straight Truck",
"additionalWeight": 0,
"weightUnitOfMeasurement": "LBS",
"specialInstructions": "string",
"dimensions": {
"unitOfMeasurement": "CM",
"length": 0,
"width": 0,
"height": 0
}
}
],
"handlingUnits": [
{
"packageType": "ACC",
"quantity": 0,
"length": 0,
"width": 0,
"height": 0,
"additionalWeight": 0,
"unitOfMeasurement": "CM",
"weightUnitOfMeasurement": "LBS",
"products": [
{
"packageType": "ACC",
"quantity": 1,
"class": 0,
"weight": 1,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "CM",
"length": 0,
"width": 0,
"height": 0
},
"nmfc": "string",
"description": "string",
"sku": "string",
"referenceNumber": "string",
"hazmatDetails": {
"name": "string",
"contactMethods": {
"phoneNumber": "string",
"extension": "string",
"faxNumber": "string",
"email": "string"
},
"isPoison": true,
"unNumber": "string",
"shippingName": "string",
"class": "string",
"packageGroup": "string"
},
"isHazmat": true,
"internationalDetails": {
"harmonizedSystemCode": "string",
"systemBCode": "string",
"eccn": "strin"
}
}
]
}
],
"loadAccessorials": [
{
"description": "Age Restricted",
"abbreviation": "AGE ",
"value": "string"
}
],
"shipperAccessorials": [
{
"description": "Age Restricted",
"abbreviation": "AGE ",
"value": "string"
}
],
"consigneeAccessorials": [
{
"description": "Age Restricted",
"abbreviation": "AGE ",
"value": "string"
}
],
"referenceFields": [
{
"type": "string",
"value": "string",
"printOnBol": true,
"printOnShippingLabel": true
}
],
"insuranceInfo": {
"vendor": "string",
"commodityType": "string",
"commodityCondition": "string",
"insuredValue": 0
},
"stops": [
{}
],
"legs": [
{}
],
"exported": true,
"isMultiStop": true,
"isMultiLeg": true,
"dispatchResponse": {
"loadId": 0,
"success": true,
"pickupNumber": "string",
"carrierName": "string",
"quoteNumber": "string",
"estimatedDeliveryDate": "2019-08-24T14:15:22Z",
"proNumber": "string",
"userMessage": "string",
"bolLink": "string",
"warnings": [
"string"
],
"errors": [
"string"
]
},
"carbonQuote": {
"offsetAmount": 0,
"offsetUnit": "string",
"estimatedPrice": 0,
"vendorFee": 0,
"currency": "string",
"orderId": "string"
},
"marketRates": [
{
"vendorName": "string",
"highBuyRate": 0,
"lowBuyRate": 0,
"buyRate": 0,
"startRate": 0,
"confidenceLevel": 0,
"currency": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"trackingNumbers": [
"string"
],
"ratingCompleted": true
}🟠400Bad request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Client Error
🟠429Too Many Requests
Modified at 2024-09-16 11:42:17