Get carrier 🚚 quotes.
Resource URL
https://api.bbamastro.com.au/carrier/quote 🔗
Parameters
Type | Name | Description | Schema |
|---|---|---|---|
Body | quotePayload optional | Quote request payload |
Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | <QuoteProjection> array |
201 | Created | No content |
401 | Unauthorized | No content |
403 | Forbidden | No content |
404 | Not Found | No content |
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 |
Please refer to the Additional Reference section for more information on BBA Integration API objects.