Get a Category List

Use this method to get a list of categories.

Valid Tokens: Company.


Request


URL: https://api.kometsales.com/api/category.list

Method: GET

Content-Type: URL Parameters


Header

authenticationToken (required)(string:50)

Komet Sales security token.


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

 

 

Response


categoryItems (array)

An array of categories.


categoryId (integer:20)

Internal Komet Sales category ID.


categoryName (string:200)

Category name.


kometNetworkId (integer:5)

Komet Network Category ID.


kometNetworkName(string:20)

Komet Network Product name.


active(boolean)

If the Category is active.

Valid values: True = Active | False = Inactive


message (string:500)

Transaction status description.


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


{ "categoryItems": [ { "categoryId": 11453, "categoryName": "Achillea", "kometNetworkId": 16064, "kometNetworkName": "Achillea", "active": false }, { "categoryId": 15709, "categoryName": "Adhesive", "kometNetworkId": null, "kometNetworkName": null, "active": false }, { "categoryId": 11454, "categoryName": "Agapanthus", "kometNetworkId": 7322, "kometNetworkName": "Agapanthus", "active": false }, { "categoryId": 16095, "categoryName": "Agapanthus 2", "kometNetworkId": 7322, "kometNetworkName": "Agapanthus", "active": false }, { "categoryId": 16043, "categoryName": "Agapanthus Blue", "kometNetworkId": 7322, "kometNetworkName": "Agapanthus", "active": false }, { "categoryId": 16046, "categoryName": "Agapanthus White", "kometNetworkId": null, "kometNetworkName": null, "active": false }, { "categoryId": 15736, "categoryName": "Allium", "kometNetworkId": null, "kometNetworkName": null, "active": false }, { "categoryId": 7410, "categoryName": "Alstro", "kometNetworkId": null, "kometNetworkName": null, "active": false }, { "categoryId": 11455, "categoryName": "Amaryllis", "kometNetworkId": null, "kometNetworkName": null, "active": false }, { "categoryId": 8110, "categoryName": "Anemone", "kometNetworkId": null, "kometNetworkName": null, "active": false } ], "message": "OK" }

 


Peacock