apiKey

required

mykey

Your BBA API Key (HTTP Header)

Body

quotePayload

optional

Quote request payload

QuotePayload

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

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

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

firstMile

optional

BreakBulkStepSummary

id

optional

interger (int32)

lastMile

optional

BreakBulkStepSummary

lineHaul

optional

BreakBulkStepSummary

name

optional

string

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)

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

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

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

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