Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Returns a list of products ordered by the product description.

Request

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

Input parameters:

  • authenticationToken (required): Komet Sales security token.
  • id: Internal product id. This field is very useful in other methods.
  • description: Product description.

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

Response

Output:

  • status
  • message
  • products: array of products
    • id
    • description
    • category
    • variety
    • color
    • grade
    • legacyCode
    • active

 

 

 

{
    "status": "1",
    "message": "OK",
    "products": [
            {
                "id": "1",
                "description": "Product description I",
                "category": "Category I",
                "variety": "Variety I",
                "color": "Color I",
                "grade": "Grade I",
                "legacyCode": "LH001"
            }
            ,
            {
                "id": "2",
                "description": "Product description II",
                "category": "Category II",
                "variety": "Variety II",
                "color": "Color II",
                "grade": "Grade II",
                "legacyCode": "LH002"
            }
    ]
}
  • No labels