Retrieve the list of product categories.
Categories are a way of categorizing your product database, and several API calls support filtering by category.
Products can additionally be organized into groups (getProductGroups, hierarchical), brands (getBrands, a flat list) and priority groups (getProductPriorityGroups, a flat list).
Note: PIM API offers a REST interface for retrieving and managing product categories.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| parentCategoryID | integer | ||
| searchAttributeName | Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. | string | |
| searchAttributeValue | Attribute value to search for. Error 1030 will be returned if value is an array. | string | |
| changedSince | Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. | Integer (Unix timestamp) | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| productCategoryID | integer | |||||||||||||
| parentCategoryID | integer | |||||||||||||
| productCategoryName | string | |||||||||||||
| attributes | array | Array of attributes. Each item looks like this:
|
||||||||||||
| added | integer | Unix timestamp. Creation time. | ||||||||||||
| lastModified | integer | Unix timestamp. Last modification time. |