GET v1/store/categories/{categoryID}
Gets the category by its unique ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| categoryID |
The unique ID of the category. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a category for the requested unique ID. Throws an exception if the requested category does not contain online products on any level.
CategoryExtendedModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SeoConfiguration |
The SEO configuration. |
SeoConfigurationModel |
None. |
| ID |
The unique ID of the category. |
globally unique identifier |
None. |
| FriendlyID |
The friendly ID of the category. |
integer |
None. |
| Name |
The name of the category. |
string |
None. |
| Description |
The description of the category. |
string |
None. |
| HasProducts |
Indicates whether the category contains at least one online product. |
boolean |
None. |
| HasSubCategories |
Indicates whether the category contains at least one sub-category, of any level, that has an online product. |
boolean |
None. |
| ImageUrl |
The URL of the category image. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SeoConfiguration": {
"Title": "sample string 1",
"Description": "sample string 2"
},
"ID": "58490566-0a6f-44ab-8f9e-47fdb1e16b64",
"FriendlyID": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"HasProducts": true,
"HasSubCategories": true,
"ImageUrl": "sample string 7"
}