apiKey

required

mykey

Your BBA API Key (HTTP Header)

200

OK

<QuoteProjection> array

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

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.accompaniedclient_deliverypresent} 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

booleanallRegions

items

optional

< Item > array

packages

optional

Quote payload packages

< Package > array

pickupDetails

optional

Indicate quote payload is all regionpickup date

PickupDetails

poBox

optional

Quote payload PO BOX

Example : false

boolean

carrierProfile Idsource

optional

Quote payload source location

stringLocation

channel tailGate

optional

Quote payload channel

string

clientPresent Indicate quote payload is tail gate

Example : false

boolean

trolleyRequired

optional

${swagger.model.quote_payload.clienttrolley_presentrequired} Example : false

booleandangerousGoods

amount

optional

Quote payload dangerous goods

Example : false

boolean

destination

amount

number

breakBulkDetails

optional

Quote payload destination location

Location

giftWrappingbreak bulk details

BreakBulkDetails

carrierBooking Options

optional

Indicate quote payload is gift wrapping Example : false

boolean

items

optional

< Item > array

packages${swagger.model.quote.carrier_options}

< CarrierBookingOption > array

carrierId

optional

Quote carrier identifier

string

carrierName

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

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_payload.trolleypickup_required} Example : false

boolean

amountfee}

number

operation

optional

Quote operation

Operation

original

optional

Quote original

Original

packages

optional

Quote packages

< Package > array

percentFuel

optional

Quote amountpercent fuel

number

breakBulkDetailspercentMargin

optional

Quote break bulk details

BreakBulkDetails

carrierBooking Optionspercent margin

number

pickupFeeEnabled

optional

${swagger.model.quote.carrierpickup_fee_optionsenabled}

< CarrierBookingOption > array

carrierId

optional

Quote carrier identifier

string

carrierName

optional

Quote carrier name

string

carrierProfile IdExample : false

boolean

serviceID

optional

Quote carrier profile service identifier

string

carrierProfile NameserviceName

optional

Quote carrier profile service name

string

currencyserviceProfile

optional

Quote currency service profile

stringServiceProfileProjection

etaserviceProfileName

optional

Quote ETAservice profile name

string

logotax

optional

Quote logo

string

minPickupFee

optional

${swagger.model.quote.min_pickup_fee}

number

operationtax

number

timeRateDetail

optional

Quote operation

Operation

originaltime based rate detail

TimeRateDetailProjection

transitTimeEarliest

optional

Quote original

Original

packagestransit time earliest

integer (int32)

transitTimeLatest

optional

Quote packages

< Package > array

percentFueltransit time latest

integer (int32)

valueFuel

optional

Quote percent value fuel

number

percentMarginvalueMargin

optional

Quote percent value margin

numberpickupFeeEnabled

addressLine1

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

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

string

addressLine2

optional

string

city

optional

string

country

optional

string

postcode

optional

string

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

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, kiogramskilograms, ounces, pounds)

width

optional

number

contentWeightasap

optional

numberboolean

cubicWeightpickupDate

optional

number

heightstring (date-time)

pickupEarliestTime

optional

numberstring

indexpickupLatestTime

optional

integer (int32)

itemsstring

pickupTimeZone

optional

< Items > array

labelEndPage

string

firstMile

optional

integer (int32)

labelStartPageBreakBulkStepSummary

id

optional

integer interger (int32)

lengthlastMile

optional

numberBreakBulkStepSummary

measureUnitlineHaul

optional

enum (cm, in, m, ft, mm)

packagingIDBreakBulkStepSummary

name

optional

stringquantity

integer (int32)

defaultValue

optional

string

weightlistValues

optional

number

weightUnit< string > array

name

optional

enum (grams, kilograms, ounces, pounds)

widthstring

type

optional

numberstring

asapcarrierProfileId

optional

booleanstring

pickupDatechannel

optional

string (date-time)

pickupEarliestTimeclickandCollect

optional

string

pickupLatestTimecurrency

optional

string

pickupTimeZonedangerousGoods

optional

stringboolean

displayPriceOverride

optional

string

firstMiledisplayRuleName

optional

BreakBulkStepSummarystring

idfixValue

optional

interger integer (int32)

lastMilegiftWrapping

optional

BreakBulkStepSummaryboolean

lineHaulid

optional

BreakBulkStepSummarystring

namemaxHeight

optional

string

defaultValue

number

maxLength

optional

stringnumber

listValuesmaxPrice

optional

< string > array

namenumber

maxWeight

optional

stringnumber

typeMaxWidth

optional

stringnumber

measureUnit

carrierProfileIdoptional

enum (cm, in, m, ft, mm)

minHeight

optional

stringnumber

channelminLength

optional

stringnumber

clickandCollectminPrice

optional

stringnumber

currencyminWeight

optional

stringnumber

dangerousGoodsminWidth

optional

booleannumber

displayPriceOverridename

optional

string

displayRuleNameoffice

optional

string

fixValuepercentageValue

optional

integer (int32)

giftWrappingpoBox

optional

boolean

id

optional

string

maxHeight

priority

optional

number

maxLengthinteger (int32)

regions

optional

number

maxPrice< Regions > array

serviceProfileID

optional

numberstring

maxWeightunattendedDelivery

optional

numberboolean

MaxWidthuser

optional

numberstring

measureUnitweightUnit

optional

enum (cmgrams, inkilograms, mounces, ft, mmpounds)minHeight

minLengthamount

optional

Quote original amount

number

minPricecurrency

optional

number

minWeightQuote original currency

string

rate

optional

Quote original rate

number

nameactive

optional

string

office

optional

string

percentageValue

optionalService profile activation status

Example : false

boolean

bbaProfileId

optional

Associated BBA profile identifier

integer (int32int64)

poBoxcarrierAccountCode

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)

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

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

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

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

country

optional

string

postcodeRangeEnd

optional

string

postcodeRangeStart

optional

string

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

email

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

details

optional

Fuel levy details

FuelLevySimpleProjections

enabled

optional

Fuel levy activation status

Example : false

boolean

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

activated

optional

Activate network effect

Example : false

boolean

enabled

optional

Enable network effect

Example : false

boolean

resellers

optional

Reseller identifiers

< string> array

description

optional

Profile setting description

string

name

optional

Profile setting name

string

password

optional

Profile setting password

string

value

optional

Profile setting value

string

active

optional

Fuel levy Service activation status

Example : false

boolean

currency

optional

Fuel levy Service currency

string

fixedfuelLevy

optional

Fuel Service fuel levy fixed amount

numberFuelLevy

id

optional

Fuel levy Service identifier

string

name

optional

Fuel levy name

string

percentage

optional

Fuel levy percentage

number

${swagger.model.service_information.name}

string

rateCategories

optional

${swagger.model.service_information.categories}

< RateCategory > array

settings

optional

Service settings

< Settings > array

activatedaddressValidationExternal

optionalActivate network effect

${swagger.model.carrier_partial_information.external_address_validation}

Example : false

boolean

enabledid

optional

Enable network effect

Example : false

boolean

resellersCarrier identifier

string

logoUrl

optional

Reseller identifiers

< string> array

active

optional

Service activation statusCarrier 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

booleancurrency

detailHidden

optional

Service currency

stringboolean

fuelLevy

optionalService fuel levy

FuelLevy

id

optionalService identifier

string

name

optional

${swagger.model.service_information.name}

string

rateCategories

optional

${swagger.model.service_information.categories}

< RateCategory > array

settings

optionalService settings

< Settings > array

active

optional

Service activation status

Example : false

boolean>array