- Version 3
- Authentication
- Shipments
- Creating
- Updating
- Retrieving
- Booking
- Canceling
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Recommended Workflow
- Additional Offerings
- Changelog
- Exports and Webhooks
Create a Full Shipment
POST
/api/v3/shipments
Create a full shipment in Banyan.#
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
Example
{
"importAsStatus": "Quoted",
"shouldRunRates": true,
"isEzRate": true,
"waitForRates": false,
"shipmentData": {
"shipType": "ThirdParty",
"payType": "Prepaid",
"shipperLocation": {
"address": {
"city": "ALBANY",
"stateOrProvince": "NY",
"zipCode": "12204",
"country": "United States"
}
},
"consigneeLocation": {
"address": {
"city": "MIAMI",
"stateOrProvince": "FL",
"zipCode": "33156",
"country": "United States"
}
},
"shipmentServices": [
{
"serviceMode": "LTL",
"quantity": 1,
"packageType": "Pallets",
"equipmentType": "Van-Standard Trailer",
"weightUnitOfMeasurement": "LBS"
}
],
"handlingUnits": [
{
"packageType": "Pallets",
"quantity": 1,
"products": [
{
"packageType": "Boxes",
"quantity": 10,
"class": 200,
"weight": 210,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 42,
"width": 42,
"height": 56
},
"description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
}
]
}
]
}
}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' \
--header 'Content-Type: application/json' \
--data-raw '{
"importAsStatus": "Quoted",
"shouldRunRates": true,
"isEzRate": true,
"waitForRates": false,
"shipmentData": {
"shipType": "ThirdParty",
"payType": "Prepaid",
"shipperLocation": {
"address": {
"city": "ALBANY",
"stateOrProvince": "NY",
"zipCode": "12204",
"country": "United States"
}
},
"consigneeLocation": {
"address": {
"city": "MIAMI",
"stateOrProvince": "FL",
"zipCode": "33156",
"country": "United States"
}
},
"shipmentServices": [
{
"serviceMode": "LTL",
"quantity": 1,
"packageType": "Pallets",
"equipmentType": "Van-Standard Trailer",
"weightUnitOfMeasurement": "LBS"
}
],
"handlingUnits": [
{
"packageType": "Pallets",
"quantity": 1,
"products": [
{
"packageType": "Boxes",
"quantity": 10,
"class": 200,
"weight": 210,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 42,
"width": 42,
"height": 56
},
"description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
}
]
}
]
}
}'Responses
🟢201Created
application/json
Body
Example
{
"loadId": 55349116,
"status": "Quoted",
"client": {
"clientId": 45086,
"clientName": "Banyan Web Services Test",
"clientRefNumber": "BWSTO123"
},
"awardedQuotePricing": {
"raw": 0,
"carrier": 0,
"customer": 0
},
"quotes": [
{
"quoteId": 448666865,
"carrierName": "Banyan Test Carrier",
"carrierId": 59742,
"scac": "BTST",
"thirdPartyName": "",
"thirdPartyScac": "",
"serviceId": "60204636",
"rawPrice": {
"netPrice": 1024,
"freightCharge": 960.5,
"discountAmount": 5,
"fuelSurcharge": 15,
"minimum": 0,
"grossCharge": 965.5,
"tariff": 0,
"interline": 0,
"accessorialCharges": 23.5,
"otherCharges": 25,
"charges": [
{
"name": "Construction Site (General)",
"amount": 25,
"code": "GCON"
},
{
"name": "Liftgate Delivery",
"amount": 2.5,
"code": "CLFTG"
},
{
"name": "Protect from Freezing",
"amount": 21,
"code": "LBSRV"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 1094,
"freightCharge": 1026.16,
"discountAmount": 5.34,
"fuelSurcharge": 16.03,
"minimum": 0,
"grossCharge": 1031.5,
"tariff": 0,
"interline": 0,
"accessorialCharges": 25.11,
"otherCharges": 26.71,
"charges": [
{
"name": "Construction Site (General)",
"amount": 26.71,
"code": "GCON"
},
{
"name": "Liftgate Delivery",
"amount": 2.67,
"code": "CLFTG"
},
{
"name": "Protect from Freezing",
"amount": 22.44,
"code": "LBSRV"
}
],
"markup": 6.84
},
"customerPrice": {
"netPrice": 1302.8,
"freightCharge": 1222.01,
"discountAmount": 6.36,
"fuelSurcharge": 19.08,
"minimum": 0,
"grossCharge": 1228.37,
"tariff": 0,
"interline": 0,
"accessorialCharges": 29.9,
"otherCharges": 31.81,
"charges": [
{
"name": "Construction Site (General)",
"amount": 31.81,
"code": "GCON"
},
{
"name": "Liftgate Delivery",
"amount": 3.18,
"code": "CLFTG"
},
{
"name": "Protect from Freezing",
"amount": 26.72,
"code": "LBSRV"
}
],
"markup": 27.23
},
"transitTime": 2,
"quoteNumber": "1711044230",
"carrierPerson": "Test Carrier Automated Quote",
"carrierNote": "",
"dateStamp": "2024-03-21T14:03:50",
"interline": false,
"accepted": false,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
}
],
"notes": [
{
"description": "Patch.IO carbon footprint: 100.093 kg\n Estimated offset cost: 0.48 USD",
"noteTypeId": 18,
"userName": "Shane Hawk",
"dateStamp": "2024-03-21T14:03:49"
},
{
"description": "No carbon project configured for your vendor. Patch.io will select a project.",
"noteTypeId": 5,
"userName": "Shane Hawk",
"dateStamp": "2024-03-21T14:03:48"
},
{
"description": "Load Created via Web Services 3.0",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2024-03-21T14:03:47"
}
],
"manifestId": "qweqeqeqwewq",
"bolNumber": "SampleBol",
"customerPo": "customerPo",
"invoiceId": "invoiceId",
"billingId": "",
"incoTermId": 0,
"pickupNumber": null,
"shipperConfirmationNumber": "",
"consigneeConfirmationNumber": "",
"estimatedPickup": "2023-06-30T00:00:00",
"actualPickup": null,
"estimatedDelivery": "2023-07-06T00:00:00",
"actualDelivery": null,
"createdDate": "2024-03-21T14:03:46",
"shipType": "ThirdParty",
"payType": "Prepaid",
"exportReason": null,
"internationalTerm": null,
"shipperLocation": {
"companyName": "s comp name",
"locationName": "s loc name",
"einNumber": null,
"note": "",
"contactMethods": {
"phoneNumber": "1111111111",
"extension": "",
"faxNumber": "",
"email": ""
},
"contactPerson": {
"firstName": "",
"lastName": ""
},
"address": {
"lineOne": "123 main st",
"lineTwo": "",
"city": "ALBANY",
"stateOrProvince": "NY",
"zipCode": "12204",
"country": "United States"
},
"vendorId": "43fffs",
"distributionCenterReferenceNumber": "",
"dock": {
"name": "Main Dock",
"note": "",
"confirmationNumber": "",
"openTime": "2023-06-30T09:00:00",
"accessTime": "2023-06-30T13:00:00",
"closeTime": "2023-06-30T16:00:00",
"isFirstComeFirstServe": false,
"limitedAccessType": ""
}
},
"consigneeLocation": {
"companyName": "c comp name",
"locationName": "c loc name",
"einNumber": null,
"note": "",
"contactMethods": {
"phoneNumber": "33333333333",
"extension": "",
"faxNumber": "",
"email": ""
},
"contactPerson": {
"firstName": "",
"lastName": ""
},
"address": {
"lineOne": "123 main st",
"lineTwo": "",
"city": "MIAMI",
"stateOrProvince": "FL",
"zipCode": "33156",
"country": "United States"
},
"vendorId": "",
"distributionCenterReferenceNumber": "",
"dock": {
"name": "Main Dock",
"note": "",
"confirmationNumber": "",
"openTime": "2023-07-06T09:00:00",
"accessTime": "2023-07-06T09:00:00",
"closeTime": "2023-07-06T16:00:00",
"isFirstComeFirstServe": false,
"limitedAccessType": ""
}
},
"billTo": {
"name": "Banyan Technology",
"contactMethods": {
"phoneNumber": "216-867-5309",
"extension": "",
"faxNumber": "",
"email": "test@banyantechnology.com"
},
"note": "",
"address": {
"lineOne": "30505 Clemens Rd",
"lineTwo": "",
"city": "Westlake",
"stateOrProvince": "OH",
"zipCode": "44145",
"country": "United States"
}
},
"packageInfo": {
"routeNumber": "",
"cod": 0,
"declaredLiability": 0
},
"shipmentServices": [
{
"serviceMode": "LTL",
"quantity": 1,
"packageType": "CRTN",
"equipmentType": "DV",
"additionalWeight": 0,
"weightUnitOfMeasurement": "LBS",
"specialInstructions": "TEST ONLY - SPECIAL INSTRUCTIONS - TEST ONLY",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 0,
"width": 0,
"height": 0
}
}
],
"handlingUnits": [
{
"packageType": "Pallets",
"quantity": 1,
"length": null,
"width": null,
"height": null,
"additionalWeight": null,
"unitOfMeasurement": "",
"weightUnitOfMeasurement": "",
"products": [
{
"packageType": "BOXS",
"quantity": 1,
"class": 200,
"weight": 210,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 0,
"width": 0,
"height": 0
},
"nmfc": null,
"description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY",
"sku": null,
"referenceNumber": null,
"hazmatDetails": null,
"internationalDetails": null,
"isHazmat": false
}
]
}
],
"loadAccessorials": [],
"shipperAccessorials": [],
"consigneeAccessorials": [],
"referenceFields": [
{
"type": "OrderNumber",
"value": "12345678",
"printOnBol": true,
"printOnShippingLabel": true
}
],
"insuranceInfo": null,
"stops": [],
"legs": [],
"exported": false,
"isMultiStop": false,
"isMultiLeg": false,
"dispatchResponse": null,
"carbonQuote": {
"offsetAmount": 100093,
"offsetUnit": "g",
"estimatedPrice": 40,
"vendorFee": 8,
"currency": "USD",
"orderId": "ord_test_b3ac6e452dcbb730b6b20e760296c8f2"
},
"marketRates": [
{
"vendorName": "Greenscreens.ai",
"highBuyRate": 567.4,
"lowBuyRate": 350.35,
"buyRate": 441.67,
"startRate": 300,
"confidenceLevel": 50,
"currency": "USDollar",
"date": "2024-03-24T14:15:22Z"
}
]
}🟠400Bad Request
🟠401Unauthorized
🟠422Client Error
🟠403Forbidden
🟠429Too Many Requests
Modified at 2025-05-23 18:26:35