Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 35 Next »

Get carrier 🚚 quotes.

Resource URL

https://api.bbamastro.com/carrier/quote 🔗

Header Request

Field

Data Type

Description

Authorization

String

Bearer Access token

Request Fields

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 purchase, gift, sale, sample, return,repair, personal_Effects

taxStatus

String

No

Tax status. Available values are private, company.

Request Fields Sample

{
    "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"
    }
}

Responses

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

[{
	"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
}]

Please refer to the Additional Reference section for more information on BBA Integration API objects.

  • No labels