Overview

Returns a list of AWBs.

Request

https://api.kometsales.com/api/awb.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.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. 
    • boxesCodes (string:500): Codes of the boxes that belongs to the AWB separated by comma. 
    • 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.