Attribute | Type | Description |
---|---|---|
WaitForRates | bool | Defaults to true. Returns when rating engine is complete.Set to false to return a response immediately. |
IsEzRate | bool | Defaults to false. Create the shipment as an EZ Rate with minimal data. |
loadAccessorials | array | For any accessorials only the description or the abbreviation is needed. See /StaticData/Accessorials endpoint for valid values. |
pullMarketRates | bool | Defaults to false. Pulls the market rates for this shipment. |
HandlingUnits | array | The handling units containing the products. For shipments that cannot utilize handling units, supply a single handling unit with 0 for quantity, and None for package type, and the shipment will not create handling units. |
VendorId | string | If vendor id is supplied, the system will look up the vendor location and use that data instead of what is in the request. If DistributionCenterReferenceNumber is supplied this can further filter data for vendors with multiple locations. |
Authorization: Bearer ********************
useDefaultBillTo
is false.abbreviation
or description
is required when supplying accessorials.abbreviation
or description
is required when supplying accessorials.abbreviation
or description
is required when supplying accessorials.{
"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": 2,
"packageType": "Pallets",
"equipmentType": "Van-Standard Trailer",
"weightUnitOfMeasurement": "LBS"
}
],
"handlingUnits": [
{
"packageType": "Pallets",
"quantity": 2,
"products": [
{
"packageType": "Boxes",
"quantity": 20,
"class": 200,
"weight": 400,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 42,
"width": 42,
"height": 56
},
"description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
}
]
}
]
}
}
curl --location --request PUT 'https://ws.integration.banyantechnology.com/api/v3/shipments/' \
--header 'Content-Type: application/json' \
--data-raw '{
"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": 2,
"packageType": "Pallets",
"equipmentType": "Van-Standard Trailer",
"weightUnitOfMeasurement": "LBS"
}
],
"handlingUnits": [
{
"packageType": "Pallets",
"quantity": 2,
"products": [
{
"packageType": "Boxes",
"quantity": 20,
"class": 200,
"weight": 400,
"weightUnitOfMeasurement": "LBS",
"dimensions": {
"unitOfMeasurement": "IN",
"length": 42,
"width": 42,
"height": 56
},
"description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
}
]
}
]
}
}'
LTL
Pallets
Van-standard trailer
LBS
Pallets
is the default value.