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

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.invoicetravel_detailsdistance}

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 purchasedinteger (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

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

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 created

string (date-time)

reasonForShippingcurrency

optional

Shipment reason for shipping

enum (purchase, gift)

returnAuthorityNumber

optional

Shipment return authority number

string

serviceDetailscurrency

string

customerReferences

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)

travelDistancecustomer 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

AddressPublicProjec tion

id

optional

Shipment identifier

string

items

optional

Items contained in shipment

< ItemPublicProjection > array

job

optional

${swagger.model.shipment.job}

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

integer (int64)

manifestedDate

optional

${swagger.model.shipment.travelmanifest_distancedate}

integer string (int64date-time)

trolleyRequiredmarketplaceId

optional

Indicate if a trolley will be required for shipping

Example : false

boolean

unattendedDelivery

optional

Indicate if shipment can be delivered unattended

Shipment marketplace identifier

string

maxDeliveryDate

optional

string (date-time)

notifyReceiver

optional

Notify receiver for any update of this shipment

Example : false

boolean

usernotifySender

optional

Shipment user

string

accompanied Delivery

optional

Indicate if the delivery will be accompanied by another person

Notify sender for any update of this shipment

Example : false

boolean

active office

optional

Shipment activation status

Example : false

boolean

amount

Shipment office

OfficeProjection

officeTransitionHistory

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

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 shipmentoffice 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

< 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

companyreasonForShipping

optional

Shipment company

Company

consignmentIdreason for shipping

enum (purchase, gift)

returnAuthorityNumber

optional

Shipment consignment identifierreturn authority number

string

consolidationserviceDetails

optional

Shipment consolidationcarrier service details

ShipmentConsolidationServiceDetails

containerIdserviceProfile

optional

Shipment crossdock container identifier

string

containerName${swagger.model.shipment.service_profile}

ServiceProfile

shippingCost

optional

Shipment crossdock container name

string

containerTypeshipping cost

ShippingCost

sourceAddress

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)

currencysource address

AddressPublicProjection

specialInstructions

optional

Shipment special instructions

string

sscc

optional

Shipment currencySSCC number

string

customerReferencessurcharge

optional

Shipment customer references

< string > array

dangerousGoodssurcharge

Surcharge

tailGate

optional

Indicate if shipment contains dangerous goodstail gate status

Example : false

boolean

deliveredDatetaxStatus

optional

The date when shipment delivered

string (date-time)

description

optional

Shipment description

string

destinationAddress

optional

Shipment destination address

AddressPublicProjec tion

id

optional

Shipment identifier

string

items

optional

Items contained in shipment

< ItemPublicProjection > array

job

optional

${swagger.model.shipment.job}

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

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

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

< 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

serviceProfile

optional

${swagger.model.shipment.service_profile}

ServiceProfile

shippingCost

optional

Shipment shipping cost

ShippingCost

sourceAddress

optional

Shipment source 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)

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)

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

ValidationResults

withheld

optional

Indicates that the shipment in on hold

Example : false

boolean

accountCode

optional

Account code

string

consolidation

optional

Indicate if the shipment use consolidation Example : false

boolean

customerCarrierAccountCodeShipment tax status

enum (private)

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)

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

ValidationResults

withheld

optional

Indicates that the shipment in on hold

Example : false

boolean

amount

optional

number

bookingParams

optional

< string, string > map

carrierId

optional

string

eta

optional

string

logo

optional

string

name

optional

string

serviceId

optional

string

shippingRuleId

optional

string

transitTimeEarliest

optional

integer (int32)

transitTimeLatest

optional

integer (int32)

firstMile

optional

BreakBulkStepSummary

id

optional

interger (int32)

lastMile

optional

BreakBulkStepSummary

lineHaul

optional

BreakBulkStepSummary

name

optional

string

accountCode

optional

Account code

string

consolidation

optional

Indicate if the shipment use consolidation Example : false

boolean

customerCarrierAccountCode

optional

${swagger.model.shipment.consolidation.customer_carrier _account_code}

string

pickType

optional

Pick type

string

receiverCode

optional

${swagger.model.shipment.consolidation.receiver_code}

string

senderCode

optional

Shipment sender code

string

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company

string

customerCarrierAccountCode

optional

string

email

optional

Address email

string

firstName

optional

Address first name

string

lastName

optional

Address last name

string

latitude

optional

${swagger.model.address.latitude}

number (double)

location

optional

Address location

Location

longitude

optional

${swagger.model.address.longitude}

number (double)

phone

optional

Address phone number

string

receiverCode

optional

string

senderCode

optional

string

change

optional

enum (CREATED, EDITED, DELETED, MANIFESTED, BOOKED, TRACKING, INVOICED

date

optional

string (date-time)

details

optional

string

user

optional

string

account

optional

${swagger.model.accounting.invoice.account}

string

actualMargin

optional

${swagger.model.accounting.invoice.actual_margin}

number

actualMarginPercentage

optional

${swagger.model.accounting.invoice.actual_margin_percen tage}

number

ada

optional

${swagger.model.accounting.invoice.ada}

number

additionalCharges

optional

${swagger.model.accounting.invoice.additional_charges}

nuumber

chargebleWeight

optional

${swagger.model.accounting.invoice.chargeable_weight}

number

ddp

optional

${swagger.model.accounting.invoice.ddp}

number

exTaxCharge

optional

${swagger.model.accounting.invoice.ex_tax_charge}

number

exTaxTotal

optional

${swagger.model.accounting.invoice.ex_tax_total}

number

forProcessing

optional

${swagger.model.accounting.invoice.for_processing}

string

fuel

optional

${swagger.model.accounting.invoice.fuel}

number

internalNotes

optional

${swagger.model.accounting.invoice.internal_notes}

< string > array

invoiceDate

optional

${swagger.model.accounting.invoice.invoice_date}

string (date-time)

invoiceNotes

optional

${swagger.model.accounting.invoice.invoice_notes}

string

rdl

optional

${swagger.model.shipmentaccounting.consolidation.customer_carrier _account_codeinvoice.rdl}

stringnumber

pickType

optional

Pick type

string

receiverCode

tax

optional

${swagger.model.shipmentaccounting.consolidationinvoice.receiver_codetax}

stringnumber

senderCodetgl

optional

Shipment sender code

string

account

${swagger.model.accounting.invoice.account}

string

actualMargin

${swagger.model.accounting.invoice.actual_margin}

number

actualMarginPercentage

${swagger.model.accounting.invoice.actual_margin_percen tage}

number

ada

${swagger.model.accounting.invoice.ada}

number

additionalCharges

${swagger.model.accounting.invoice.additional_charges}

nuumber

chargebleWeight

${swagger.model.accounting.invoice.chargeable_weight}

number

ddp

${swagger.model.accounting.invoice.ddp}

number

exTaxCharge

${swagger.model.accounting.invoice.ex_tax_charge}

number

exTaxTotal

${swagger.model.accounting.invoice.ex_tax_total}

number

forProcessing

${swagger.model.accounting.invoice.for_processing}

string

fuel

${swagger.model.accounting.invoice.fuel}

number

internalNotes

${swagger.model.accounting.invoice.internal_notes}

< string > array

invoiceDate

${swagger.model.accounting.invoice.invoice_date}

string (date-time)

invoiceNotes

${swagger.model.accounting.invoice.invoice_notes}

string

rdl

${swagger.model.accounting.invoice.rdl}

number

tax

${swagger.model.accounting.invoice.tax}

number

tgl

${swagger.model.accounting.invoice.tgl}

number

weightUnit

${swagger.model.accounting.invoice.weight_unit}

enum (grams, kilograms, ounces, pounds)${swagger.model.accounting.invoice.tgl}

number

weightUnit

optional

${swagger.model.accounting.invoice.weight_unit}

enum (grams, kilograms, ounces, pounds)

categories

optional

Item categories

< string > array

code

optional

Item code

string

country

optional

Item country

string

currency

optional

Item currency

string

description

optional

Item description

string

height

optional

Item height

number

id

optional

Item identifier

string

itemType

optional

Item type

string

length

optional

Item length

number

manufacturer

optional

Item manufacturer

string

measureUnit

optional

Item measure unit

enum (cm, in, m, ft, mm)

name

optional

Item name

string

quantity

optional

Item quantity

integer (int32)

remoteId

optional

Marketplace item’s identifier

string

returnedQuantity

optional

Item returned quantity

integer (int32)

sku

optional

Item SKU

string

taxes

optional

Item taxes

string

value

optional

Item value

number

weight

optional

Item weight

number

weightUnit

optional

Item weight unit

enum (grams, kilograms, ounces, pounds)

width

optional

Item width

number

approved

optional

boolean

carrierId

optional

string

carrierProfileId

optional

string

companyId

optional

string

createdBy

optional

string

createdDate

optional

string (date-time)

documentData

optional

string (byte)

id

optional

string

lastModifiedBy

optional

string

lastModifiedDate

optional

string (date-time)

manifestNumber

optional

integer (int64)

officeId

optional

string

orderId

optional

string

serviceProfileId

optional

string

shipments

optional

< Shipment > array

shipmentsToCrossdock

optional

< Shipment > array