Get carrier 🚚 quotes.
Resource URL
https://api.bbamastro.com.au/carrier/quote🔗
Headers
Type | Name | Description |
|---|---|---|
apiKeyrequired | mykey | Your BBA API Key (HTTP Header) |
Parameters
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
In: HEADER
QuotePayLoad
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 |
QuoteProjection
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 |
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 | 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 optional | string |
clickandCollect optional | string |
currency optional | string |
dangerousGoods optional | boolean |
displayPriceOverride optional | string |
displayRuleName optional | string |
fixValue optional | integer (int32) |
giftWrapping optional | boolean |
id optional | string |
maxHeight optional | number |
maxLength optional | number |
maxPrice optional | number |
maxWeight optional | number |
MaxWidth optional | number |
measureUnit optional | enum (cm, in, m, ft, mm) |
minHeight optional | number |
minLength optional | number |
minPrice optional | number |
minWeight optional | number |
minWidth optional | number |
name optional | string |
office optional | string |
percentageValue optional | integer (int32) |
poBox optional | boolean |
priority optional | integer (int32) |
regions optional | < Regions > array |
serviceProfileID optional | string |
unattendedDelivery optional | boolean |
user optional | string |
weightUnit optional | enum (grams, kilograms, ounces, pounds) |
Original
Name | Description | Schema |
|---|---|---|
amount optional | Quote original amount | number |
currency optional | Quote original currency | string |
rate optional | Quote original rate | number |
ServiceProfileProjection
Name | Description | Schema |
|---|---|---|
active optional | Service profile activation status Example : false | boolean |
bbaProfileId optional | Associated BBA profile identifier | integer (int64) |
carrierAccountCode optional | Service profile carrier account code | string |
carrierProfile optional | Service profile carrier profile | CarrierProfileProjection |
currency optional | Service profile currency | string |
detailHidden optional | Service profile detail hidden Example : false | boolean |
driverDirectEnabled optional | boolean | |
fuelLevy optional | Service profile fuel levy | FuelLevyWrapperProjection |
id optional | Service profile identifier | string |
marginEnabled optional | boolean | |
name optional | Service profile name | string |
networkEffect optional | Service profile network effect | NetworkEffect |
owned optional | boolean | |
profileSettings optional | Service profile settings | < ProfileSettings > array |
readOnly optional | Boolean | |
received optional | boolean | |
service optional | Service profile service | ServiceInformationProjection |
serviceName optional | Service name that is displayed in label | string |
TimeRateDetailProjection
Name | Description | Schema |
|---|---|---|
hourlyRate optional | Time based rate hourly rate | number |
maxAmount optional | Time based rate maximum amount | number |
maxDuration optional | Time based rate maximum duration | number |
maxTax optional | Time based rate maximum tax | number |
maxVariance optional | Time based rate maximum variance | number |
minAmount optional | Time based rate minimum amount | number |
minDuration optional | Time based rate minimum duration | number |
minTax optional | Time based rate minimum tax | number |
minVariance optional | Time based rate minimum variance | number |
Items
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) |
remodeId optional | string |
returnedQuantity optional | integer (int32) |
sku optional | string |
taxes optional | string |
value optional | number |
weight optional | number |
weightUnit optional | enum (grams, kilograms, ounces, pounds |
width optional | number |
BreakBulkStepSummary
Name | Schema |
|---|---|
carrierProfileId optional | string |
consignmentId optional | string |
cost optional | number |
id optional | integer (int64) |
manifestNumber optional | string |
name optional | string |
serviceProfileId optional | string |
status optional | string |
Regions
Name | Schema |
|---|---|
country optional | string |
postcodeRangeEnd optional | string |
postcodeRangeStart optional | string |
CarrierProfileProjection
Name | Description | Schema |
|---|---|---|
active optional | Carrier profile activation status Example : false | boolean |
address1 optional | Carrier profile address line 1 | string |
address2 optional | Carrier profile address line 2 | string |
carrier optional | ${swagger.model.carrier_profile.carrier} | CarrierPartialInformation |
driverDirectEnabled optional | boolean | |
optional | Carrier profile email | string |
id optional | Carrier profile identifier | string |
logoUrl optional | ${swagger.model.carrier_profile.url} | string |
marginEnabled optional | boolean | |
name optional | Carrier profile name | string |
networkEffect optional | Carrier profile network effect | NetworkEffect |
owned optional | boolean | |
phone1 optional | Carrier profile primary phone | string |
phone2 optional | Carrier profile secondary phone | string |
profileSettings optional | Carrier profile profile settings | < ProfileSettings > array |
readOnly optional | boolean | |
received optional | boolean | |
settings optional | Carrier profile settings | < Settings > array |
website optional | Carrier profile website | string |
FuelLevyWrapperProjection
Name | Description | Schema |
|---|---|---|
details optional | Fuel levy details | FuelLevySimpleProjections |
enabled optional | Fuel levy activation status Example : false | boolean |
FuelLevySimpleProjection
Name | Description | Schema |
|---|---|---|
active optional | Fuel levy activation status Example : false | boolean |
currency optional | Fuel levy currency | string |
fixed optional | Fuel levy fixed amount | number |
id optional | Fuel levy identifier | string |
name optional | Fuel levy name | string |
percentage optional | Fuel levy percentage | number |
NetworkEffect
Name | Description | Schema |
|---|---|---|
activated optional | Activate network effect Example : false | boolean |
enabled optional | Enable network effect Example : false | boolean |
resellers optional | Reseller identifiers | < string> array |
ProfileSettings
Name | Description | Schema |
|---|---|---|
description optional | Profile setting description | string |
name optional | Profile setting name | string |
password optional | Profile setting password | string |
value optional | Profile setting value | string |
ServiceInformationProjection
Name | Description | Schema |
|---|---|---|
active optional | Service activation status Example : false | boolean |
currency optional | Service currency | string |
fuelLevy optional | Service fuel levy | FuelLevy |
id optional | Service identifier | string |
name optional | ${swagger.model.service_information.name} | string |
rateCategories optional | ${swagger.model.service_information.categories} | < RateCategory > array |
settings optional | Service settings | < Settings > array |
CarrierPartialInformation
Name | Description | Schema |
|---|---|---|
addressValidationExternal optional | ${swagger.model.carrier_partial_information.external_address_validation} Example : false | boolean |
id optional | Carrier identifier | string |
logoUrl optional | Carrier logo URL | string |
name optional | Carrier name | string |
networkEffect optional | Carrier Network Effect | NetworkEffect |
productSource optional | product Source | string |
quoteGenerat edByCarrierApi optional | ${swagger.model.carrier_partial_information.external_quo te} Example : false | boolean |
services optional | Carrier services | < ServicePartialInformation > array |
settings optional | Carrier settings | < Settings > array |
shipmentGeneratedByCarrierApi optional | ${swagger.model.carrier_partial_information.external_shipment} Example : false | boolean |
ServicePartialInformation
Name | Schema |
|---|---|
detailHidden optional | boolean |
fuelLevy optional | FuelLevy |
id optional | string |
name optional | string |
rateCategories optional | < RateCategory > array |
settings optional | < Settings >array |
Settings
Name | Schema |
|---|---|
description optional | string |
mandatory optional | boolean |
name optional | string |
option optional | Option |
prerequisiteSettings optional | < string > array |
value optional | string |
valueList optional | < string > array |
valueType optional | string |
FuelLevy
Name | Schema |
|---|---|
active optional | boolean |
CarrierId optional | string |
fixed optional | number |
id optional | string |
name optional | string |
percentage optional | number |
serviceId optional | string |
RateCategory
Name | Schema |
|---|---|
categories optional | < string > array |
name optional | string |
value optional | enum (flatrate, byweight, bypallet, bydistance, bytime) |
Option
Name | Schema |
|---|---|
vfalse optional | string |
vtrue optional | string |