product.list

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

Request

URL: 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. Keep these in mind when using filters:

Filtering by ID and Legacy Code uses an exact match.
Filtering by description uses a "LIKE" expression.
Filters are not case-sensitive.

curl

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): The product variety.
- color (string:200): The color of the product.
- grade (string:200): Grade or Length.
- legacyCode (string:20): Product Code or Legacy Code.
- tags (string:200): Tags associated with the product separated by a comma.

Sample Response

{
    "status": "1",
    "message": "OK",
    "products": [
            {
                "id": "1",
                "description": "Product description I",
                "category": "Category I",
                "divisionId": "1",
                "divisionDescription": "Flowers",
                "variety": "Variety I",
                "color": "Color I",
                "grade": "Grade I",
                "legacyCode": "LH001",
                "tags": "standard,xmas"
            }
            ,
            {
                "id": "2",
                "description": "Product description II",
                "category": "Category II",
                "divisionId": "1",
                "divisionDescription": "Plants",
                "variety": "Variety II",
                "color": "Color II",
                "grade": "Grade II",
                "legacyCode": "LH002",
                "tags": "standard"
            }
    ]
}

Valid Tokens: Company and Vendor.

Knowledge Base