Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
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.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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.
| Code Block | |
|---|---|
|
...
|
...
| ||
{ "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" } , { "id": "2", "description": "Product description II", "category": "Category II", "divisionId": "1", "divisionDescription": "Plants", "variety": "Variety II", "color": "Color II", "grade": "Grade II", "legacyCode": "LH002" } ] } |