This endpoint is used to create new shipment by passing JSON request payload.
Resource URL
https://api.bbamastro.com.au/shipment🔗
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 | ${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) |