Overview


This method returns a list of the inventory displayed on e-commerce for a given customer. This method includes all the inventories based on the setup of the company: On Hand, Future and Vendor Availability in Boxes.

Request

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

  • Method: GET
  • Content-Type: URL Params.

Header

  • X-SALES-CHANNEL (optional) (string: 20): Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 
  • X-ACCOUNT (required)(integer:20): Company ID that is using the API. Please ask Komet Sales team to have this ID. 
  • authenticationToken (required)(string:50): Komet Sales security token.

Input parameters:

  • customerId (required)(integer:20): customer ID, used to search the inventory based on the configuration for the customer. You can obtain this value from the customer.list API method.
  • companyLocationId (integer:20). Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.
  • availableDate (date) (date format YYYY-MM-DD). The date when the product is available. Leaving this field empty, the system will search for inventory available from the current date up to 2 months in the future. Use this filter only if you want to search for Open Market inventory.
  • page (integer:20): the paging number where you want to place. If this value is not given, the system will return only the first page with 30 records. 
  • rows (integer:20): the number of rows that each page will display. If this number is not given, the system will return only 30 records. 
  • searchText (String): a field for searching for a product by its description.
  • categoryId (integer:20): Komet Sales internal category ID. You can obtain this value from the category.list API method.
  • color (string): a field for searching for products by color.
  • inventoryOrigin (integer: 1): Number that identifies the type of the inventory. 1 = Open Market, 2 = Future Sales, 4 = K2K. 
  • separateLines (boolean): If this value is given in true, the system will separate all the inventory lines one by one. By default it's false, this means that the system will consolidate all the similar inventory lines into one single line. 


Sample
https://api.kometsales.com/api/ecommerce/inventory.list?
customerId=7349&page=1&rows=28&
companyLocationId=13 -H authenticationToken=token_info_goes_here

Response

Output:

    • message (String):  description of the transaction status.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • total (integer:20): the total of records found.
    • inventoryItems (array): array of inventory items available in the inventory. 
      • id (integer: 20): Number that identifies the row between all the records of the result. Starts with 0 and it is auto-incremental. 
      • inventoryLineIds (string: 200): List of inventory IDs that belongs to the line. 
      • inventoryOrigin (integer:1): Number that identifies the type of the inventory. 1 = Open Market, 2 = Future Sales, 4 = K2K. 
      • productDescription (string: 200): Product description. 
      • productId (integer: 20): Internal Komet Sales product ID. 
      • color (string: 50): Color of the product.
      • variety (string:100): variety of the product.
      • category (string: 50): Category name of the product. 
      • categoryId (integer: 20): Category Id.
      • price (decimal: 10,3): Unit price. 
      • unitType (string: 10): Stem or Bunch. 
      • units (integer: 10): Number of stems per bunch. 
      • bunches (integer: 10): Number of bunches per box.
      • quantity (integer:20): number of available boxes.
      • vendor (string: 50): vendor name of code.
      • growerOriginCode (string: 5): The origin code of the vendor (UIO, MDE, BOG, etc). 
      • companyProductId (integer:20): ID of the product. 
      • pack (integer: 10): Number of units per box. 
      • totalBunches (integer: 10): Total bunches available. 
      • totalUnits (integer: 10): Total units available, based on the Unit Type. 
      • itemSizeCode (string: 3): Box type code (HB, QB, FB, etc). 
      • isAssorted (boolean): true if the product is assorted.
      • companyLocationId (integer: 20): Id the location. Only applies for companies in Multi Location mode. 
      • sellFast (boolean): true if the product was marked as Sell Fast. 
      • productImageUrl (string): URL for the product image. 
      • availableFrom (date): Date when the product is available from. Date format: YYYY-MM-DD.  
      • availableFromCalculated (date): First date when the product is available from based on the rules applied for the customer and the date range between the fields availableFrom and availableTo. Date format: YYYY-MM-DD. 
      • availableTo (date): Date when the product is available to. Date format: YYYY-MM-DD. 
      • unableToBuy (string: 50): Any reason that indicates that the product cannot be bought. 
      • carrierId (integer: 20): Suggested carrier ID for the first day available. 
    • categoriesList (array): array of categories available in the inventory. 
      • categoryId (integer:20): Id of the category.
      • categoryName (string:20): Name of the category.
    • colorsList (array): array of product colors available in the inventory.