Get a Product List
- Andres Toledo
Use this method to get a list of products ordered by product description.
Valid Tokens: Company and Vendor.
Take the following statements into account when applying filters:
Filtering by
idandlegacyCodeuses an exact match.Filtering by
descriptionuses a "LIKE" expression.Filters are not case-sensitive.
Related Articles
-
Add a Carrier (API)
-
-
-
-
Request
URL: https://api.kometsales.com/api/product.list
Method: GET
Content-Type: URL Parameters
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.
https://api.kometsales.com/api/product.list?
authenticationToken=token_info_goes_hereResponse
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
products (array)
An array containing products.
id (integer:20)
Komet Sales internal Product ID.
description (string:200)
Product description.
active (boolean:1)
If the product is active.
Valid values: 1 = Active | 0 = Inactive
category (string:200)
Category name.
divisionId (integer:20)
Komet Sales internal Category Division ID.
divisionDescription (string:20)
Category division name.
variety (string:200)
Product variety.
color (string:200)
Product color.
grade (string:200)
Product Grade or Length.
legacyCode (string:20)
Product Code or Legacy Code.
tags (string:200)
Tags associated with the product separated by a comma.
{
"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"
}
]
}