Overview

This method allows you to obtain a list of the current available inventory. This method works either with tokens type "Company" and "Vendor". 

Request

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

Parameters:

  • authenticationToken (required) (string:50): Komet Sales security token.
  • includeBoxes:* (optional) (integer:1) 1 include boxes. 0 or empty does not include boxes.
  • inventoryType:* (optional) (string:5). valid values: all or M, L, S, P (OpenMarket, Local, Standing Order and Prebook), M is the default option. You can enter different values separated by commas (L, S, P). With "all" you will include all the options.
  • lotNumber (optional)(integer: 6): Lot number that identifies the inventory item. 

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.
    • companyProductId (integer:20): ID of the product.
    • orderItemId (integer:20): Inventory Item ID.
    • grade (string:100): grade or product cut point.
    • productDescription (string:200): product description.
    • productCode (optional)(string:50): product legacy code.
    • 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.
    • growerId (integer: 20): grower or vendor ID.
    • growerName (string:200): grower or vendor name.
    • 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.
    • inventoryDate (date): inventory date.
    • price (decimal:10,2): unit price or price per individual item. No available when the token used is type Vendor.
    • sellFast (boolean: true/false): indicates whether this item qualifies as sell fast.
    • isAssorted (bolean: true/false): indicates whether this item is assorted or it has breakdowns.
    • category (string: 200): category name.
    • awb (string:20): air waybill number.
    • unitCost (decimal:10,2): unit cost.
    • landedCost (decimal: 10,2): unit landed cost.
    • reference (string:100): item reference.
    • lotNumber (integer:10): lot number.
    • markCode (string:20): mark code or item label.
    • aging (integer:20): the amount of time (in days) the item has been in inventory.
    • 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.
      • cost (decimal:10,2): unit cost.
      • price (decimal:10,2): unit price. No available when the token used is type Vendor.

Response Example
{
   "message": "success",
   "status": "1",
   "inventoryItems": [
   {
     "companyProductId": 999999,
     "orderItemId": 9999999,
     "grade": "60 Cm",
     "productDescription": "Agapanthus Blue Crme de la Crme 60 Cm",
     "quantity": 85,
     "totalUnits": 12240,
     "growerId": 21738,
     "growerName": "Follajes La Luna",
     "boxTypeId": 900,
     "boxTypeCode": "FB",
     "unitType": "Stem",
     "bunches": 12,
     "unitsPerBox": 144,
     "stemsBunch": 12,
     "inventoryDate": "2014-03-02",
     "price": 3.01389,
     "sellFast": false,
     "isAssorted": false,
     "category": "Agapanthus",
     "awb": "131322",
     "unitCost": 2,
     "landedCost": 2.17,
     "reference": "text for reference",
     "lotNumber": "4308",
     "markCode": "text for mark code",
     "aging": 10,
     "breakdowns": [ 
       {
          "assorteCompositionId": 9999,
          "productDescription": "text for product description", 
          "productId": 99999,
          "bunches": 10,
          "stemsBunch": 12,
          "cost": 0.56,
          "price": 1.25 
        }
      ]
   }
 ]
}