- Version 3
- Authentication
- Shipments
- Creating
- Updating
- Retrieving
- Booking
- Canceling
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Recommended Workflow
- Additional Offerings
- Changelog
- Exports and Webhooks
Get a Shipment
GET
/api/v3/shipments/{Id}
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
Header Params
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 GET 'https://ws.integration.banyantechnology.com/api/v3/shipments/' \
--header 'Authorization: Bearer: {jwt}'Responses
🟢200Success
application/json
Body
Example
{
"loadId": 48532482,
"status": "Dispatched",
"client": {
"clientId": 45086,
"clientName": "Banyan Web Services - Test Only",
"clientRefNumber": "BWSTO123"
},
"awardedQuotePricing": {
"raw": 138.53,
"carrier": 138.53,
"customer": 166.24
},
"quotes": [
{
"quoteId": 412276791,
"carrierName": "BanyanTest3PL_4",
"carrierId": 150950,
"scac": "BTPL",
"thirdPartyName": "BanyanTest3PL_4",
"thirdPartyScac": "BTPL",
"serviceId": "53603276",
"rawPrice": {
"netPrice": 847.38,
"freightCharge": 704.52,
"discountAmount": 119.77,
"fuelSurcharge": 30.86,
"minimum": 0,
"grossCharge": 704.52,
"tariff": 0,
"interline": 0,
"accessorialCharges": 112,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 34,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 16,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 30,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 32,
"code": "CLFTG"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 847.38,
"freightCharge": 704.52,
"discountAmount": 119.77,
"fuelSurcharge": 30.86,
"minimum": 0,
"grossCharge": 704.52,
"tariff": 0,
"interline": 0,
"accessorialCharges": 112,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 34,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 16,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 30,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 32,
"code": "CLFTG"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 1016.86,
"freightCharge": 845.43,
"discountAmount": 143.72,
"fuelSurcharge": 37.03,
"minimum": 0,
"grossCharge": 845.43,
"tariff": 0,
"interline": 0,
"accessorialCharges": 134.4,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 40.8,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 19.2,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 36,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 38.4,
"code": "CLFTG"
}
],
"markup": 20
},
"transitTime": 2,
"quoteNumber": "828736261",
"carrierPerson": "BanyanTest3PL Automated Quote",
"carrierNote": "",
"dateStamp": "2023-02-27T12:58:12",
"interline": false,
"accepted": false,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
},
{
"quoteId": 412276792,
"carrierName": "BanyanTest3PL_3",
"carrierId": 150950,
"scac": "BTPL",
"thirdPartyName": "BanyanTest3PL_3",
"thirdPartyScac": "BTPL",
"serviceId": "53603276",
"rawPrice": {
"netPrice": 768.49,
"freightCharge": 665.34,
"discountAmount": 259.48,
"fuelSurcharge": 29.15,
"minimum": 0,
"grossCharge": 665.34,
"tariff": 0,
"interline": 0,
"accessorialCharges": 74,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 22,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 10,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 27,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 15,
"code": "CLFTG"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 768.49,
"freightCharge": 665.34,
"discountAmount": 259.48,
"fuelSurcharge": 29.15,
"minimum": 0,
"grossCharge": 665.34,
"tariff": 0,
"interline": 0,
"accessorialCharges": 74,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 22,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 10,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 27,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 15,
"code": "CLFTG"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 922.19,
"freightCharge": 798.41,
"discountAmount": 311.38,
"fuelSurcharge": 34.97,
"minimum": 0,
"grossCharge": 798.41,
"tariff": 0,
"interline": 0,
"accessorialCharges": 88.8,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 26.4,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 12,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 32.4,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 18,
"code": "CLFTG"
}
],
"markup": 20
},
"transitTime": 2,
"quoteNumber": "1631756660",
"carrierPerson": "BanyanTest3PL Automated Quote",
"carrierNote": "",
"dateStamp": "2023-02-27T12:58:12",
"interline": false,
"accepted": false,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
},
{
"quoteId": 412276793,
"carrierName": "BanyanTest3PL_5",
"carrierId": 150950,
"scac": "BTPL",
"thirdPartyName": "BanyanTest3PL_5",
"thirdPartyScac": "BTPL",
"serviceId": "53603276",
"rawPrice": {
"netPrice": 471.98,
"freightCharge": 362.12,
"discountAmount": 181.06,
"fuelSurcharge": 15.86,
"minimum": 0,
"grossCharge": 362.12,
"tariff": 0,
"interline": 0,
"accessorialCharges": 94,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 12,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 28,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 34,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 20,
"code": "CLFTG"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 471.98,
"freightCharge": 362.12,
"discountAmount": 181.06,
"fuelSurcharge": 15.86,
"minimum": 0,
"grossCharge": 362.12,
"tariff": 0,
"interline": 0,
"accessorialCharges": 94,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 12,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 28,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 34,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 20,
"code": "CLFTG"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 566.38,
"freightCharge": 434.55,
"discountAmount": 217.27,
"fuelSurcharge": 19.04,
"minimum": 0,
"grossCharge": 434.55,
"tariff": 0,
"interline": 0,
"accessorialCharges": 112.8,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 14.4,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 33.6,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 40.8,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 24,
"code": "CLFTG"
}
],
"markup": 20
},
"transitTime": 2,
"quoteNumber": "1407577976",
"carrierPerson": "BanyanTest3PL Automated Quote",
"carrierNote": "",
"dateStamp": "2023-02-27T12:58:12",
"interline": false,
"accepted": false,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
},
{
"quoteId": 412276794,
"carrierName": "BanyanTest3PL_2",
"carrierId": 150950,
"scac": "BTPL",
"thirdPartyName": "BanyanTest3PL_2",
"thirdPartyScac": "BTPL",
"serviceId": "53603276",
"rawPrice": {
"netPrice": 299.89,
"freightCharge": 208.74,
"discountAmount": 62.62,
"fuelSurcharge": 9.14,
"minimum": 0,
"grossCharge": 208.74,
"tariff": 0,
"interline": 0,
"accessorialCharges": 82,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 12,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 26,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 29,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 15,
"code": "CLFTG"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 299.89,
"freightCharge": 208.74,
"discountAmount": 62.62,
"fuelSurcharge": 9.14,
"minimum": 0,
"grossCharge": 208.74,
"tariff": 0,
"interline": 0,
"accessorialCharges": 82,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 12,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 26,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 29,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 15,
"code": "CLFTG"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 359.87,
"freightCharge": 250.49,
"discountAmount": 75.14,
"fuelSurcharge": 10.97,
"minimum": 0,
"grossCharge": 250.49,
"tariff": 0,
"interline": 0,
"accessorialCharges": 98.4,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 14.4,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 31.2,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 34.8,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 18,
"code": "CLFTG"
}
],
"markup": 20
},
"transitTime": 1,
"quoteNumber": "275404533",
"carrierPerson": "BanyanTest3PL Automated Quote",
"carrierNote": "",
"dateStamp": "2023-02-27T12:58:12",
"interline": false,
"accepted": false,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
},
{
"quoteId": 412276795,
"carrierName": "BanyanTest3PL_1",
"carrierId": 150950,
"scac": "BTPL",
"thirdPartyName": "BanyanTest3PL_1",
"thirdPartyScac": "BTPL",
"serviceId": "53603276",
"rawPrice": {
"netPrice": 138.53,
"freightCharge": 38.83,
"discountAmount": 9.32,
"fuelSurcharge": 1.7,
"minimum": 0,
"grossCharge": 38.83,
"tariff": 0,
"interline": 0,
"accessorialCharges": 98,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 20,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 29,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 20,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 29,
"code": "CLFTG"
}
],
"markup": 0
},
"carrierPrice": {
"netPrice": 138.53,
"freightCharge": 38.83,
"discountAmount": 9.32,
"fuelSurcharge": 1.7,
"minimum": 0,
"grossCharge": 38.83,
"tariff": 0,
"interline": 0,
"accessorialCharges": 98,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 20,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 29,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 20,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 29,
"code": "CLFTG"
}
],
"markup": 0
},
"customerPrice": {
"netPrice": 166.24,
"freightCharge": 46.6,
"discountAmount": 11.18,
"fuelSurcharge": 2.04,
"minimum": 0,
"grossCharge": 46.6,
"tariff": 0,
"interline": 0,
"accessorialCharges": 117.6,
"otherCharges": 0,
"charges": [
{
"name": "Stackable",
"amount": 24,
"code": "LSTAC"
},
{
"name": "Liftgate Pickup",
"amount": 34.8,
"code": "SLFTG"
},
{
"name": "Appointment Required",
"amount": 24,
"code": "CAPPT"
},
{
"name": "Liftgate Delivery",
"amount": 34.8,
"code": "CLFTG"
}
],
"markup": 20
},
"transitTime": 1,
"quoteNumber": "1161146044",
"carrierPerson": "BanyanTest3PL Automated Quote",
"carrierNote": "",
"dateStamp": "2023-02-27T12:58:12",
"interline": false,
"accepted": true,
"currencyType": "USDollar",
"service": "LTL",
"insuranceDetails": null,
"accountNumber": "NewAccount"
}
],
"notes": [
{
"description": "Load Status was changed from 'Booked' to 'Dispatched'",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:57"
},
{
"description": "Pickup Request Successful. <br/>Your Pickup Number is: <b>1677520735</b><br/>Your Pro Number is: <b>PRO-1601000097</b><br/>",
"noteTypeId": 14,
"userName": "Automation",
"dateStamp": "2023-02-27T12:58:57"
},
{
"description": "LoadID:48532482<br/>BolNum:BWS2305800002<br/>QuoteID:412276795<br/>ManifestID:<br/>ActualCharge:166.24<br/>PickupDate:2/27/2023<br/>AccessTime:12:00<br/>CarrierID:150950<br/>Web_Dispatch:True<br/>EDI_Dispatch:False<br/>",
"noteTypeId": 7,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:54"
},
{
"description": "BanyanTest3PL does not have a carrier user setup for this client. (No Email Could Be Sent)",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:54"
},
{
"description": "Load booked with BanyanTest3PL_1.",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:54"
},
{
"description": "<a href=javascript:ShowTerminalLink('150950','48532482')>Terminal Link</a>",
"noteTypeId": 19,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:54"
},
{
"description": "Original shipperDateTime = 02/27/2023<br/>Original consigneedatetime = 02/28/2023<br/>New shipperDateTime = 02/27/2023<br/>New consigneedatetime = 02/28/2023<br/>ActualPickupDate = 02/27/2023<br/>ActualDeliverDate = 02/28/2023<br/>",
"noteTypeId": 7,
"userName": "Automation",
"dateStamp": "2023-02-27T12:58:54"
},
{
"description": "Rating Process Started.",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:09"
},
{
"description": "Status changed from Pending to Open.",
"noteTypeId": 12,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:09"
},
{
"description": "Product's UnNumber changed from to . <br/>Product's HazMatShippingName changed from to . <br/>Product's HazMatClass changed from to . <br/>Product's HazMatPkgGroup changed from to . <br/>Product's Phone changed from to . <br/>Product's PhoneExt changed from to . <br/>Product's DeliveryConfirmationId changed from 0 to . <br/>Product's CodTypeId changed from 0 to . <br/>Product's CodAmount changed from 0.00 to . <br/>Product's InsuranceAmount changed from 0.00 to . <br/>Product's HazMatContact changed from to",
"noteTypeId": 24,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:08"
},
{
"description": "Load Saved.",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:06"
},
{
"description": "Load Saved.",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:05"
},
{
"description": "This load was copied from <a href='extendedload.aspx?loadID=48532481'>BOL Number: BWS2305800001</a>",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:00"
},
{
"description": "Load Created",
"noteTypeId": 10,
"userName": "Shane Hawk",
"dateStamp": "2023-02-27T12:58:00"
},
{
"description": "Original BOLID: BWS2305800002",
"noteTypeId": 7,
"userName": "Automation",
"dateStamp": "2023-02-27T12:58:00"
}
],
"manifestId": "PRO-1601000097",
"bolNumber": "BWS2305800002",
"customerPo": "",
"invoiceId": "",
"billingId": "",
"incoTermId": 0,
"pickupNumber": "1677520735",
"shipperConfirmationNumber": "",
"consigneeConfirmationNumber": "",
"estimatedPickup": "2023-02-27T00:00:00",
"actualPickup": "2023-02-27T00:00:00",
"estimatedDelivery": "2023-02-28T00:00:00",
"actualDelivery": "2023-02-28T00:00:00",
"createdDate": "2023-02-27T12:58:00",
"shipType": "ThirdParty",
"payType": "Prepaid",
"shipperLocation": {
"companyName": "Test Merchant",
"locationName": "Test Location 1",
"note": "",
"contactMethods": {
"phoneNumber": "",
"extension": "",
"faxNumber": "",
"email": ""
},
"contactPerson": {
"firstName": "",
"lastName": ""
},
"address": {
"lineOne": "1234 Main St",
"lineTwo": "",
"city": "Cleveland",
"stateOrProvince": "OH",
"zipCode": "44102",
"country": "United States"
},
"vendorId": "",
"distributionCenterReferenceNumber": "",
"dock": {
"name": "Main Dock",
"note": "",
"confirmationNumber": "",
"openTime": "2023-02-27T08:00:00",
"accessTime": "2023-02-27T12:00:00",
"closeTime": "2023-02-27T17:00:00",
"isFirstComeFirstServe": false,
"limitedAccessType": "None"
}
},
"consigneeLocation": {
"companyName": "test2",
"locationName": "test2",
"note": "",
"contactMethods": {
"phoneNumber": "",
"extension": "",
"faxNumber": "",
"email": ""
},
"contactPerson": {
"firstName": "",
"lastName": ""
},
"address": {
"lineOne": "test 432",
"lineTwo": "",
"city": "Chicago",
"stateOrProvince": "IL",
"zipCode": "60606",
"country": "United States"
},
"vendorId": "",
"distributionCenterReferenceNumber": "",
"dock": {
"name": "Main Dock",
"note": "",
"confirmationNumber": "",
"openTime": "2023-02-27T08:00:00",
"accessTime": "2023-02-27T12:00:00",
"closeTime": "2023-02-27T17:00:00",
"isFirstComeFirstServe": false,
"limitedAccessType": "None"
}
},
"billTo": {
"name": "Banyan Web Services - Test Only - Prod Validation",
"contactMethods": {
"phoneNumber": "800-846-3400",
"extension": "",
"faxNumber": "",
"email": "Dev@banyantechnology.com"
},
"note": "",
"address": {
"lineOne": "151 Innovation Drive",
"lineTwo": "Suite 310",
"city": "Elyria",
"stateOrProvince": "OH",
"zipCode": "44035",
"country": "United States"
}
},
"packageInfo": {
"routeNumber": "",
"cod": 0,
"declaredLiability": 0
},
"shipmentServices": [
{
"serviceMode": "LTL",
"quantity": 2,
"packageType": "BALE",
"equipmentType": "DV",
"additionalWeight": 0,
"weightUnitOfMeasurement": "LBS",
"specialInstructions": "",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 0,
"width": 0,
"height": 0
}
}
],
"handlingUnits": [
{
"packageType": "",
"quantity": 0,
"products": [
{
"packageType": "BALE",
"quantity": 5,
"class": 250,
"weight": 100,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 20,
"width": 30,
"height": 40
},
"nmfc": null,
"description": "GLASS",
"sku": "",
"hazmatDetails": null,
"isHazmat": false
}
]
}
],
"loadAccessorials": [
{
"description": "Stackable",
"abbreviation": "LSTAC",
"value": null
}
],
"shipperAccessorials": [
{
"description": "Liftgate Pickup",
"abbreviation": "SLFTG",
"value": null
}
],
"consigneeAccessorials": [
{
"description": "Appointment Required",
"abbreviation": "CAPPT",
"value": null
},
{
"description": "Liftgate Delivery",
"abbreviation": "CLFTG",
"value": null
}
],
"referenceFields": [
{
"type": "FO Location ID",
"value": "XPOCCHNC",
"printOnBol": false,
"printOnShippingLabel": false
}
],
"insuranceInfo": null,
"stops": [],
"legs": [],
"exported": false,
"isMultiStop": false,
"isMultiLeg": false,
"dispatchResponse": null
}🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠429Too Many Requests
Modified at 2024-09-16 11:42:17