Get Search for category

This API allows you to search a category by name. The response is structured to the level depending upon what is the sub-cat or product that results in search.

📘

Note

Default pageSize = 10
Default pageNumber = 1

Request

ParameterNameDataTypeParameterTypeRequirementDescription
searchKeyStringQueryMandatorysearchKey
pageSizeintQueryOptionalpageSize used for pagination
pageNumberintQueryOptionalpageNumber used for pagination

Response

metadata :

FieldNameDataTypeDescription
requestIdStringUnique ID for the request
clientIdStringPartnerI Id
responseTimeLongResponse Time
requestedURIStringRequested URI
messageStringError message

payload :

FieldNameDataTypeDescription
resultsListList of CategoryDTOs
pageNumberintpage Number
pageSizeintpage Size

CategoryDTO :

FieldNameDataTypeDescription
idIntegerCategory Id
nameStringCategory Name
productTypebooleanvalue false means category contains child categories.
categoryUrlStringcategoryUrl
parentCategoryCategoryDTOparentCategory
Language
Authorization