Overview

Returns a list of AWBs with their corresponding details. 

Request

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

  • Method: GET
  • Content-Type: URL Params

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • awb (required) (number:4): Last four digits of the AWB. This filter is required if the ship date is not provided. 
  • shipDate (required) (date): AWB ship date (date format YYYY-MM-DD). This filter is required if the AWB number is not provided. 
  • originCode (optional)(string:5): Origin code. Example: UIO, MDE, BOG, etc. 
  • locationCode (optional)(string:10): Location code of the AWB. It applies for Multi-Location companies. 


Sample 1
https://api.kometsales.com/api/awb.details.list?authenticationToken=token_info_goes_here&shipDate=2016-02-15

 

 

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • awbs: array of awbs
    • awbId (integer:20): Komet Sales internal AWB ID.
    • awb (string:15): AWB number.
    • origin (string:5): Code of the origin. Example: UIO, MDE, BOG, etc. 
    • shipDate (date): ship date of the AWB. (date format YYYY-MM-DD).
    • arrivalDate (date): Date when the AWB arrives to the warehouse. (date format YYYY-MM-DD).
    • pieces (integer:10): total of boxes.
    • piecesReceived (integer:10): number of boxes scanned as received in the warehouse. 
    • locationCode (string:20): Location code of the AWB. It applies for Multi Location companies. 
    • status (integer: 0): 1 if the AWB is still Open, 0 if it's Closed. 
    • boxes: array of boxes that are shipped:
      • code (string:15): box code.
      • lotNumber (string:10): lot number.
      • hawb (string:20): House AWB number. 
      • vendorCode (string:20): code of the vendor. 
      • customerCode (string:20): code of the customer. 
      • boxType (string:3): box type code (FB, HB, QB, etc).
      • productDescription (string:200): product description.
      • productCode (string:20): product code.
      • length (double: 5): length of the box. 
      • width (double: 5): width of the box. 
      • height (double: 5): height of the box. 
      • units (integer:10): units per box.
      • unitType (string:10): stem or bunch.
      • bunchesBox (integer:10): bunches per box.
      • stemsBunch (integer:10): stems per bunch.
      • origin (string:5): Code of the origin. Example: UIO, MDE, BOG, etc. 
      • locationCode (string:20): Location code of the AWB. It applies for Multi Location companies. 
      • status (string:20): status of the box: (Farm Shipped, Received Warehouse, Shipped Warehouse)

Output Sample
{
    "status" : 1,
    "message" : "OK",
    "awbs" :
    [
        {
            "awbId" : 148807,
            "awb" : "234-2367-0983",
            "origin" : "UIO",
            "shipDate" : "2016-02-15",
            "arrivalDate" : "2016-02-18",
            "pieces" : 3,
            "piecesReceived" : 2,
            "locationCode" : "06",
            "status" : 1,
            "boxes" :
            [
                {
                    "code" : "KS23060443",
                    "lotNumber" : 3434,
                    "hawb" : "CM234230022",
                    "vendorCode" : "ABC",
                    "customerCode" : "THS",
                    "boxType" : "HB",
                    "productDescription" : "Rose Red Freedom 60 cm",
                    "productCode" : "RF60",
                    "length" : 40,
                    "width" : 12,
                    "height" : 11,
                    "units" : 25,
					"unitType" : "Stem",
                    "bunchesBox" : 12,
                    "stemsBunch" : 25,
                    "origin" : "UIO",
                    "locationCode" : "06",
                    "status" : "Farm Shipped"                   
                },
				{
                    "code" : "KS23060234",
                    "lotNumber" : 3435,
                    "hawb" : "CM234230022",
                    "vendorCode" : "ABC",
                    "customerCode" : "LKS",
                    "boxType" : "HB",
                    "productDescription" : "Rose Yellow Freedom 60 cm",
                    "productCode" : "RY60",
                    "length" : 40,
                    "width" : 12,
                    "height" : 11,
                    "units" : 25,
					"unitType" : "Stem",
                    "bunchesBox" : 12,
                    "stemsBunch" : 25,
                    "origin" : "UIO",
                    "locationCode" : "06",
                    "status" : "Received Warehouse"                   
                },
				{
                    "code" : "KS23060211",
                    "lotNumber" : 3436,
                    "hawb" : "CM234230022",
                    "vendorCode" : "ABC",
                    "customerCode" : "LKS",
                    "boxType" : "HB",
                    "productDescription" : "Rose White Freedom 60 cm",
                    "productCode" : "RW60",
                    "length" : 40,
                    "width" : 12,
                    "height" : 11,
                    "units" : 25,
					"unitType" : "Stem",
                    "bunchesBox" : 12,
                    "stemsBunch" : 25,
                    "origin" : "UIO",
                    "locationCode" : "06",
                    "status" : "Received Warehouse"                   
                }
            ]
        }
    ]
}