- Version 3
- Authentication
- Shipments
- Creating
- Updating
- Retrieving
- Booking
- Canceling
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Recommended Workflow
- Additional Offerings
- Changelog
- Exports and Webhooks
Cancels a shipment.
POST
/api/v3/shipments/{Id}/Cancel
Shipments
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
Id
integer
required
Request 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//Cancel'
Responses
🟢200Success
application/json
Body
Class ShipmentDto.
loadId
integer <int32>
required
status
enum<string>
required
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto)
required
clientId
integer <int32>
optional
clientName
string | null
optional
clientRefNumber
string | null
optional
awardedQuotePricing
object (AwardedQuotePricingDto)
optional
raw
number <double>
optional
carrier
number <double>
optional
customer
number <double>
optional
quotes
array[object (QuoteDto) {21}] | null
optional
quoteId
integer <int32>
optional
carrierName
string
optional
carrierId
integer <int32>
optional
scac
string
optional
thirdPartyName
string | null
optional
thirdPartyScac
string | null
optional
serviceId
string | null
optional
rawPrice
object (QuotePriceDto)
optional
carrierPrice
object (QuotePriceDto)
optional
customerPrice
object (QuotePriceDto)
optional
transitTime
integer <int32>
optional
quoteNumber
string | null
optional
carrierPerson
string | null
optional
carrierNote
string | null
optional
dateStamp
string <date-time>
optional
interline
boolean
optional
accepted
boolean
optional
currencyType
optional
service
string | null
optional
insuranceDetails
optional
accountNumber
string | null
optional
notes
array[object (NoteDto) {4}] | null
optional
description
string | null
optional
noteTypeId
integer <int32>
optional
userName
string | null
optional
dateStamp
string <date-time>
optional
manifestId
string | null
optional
bolNumber
string | null
optional
customerPo
string | null
optional
invoiceId
string | null
optional
billingId
string | null
optional
incoTermId
integer <int32>
optional
pickupNumber
string | null
optional
shipperConfirmationNumber
string | null
optional
consigneeConfirmationNumber
string | null
optional
estimatedPickup
string <date-time> | null
optional
actualPickup
string <date-time> | null
optional
estimatedDelivery
string <date-time> | null
optional
actualDelivery
string <date-time> | null
optional
createdDate
string <date-time> | null
optional
shipType
enum<string>
required
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string>
required
Allowed values:
CollectPrepaid
exportReason
string | null
optional
internationalTerm
string | null
optional
shipperLocation
object (LocationDto)
optional
companyName
string | null
optional
locationName
string | null
optional
einNumber
string | null
optional
note
string | null
optional
contactMethods
object (ContactMethodsDto)
optional
contactPerson
object (ContactPersonDto)
optional
address
object (AddressDto)
optional
vendorId
string | null
optional
The system will look up the vendor location and use that data instead of what is in the request.
distributionCenterReferenceNumber
string | null
optional
dock
object (DockDetailsDto) | null
optional
consigneeLocation
object (LocationDto)
optional
billTo
object (BillToDto)
optional
name
string | null
optional
<= 50 characters
contactMethods
object (ContactMethodsDto)
optional
note
string | null
optional
address
object (AddressDto)
optional
packageInfo
object (PackageInfoDto)
optional
routeNumber
string | null
optional
cod
number <double>
optional
>= 0
declaredLiability
number <double>
optional
>= 0
shipmentServices
array[object (ShipmentServiceDto) {8}] | null
optional
serviceMode
enum<string>
required
LTL
Allowed values:
Standard Parcel ServiceLTLVolumeAir CargoOcean FreightDrive AwayIntermodalOcean LCLAir InternationalInternational ExpeditedDomestic ExpeditedFull TruckloadBulkRailDrayageLocal CarrierExpeditedScheduledPartial TruckloadGFPSpot QuoteFinal Mile
quantity
integer <int32>
optional
> 0
packageType
enum<string>
required
Pallets
Allowed values:
ACCATTBAGSBALEBRRLBASKBINBOXSBUCKBHDSBNDLCARBCRTNCASECHSTCOILCTNCRTSCYLSDRUMEACHENVLPFEETFIRKGYLDKEGSLOOSOCTAPACKPAILPLTSPIECPCJCRACKREELROLLSKIDSLIPSPRSTOTETRLRTRYSTRCKTRNKTUBETUBSUNITSUNPKVHCL
equipmentType
enum<string>
required
Van-standard trailer
Allowed values:
16ft Straight Truck18ft Straight Truck24ft Straight Truck24ft Straight Truck w/ lift gate26ft Straight Truck26ft Straight Truck w/ lift gate4x453ft - Van TrailerAir CargoALLBox truckBox truck w/ lift gateBulk TruckCarCar-CarrierCargo VanContainer - 20ftContainer - 40ftContainer - 40HQContainer - 45ftContainer - 53ftDouble DropDoublesDump TruckDumper - 20 yardDumper - 40 yardDumper - 60 yardDumper - 80 yardFlat BedFrozenFull Size VanGooseneckHopper BottomLow BoyMaxi TrailerMinivanOtherParcel TruckPickup TruckRail Car - 20ftRail Car - 40ftRail Car - 53ftRefrigeratedRemovable GooseneckRoll-off TruckSprinter VanStep DeckTankerTractorTractor TrailerTrailer – 24ftTrailer – 26ftTrailer – 28ftTrailer – 48ftTrailer – 53ftTri-Axle VanTruckTruck w/ lift gateVanVan w/ lift gateVan-standard trailerWalking FloorWinch Truck
additionalWeight
number <double>
optional
>= 0
weightUnitOfMeasurement
optional
LBS
specialInstructions
string | null
optional
dimensions
object (DimensionsDto)
optional
handlingUnits
array[object (HandlingUnitDto) {9}] | null
optional
packageType
enum<string>
required
Pallets
is the default value.Allowed values:
ACCATTBAGSBALEBRRLBASKBINBOXSBUCKBHDSBNDLCARBCRTNCASECHSTCOILCTNCRTSCYLSDRUMEACHENVLPFEETFIRKGYLDKEGSLOOSOCTAPACKPAILPLTSPIECPCJCRACKREELROLLSKIDSLIPSPRSTOTETRLRTRYSTRCKTRNKTUBETUBSUNITSUNPKVHCL
quantity
integer <int32>
optional
length
number <double>
optional
width
number <double>
optional
height
number <double>
optional
additionalWeight
number <double>
optional
unitOfMeasurement
enum<string>
optional
Allowed values:
CMFTIN
weightUnitOfMeasurement
enum<string>
optional
Allowed values:
LBSKG
products
array[object (ProductDto) {13}]
required
>= 1 items
loadAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
description
enum<string>
optional
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string>
optional
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string | null
optional
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
description
enum<string>
optional
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string>
optional
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string | null
optional
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
description
enum<string>
optional
Allowed values:
Age RestrictedLight AssemblyBulkheadBindersCustoms In-BondBlanket Service - ChilledBlanket Service - FrozenBlind ShipmentProtect from FreezingChains RequiredExpeditedFood Grade ProductsGuaranteedHoliday DeliveryHoliday PickupOver DimensionUnattendedSingle ShipmentStackableStakes RequiredMust Be StrappedTanker Endorsed Driver RequiredTime DefiniteTurnkeyTSAVolume ShipmentWeight DeterminationNo SignatureProactive ResponseRestricted DeliveryReturn ReceiptRoom of ChoiceSaturday DeliveryShipper ReleaseShipment HoldSignature Required2nd ManSpecial HandlingThresholdWhite Glove
abbreviation
enum<string>
optional
Allowed values:
AGE ASSEMBLKHDLBINDLBONDLBSCHLBSFZLBSHPLBSRVLCHAILEXPDLFGP LGUARLHDELLHPCKLODIMLPSLALSINGLSTACLSTAKLSTRALTEDRLTIMELTKEYLTSA LVSHPLWDETNOSG PRORERESDERETREROCH SATDESHIRESHLD SIGRQSMAN SPEHATHRS WGLV
value
string | null
optional
referenceFields
array[object (ReferenceFieldDto) {4}] | null
optional
type
string
required
>= 1 characters<= 250 characters
value
string
required
>= 1 characters<= 250 characters
printOnBol
boolean
optional
printOnShippingLabel
boolean
optional
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto)
optional
vendor
string | null
optional
commodityType
string | null
optional
commodityCondition
string | null
optional
insuredValue
number <double> | null
optional
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
loadId
integer <int32>
required
status
enum<string>
required
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto)
required
awardedQuotePricing
object (AwardedQuotePricingDto)
optional
quotes
array[object (QuoteDto) {21}] | null
optional
notes
array[object (NoteDto) {4}] | null
optional
manifestId
string | null
optional
bolNumber
string | null
optional
customerPo
string | null
optional
invoiceId
string | null
optional
billingId
string | null
optional
incoTermId
integer <int32>
optional
pickupNumber
string | null
optional
shipperConfirmationNumber
string | null
optional
consigneeConfirmationNumber
string | null
optional
estimatedPickup
string <date-time> | null
optional
actualPickup
string <date-time> | null
optional
estimatedDelivery
string <date-time> | null
optional
actualDelivery
string <date-time> | null
optional
createdDate
string <date-time> | null
optional
shipType
enum<string>
required
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string>
required
Allowed values:
CollectPrepaid
exportReason
string | null
optional
internationalTerm
string | null
optional
shipperLocation
object (LocationDto)
optional
consigneeLocation
object (LocationDto)
optional
billTo
object (BillToDto)
optional
packageInfo
object (PackageInfoDto)
optional
shipmentServices
array[object (ShipmentServiceDto) {8}] | null
optional
handlingUnits
array[object (HandlingUnitDto) {9}] | null
optional
loadAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
referenceFields
array[object (ReferenceFieldDto) {4}] | null
optional
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto)
optional
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
exported
boolean
optional
isMultiStop
boolean
read-onlyoptional
isMultiLeg
boolean
read-onlyoptional
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto)
optional
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto)
optional
marketRates
array[object (BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto) {8}] | null
optional
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
loadId
integer <int32>
required
status
enum<string>
required
Allowed values:
PendingOpenQuotedBookedDispatchedIn TransitDeliveredCancelledDispatch RequestedDispatch FailedQuote Approval PendingApproval Denied
client
object (ClientDto)
required
awardedQuotePricing
object (AwardedQuotePricingDto)
optional
quotes
array[object (QuoteDto) {21}] | null
optional
notes
array[object (NoteDto) {4}] | null
optional
manifestId
string | null
optional
bolNumber
string | null
optional
customerPo
string | null
optional
invoiceId
string | null
optional
billingId
string | null
optional
incoTermId
integer <int32>
optional
pickupNumber
string | null
optional
shipperConfirmationNumber
string | null
optional
consigneeConfirmationNumber
string | null
optional
estimatedPickup
string <date-time> | null
optional
actualPickup
string <date-time> | null
optional
estimatedDelivery
string <date-time> | null
optional
actualDelivery
string <date-time> | null
optional
createdDate
string <date-time> | null
optional
shipType
enum<string>
required
Allowed values:
ShipperConsigneeThirdParty
payType
enum<string>
required
Allowed values:
CollectPrepaid
exportReason
string | null
optional
internationalTerm
string | null
optional
shipperLocation
object (LocationDto)
optional
consigneeLocation
object (LocationDto)
optional
billTo
object (BillToDto)
optional
packageInfo
object (PackageInfoDto)
optional
shipmentServices
array[object (ShipmentServiceDto) {8}] | null
optional
handlingUnits
array[object (HandlingUnitDto) {9}] | null
optional
loadAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
shipperAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
consigneeAccessorials
array[object (ShipmentAccessorialDto) {3}] | null
optional
referenceFields
array[object (ReferenceFieldDto) {4}] | null
optional
insuranceInfo
object (BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto)
optional
stops
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
legs
array[object (BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto) {43}] | null
optional
exported
boolean
optional
isMultiStop
boolean
read-onlyoptional
isMultiLeg
boolean
read-onlyoptional
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto)
optional
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto)
optional
marketRates
array[object (BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto) {8}] | null
optional
exported
boolean
optional
isMultiStop
boolean
read-onlyoptional
isMultiLeg
boolean
read-onlyoptional
dispatchResponse
object (BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto)
optional
loadId
integer <int32>
optional
success
boolean
optional
pickupNumber
string | null
optional
carrierName
string | null
optional
quoteNumber
string | null
optional
estimatedDeliveryDate
string <date-time> | null
optional
proNumber
string | null
optional
userMessage
string | null
optional
bolLink
string | null
optional
warnings
array[string] | null
optional
errors
array[string] | null
optional
carbonQuote
object (BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto)
optional
offsetAmount
number <double>
optional
offsetUnit
string