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

201

Created

ShipmentPublicProjection

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

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

${swagger.model.shipment.break_bulk_details}

BreakBulkDetails

carrierBookingOptions

${swagger.model.shipment.carrier_booking_options}

< string, string > map

carrierID

Shipment carrier identifier

string

carrierOderId

${swagger.model.shipment.carrierOrderId}

string

carrierProfileId

Shipment carrier profile identifier

string

carrierServiceRateId

${swagger.model.shipment.carrier_service_rate_id}

string

carrierShipmentId

Carrier’s shipment identifier

string

clientPresent

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

Example: false

boolean

company

Shipment company

string

consignmentId

Shipment consignment identifier

string

consolidation

Shipment consolidation

ShipmentConsolidation

containerId

Shipment crossdock container identifier

string

containerName

Shipment crossdock container name

string

containerType

Shipment crossdock container type

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

createdDate

The date when shipment created

string (date-time)

currency

Shipment currency

string

customerReferences

Shipment customer references

< string > array

dangerousGoods

Indicate if shipment contains dangerous goods

Example : false

boolean

deliveredDate

The date when shipment delivered

string (date-time)

description

Shipment description

string

destinationAddress

Shipment destination address

Address

eta

Shipment ETA

string

fromFtp

Indicate if the shipment data from FTP file

Example : false

boolean

history

< History > array

id

Shipment identifier

string

invoiceDetails

${swagger.model.shipment.invoice_details}

InvoiceDetails

invoiceId

string

items

Items contained in shipment

< Item > array

jobId

${swagger.model.shipment.job_id}

integer (int64)

lastDocumentPrintedTime

The time when shipment document printed

string (date-time)

lastModifiedDate

Date when the last time shipment data modified

string (date-time)

manifest

Shipment manifest

Manifest

manifestedDate

${swagger.model.shipment.manifest_date}

string (date-time)

marketplaceId

Shipment marketplace identifier

string

maxDeliveryDate

string (date-time)

notifyReceiver

Notify receiver for any update of this shipment

Example : false

boolean

notifySender

Notify sender for any update of this shipment

Example : false

boolean

office

Shipment office

string

officeTransitionHistory

Shipment office transition history

< string > array

originalConsignmentId

Shipment original consignment identifier (for return shipment)

string

originalShipmentId

Original shipment id (for return shipment)

string

packDescAutoPopulate

Indicate if shipment package is auto populate

Example : false

boolean

packages

Shipment packages

< Package > array

packaging

Shipment packaging

string

pickupDetails

Shipment pickup details

PickupDetails

poBox

Indicate if shipment has PO BOX

Example : false

boolean

previousTrackingStatus

Shipment previous tracking status

enum (documentationprepared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)

purchasedDate

The date when shipment purchased

string (date-time)

reasonForShipping

Shipment reason for shipping

enum (purchase, gift)

returnAuthorityNumber

Shipment return authority number

string

serviceDetails

Shipment carrier service details

ServiceDetails

serviceId

Shipment carrier service identifier

string

serviceProfileId

Shipment service profile identifier

string

shippingCost

Shipment shipping cost

ShippingCost

skuList

Shipment SKUs

< SKUItem > array

sourceAddress

Shipment source address

Address

specialInstructions

Shipment special instructions

string

sscc

Shipment SSCC number

string

surcharge

Shipment surcharge

Surcharge

tailGate

Indicate if shipment tail gate status

Example : false

boolean

taxStatus

Shipment tax status

enum (private)

timeBased

Indicate if shipment uses time based rate

Example : false

boolean

timeBasedRateDetail

Time base rate detail

TimeBasedRateDetail

trackingNumber

Shipment tracking number

string

trackingStatus

Shipment tracking status

enum (documentationprep ared, bookingarranged, collected, intransit, arrivedatdestination , outfordelivery, delivered, instore, missing)

travelDistance

${swagger.model.shipment.travel_distance}

integer (int64)

trolleyRequired

Indicate if a trolley will be required for shipping

Example : false

boolean

unattendedDelivery

Indicate if shipment can be delivered unattended

Example : false

boolean

user

Shipment user

string