GET v1/store/categories?pageNumber={pageNumber}&pageSize={pageSize}
Gets the top level product categories of a store, using pagination.
Categories that do not contain online products on any level are filtered out.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageNumber |
The requested page number. |
integer |
Optional. Default value is 1 |
| pageSize |
The number of categories on a single page. The maximum is 200. |
integer |
Optional. Default value is 50 |
Body Parameters
None.
Response Information
Resource Description
Returns a list of product categories according the requested parameters.
CategoryListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Categories |
The list of the product categories according to the pagination. |
Collection of CategoryModel |
None. |
| Count |
The total number of product categories without pagination. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Categories": [
{
"ID": "32af7316-0f89-4133-bc38-cb1f10d349fe",
"FriendlyID": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"HasProducts": true,
"HasSubCategories": true,
"ImageUrl": "sample string 7"
},
{
"ID": "32af7316-0f89-4133-bc38-cb1f10d349fe",
"FriendlyID": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"HasProducts": true,
"HasSubCategories": true,
"ImageUrl": "sample string 7"
}
],
"Count": 1
}