Get carrier 🚚 quotes.
Resource URL
...
Headers
...
Type
...
Name
...
Description
...
apiKey
required
...
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
...
Get carrier 🚚 quotes.
Resource URL
Cluster | URL |
|---|---|
Australia | |
US |
Header Request
Field | Data Type | Description |
|---|---|---|
Authorization | String | Bearer Access token |
Request Payload
Field | Data Type | Required | Description | |
|---|---|---|---|---|
channel | String | No | Request channel | |
source | Object | Yes | Source Address | |
officeId | String | No | Office identifier | |
addressLine1 | String | Yes | Source address line 1 | |
addressLine2 | String | No | Source address line 2 | |
country | String | Yes | Source country code | |
city | String | Yes | Source city name | |
postcode | String | Yes | Source postal code | |
destination | Object | Yes | Destination Address | |
addressLine1 | String | Yes | Destination address line 1 | |
addressLine2 | String | No | Destination address line 2 | |
country | String | Yes | Destination country code | |
city | String | Yes | Destination city name | |
postcode | String | Yes | Destination postal code | |
items | Object[] | Yes for international shipment | Items | |
hsCode | String | No | Item Harmonized System (HS) Code | |
quantity | Integer | Yes | Item quantity | |
value | Decimal | No | Item price | |
categories | String[] | No | Item categories | |
sku | String | No | Item SKU | |
weight | Decimal | Yes | Item weight | |
length | Decimal | Yes | Item length | |
width | Decimal | Yes | Item width | |
height | Decimal | Yes | Item height | |
name | String | No | Item name | |
measureUnit | String | No | Item measure unit. Available values are CM, IN, M, FT, MM. Default value will be used if the value is null. | |
weightUnit | String | No | Item weight unit. Available values are Grams, Kilograms, Ounces, Pounds. Default value will be used if the value is null. | |
currency | String | No | Item currency. Default value will be used if the value is null | |
packages | Object[] | yes | Packages | |
length | Decimal | Yes | Package length | |
width | Decimal | Yes | Package width | |
height | Decimal | Yes | Package height | |
weight | Decimal | Yes | Package weight | |
contentWeight | Decimal | Yes | Package content weight | |
measureUnit | String | No | Item measure unit. Available values are CM, IN, M, FT, MM. Default value will be used if the value is null. | |
weightUnit | String | No | Item weight unit. Available values are Grams, Kilograms, Ounces, Pounds. Default value will be used if the value is null. | |
quantity | Integer | Yes | Package quantity | |
pickupDetails | Object | Yes | Quote pickup details | |
asap | Boolean | Yes | Pickup ASAP | |
pickupDate | Date | Yes if asap is true | Pickup date. The format is “yyyy-MM-dd“. ex: “2022-09-27“ | |
pickupTimezone | String | Yes if asap is true | Pickup timezone. ex: “+10:00“ | |
pickupEarliestTime | String | yes if asap is true | Pickup earliest time. The format is “hh:mm“. ex: “10:00“ | |
poBox | Boolean | No | PO box. Default value is false | |
dangerousGoods | Boolean | No | Dangerous goods. Default value is false | |
giftWrapping | Boolean | No | Gift wrapping. Default value is false | |
unattendedDelivery | Boolean | No | Unattended delivery. Default value is false | |
tailGate | Boolean | No | Tail gate | |
residentialDelivery | Boolean | No | Residential delivery | |
residentialPickup | Boolean | No | Residential pickup | |
trolleyRequired | Boolean | No | Trolley required | |
clientPresent | Boolean | No | Client present | |
accompaniedDelivery | Boolean | No | Accompanied delivery | |
fragile | Boolean | No | Fragile | |
reasonForShipping | String | No | Reason for shipping. Available values are | |
taxStatus | String | No | Tax status. Available values are | |
Request Payload Sample
| Code Block | ||
|---|---|---|
| ||
{
"source": {
"addressLine1": "Highway Street",
"addressLine2": null,
"country": "AU",
"city": "South Melbourne",
"postcode": "3205"
},
"destination": {
"addressLine1": "58 Springfield Road",
"addressLine2": null,
"country": "GB",
"city": "Saint Albans",
"postcode": "AL1 1AG"
},
"packages": [
{
"measureUnit": "CM",
"weightUnit": "Kilograms",
"weight": 1,
"contentWeight": 1,
"quantity": "1",
"length": "1",
"width": "1",
"height": "1"
}
],
"pickupDetails": {
"asap": false,
"pickupDate": "2022-09-27",
"pickupTimezone": "+10:00",
"pickupEarliestTime": "10:00"
}
} |
Response statuses
HTTP Code | Description |
|---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Response Payload
Field | Data Type | Description | |
|---|---|---|---|
displayName | String | Quote name | |
carrierId | String | Carrier id | |
serviceId | String | Service id | |
carrierName | String | Carrier name | |
serviceName | String | Service name | |
carrierProfileId | String | Carrier profile id | |
carrierProfileName | String | Carrier profile name | |
serviceProfileId | String | Service profile id | |
serviceProfileName | String | Service profile name | |
logo | String | Carrier logo url | |
currency | String | Quote currency | |
eta | String | Quote eta | |
transitTimeEarliest | String | Transit time earliest | |
transitTimeLatest | String | Transit time latest | |
amount | Decimal | Quote amount | |
packages | Object[] | ||
length | Decimal | Package length | |
width | Decimal | Package width | |
height | Decimal | Package height | |
weight | Decimal | Package weight | |
contentWeight | Decimal | Package content weight | |
quantity | Integer | Package quantity | |
measureUnit | String | Package measure unit. Available values are CM, IN, M, FT, MM. | |
weightUnit | String | Package weight unit. Available values are Grams, Kilograms, Ounces, Pounds. | |
fieldConstraints | Object[] | Field validation constraints | |
name | String | Field name | |
maxLength | Integer | Field max length | |
carrierBookingOptions | Object[] | Carrier booking options | |
name | String | Carrier booking options name | |
type | String | Carrier booking options data type | |
defaultValue | String | Carrier booking options default value | |
group | String | Carrier booking options group | |
listValues | String[] | Carrier booking options available values | |
mandatory | boolean | Indicate if the booking option is mandatory or no | |
Response Payload Sample
| Code Block |
|---|
[{
"currency": "AUD",
"logo": "https://storage.googleapis.com/bba-img/dhl-logo.png",
"carrierId": "dhl",
"serviceId": "P",
"carrierName": "DHL",
"serviceName": null,
"carrierProfileId": "62e95e0710d1d100019b1d87",
"serviceProfileId": "62e95e0710d1d100019b1d88",
"transitTimeEarliest": 72,
"transitTimeLatest": 72,
"amount": 56.47,
"tax": 0,
"carrierBookingOptions": [],
"directCarrierBillsServiceEnabled": false,
"minPickupFee": 0,
"pickupFeeEnabled": false,
"fieldConstraints": [{
"name": "companyName",
"maxLength": 60
},
{
"name": "contactName",
"maxLength": 45
},
{
"name": "address1",
"maxLength": 30
},
{
"name": "address2",
"maxLength": 30
},
{
"name": "phone",
"maxLength": 25
},
{
"name": "customerReference",
"maxLength": 35
}
],
"serviceProfileName": "S2A - New DHL Net 2 (CP share) - Express Worldwide NonDoc",
"eta": "3 - 3 day(s)",
"carrierProfileName": "S2A - New DHL Net 2 (CP share)",
"packages": [{
"packagingId": null,
"items": null,
"length": 1.00,
"width": 1.00,
"height": 1.00,
"weight": 1.00,
"contentWeight": 1.00,
"cubicWeight": null,
"cubicMeter": null,
"totalDeadWeight": null,
"totalCubicWeight": null,
"quantity": 1,
"measureUnit": "cm",
"weightUnit": "kilograms",
"type": null,
"index": 0,
"labelStartPage": 0,
"labelEndPage": 0,
"packageId": null,
"customerReference": null,
"externalId": null,
"createdDate": null,
"ssccList": null,
"barcodeText": null,
"logisticsUnitType": null,
"name": null,
"packageType": null,
"atlNumber": null
}],
"displayName": null
}] |
| Info |
|---|
Please refer to the Additional Reference section for more information on BBA Integration API objects. |