Search

getProductCategories

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)

Input parameters

Parameter nameDescriptionPossible valueRequired
parentCategoryIDInteger
searchAttributeNameName of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified.String
searchAttributeValueAttribute value to search for.String
changedSinceRetrieve 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)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
productCategoryIDInteger
parentCategoryIDInteger
productCategoryNameString
attributesArrayArray of attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value
addedUnix timestampCreation time.
lastModifiedUnix timestampLast modification time.