URL: https://api.kometsales.com/api/awb.details.list

Method: GET

Content-Type: URL Parameters

Input parameters

authenticationToken (required)(string:50)

The Komet Sales security token.

awb (required) (number:4)

The last four digits of the AWB.

This filter is required if the shipDate is not provided. 

shipDate (required) (date)

The AWB ship date.

This filter is required if the awb is not provided.

Date format: YYYY-MM-DD  

originCode (optional)(string:5)

The origin code.

Example: UIO, MDE, BOG, etc. 

locationCode (optional)(string:10)

The AWB Location code.

Only applies to Multi-Location companies. 

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transactions status description.

awbs (array)

The array containing the AWBs.

awbId (integer:20)

Komet Sales internal AWB ID.

awb (string:15)

AWB number.

origin (string:5)

The origin code.

Example: UIO, MDE, BOG, etc. 

shipDate (date)

The AWB shipping date.

Date format: YYYY-MM-DD

arrivalDate (date)

The AWBs Warehouse arrival date.

Date format: YYYY-MM-DD

pieces (integer:10)

The total boxes in the AWB.

piecesReceived (integer:10)

The number of scanned as received boxes in the warehouse. 

locationCode (string:20)

The AWB Location code.

Only applies to Multi-Location Companies. 

status (integer: 0)

AWB status.

Valid values: 1 = Open | 0 = Closed 

boxes (array)

An array containing the shipped boxes.

code (string:15)

The box code.

unitCost(decimal:10,3)

The product cost per unit.

carrierName(string:200)

The Carrier associated to the Prebook.

carrierCode (string:20)

The Carrier code associated to the Prebook.

truckDate (date)

The Prebook’s truck date. 

Date format: YYYY-MM-DD

shipToId (integer:10)

Ship-To ID associated to the Prebook. 

shipToName (string:200)

The Ship-To name associated to the Prebook. 

productId (integer:20)

Komet Sales internal Product ID.

categoryId (integer:20)

Komet Sales internal Category ID.

categoryName (string:50)

The product’s category name. 

kometNetworkCategoryId (integer:20)

The Komet Network Code Category ID. 

kometNetworkCategoryName (string:50)

The Komet Network Code Category name. 

shipVia (string:50)

Order Ship Via.

Valid values: WH Cross-Dock, Grower, or Warehouse.

vendorId(integer:20)

The Komet Sales internal Vendor ID.

customerId(integer:20)

The Komet Sales internal Customer ID.

lotNumber (string:10)

The lot number.

hawb (string:20)

The AWB House number. 

vendorCode (string:20)

The Vendor code. 

vendorMID (string:50)

The Vendor Manufacturer ID. 

customerCode (string:20)

The Customer code. 

boxType (string:3)

The box-type code.

Example: FB, HB, QB, etc.

productDescription (string:200)

The product description.

productCode (string:20)

The product code.

length (double: 5)

The box length. 

width (double:5)

The box width. 

height (double: 5)

The box height. 

units (integer:10)

The number of Units per box.

unitType (string:10)

The Unit Type.

Valid values: Stem or Bunch

bunchesBox (integer:10)

The number of bunches per box.

stemsBunch (integer:10)

The number of stems per bunch.

origin (string:5)

The origin code.

Example: UIO, MDE, BOG, etc. 

locationCode (string:20)

The AWB Location code.

Only applies to Multi Location companies. 

status (string:20)

The box status.

Valid values: Farm Shipped, Received Warehouse, and Shipped Warehouse.