Appearance
Request body
JSON
{
"aggregations": {
"attribute1": {
"size": 12345
},
"attribute1Group": {
"size": 12345
},
"attribute2": {
"size": 12345
},
"attribute2Group": {
"size": 12345
},
"attribute3": {
"size": 12345
},
"attribute3Group": {
"size": 12345
},
"brand": {
"size": 12345
},
"category": {
"size": 12345
},
"property": {
"size": 12345
}
},
"categoryId": 12345,
"categoryUUID": "...",
"countryCode": "...",
"countryId": 12345,
"customerReducedPricePercentage": 12345,
"customerType": "...",
"daysAsNew": 12345,
"filter": {
"attribute1Ids": [
12345,
12345
],
"attribute1Tags": [
"...",
"..."
],
"attribute2Ids": [
12345,
12345
],
"attribute2Tags": [
"...",
"..."
],
"attribute3Ids": [
12345,
12345
],
"attribute3Tags": [
"...",
"..."
],
"brandIds": [
12345,
12345
],
"brandTags": [
"...",
"..."
],
"categoryIds": [
12345,
12345
],
"europeanArticleNumbers": [
"...",
"..."
],
"priceRange": {
"from": 12345,
"to": 12345
},
"priceType": "...",
"properties": [
{
"keyName": "...",
"valueIds": [
12345,
12345
]
}
],
"propertyTags": [
{
"keyName": "...",
"valueTags": [
"...",
"..."
]
}
]
},
"from": 12345,
"helloRetailData": {
"filters": {
"property1": {
},
"property2": {
}
},
"sort": [
"...",
"..."
],
"trackingUserId": "...",
"url": "..."
},
"includeAllVariants": true,
"includeCustomerCategoryOffers": true,
"includeProperties": true,
"languageId": 12345,
"mediaRowIds": [
12345,
12345
],
"preview": true,
"priceListIds": [
12345,
12345
],
"productNumbers": [
"...",
"..."
],
"productSources": [
{
"attribute1Id": 12345,
"productId": 12345
}
],
"requireBalance": true,
"requireBalancesForRelatedProducts": true,
"requireMedia": true,
"requireMediaForRelatedProducts": true,
"requireStoreBalances": true,
"serviceProviderConfigId": 12345,
"size": 12345,
"sort": "...",
"splitByAttribute1": true,
"stockKeepingUnitStatusExclusions": [
"..."
]
}
Response
Product list was fetched successfully
JSON
{
"aggregations": {
"attribute1": {
"buckets": [
{
"count": 12345,
"item": {...}
}
]
},
"attribute2": {
"buckets": [
{
"count": 12345,
"item": {...}
}
]
},
"attribute3": {
"buckets": [
{
"count": 12345,
"item": {...}
}
]
},
"brand": {
"buckets": [
{
"count": 12345,
"item": {...}
}
]
},
"category": {
"buckets": [
{
"count": 12345,
"item": {...}
}
]
},
"lowestPrice": {
"average": 12345,
"maximum": 12345,
"minimum": 12345
},
"property": [
{
"buckets": [
{...}
],
"keyName": "..."
}
]
},
"products": [
{
"articleStatus": "...",
"attribute1Id": 12345,
"attribute1IdToDisplay": 12345,
"brand": {
"brandId": 12345,
"brandName": "...",
"category": {
"linkFriendlyName": "..."
},
"media": {
"dimensions": {...},
"fileName": "..."
}
},
"brandNew": true,
"comingSoon": true,
"linkFriendlyName": "...",
"lowestPriceWithinPeriod": 12345,
"media": [
{
"alternativeText": "...",
"attribute1Id": 12345,
"attribute2Id": 12345,
"attribute3Id": 12345,
"description": "...",
"dimensions": {...},
"fileName": "...",
"mediaId": 12345,
"mediaType": "...",
"presentationType": "...",
"sort": 12345
}
],
"meta": {
"description": "...",
"title": "..."
},
"offers": [
{
"alternativeOfferName": "...",
"customerType": 12345,
"description": "...",
"offerId": 12345,
"offerName": "...",
"offerTypeId": 12345,
"parameters": [...],
"properties": [...],
"stockKeepingUnitIds": [...]
}
],
"preview": true,
"priceCampaigns": [
{
"alternativeCampaignName": "...",
"campaignName": "...",
"customerType": 12345,
"description": "...",
"offerTypeId": 12345,
"parameters": [...],
"priceCampaignId": 12345,
"properties": [...],
"stockKeepingUnitIds": [...]
}
],
"productId": 12345,
"productName": "...",
"productNumber": "...",
"productType": "...",
"productUUID": "...",
"properties": [
{
"description": "...",
"group": "...",
"internalKeyName": "...",
"keyName": "...",
"usedForFilter": true,
"values": [...]
}
],
"providerData": {
"property1": {
},
"property2": {
}
},
"publishDate": "...",
"shortDescription": "...",
"stock": {
"incoming": true,
"incomingAt": "2025-06-01",
"physicalStore": "...",
"web": "..."
},
"stockKeepingUnits": [
{
"attribute1": {...},
"attribute2": {...},
"attribute3": {...},
"balance": 12345,
"brandNew": true,
"closestEstimatedShippingDate": "...",
"comingSoon": true,
"dimensions": {...},
"europeanArticleNumber": "...",
"price": {...},
"priceLookUpNumber": "...",
"properties": [...],
"publishDate": "...",
"status": "...",
"stock": {...},
"stockKeepingUnitId": 12345
}
],
"subscriptionTemplates": [
{
"linkFriendlyName": "...",
"longDescription": "...",
"shipmentPlan": [...],
"shortDescription": "...",
"subscriptionTemplateId": 12345,
"templateName": "...",
"useAttribute1": "...",
"useAttribute2": "...",
"useAttribute3": "..."
}
]
}
],
"sort": {
"descending": true,
"resolvedSort": "...",
"source": "..."
},
"sortOptions": {
"options": [
{
"group": "...",
"label": "...",
"selected": true,
"value": "..."
}
],
"provider": "..."
},
"total": 12345
}