Overview


This method returns a list of products ordered by the product description.

 


Request

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

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

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • id (optional)(integer:20): Komet Sales internal product ID.
  • description (optional)(string:200): product description.
  • legacyCode (optional)(string:50): product legacy code.

You can send other parameters such as the ID and description in order to filter the results. Filtering by ID and Legacy Code uses an exact match. Filtering by description uses a "LIKE" expression. Filters are not case sensitive.

Sample
https://api.kometsales.com/api/product.list?authenticationToken=token_info_goes_here

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • products: array of products.
    • id (integer:20): Komet Sales internal product ID.
    • description (string:200): description of the product.
    • active (boolean:1): 1 if the product is active, 0 if the product is not active.
    • category (string:200): category name.
    • divisionId (integer:20): category division internal ID.
    • divisionDescription (string:20): category division name. (FreshCutFlowers, Plants or Hard Goods).
    • variety (string:200): variety of the product.
    • color (string:200): color of the product.
    • grade (string:200): grade or length.
    • legacyCode (string:20): product code or legacy code.
    • tags (string:200): Tags associated to the product separated by comma.