Get Search All Products

This API is required when list an existing products. The seller can search existing products from other sellers and add to his portfolio.

📘

note

The response will have boolean attribute soldBySeller indicating the given product is sold by the requesting seller.
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
activebooleanQueryOptionalSearch onlly live products or not

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

AttributeDTO :

FieldNameDataTypeDescription
nameStringattribute name
valueStringattribute value

ProductCategoryDTO :

FieldNameDataTypeDescription
idIntegerid
nameStringname
subCategoriesListsubCategories
countlongcount
parentIdIntegerparentId
parentNameStringparentName

ProductBrandDTO :

FieldNameDataTypeDescription
idIntegerid
nameStringname
countLongcount
Language
Authorization