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 |
...
Definitions
...
mykey
Type: apiKey
Name: Authorization
...
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 |
Location
Name | Schema |
|---|---|
addressLine1 optional | string |
addressLine2 optional | string |
city optional | string |
country optional | string |
postcode optional | string |
Item
Name | Schema |
|---|---|
categories optional | < string > array |
code optional | string |
country optional | string |
currency optional | string |
description optional | string |
height optional | number |
id optional | string |
itemType optional | string |
length optional | number |
manufacturer optional | string |
measureUnit optional | enum (cm, in, m, ft, mm) |
name optional | string |
quantity optional | integer (int32) |
remoteID optional | string |
returnredQuantity optional | integer (int32) |
sku optional | string |
taxes optional | string |
value optional | number |
weight optional | number |
weightUnit optional | enum (grams, kiograms, ounces, pounds) |
width optional | number |
Package
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 | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |
CarrierBookingOption
Name | Description | Schema |
|---|---|---|
amount optional | Quote amount | number |