Get Search Seller Product

The API searches the products the seller owns. Returns all matching search key. for eg: /products/search?key=mobile will result in all products matching mobile attribute entries.

📘

note

If searchKey is not provided, it will default to null and all results will be returned.
Default pageSize = 10
Default pageNumber = 1

Request

ParameterNameDataTypeParameterTypeRequirementDescription
searchKeyStringQueryOptionalsearch query (filter)
categoryIdsStringQueryOptionalcomma separated subcategory ids (filter)
brandIdsStringQueryOptionalcomma separated brand ids (filter)
pageNumberintQueryOptionalpageNumber used for pagination
pageSizeintQueryOptionalpageSize used for pagination
activebooleanQueryOptionalactive

Response

metadata :

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

payload :

FieldNameDataTypeDescription
supcDetailsListsupcDetails
categorySummaryListcategorySummary
brandSummaryListbrandSummary
currentPagelongcurrentPage
pageSizelongpageSize

SUPCDetailSRO :

FieldNameDataTypeDescription
supcStringsupc
productNameStringproductName
categoryNameStringcategoryName
brandNameStringbrandName
soldBySellerBooleanproduct is soldBySeller or not
competitivePriceIntegercompetitivePrice
pageUrlStringpageUrl
imageUrlStringimageUrl
bucketNameStringbucketName
attributesListattributes
fulfilmentModeStringfulfilmentMode
sellerSKUStringsellerSKU

AttributeDTO :

FieldNameDataTypeDescription
nameStringattribute name
valueStringattribute value

ProductCategoryDTO :

FieldNameDataTypeDescription
idIntegerid
nameStringname
subCategoriesListsubCategories
countlongcount
parentIdIntegerparentId
parentNameStringparentName

ProductBrandDTO :

FieldNameDataTypeDescription
idIntegerid
nameStringname
countLongcount
Language
Authorization