Endpoint - Get Categories
Endpoint which returns a list of categories. This is called e.g. when configurator categories window is first opened, or when categories are refreshed by customer.
Endpoint which returns a list of categories. This is called e.g. when configurator categories window is first opened, or when categories are refreshed by customer.
Request
Post
ProductCategoriesRequest
ProductCategoriesRequest
Field Name | Type | Description |
---|---|---|
AuthorizationToken | String | Authorization Token from the customers integration. |
PageNumber | Integer | Will start with 1 and if more pages are required to return categories, will increase by 1. |
Sample
{
"AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
"PageNumber": 1
}
Response
ProductCategoriesResponse
ProductCategoriesResponse
Field Name | Type | Description |
---|---|---|
HasMorePages | Boolean | If true is returned, then new category request will be made with increased PageNumber. |
Categories | ListingCategory[] | See ListingCategory table. List of categories for the provided page number and customer. |
Error | String | Defines if there was an error with the request and returns it. |
ListingCategory
ListingCategory
Field Name | Type | Description |
---|---|---|
CategoryId | Long | Category ID. |
CategoryName | String | Category Name |
Sample
{
"HasMorePages": false,
"Categories": [
{
"CategoryId": 17,
"CategoryName": "Boots"
},
{
"CategoryId": 18,
"CategoryName": "Flip-flops"
}
]
}
Updated over 1 year ago