This endpoint is used to create new shipment by passing JSON request payload.

Resource URL

...

Parameters

...

Type

...

Name

...

Description

...

Schema

...

Default

...

Header

...

domain

optional

...

Domain where the request is coming from

...

string

...

"http://dashboard.bbalogistics.com.au"

...

Query

...

generateCarrierDetails

optional

...

Generate carrier details

...

string

...

Body

...

shipment

optional

...

Shipment request parameter

...

Shipment

Responses

...

HTTP Code

...

Description

...

Schema

...

201

...

Created

...

ShipmentPublicProjection

...

401

...

Unauthorized

...

No Content

...

403

...

Forbidden

...

No Content

...

404

...

Not Found

...

No Content

Definitions

mykey

Type: apiKey

Name: Authorization

In: HEADER

Shipment

...

Name

...

Description

...

Schema

...

accompanied Delivery

optional

...

Indicate if the delivery will be accompanied by another person

Example : false

...

boolean

...

active

optional

...

Shipment activation status

Example : false

...

boolean

...

amount

optional

...

Shipment amount

...

number

...

appliedShippingRule

optional

...

Shipping rules that are applied to shipment

...

ShippingRule

...

bbaReferenceNumber

optional

...

Shipment BBA Reference number

...

string

...

billed

optional

...

boolean

...

bookingDate

optional

...

The date when shipment booked

...

string (date-time)

...

bookingStatus

optional

...

Shipment booking status

...

enum (new, unprocessed, inprogress, pending, processed)

...

breakBulkDetails

optional

...

${swagger.model.shipment.break_bulk_details}

...

BreakBulkDetails

...

carrierBookingOptions

optional

...

${swagger.model.shipment.carrier_booking_options}

...

< string, string > map

...

carrierID

optional

...

Shipment carrier identifier

...

string

...

carrierOderId

optional

...

${swagger.model.shipment.carrierOrderId}

...

string

...

carrierProfileId

optional

...

Shipment carrier profile identifier

...

string

carrierServiceRateId

This endpoint is used to create new shipment by passing JSON request payload.

Resource URL

Cluster	URL
Australia	https://api.bbamastro.com/shipment
US	https://api-us.bbamastro.com/shipment

Header Request

Field	Data Type	Description
Authorization	String	Bearer Access token

Request Payload

Field		Data Type	Required	Description
sourceAddress		Object	Yes	Source address
	name	String	No	Source address name
	firstName	String	Yes	Sender first name
	lastName	String	Yes	Sender last name
	addressLine1	String	Yes	Sender address line 1
	addressLine2	String	No	Sender address line 2
	phone	String	Yes	Sender phone number
	email	String	Yes	Sender email address
	company	String	No	Sender company name
	location.code	String	Yes	Sender postal code
	location.country.code	String	Yes	Sender country code
	location.id	Long	Yes	Sender address location id
	location.name	String	Yes	Source address location name
	location.state.code	String	Yes	Source postal code
destinationAddress		Object	Yes	Destination address
	firstName	String	Yes	Destination first name
	lastName	String	Yes	Destination last name
	addressLine1	String	Yes	Destination address line 1
	addressLine2	String	No	Destination address line 2
	phone	String	Yes	Destination phone number
	email	String	Yes	Destination email address
	company	String	No	Destination company name
	location.code	String	Yes	Destination postal code
	location.country.code	String	Yes	Destination country code
	location.name	String	Yes	Destination location name
	location.state.code	String	Yes	Destination state code
reasonForShipping		String	Yes	Reason for shipping. Available values are `purchase`, `gift`, `sale`, `sample`, `return`,`repair`, `personal_Effects`
taxStatus		String	Yes	Tax status. Available values are `private`, `company`.
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“
notifyReceiver		Boolean	No	Notify receiver for any update of this shipment
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
items		Object[]	yes	Items
	name	String	Yes	Item Name
	sku	String	No	Item SKU
	length	Decimal	Yes	Item length
	width	Decimal	Yes	Package width
	height	Decimal	Yes	Package height
	weight	Decimal	Yes	Package weight
	measureUnit	String	Yes	Item measure unit. Available values are CM, IN, M, FT, MM. Default value will be used if the value is null.
	weightUnit	String	Yes	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
	value	Decimal	Yes	Item Price
	currency	String	Yes	Item currency
	manufacturer	String	No	Origin of item
carrierId		String	Yes	Carrier id
serviceId		String	Yes	Service id
serviceProfileId		String	Yes	Service profile id
office		Long	No	Office id

Request Payload Sample

Code Block

{
    "destinationAddress": {
        "firstName": "Greg",
        "lastName": "Sharp",
        "addressLine1": "11A Edinburgh Rd",
        "phone": "+61415149001",
        "email": "info@mailinator.com",
        "location": {
            "code": "2204",
            "country": {
                "code": "AU"
            },
            "name": "Marrickville",
            "state": {
                "code": "NSW"
            }
        }
    },
    "sourceAddress": {
        "firstName": "Ship2Anywhere",
        "lastName": "user",
        "addressLine1": "Highway Street",
        "phone": "+61423793039",
        "email": "ship2anywhere@mailinator.com",
        "company": "Ship2Anywhere",
        "location": {
            "code": "3205",
            "country": {
                "code": "AU"
            },
            "id": 18011,
            "name": "South Melbourne",
            "state": {
                "code": "VIC"
            }
        }
    },
    "reasonForShipping": "sale",
    "taxStatus": "private",
    "pickupDetails": {
        "asap": true
    },
    "packages": [
        {
            "measureUnit": "CM",
            "weightUnit": "Kilograms",
            "weight": "1",
            "contentWeight": "1",
            "quantity": "1",
            "length": "1",
            "width": "1",
            "height": "1"
        }
    ],
    "items": [
        {
            "quantity": 1,
            "value": "100",
            "manufacturer": "AU",
            "sku": null,            
            "weight": "1",
            "length": "11",
            "width": "11",
            "height": "11",
            "name": "Test item",
            "measureUnit": "CM",
            "weightUnit": "Kilograms",
            "currency": "AUD"
        }
    ],
    "carrierId": "couriers-please",
    "serviceId": "P2A",
    "serviceProfileId": "62ee60a110d1d100019b1e19"
}

Responses

HTTP Code	Description	Schema
201	Created	ShipmentPublicProjection
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

...

Shipment

Name	Description	Schema
accompanied Delivery optional	Indicate if the delivery will be accompanied by another person Example : false	boolean
active optional	Shipment activation status Example : false	boolean
amount optional	Shipment amount	number
appliedShippingRule optional	Shipping rules that are applied to shipment	ShippingRule
bbaReferenceNumber optional	Shipment BBA Reference number	string
billed optional		boolean
bookingDate optional	The date when shipment booked	string (date-time)
bookingStatus optional	Shipment booking status	enum (new, unprocessed, inprogress, pending, processed)
breakBulkDetails optional	${swagger.model.shipment.break_bulk_details}	BreakBulkDetails
carrierBookingOptions optional	${swagger.model.shipment.carrier_booking_options}	< string, string > map
carrierID optional	Shipment carrier identifier	string
carrierOderId optional	${swagger.model.shipment.carrierOrderId}	string
carrierProfileId optional	Shipment carrier profile identifier	string
carrierServiceRateId optional	${swagger.model.shipment.carrier_service_rate_id}	string
carrierShipmentId optional	Carrier’s shipment identifier	string
clientPresent optional	Indicate if client will be present to assist the receiving of shipment Example: false	boolean
company optional	Shipment company	string
consignmentId optional	Shipment consignment identifier	string
consolidation optional	Shipment consolidation	ShipmentConsolidation
containerId optional	Shipment crossdock container identifier	string
containerName optional	Shipment crossdock container name	string
containerType optional	Shipment crossdock container type	enum (bag, box, carton, case, crate, envelope, pallet, rack, sack, tray)
createdDate optional	The date when shipment created	string (date-time)
currency optional	Shipment currency	string
customerReferences optional	Shipment customer references	< string > array
dangerousGoods optional	Indicate if shipment contains dangerous goods Example : false	boolean
deliveredDate optional	The date when shipment delivered	string (date-time)
description optional	Shipment description	string
destinationAddress optional	Shipment destination address	Address
eta optional	Shipment ETA	string
fromFtp optional	Indicate if the shipment data from FTP file Example : false	boolean
history optional		< History > array
id optional	Shipment identifier	string
invoiceDetails optional	${swagger.model.shipment.invoice_details}	InvoiceDetails
invoiceId optional		string
items optional	Items contained in shipment	< Item > array
jobId optional	${swagger.model.shipment.job_id}	integer (int64)
lastDocumentPrintedTime optional	The time when shipment document printed	string (date-time)
lastModifiedDate optional	Date when the last time shipment data modified	string (date-time)
manifest optional	Shipment manifest	Manifest
manifestedDate optional	${swagger.model.shipment.manifest_date}	string (date-time)
marketplaceId optional	Shipment marketplace identifier	string
maxDeliveryDate optional		string (date-time)
notifyReceiver optional	Notify receiver for any update of this shipment Example : false	boolean
notifySender optional	Notify sender for any update of this shipment Example : false	boolean
office optional	Shipment office	string
officeTransitionHistory optional	Shipment office transition history	< string > array
originalConsignmentId optional	Shipment original consignment identifier (for return shipment)	string
originalShipmentId optional	Original shipment id (for return shipment)	string
packDescAutoPopulate optional	Indicate if shipment package is auto populate Example : false	boolean
packages optional	Shipment packages	< Package > array
packaging optional	Shipment packaging	string
pickupDetails optional	Shipment pickup details	PickupDetails
poBox optional	Indicate if shipment has PO BOX Example : false	boolean
previousTrackingStatus optional	Shipment previous tracking status	enum (documentationprepared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)
purchasedDate optional	The date when shipment purchased	string (date-time)
reasonForShipping optional	Shipment reason for shipping	enum (purchase, gift)
returnAuthorityNumber optional	Shipment return authority number	string
serviceDetails optional	Shipment carrier service details	ServiceDetails
serviceId optional	Shipment carrier service identifier	string
serviceProfileId optional	Shipment service profile identifier	string
shippingCost optional	Shipment shipping cost	ShippingCost
skuList optional	Shipment SKUs	< SKUItem > array
sourceAddress optional	Shipment source address	Address
specialInstructions optional	Shipment special instructions	string
sscc optional	Shipment SSCC number	string
surcharge optional	Shipment surcharge	Surcharge
tailGate optional	Indicate if shipment tail gate status Example : false	boolean
taxStatus optional	Shipment tax status	enum (private)
timeBased optional	Indicate if shipment uses time based rate Example : false	boolean
timeBasedRateDetail optional	Time base rate detail	TimeBasedRateDetail
trackingNumber optional	Shipment tracking number	string
trackingStatus optional	Shipment tracking status	enum (documentationprep ared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)
travelDistance optional	${swagger.model.shipment.travel_distance}	integer (int64)
trolleyRequired optional	Indicate if a trolley will be required for shipping Example : false	boolean
unattendedDelivery optional	Indicate if shipment can be delivered unattended Example : false	boolean
user optional	Shipment user	string

ShipmentPublicProjection

Name	Description	Schema
accompanied Delivery optional	Indicate if the delivery will be accompanied by another person Example : false	boolean
active optional	Shipment activation status Example : false	boolean
amount optional	Shipment amount	number
appliedShippingRule optional	Shipping rules that are applied to shipment	ShippingRule
bbaReferenceNumber optional	Shipment BBA Reference number	string
billed optional		boolean
bookingDate optional	The date when shipment booked	string (date-time)
bookingStatus optional	Shipment booking status	enum (new, unprocessed, inprogress, pending, processed)
breakBulkDetails optional	${swagger.model.shipment.

carrier

break_

service_rate_id}

string

carrierShipmentId

optional

Carrier’s shipment identifier

string

clientPresent

optional

Indicate if client will be present to assist the receiving of shipment

Example: false

boolean

company

optional

Shipment company

string

consignmentId

optional

Shipment consignment identifier

string

consolidation

optional

Shipment consolidation

ShipmentConsolidation

containerId

optional

Shipment crossdock container identifier

string

containerName

optional

Shipment crossdock container name

string

containerType

optional

Shipment crossdock container type

enum (bag, box, carton, case, crate, envelope, pallet, rack, sack, tray)

createdDate

optional

The date when shipment created

string (date-time)

currency

optional

Shipment currency

string

customerReferences

optional

Shipment customer references

< string > array

dangerousGoods

optional

Indicate if shipment contains dangerous goods

Example : false

boolean

deliveredDate

bulk_details}	BreakBulkDetails
carrierBookingOptions optional	${swagger.model.shipment.carrier_booking_options}	< string, string > map
carrierConfiguration optional	${swagger.model.shipment.job}	CarrierConfiguratio nProjection
carrierOrderId optional	${swagger.model.shipment.carrierOrderId}	string
clientPresent optional	Indicate if client will be present to assist the receiving of shipment Example: false	boolean
company optional	Shipment company	Company
consignmentId optional	Shipment consignment identifier	string
consolidation optional	Shipment consolidation	ShipmentConsolidation
containerId optional	Shipment crossdock container identifier	string
containerName optional	Shipment crossdock container name	string
containerType optional	Shipment crossdock container type	enum (bag, box, carton, case, crate, envelope, pallet, rack, sack, tray)
createdDate optional	The date when shipment

delivered

created

string (date-time)

description

currency

optional

Shipment

description

currency

string

destinationAddress

customerReferences

optional

Shipment

destination address

Address

eta

optional

Shipment ETA

string

fromFtp

customer references

< string > array

dangerousGoods

optional

Indicate if

the shipment data from FTP file

shipment contains dangerous goods

Example : false

boolean

historyid

deliveredDate

optional

< History > array

The date when shipment delivered

string (date-time)

description

optional

Shipment

identifier

description

string

invoiceDetails

invoiceId

optional

destinationAddress

optional

${swagger.model.shipment.invoice_details}

InvoiceDetails

Shipment destination address

AddressPublicProjection

id

optional

Shipment identifier

string

items

optional

Items contained in shipment

<

Item

ItemPublicProjection > array

jobId

job

optional

${swagger.model.shipment.job

_id

}

integer (int64)

Job
lastDocumentPrintedTime optional	The time when shipment document printed	string (date-time)
lastModifiedDate optional	Date when the last time shipment data modified	string (date-time)
manifestId optional	Shipment manifest identifier	string
manifesteNo optional	Shipment manifest number

Manifest

integer (int64)
manifestedDate optional	${swagger.model.shipment.manifest_date}	string (date-time)
marketplaceId optional	Shipment marketplace identifier	string
maxDeliveryDate optional		string (date-time)
notifyReceiver optional	Notify receiver for any update of this shipment Example : false	boolean
notifySender optional	Notify sender for any update of this shipment Example : false	boolean
office optional	Shipment office

string

OfficeProjection
officeTransitionHistory optional	Shipment office transition history	< string > array
originalConsignmentId optional	Shipment original consignment identifier (for return shipment)	string
originalShipmentId optional	Original shipment id (for return shipment)	string
packDescAutoPopulate optional	Indicate if shipment package is auto populate Example : false	boolean
packages optional	Shipment packages	<

Package

PackagePublicProjection > array
packaging optional	Shipment packaging	string
pickupDetails optional	Shipment pickup details	PickupDetails
poBox optional	Indicate if shipment has PO BOX Example : false	boolean
previousTrackingStatus optional	Shipment previous tracking status	enum (documentationprepared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)
purchasedDate optional	The date when shipment purchased	string (date-time)
readyForProcess optional	Indicate if shipment ready for process Example : false	boolean
reasonForShipping optional	Shipment reason for shipping	enum (purchase, gift)
returnAuthorityNumber optional	Shipment return authority number	string
serviceDetails optional	Shipment carrier service details	ServiceDetails

serviceIdstring

serviceProfile

optional

Shipment carrier service identifier

string

serviceProfileId

optional

Shipment service profile identifier

${swagger.model.shipment.service_profile}

ServiceProfile

shippingCost

optional

Shipment shipping cost

ShippingCost

skuList

optional

Shipment SKUs

< SKUItem > array

sourceAddress

optional

Shipment source address

Address

AddressPublicProjection
specialInstructions optional	Shipment special instructions	string
sscc optional	Shipment SSCC number	string
surcharge optional	Shipment surcharge	Surcharge
tailGate optional	Indicate if shipment tail gate status Example : false	boolean
taxStatus optional	Shipment tax status	enum (private)

timeBased

optional

Indicate if shipment uses time based rate

Example : false

boolean


timeBasedRateDetail optional	Time base rate detail	TimeBasedRateDetail
trackingNumber optional	Shipment tracking number	string
trackingStatus optional	Shipment tracking status	enum (documentationprep ared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery,

delivered, instore, missing)

travelDistance

optional

${swagger.model.shipment.travel_distance}

integer (int64

delivered, instore, missing)
trolleyRequired optional	Indicate if a trolley will be required for shipping Example : false	boolean
unattendedDelivery optional	Indicate if shipment can be delivered unattended Example : false	boolean
user optional	Shipment user	string
validationResults optional	Indicate if shipment data is valid	ValidationResult
withheld optional	Indicates that the shipment in on hold Example : false	boolean

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

Version	Old Version 4	New Version Current
Changes made by	Rex Enage (Unlicensed)	Zulfy Adi Harianto
Saved on	Oct 14, 2019	Aug 21, 2024

Content Comparison

Versions Compared

Key

Resource URL

Parameters

Responses

Definitions

mykey

Shipment

Resource URL

Header Request

Request Payload

Request Payload Sample

Responses

Shipment

ShipmentPublicProjection