Overview

This method allows you to obtain a list of the current available inventory but it will only include the Open Market items and it doesn't include costs and aging.

Request

https://api.kometsales.com/api/inventory.openmarket.list

Parameters:

  • authenticationToken (required) (string:50): Komet Sales security token.
  • locationId (optional) (integer:20): Id of the location where belongs the inventory. This applies for companies in multilocation mode. 
  • customerId (optional) (integer:20): Id of the customer. This value could be given if you want the API result to show the correct FOB Price based on the settings of the customer given. 

Response

Output:

  • status (integer:1): transaction status. 1 for sucess or 0 for failure/error.
  • message (string:500): contains status description of request.
  • inventoryItems: array of available inventory items.
    • inventoryId (integer:20): Inventory Item ID. In Komet Sales this field represents the Inventory Line Id. 
    • companyProductId (integer:20): ID of the product.
    • productDescription (string:200): product description.
    • productCode (string:20): product code. It's also called Product Legacy Code. 
    • grade (string:100): grade or product cut point.
    • category (string: 200): category name.
    • vendor (string: 200): vendor code or vendor name. This field will be only returned when the customer given in the filters has access to see the vendor code or name. 
    • quantity (integer:20): number of available boxes.
    • totalUnits (integer:20): total units. When unit type is bunch this is the number of total bunches; when the unit type is stem this is the number of total stems.
    • boxTypeId (integer:20): box type ID.
    • boxTypeCode (string:3): code used that corresponds to the size of the box (i.e. FB, EB, etc.).
    • unitType (string:5): unit type (Bunch or Stem).
    • bunches (integer:20): number of bunches per box.
    • unitsPerBox (integer:20): units per box or pack.
    • stemsBunch (integer:20) number of stems per bunch.
    • price (decimal:10,2): unit price based on the unit type of the product. 
    • priceB (decimal:10,2): unit price B based on the unit type of the product. 
    • fobPrice (decimal:10,2): unit fob price based on the unit type of the product and the customer given on the filters. If the customer is not given, this value will be the same unit price. 
    • image (string:200): The url of the product image, if it exists. 
    • awb (string:15): Air way bill number or shipment reference. 
    • shipDate (date): Date when the product was shipped from the vendor (date format YYYY-MM-DD).
    • availableFrom (date): Date when the product is available (date format YYYY-MM-DD).
    • isAssorted (bolean: true/false): indicates whether this item is assorted or it has breakdowns.
    • lotNumber (integer:10): lot number.
    • breakdowns: an array of breakdowns (empty when isAssorted is false).
      • assortedCompositionId (integer:20): breakdown item ID.
      • productId (integer:20): product ID.
      • productDescription (string:200): breakdown product description.
      • bunches (integer:20): number of bunches.
      • stemsBunch (integer:20): number of stems per bunch.

Response Example
{
   "message": "success",
   "status": "1",
   "inventoryItems": [
   {
     "inventoryId": 234234,
     "companyProductId": 92341,
     "category": "Agapanthus",
     "productDescription": "Agapanthus Blue Crme de la Crme 60 Cm",
     "productCode": "AGA60",
     "image": "http://app.kometsales.com/productImage.jpg",
     "grade": "60 Cm",
     "vendor": "ABC",
     "quantity": 85,
     "totalUnits": 12240,
     "boxTypeId": 900,
     "boxTypeCode": "FB",
     "unitType": "Stem",
     "bunches": 12,
     "unitsPerBox": 144,
     "stemsBunch": 12,
     "price": 3.01389,
	 "fobPrice": 3.6211,
     "isAssorted": false,
     "lotNumber": "4308",
     "awb": "098-0823-6522",
     "availableFrom": "2016-07-01",
     "shipDate": "2016-06-28",
     "breakdowns": [ 
       {
          "assorteCompositionId": 9999,
          "productDescription": "text for product description", 
          "productId": 99999,
          "bunches": 10,
          "stemsBunch": 12
        }
      ]
   }
 ]
}