Get carrier 🚚 quotes.
...
Type | Name | Description |
|---|---|---|
apiKeyrequired | mykey | Your BBA API Key (HTTP Header) |
...
Type | Name | Description | Schema |
|---|---|---|---|
Body | quotePayload optional | Quote request payload | QuotePayload |
Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | <QuoteProjection> array |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
...
Name | Description | Schema |
|---|---|---|
accompanied Delivery optional | ${swagger.model.quote_payload.accompanied_delivery} Example : false | boolean |
allRegions optional | Indicate quote payload is all region Example : false | boolean |
carrierProfile Id optional | string | |
channel optional | Quote payload channel | string |
clientPresent optional | ${swagger.model.quote_payload.client_present} Example : false | boolean |
dangerousGoods optional | Quote payload dangerous goods Example : false | boolean |
destination optional | Quote payload destination location | Location |
giftWrapping optional | Indicate quote payload is gift wrapping Example : false | boolean |
items optional | < Item > array | |
packages optional | Quote payload packages | < Package > array |
pickupDetails optional | Indicate quote payload is pickup date | PickupDetails |
poBox optional | Quote payload PO BOX Example : false | boolean |
source optional | Quote payload source location | Location |
tailGate optional | Indicate quote payload is tail gate Example : false | boolean |
trolleyRequired optional | ${swagger.model.quote_payload.trolley_required} Example : false | boolean |
...
Name | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |
breakBulkDetails optional | Quote break bulk details | BreakBulkDetails |
carrierBooking Options optional | ${swagger.model.quote.carrier_options} | < CarrierBookingOption > array |
carrierId optional | Quote carrier identifier | string |
carrierName optional | Quote carrier name | string |
carrierProfile Id optional | Quote carrier profile identifier | string |
carrierProfile Name optional | Quote carrier profile name | string |
currency optional | Quote currency | string |
eta optional | Quote ETA | string |
logo optional | Quote logo | string |
minPickupFee optional | ${swagger.model.quote.min_pickup_fee} | number |
operation optional | Quote operation | Operation |
original optional | Quote original | Original |
packages optional | Quote packages | < Package > array |
percentFuel optional | Quote percent fuel | number |
percentMargin optional | Quote percent margin | number |
pickupFeeEnabled optional | ${swagger.model.quote.pickup_fee_enabled} Example : false | boolean |
serviceID optional | Quote service identifier | string |
serviceName optional | Quote service name | string |
serviceProfile optional | Quote service profile | ServiceProfileProjection |
serviceProfileName optional | Quote service profile name | string |
tax optional | Quote tax | number |
timeRateDetail optional | Quote time based rate detail | TimeRateDetailProjection |
transitTimeEarliest optional | Quote transit time earliest | integer (int32) |
transitTimeLatest optional | Quote transit time latest | integer (int32) |
valueFuel optional | Quote value fuel | number |
valueMargin optional | Quote value margin | number |
Location
Name | Schema |
|---|---|
addressLine1 optional | string |
addressLine2 optional | string |
city optional | string |
country optional | string |
postcode optional | string |
...
Name | Schema |
|---|---|
contentWeight optional | number |
cubicWeight optional | number |
height optional | number |
index optional | integer (int32) |
items optional | < Items > array |
labelEndPage optional | integer (int32) |
labelStartPage optional | integer (int32) |
length optional | number |
measureUnit optional | enum (cm, in, m, ft, mm) |
packagingID optional | string |
quantity optional | integer (int32) |
type optional | string |
weight optional | number |
weightUnit optional | enum (grams, kilograms, ounces, pounds) |
width optional | number |
PickupDetails
Name | Schema |
|---|---|
asap optional | boolean |
pickupDate optional | string (date-time) |
pickupEarliestTime optional | string |
pickupLatestTime optional | string |
pickupTimeZone optional | string |
BreakBulkDetails
Name | Schema |
|---|---|
firstMile optional | BreakBulkStepSummary |
id optional | interger (int32) |
lastMile optional | BreakBulkStepSummary |
lineHaul optional | BreakBulkStepSummary |
name optional | string |
CarrierBookingOption
Name | Schema |
|---|---|
defaultValue optional | string |
listValues optional | < string > array |
name optional | string |
type optional | string |
Operation
Name | Schema |
|---|---|
carrierProfileId optional | string |
channel | string |
clickandCollect | string |
currency | string |
dangerousGoods | boolean |
displayPriceOverride | string |
displayRuleName | string |
fixValue | integer (int32) |
giftWrapping | boolean |
id | string |
maxHeight | number |
maxLength | number |
maxPrice | number |
maxWeight | number |
MaxWidth | number |
measureUnit | enum (cm, in, m, ft, mm) |
minHeight | |
minLength | |
minPrice | |
minWeight | |
minWidth | |
name | |
office | |
percentageValue | integer (int32) |
poBox | boolean |
priority | integer (int32) |
regions | < Regions > array |
serviceProfileID | string |
unattendedDelivery | boolean |
user | string |
weightUnit | enum (grams, kilograms, ounces, pounds) |
Original
Name | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |
ServiceProfileProjection
Name | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |
...
TimeRateDetailProjection
Name | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |
...