Download OpenAPI specification:Download
Welcome to the Developer Portal for the SmartWithFood Product API. This API provides access to a rich database of products, enabling you to seamlessly integrate product-related information into your applications, websites, and services. Whether you are building an e-commerce platform, a logistics solution, or a product comparison site, our API has you covered.
On this developer portal you find the API specifications including a short description of every field, a request example and a response example for every endpoint, and security information, as well as information about the non-functional requirements you can expect from our API is provided. Furthermore, you can find information on how to get started using our API and on who to contact when you are in need of further assistance.
Follow the following steps to easily get started with our Product API.
Should you have any questions or need further assistance, please do not hesitate to contact our support team at at support@smartwithfood.com or at https://smartwithfood.atlassian.net/servicedesk/customer/portal/6.
The change log in our API developer portal serves as a chronological record detailing updates, enhancements, and modifications to the API, offering developers a transparent history of changes and version releases for improved clarity and understanding.
Modified 'warehouses' request parameter
Added new endpoints
Added new functionalities to the POST /search
Modified 'article' object
Modified 'article' promotions object
Modified 'trade item' object
Modified 'warehouses' request parameter
Added new endpoints
Added new functionalities to the POST /search
Modified 'article' object
Modified 'article' promotions object
Modified 'trade item' object
We are committed to providing you with a seamless and reliable experience when integrating our API into your applications. Below you can find the non-functional requirements you can expect from our API.
Suggest endpoint
All other endpoints
Our API aims for an availability of 99.9%. This translates to approximately 8.5 hours of planned downtime per year.
Normal Circumstances
Peak Circumstances
With this Product API you can access information about articles and trade items. Trade items comprise information associated with the GTIN (Global Trade Item Number) and are therefore not retailer specific. Articles comprise the merged information of a collection of trade items that are sold as one article and are therefore retailer specific. Information that can be consulted on trade item level, but not on article level, includes logistic information and storage information. Information that can be consulted on article level, but not on trade item level, includes prices, promotions and warehouses.
On article level, following methods and endpoints can be used:
On trade item level, following methods and endpoints can be used:
Check if the Product API is available
Succesful operation.
Resource not found.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "title": "Not Found",
- "status": 404,
- "detail": "The requested path was not found",
- "instance": "/recipe/v1/productise"
}
Retrieve a relevance based list of articles, based on search criteria
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "page": 1,
- "limit": 25,
- "channel": "CLP",
- "facets": [
- [
- {
- "identifier": "allergens",
- "keys": [
- "lactoseFree",
- "glutenFree"
]
}, - {
- "identifier": "lifestyles",
- "keys": [
- "veganism",
- "halal"
]
}, - {
- "identifier": "categories",
- "keys": [
- "554",
- "223"
]
}, - {
- "identifier": "brands",
- "keys": [
- "boni",
- "danone"
]
}, - {
- "identifier": "nutriScore",
- "keys": [
- "A",
- "B"
]
}, - {
- "identifier": "ecoScore",
- "keys": [
- "A",
- "B"
]
}, - {
- "identifier": "isPrivateLabel"
}, - {
- "identifier": "inPromo"
}, - {
- "identifier": "inAction"
}, - {
- "identifier": "userMostBought"
}, - {
- "identifier": "labels",
- "keys": [
- "isNew",
- "inSeason",
- "addedSugars",
- "sugarFree",
- "lowSugar"
]
}, - {
- "identifier": "prices",
- "range": {
- "min": 0,
- "max": 20
}
}
]
], - "q": "kaas met gaten",
- "identifiers": [
- "technicalArticleNumber:1515454",
- "commercialArticleNumber:7654321"
], - "warehouses": [
- "branchId:7863",
- [
- "bannerCode:CO",
- "countryCode:BE",
- "branchType:HANDOVER_POINT"
], - [
- "bannerCode:2B",
- "sellingPartner:CLPBE"
]
], - "brands": [
- "Boni Selection",
- "Danone"
], - "allergens": {
- "must": [
- "gluten",
- "ACADA715-3842-11EA-BA36-6E1C41F2F90A"
], - "mustNot": [
- "nuts",
- "ACFA978A-3842-11EA-BA36-6E1C41F2F90A"
]
}, - "lifestyles": {
- "must": [
- "veganism",
- "0A06EFC4-3843-11EA-BA36-6E1C41F2F90A"
], - "mustNot": [
- "halal",
- "09F0E916-3843-11EA-BA36-6E1C41F2F90A"
]
}, - "preferences": {
- "must": [
- "garlic",
- "8E695CB0-A945-11EC-BBC8-995808538238"
], - "mustNot": [
- "preservatives",
- "856FD8A0-A945-11EC-BBC8-995808538238"
]
}, - "customerId": "1234585",
- "select": [
- "id",
- "name",
- "brand"
], - "mediaSizes": [
- "small",
- "100x100"
], - "sort": [
- "price:B:asc",
- "measurementUnitPrice:B:desc",
- "ecoscore:desc",
- "nutriscore:asc",
- "promotions:asc",
- "isNew:desc"
], - "customFields": [
- "6B563C81-995D-4B4F-AF3D-00654EF5353F:87654",
- "replacementArticle:87654"
]
}
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "articles": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
], - "relevance": {
- "name": "exactMatch",
- "position": 1
}
}
], - "facets": [
- [
- {
- "identifier": "categories",
- "type": "select",
- "count": 1056,
- "order": 0,
- "children": [
- {
- "key": "543",
- "name": {
- "text": "Conserven",
- "language": "nl"
}, - "count": 565,
- "order": 0,
- "children": [
- {
- "key": "654",
- "name": {
- "text": "Groentenconserven",
- "language": "nl"
}, - "count": 342,
- "order": 0,
- "children": [
- {
- "key": "322",
- "name": {
- "text": "Olijven",
- "language": "nl"
}, - "count": 13,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "key": "655",
- "name": {
- "text": "Fruitconserven",
- "language": "ml"
}, - "type": "select",
- "count": 156,
- "order": 1,
- "children": [
- {
- "key": "873",
- "name": {
- "text": "Ananas",
- "language": "nl"
}, - "count": 12,
- "order": 1,
- "children": [ ]
}
]
}
]
}
]
}, - {
- "identifier": "allergens",
- "type": "select",
- "order": 1,
- "children": [
- {
- "key": "lactoseFree",
- "count": 321,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "lifestyles",
- "type": "select",
- "order": 2,
- "children": [
- {
- "key": "halal",
- "count": 281,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "brands",
- "type": "select",
- "order": 3,
- "children": [
- {
- "key": "danone",
- "name": {
- "text": "Danone",
- "language": "nl"
}, - "count": 432,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "nutriScore",
- "type": "select",
- "order": 4,
- "children": [
- {
- "key": "A",
- "count": 125,
- "order": 0,
- "children": [ ]
}, - {
- "key": "B",
- "count": 126,
- "order": 1,
- "children": [ ]
}
]
}, - {
- "identifier": "ecoScore",
- "type": "select",
- "order": 5,
- "children": [
- {
- "key": "A",
- "count": 129,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "isPrivateLabel",
- "count": 87,
- "order": 6,
- "children": [ ]
}, - {
- "identifier": "inPromo",
- "count": 234,
- "order": 7,
- "children": [ ]
}, - {
- "identifier": "userMostBought",
- "count": 345,
- "order": 8,
- "children": [ ]
}, - {
- "identifier": "inAction",
- "count": 342,
- "order": 9,
- "children": [ ]
}, - {
- "identifier": "labels",
- "count": 654,
- "order": 10,
- "children": [
- {
- "key": "isNew",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "inSeason",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "addedSugars",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "sugarFree",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "lowSugar",
- "count": 281,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "prices",
- "type": "range",
- "order": 11,
- "range": {
- "min": 5,
- "max": 6
}, - "children": [ ]
}
]
], - "ironStock": true
}
Get product suggestions based on user input. This endpoint offers real-time suggestions to enhance the user experience and improve search accuracy.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "suggestions": [
- {
- "suggestion": "apple"
}
]
}
Retrieve all articles of a specific warehouse.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "articles": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
]
}
]
}
Create a new article.
The article has been created successfully.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "name": [
- {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}
], - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "brand": [
- {
- "language": "nl",
- "text": "Danone"
}
], - "brands": [
- {
- "brand": [
- {
- "language": "nl",
- "text": "Danone"
}
], - "order": 1
}
], - "media": [
- {
- "type": "product image full front",
- "size": "100x100",
- "language": "nl",
- "title": "Cream cheese on toast.",
- "description": "This image shows an example of how to use cream cheese in a recipe."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "servings": 5,
- "amount": 250,
- "amountUnit": "g",
- "isWeightArticle": true,
- "isPrivateLabel": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "description": [
- {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}
], - "identifiers": [
- {
- "identifier": "commercialArticleNumber",
- "value": 65433
}
], - "tradeItems": [
- "04008789053381",
- "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d"
], - "warehouses": [
- "bannerCode:CO"
], - "allergens": [
- {
- "identifier": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "identifier": "halal",
- "value": "true"
}
], - "labels": [
- [
- "countriesOfOrigin:Gambia",
- "inSeason"
]
], - "customFields": [
- {
- "identifier": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "value": "web"
}, - {
- "identifier": "visibleOn",
- "values": [
- "web",
- "mobile"
]
}
]
}
{- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
]
}
Get detailed information about a specific article by providing its unique identifier.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
]
}
Delete a specific article by providing its unique identifier.
No Content - Delete is processed.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Validation Error",
- "instance": "/productize",
- "invalidParams": [
- {
- "in": "query",
- "name": "limit",
- "reason": "limit must not be greater than 100",
- "value": 101
}
]
}
Update an existing article.
The article has been updated successfully.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "name": [
- {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}
], - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "brand": [
- {
- "language": "nl",
- "text": "Danone"
}
], - "brands": [
- {
- "brand": [
- {
- "language": "nl",
- "text": "Danone"
}
], - "order": 1
}
], - "media": [
- {
- "type": "product image full front",
- "size": "100x100",
- "language": "nl",
- "title": "Cream cheese on toast.",
- "description": "This image shows an example of how to use cream cheese in a recipe."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "servings": 5,
- "amount": 250,
- "amountUnit": "g",
- "isWeightArticle": true,
- "isPrivateLabel": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "description": [
- {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}
], - "identifiers": [
- {
- "identifier": "commercialArticleNumber",
- "value": 65433
}
], - "tradeItems": [
- "04008789053381",
- "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d"
], - "warehouses": [
- "bannerCode:CO"
], - "allergens": [
- {
- "identifier": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "identifier": "halal",
- "value": "true"
}
], - "labels": [
- [
- "countriesOfOrigin:Gambia",
- "inSeason"
]
], - "customFields": [
- {
- "identifier": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "value": "web"
}, - {
- "identifier": "visibleOn",
- "values": [
- "web",
- "mobile"
]
}
]
}
{- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
]
}
Retrieve alternative articles related to a specific product. This endpoint suggests similar products as alternatives to the one specified.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "page": 1,
- "limit": 25,
- "warehouses": [
- "branchId:7863",
- [
- "bannerCode:CO",
- "countryCode:BE",
- "branchType:HANDOVER_POINT"
], - [
- "bannerCode:2B",
- "sellingPartner:CLPBE"
]
], - "allergens": {
- "must": [
- "gluten",
- "ACADA715-3842-11EA-BA36-6E1C41F2F90A"
], - "mustNot": [
- "nuts",
- "ACFA978A-3842-11EA-BA36-6E1C41F2F90A"
]
}, - "lifestyles": {
- "must": [
- "veganism",
- "0A06EFC4-3843-11EA-BA36-6E1C41F2F90A"
], - "mustNot": [
- "halal",
- "09F0E916-3843-11EA-BA36-6E1C41F2F90A"
]
}, - "preferences": {
- "must": [
- "garlic",
- "8E695CB0-A945-11EC-BBC8-995808538238"
], - "mustNot": [
- "preservatives",
- "856FD8A0-A945-11EC-BBC8-995808538238"
]
}, - "customerId": "1234585",
- "select": [
- "id",
- "name",
- "brand"
], - "mediaSizes": [
- "small",
- "100x100"
]
}
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "articles": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "nl",
- "text": "Vanille ijs 1kg"
}, - "names": [
- {
- "language": "nl",
- "text": "Vanille ijs",
- "type": "longNameDescription"
}
], - "description": {
- "language": "nl",
- "text": "Heerlijk Belgisch vanille ijs."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "commercialArticleNumber",
- "identifier": "30542"
}
], - "barcodes": [
- "04008789053381",
- "04008789753380"
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "brands": [
- {
- "brand": {
- "language": "nl",
- "text": "Danone"
}, - "order": 1
}
], - "warehouses": {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Name warehouse"
}, - "identifiers": [
- {
- "id": "T4A4CCP2-25BD-48C6-8382-782296AEB6PA",
- "type": "branchId",
- "identifier": "3873"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782296AEB6PA",
- "type": "countryCode",
- "identifier": "BE"
}, - {
- "id": "B4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "sellingPartner",
- "identifier": "CLP"
}, - {
- "id": "Z4A4CCA2-25BD-48C6-8382-782236AEB6DA",
- "type": "type",
- "identifier": "HANDOVER_POINT"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6PA",
- "type": "bannerCode",
- "identifier": "CO"
}, - {
- "id": "B4A4CCA2-65BD-48C6-8382-782296AEB6RC",
- "type": "commerceCode",
- "identifier": "COLRUYT"
}
], - "prices": [
- {
- "priceType": "reducedPrice",
- "currency": "EUR",
- "price": 5.99,
- "priceUnit": "kg",
- "measurementUnitPrice": 1.45,
- "measurementUnit": "l",
- "quantity": 5,
- "customFlag": "redPrice",
- "priceReason": "C",
- "referencePrice": 3.45,
- "retentionPeriod": 30
}
]
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "100x100",
- "language": "nl",
- "title": "Celery chopping",
- "description": "This image shows how to chop celery."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "allergens": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "gluten",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": "chocolate",
- "value": "present"
}
], - "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "promotions": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "type": "withEvery",
- "maxTimes": 2,
- "warehouses": [
- {
- "id": "d5958dda-df78-4fc2-8524-62f8867e0501",
- "startDate": "2022-07-13T15:34:16+0200",
- "endDate": "2023-07-13T15:34:16+0200",
- "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": "branchId",
- "identifier": "3873"
}
]
}
], - "benefits": [
- {
- "type": "percentage",
- "amount": 10,
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
], - "conditions": [
- {
- "limitUnit": "piece",
- "minLimit": 2,
- "maxLimit": 15,
- "sequence": 1
}
]
}
], - "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "isWeightArticle": true,
- "weightConversionFactor": 100,
- "orderUnits": [
- "P",
- "Kg",
- "P, Kg"
], - "isPrivateLabel": true,
- "labels": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "identifier": "Gambia",
- "name": {
- "language": "nl",
- "text": "Gambia"
}, - "channels": [
- "CLP"
]
}
]
}
]
}
Retrieve all facets or a selection of facets.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "channel": "CLP",
- "facetFilters": [
- [
- {
- "identifier": "allergens",
- "keys": [
- "lactoseFree",
- "glutenFree"
]
}, - {
- "identifier": "lifestyles",
- "keys": [
- "veganism",
- "halal"
]
}, - {
- "identifier": "categories",
- "keys": [
- "554",
- "223"
]
}, - {
- "identifier": "brands",
- "keys": [
- "boni",
- "danone"
]
}, - {
- "identifier": "nutriScore",
- "keys": [
- "A",
- "B"
]
}, - {
- "identifier": "ecoScore",
- "keys": [
- "A",
- "B"
]
}, - {
- "identifier": "isPrivateLabel",
- "keys": [ ]
}, - {
- "identifier": "inPromo",
- "keys": [ ]
}, - {
- "identifier": "inAction",
- "keys": [ ]
}, - {
- "identifier": "userMostBought",
- "keys": [ ]
}, - {
- "identifier": "inAction",
- "keys": [ ]
}, - {
- "identifier": "labels",
- "keys": [
- "isNew",
- "inSeason",
- "addedSugars",
- "sugarFree",
- "lowSugar"
]
}, - {
- "identifier": "prices",
- "range": {
- "min": 0,
- "max": 20
}
}
]
], - "warehouses": [
- "branchId:7863",
- [
- "bannerCode:CO",
- "countryCode:BE",
- "branchType:HANDOVER_POINT"
], - [
- "bannerCode:2B",
- "sellingPartner:CLPBE"
]
], - "customerId": "1234585"
}
{- "total": 30,
- "facets": [
- [
- {
- "identifier": "categories",
- "type": "select",
- "count": 1056,
- "order": 0,
- "children": [
- {
- "key": "543",
- "name": {
- "text": "Conserven",
- "language": "nl"
}, - "count": 565,
- "order": 0,
- "children": [
- {
- "key": "654",
- "name": {
- "text": "Groentenconserven",
- "language": "nl"
}, - "count": 342,
- "order": 0,
- "children": [
- {
- "key": "322",
- "name": {
- "text": "Olijven",
- "language": "nl"
}, - "count": 13,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "key": "655",
- "name": {
- "text": "Fruitconserven",
- "language": "ml"
}, - "type": "select",
- "count": 156,
- "order": 1,
- "children": [
- {
- "key": "873",
- "name": {
- "text": "Ananas",
- "language": "nl"
}, - "count": 12,
- "order": 1,
- "children": [ ]
}
]
}
]
}
]
}, - {
- "identifier": "allergens",
- "type": "select",
- "order": 1,
- "children": [
- {
- "key": "lactoseFree",
- "count": 321,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "lifestyles",
- "type": "select",
- "order": 2,
- "children": [
- {
- "key": "halal",
- "count": 281,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "brands",
- "type": "select",
- "order": 3,
- "children": [
- {
- "key": "danone",
- "name": {
- "text": "Danone",
- "language": "nl"
}, - "count": 432,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "nutriScore",
- "type": "select",
- "order": 4,
- "children": [
- {
- "key": "A",
- "count": 125,
- "order": 0,
- "children": [ ]
}, - {
- "key": "B",
- "count": 126,
- "order": 1,
- "children": [ ]
}
]
}, - {
- "identifier": "ecoScore",
- "type": "select",
- "order": 5,
- "children": [
- {
- "key": "A",
- "count": 129,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "isPrivateLabel",
- "count": 87,
- "order": 6,
- "children": [ ]
}, - {
- "identifier": "inPromo",
- "count": 234,
- "order": 7,
- "children": [ ]
}, - {
- "identifier": "userMostBought",
- "count": 345,
- "order": 8,
- "children": [ ]
}, - {
- "identifier": "inAction",
- "count": 342,
- "order": 9,
- "children": [ ]
}, - {
- "identifier": "labels",
- "count": 654,
- "order": 10,
- "children": [
- {
- "key": "isNew",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "inSeason",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "addedSugars",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "sugarFree",
- "count": 281,
- "order": 0,
- "children": [ ]
}, - {
- "key": "lowSugar",
- "count": 281,
- "order": 0,
- "children": [ ]
}
]
}, - {
- "identifier": "prices",
- "type": "range",
- "order": 11,
- "range": {
- "min": 5,
- "max": 6
}, - "children": [ ]
}
]
]
}
Retrieve all trade items.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "tradeItems": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "source": "PSS",
- "barcode": 4008789053381,
- "name": {
- "language": "nl",
- "text": "Leerdammer kaas met gaten"
}, - "description": {
- "language": "nl",
- "text": "Heerlijke kaas met gaten."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": null,
- "identifier": null
}
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "small",
- "language": "nl",
- "title": "Cream cheese on toast.",
- "description": "This image shows an example of how to use cream cheese in a recipe."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "isWeightArticle": true,
- "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
]
}
]
}
Get detailed information about a specific trade item by providing its unique identifier.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "source": "PSS",
- "barcode": 4008789053381,
- "name": {
- "language": "nl",
- "text": "Leerdammer kaas met gaten"
}, - "description": {
- "language": "nl",
- "text": "Heerlijke kaas met gaten."
}, - "identifiers": [
- {
- "id": "e62aaf74-86b7-4231-8c30-0dca7d5c4e7d",
- "type": null,
- "identifier": null
}
], - "brand": {
- "language": "nl",
- "text": "Danone"
}, - "media": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "type": "small",
- "language": "nl",
- "title": "Cream cheese on toast.",
- "description": "This image shows an example of how to use cream cheese in a recipe."
}
], - "ecoScore": "A",
- "nutriScore": "A",
- "servings": 5,
- "amount": 1,
- "amountUnit": "piece",
- "isWeightArticle": true,
- "customFields": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": false,
- "value": "web"
}, - {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": "select",
- "name": "visibleOn",
- "description": "Specifies if content is visible on web and/or mobile",
- "createdAt": "2022-07-13T15:34:16+0200",
- "modifiedAt": "2022-07-13T15:34:16+0200",
- "multipleOptions": true,
- "values": [
- "web",
- "mobile"
]
}
], - "ingredients": {
- "language": "nl",
- "text": "Water, perenmoes (42%), suiker, antioxidant (ascorbinezuur). Vruchtgehalte: 42%."
}, - "allergens": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "name": "gluten",
- "value": "present"
}
], - "subAllergens": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "name": "pecan nut",
- "value": "present"
}
], - "lifestyles": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "name": "halal",
- "value": "true"
}
], - "preferences": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "name": "chocolate",
- "value": "present"
}
], - "nutritionalsPer100Gram": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Suiker"
}, - "amount": {
- "value": 543254.4567,
- "unit": "SUGAR",
- "factor": 0.239
}, - "portion": {
- "value": 40,
- "unit": "g",
- "factor": 0.239
}, - "conversion": {
- "value": 1.38501,
- "unit": "g",
- "factor": 0.000001
}, - "createdAt": "2019-08-24T14:15:22Z",
- "modifiedAt": "2019-08-24T14:15:22Z"
}
], - "nutritionalsPerPortion": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Suiker"
}, - "amount": {
- "value": 543254.4567,
- "unit": "SUGAR",
- "factor": 0.239
}, - "portion": {
- "value": 40,
- "unit": "g",
- "factor": 0.239
}, - "conversion": {
- "value": 1.38501,
- "unit": "g",
- "factor": 0.000001
}, - "createdAt": "2019-08-24T14:15:22Z",
- "modifiedAt": "2019-08-24T14:15:22Z"
}
], - "nutritionalsPercentDailyIntake": [
- {
- "id": "e1b044ad-8998-45cd-962b-b0fd8ca7cc0d",
- "name": {
- "language": "nl",
- "text": "Suiker"
}, - "amount": {
- "value": 543254.4567,
- "unit": "SUGAR",
- "factor": 0.239
}, - "portion": {
- "value": 40,
- "unit": "g",
- "factor": 0.239
}, - "conversion": {
- "value": 1.38501,
- "unit": "g",
- "factor": 0.000001
}, - "createdAt": "2019-08-24T14:15:22Z",
- "modifiedAt": "2019-08-24T14:15:22Z"
}
], - "percentAlcohol": 4,
- "extraTextFields": [
- {
- "id": "61c5bf4b-fbcf-48d0-ae21-34c9bb3151a6",
- "type": "regulatedName",
- "value": {
- "language": "nl",
- "text": "Oikos Greek Yoghurt"
}
}
], - "gln": 4008789053381
}
Retrieve logistics information related to a specific trade item. This endpoint provides details about shipping, handling, and transportation for the specified product.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "logistics": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "barcode": "04008789053381",
- "referenceTradeItemId": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "intrastatCode": 21039090,
- "isConsumerUnit": true,
- "isBaseUnit": true,
- "isDispatchUnit": true,
- "isVariableUnit": true,
- "isInvoiceUnit": true,
- "isOrderableUnit": true,
- "numberOfUnits": 6,
- "distributorName": "PepsiCo BeLux BVBA/SPRL",
- "layersPerPallet": 30,
- "tradeItemsPerPalletLayer": 12,
- "dimensions": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "en",
- "text": "netWeight"
}, - "value": 24,
- "unit": "kg"
}
], - "packaging": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "type": {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "en",
- "text": "pallet1200x1000mm"
}, - "description": {
- "language": "en",
- "text": "Flat pallet with dimensions of 1200 x 1000 mm ISO 6780 ISO 2 Pallet, EUR 2 Pallet."
}, - "gs1Code": 12
}, - "dimensions": [
- {
- "id": "762C947E-0B17-4AC7-92DF-798D868576DB",
- "name": {
- "language": null,
- "text": null
}, - "value": 1638,
- "unit": "mm"
}
], - "materials": [
- {
- "id": "762C947E-0B17-4AC7-92DF-798D868576DB",
- "name": {
- "language": null,
- "text": null
}, - "description": {
- "language": null,
- "text": null
}, - "gs1Code": "WOOD_HARDWOOD",
- "isRecyclable": true
}
]
}
]
}
]
}
Get storage information for a specific trade item. This endpoint offers insights into how the product should be stored, including temperature requirements and shelf life.
Succesful operation.
The request could not be understood by the server due to malformed syntax.
The caller is not authorized to execute the endpoint.
Resource not found.
Not Acceptable.
The caller is doing too many requests in a small timeframe.
The server could not process the request.
{- "total": 30,
- "pageSize": 25,
- "totalPages": 2,
- "storage": [
- {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "stage": {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "en",
- "text": "afterPreparation"
}, - "gs1Code": "STORAGE_HANDLING",
- "description": {
- "language": "en",
- "text": "Trade item is being stored or handled."
}
}, - "condition": {
- "id": "38ba2e76-abad-42ff-a648-d5ef8db434b1",
- "name": {
- "language": "en",
- "text": "deep_frozen"
}, - "gs1Code": "DEEP_FROZEN",
- "description": {
- "language": "en",
- "text": "The product is stored inside of a deep freezer (not in a refrigerator) at a temperature which maintains a deep-frozen state, but is not above -18C/0F. Please refer to local regulations for temperature range."
}
}, - "temperature": {
- "min": -18,
- "max": -7,
- "unit": "°C"
}, - "lifespan": {
- "value": 4,
- "unit": "years"
}
}
]
}