Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get carrier 🚚 quotes.

...

Type

Name

Description

apiKey

required

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

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