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

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

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)

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

AddressPublicProjection

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

ValidationResult

withheld

optional

Indicates that the shipment in on hold

Example : false

boolean

firstMile

optional

BreakBulkStepSummary

id

optional

interger (int32)

lastMile

optional

BreakBulkStepSummary

lineHaul

optional

BreakBulkStepSummary

name

optional

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

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

active

optional

boolean

addressLine1

optional

string

addressLine2

optional

string

billingProfile

optional

BillingProfile

customerCarrierAccountCode

optional

string

email

optional

string

enableServiceSharing

optional

boolean

id

optional

string

isReseller

optional

boolean

location

optional

integer (int64)

logoUrl

optional

string

name

optional

string

networkEnabled

optional

boolean

offices

optional

< Office > array

phone1

optional

string

phone2

optional

string

primaryContact

optional

PrimaryContact

reseller

optional

Company

smsNotificationEnabled

optional

boolean

website

optional

string

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company

string

email

optional

Address email

string

firstName

optional

Address FirstName

string

lastName

optional

Address last name

string

location

optional

address location

Location

phone

optional

Address phone

string

destination

optional

Address

id

optional

integer (int64)

jobFinancials

optional

JobFinancials

jobId

optional

string

jobStatus

optional

enum (unassigned, forapproval, pending, accepted, received, inprogress, delivered, failed, notyetstarted)

manifested

optional

boolean

shipmentId

optional

string

signatureUrl

optional

string

sourceAddress

optional

Address

timeBased

optional

boolean

travelDistance

optional

integer (int64)

type

optional

enum (p2p, delivery, pickuponly)

active

optional

Office activation status

Example : false

boolean

addressLine1

optional

Office address line 1

string

addressLine2

optional

Office address line 2

string

code

optional

Office code

string

company

optional

Office’s company

Company

currency

optional

Office currency

string

description

optional

Office description

string

email

optional

Office email address

string

firstName

optional

Office first name

string

id

optional

Office identifier

string

lastName

optional

Office last name

string

location

optional

Office location

Location

locationProfile

optional

Office location profile

LocationProfileProjection

measurementUnit

optional

Office measure unit

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

name

optional

Office name

string

notificationPreferences

optional

Office notification preferences

NotificationPreferences

officeConfiguration

optional

${swagger.model.office.office_configuration}

OfficeConfiguration

parent

optional

Parent office

string

phone1

optional

Office primary phone number

string

phone2

optional

Office secondary phone number

string

website

optional

Office website

string

weightUnit

optional

Office weight unit

enum (grams, kilograms, ounces, pounds)

active

optional

boolean

addressLine1

optional

string

addressLine2

optional

string

code

optional

string

company

optional

Company

currency

optional

string

defaultDimensions

optional

DefaultDimensions

description

optional

string

driverDirectSetting

optional

DriverDirectSettingsDriverDirectSetting

email

optional

string

firstName

optional

string

geoLocation

optional

GeoLocation

id

optional

string

lastName

optional

string

location

optional

integer (int64)

locationProfile

optional

LocationProfile

measurementUnit

optional

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

name

optional

string

notificationPreferences

optional

NotificationPreferences

officeConfiguration

optional

OfficeConfiguration

officeType

optional

enum (crossdock, warehouse, thirdpartylogistics)

parent

optional

string

phone1

optional

string

phone2

optional

string

receiverCode

optional

string

senderCode

optional

string

website

optional

string

weightUnit

optional

enum (grams, kilograms, ounces, pounds)

messages

optional

< ValidationResultsEntry > array

valid

optional

boolean

messages

optional

< ValidationResultsEntry > array

name

optional

string

value

optional

string

address1

optional

Location profile address line 1

string

address2

optional

Location profile address line 2

string

email

optional

Location profile email address

string

firstName

optional

Location profile First name

string

lastName

optional

Location profile last name

string

location

optional

Location profile location

integer (int64)

locationDetails

optional

Location profile location

LocationProjection

phone1

optional

Location profile primary phone number

string

phone2

optional

Location profile secondary phone number

string

code

optional

Location code

string

country

optional

Location country

Country

id

optional

Location Identifier

integer (int64)

name

optional

Location name

string

state

optional

Location state

State