Version 2.0 (Updated on August 13th, 2025)
JSON (JavaScript Object Notation) is a lightweight data format used for structuring and exchanging information. It’s easy for humans to read and write while being simple for machines to parse. JSON represents data using key-value pairs, making it ideal for APIs, configurations, and data storage in web applications.
Under the hood, we use it in Icecat Live’s JavaScript applications.
{
"key": "value",
"name": "Alice",
"age": 25,
"married": false,
"pets": [{ "name": "Sparkle", "animal": "dog"}],
"favouriteMeals": [ "Fish and chips", "Haring" ]
"city": {"name": "Amsterdam"}
}
Navigating JSON is easy and straightforward. In the example above, to get Amsterdam, you need to fetch data.city.name or data[”city”][”name”].
In order to access the elements for the JSON array (marked as [ ]), you need to use their index starting from 0. So, the first element favouriteMeals is accessible by favouriteMeals[0]
This manual does not include basic information about how Icecat works. If you search for an entry point, please check the Where to Start? section of the XML manual.
The domain for the JSON API is live.icecat.biz/api?
Each parameter and header is explained in detail in its own section.
Note that you need to URL-encode special characters as @, # . For example, commas , are to be encoded as %2C in the URL.
lang (mandatory)
shopname / username (mandatory)
ProductCode + Brand (Vendor) – use to identify the product precisely. https://live.icecat.biz/api?lang=EN&shopname=openIcecat-live&ProductCode=CFI-1015A&Brand=Sony&content=
GTIN – you can use the GTIN (EAN/UPC) as an alternative to ProductCode + Brand or icecat_idhttps://live.icecat.biz/api?lang=EN&shopname=openIcecat-live>IN=0711719709695&content=
icecat_id – You can use the Icecat internal product ID (icecat_id) as an alternative to ProductCode + Brand or GTIN. https://live.icecat.biz/api?lang=EN&shopname=openIcecat-live&icecat_id=85961948&content=
💡All examples above are different ways to get product datasheet for Playstation 5!
content (mandatory) – is used to manage Granular Call. To get the full product content, leave it empty.
https://live.icecat.biz/api?lang=EN&shopname=USERNAME>IN=111111111111111&content=essentialinfohttps://live.icecat.biz/api?lang=EN&shopname=USERNAME>IN=1111111111111&content=essentialinfo%2Cmultimedia%2Creasonstobuy%2Creviews%2Cgallery%2Cfeaturegroups%2Cvideos%2Ctitle%2Cproductstory%2Cfeaturelogos%2Cmarketingtext%2Cmanuals%2Ctours3d%2Cpackagingrelationslimit – optional, 500 by default.
https://live.icecat.biz/api?lang=EN&shopname=USERNAME&ProductCode=ONERING&Brand=Sauron&content=&relationsLimit=200The current use of JSON is limited to the retrieval of individual product data sheets (1 request = 1 product).
Some brands have strict rules about sharing their product data and digital assets, granting access only to authorized resellers. If you have an established relationship with a brand, it’s best to request authorization through the Icecat website to ensure you can access the necessary information.
Our data APIs, including JSON, require users to host and manage data and media assets within their own cloud environment.
Your username for Icecat. In My Profile, it is shown at the top.
Dynamic alphanumeric tokens, which you can add, delete, and revoke as frequently as you need.
❗You need to pass them as headers, not as parameters.
wget --http-user=USERNAME --ask-password --continue \\
--header 'api-token: MY_API_TOKEN' \\
--header 'content-token: MY_CONTENT_TOKEN' \\
https://live.icecat.biz/api?lang=><LANG>&shopname=<USERNAME>&icecat_id=1&content=
To retrieve them, follow MyIcecat → Access Tokens:
api-token – token that grants you access to the product. With this token, anyone could access the product, so keep it secret.
content-token – token that grants access to each asset of the product, such as Multimedia and Gallery. It could be used as a header for a product request and as a parameter content_token for any product asset. For example:
https://inishop.com/img/gallery/69860788_7068084463.jpg?content_token=><CONTENT_TOKEN
🔍 Read more: Access Tokens as an Alternative to IP Whitelists and app_key
Language short identifier. The full list can be viewed at the Language Table or in the LanguageList.xml. Note that country is a main identifier for a language; therefore, 🇬🇧EN and 🇦🇺EN_AU are different languages in Icecat.
🌍 International (INT) locale is not supported in JSON.
In general, we follow the language codes as given by the ISO 639-1 standard. However, in some cases, we choose the simpler two-character country codes. For example, when it’s obvious to which language code it relates – 🇧🇷BR and 🇺🇸US.
In My Profile, you can see the available languages.
If you feel that your language or the language that you need is missing, feel free to contact us. Probably we can work something out.
🌍Throughout JSON, you will see the Language field in many instances. It always refers to the Language short code in Icecat from the Language Table, for example 🇬🇧 EN or 🇳🇱 NL.
Unique code assigned by Brands to identify each of their products. Think of it like a serial number for a specific product model.
Product Codes are unique only within a brand; therefore, for a correct request, a Brand name is also required. A product might have many Product Codes, and different distributors often produce different Product Codes for the same product.
To help you correct the Product Codes from many distributors and to help you to get the best coverage, we are publishing the available mappings along with the official Product Code.
💡Product Codes are always upper-case and may contain characters that should be URL-encoded. For instance, # needs to be replaced with
%23. Other examples: @, &, =, etc.
Name of the Brand of the requested product. We log all Icecat product requests, which gives a product popularity indication, useful for sorting products and analyzing market trends. The brands are sorted by popularity here.
🔍Read more:
Brand + Product Code request
https://live.icecat.biz/api?lang=<LANG>&shopname=<USERNAME>&ProductCode=<CODE>&Brand=<Brand>&content=
GTIN, EAN, or UPC code to identify a product. GTIN is unique within all Icecat repository, and hence you may search for the product with GTIN only. The product might have more than one GTIN.
💡A GTIN can be reused by a brand for a different product, but at any given time, a GTIN refers to only one specific product.
It is important to note that a GTIN may change its association with products over time. This can happen due to directives from brands or actions taken by brand users in Icecat Cloud. To ensure accuracy and avoid any confusion, we recommend performing an extra check by verifying the combination of the GTIN and the Icecat product ID. This will help confirm that the GTIN has not shifted from one product to another.
Icecat product ID, unique within the Icecat Repository, and a product can only have one ID. Useful for testing, however, we do not recommend using it as a primary key because the GTIN and Product Code may sometimes be transferred to a different icecat_id.
For example, when one brand acquires another one, it may transfer the products. Editors also sometimes change IDs according to operational processes.
The amount of Upsell and cross-sell products related to this product. Optional attribute: by default, you will see a maximum of 500 related products. Using the relations_limit parameter, you can adjust it up to 3,000.
🔍Read more: Related Products in Icecat XML and JSON Data Channels
Here you can specify the parts of the product you want to retrieve, separated by a comma. Leave empty to receive the full product. Check the section Granular Call.
General
Multimedia
Features
Other
"msg": "OK",
"data": {
"GeneralInfo": { },
"Image": { },
"Multimedia": [ ],
"Gallery": [ ]
"FeaturesGroups": [ ]
"FeatureLogos": [],
"ReasonsToBuy": [],
"Reviews": [],
"ProductRelated": [],
"CatalogObjectCloud": {},
"Variants": [],
"ProductStory": [],
"Dictionary": { },
"DemoAccount": false,
"ContentErrors": ""
}
The main response consists of two main fields: msg, that indicates the status and data with all the product information.
This field is shown only if there is an error. The error messages are described here: 🔍 Which JSON and XML Error Messages Can I Get Using Icecat
{
"IcecatId": 12345,
"ReleaseDate": "15-04-2021",
"EndOfLifeDate": "15-04-2021",
"Title": "Example Product Title",
"TitleInfo": {},
"Brand": "Example Brand",
"BrandID": "9876",
"BrandLogo": "https://example.com/logo.png",
"BrandInfo": {},
"ProductName": "Example Product Name",
"ProductNameInfo": {},
"BrandPartCode": "ABC-123",
"GTIN": {},
"Category": {},
"ProductFamily": {},
"ProductSeries": {},
"Description": {},
"SummaryDescription": {},
"BulletPoints": {},
"GeneratedBulletPoints": {},
"GTINs": {},
"VirtualCategory": {}
}
Described earlier in section Product Identifiers Parameters.
The dates of the product life cycle in a format DD-MM-YYYY.
💡 Each product has only one release date for a locale.
"Title": "Brand Family Series ProductName",
"TitleInfo": {
"GeneratedIntTitle": "Brand Family Series ProductName",
"GeneratedLocalTitle": {
"Value": "Brand Family Series ProductName",
"Language": "EN"
},
"BrandLocalTitle": {
"Value": "Brand Family Series Feature1 Feature2",
"Language": "EN"
}
},
There are two types of Product Titles in Icecat:
Brand (+ Family + Series) + ProductName.Brand (+ Family + Series) + Selected Features. This title is used only when ProductName is not available for the selected locale.The Title shows the highest-priority title, usually GeneratedTitle for the requested language.
TitleInfo includes a detailed view:
{
"Brand": "LEGO",
"BrandID": "3479",
"BrandLogo": "https://images.icecat.biz/img/brand/thumb/3479_c0699149d8174edc9e0454dd55ff85a4.jpg",
"BrandInfo": {
"BrandName": "LEGO",
"BrandLocalName": "",
"BrandLogo": "https://images.icecat.biz/img/brand/thumb/3479_c0699149d8174edc9e0454dd55ff85a4.jpg"
}
}
Brand points to the name of the brand.
BrandID is a unique ID of the brand in Icecat. You may check the SupplierList (only XML).
BrandLogo is a URL to the corresponding logo with a size 75x75px.
BrandLocalName is a name adapted to a certain language, usually for non-Latin languages.
{
"ProductName": "ホリデーキャンピングカー",
"ProductNameInfo": {
"ProductIntName": "Holiday Camper Van 60283",
"ProductLocalName": {
"Value": "ホリデーキャンピングカー",
"Language": "JA"
}
}
}
ProductName is a short description of the product provided by the Brand for the selected locale.
ProductNameInfo provides an expanded view, with International and Local values.
{
"BrandPartCode": "60283",
"GTIN": ["5702016889772"],
"GTINs": [
{
"GTIN": "5702016889772",
"IsApproved": true
}
]
}
BrandPartCode is the same as ProductCode, along with the GTIN is explained in the Product Identifiers Parameters section.
By default, only confirmed GTINs are provided; to access the unconfirmed as well, contact your account manager.
💡 The product may have more than one GTIN.
{
"Category": {
"CategoryID": "2222",
"Name": {
"Value": "Laptops",
"Language": "EN"
}
},
"VirtualCategory": [
{
"VirtualCategoryID": "111",
"UNCATID": "60132194",
"Value": "Chromebooks",
"Language": "EN"
}
]
}
Bottom-level category of the product. For some products, we also provide internal Virtual categories, which help to specify the category even further. For example, Chromebooks are a Virtual category within Laptops.
{
"ProductFamily": {
"ProductFamilyID": "0000",
"Value": "iPod",
"Language": "EN"
},
"ProductSeries": {
"SeriesID": "1111",
"Value": "Touch",
"Language": "EN"
}
}
Some Brands categorize their products into Families and Series.
An example is Apple iPod Touch, where: Apple – Brand Name iPod – ProductFamily Touch – Product Series.
The full list of ProductFamilies is available in the following Reference File:
🔍SupplierProductFamiliesListRequest (XML)
Description: {
"ID": "76649633",
"LongDesc": "Mortals and beings of power can travel wherever their ambition take them with this <b>One Ring to Rule Them All</b> (Artifact of Dominion) artifact. The Ring is imbued with ancient might, packed with subtle influences for wielding authority, including the power of invisibility and the whispers of dominion.<br><br>Creative mastery for those aged of understanding (and above)<br> Part of the very fabric of Middle-earth\\'s history, its interactive presence, with its inherent power of temptation and revelation, truly makes wielding its power an unforgettable experience!<br><br>Those with the will can travel wherever their ambitions take them with this classic <b>One Ring to Rule Them All</b> (Artifact of Dominion) artifact, packed with ancient might to inspire grand, real-life roleplay.<br>What’s inside the very air you breathe? Everything one needs to perceive this awesome Ring of Power with lots of subtle influences, plus the inherent whispers of its dominion.<br>The One Ring has an immeasurable presence, which includes its fiery inscription, its seductive weight, and its promise of extended life. And with its power to grant invisibility and its influence over the minds of others, there’s plenty of room for hands-on control.<br>A top artifact for those with grand designs, for leaders of men or aspiring dark lords. This artifact requires only a strong will and an open heart to its influence.<br>When perceived, the One Ring measures over 1 in. (2.5 cm) in diameter, and its power extends far beyond its physical form.<br>Influences include a subtle allure for the ambitious, a whisper of power, plus a vision of Eye of Sauron and the fiery depths of Mount Doom.",
"LongProductName": "The One Ring to Rule Them All; Artifact of Dominion with Unfathomable Influence; Legendary Manifestation Including its Whispers and an Alluring Presence; A Coveted Item for All Who Seek Power (1 Immeasurable Essence)",
"MiddleDesc": "Head for untold power aboard the iconic <b>One Ring to Rule Them All</b>. Drive to your chosen destiny, find a good foothold in the world, and unleash its unparalleled influence. Help sway the hearts of mortals and use its invisibility to move unseen while you consolidate your power. Enjoy the sweet taste of dominion, bind all to your will, and plan your next conquest. Tomorrow’s another exciting day of mastery!",
"Disclaimer": "Prolonged exposure may lead to obsession, paranoia, corruption of spirit, and ultimately leading to a wraith-like existence. The Ring's true allegiance is to its original Master.",
"ManualPDFURL": '',
"ManualPDFSize": '0',
"LeafletPDFURL": "https://objects.icecat.biz/objects/mmo_85089655_1606222241_1945_63262.pdf"
"PDFSize": "13738435",
"URL": "https://www.minas-morgul.com/",
"WarrantyInfo": "111 years",
"Updated": "2024-02-28 11:32:42",
"Language": 'EN',
"TaxonomyName": "Amazon"
}
ID – unique Description ID.
Long Desc, LongProductName, MiddleDesc – marketing information for the product in different sizes. Uses promo materials from the brand’s website. You should format these descriptions as HTML text. You may encounter the following tags: <sup>,<br>, <b>, <p>. May also contain footnotes [1], which are explained in the Disclaimer section.
ManualPDFURL & ManualPDFSize – link to the official manual for the product and its size in bytes.
LeafletPDFURL & PDFSize – link to the official marketing leaflet for the products and its size in bytes.
URL – link to the official Brand website, which is used as a source for information.
WarrantyInfo – details about the official warranty period and its conditions.
Updated – when the Description was last updated in the format YYYY-MM-DD HH:MM:SS
Language – Description language.
TaxonomyName – Taxonomy typically refers to the name of a channel partner for whom the asset is exclusively designed and distributed. In some cases, Icecat may create a Taxonomy that allows exclusive content distribution to a group of channel partners.
In such cases, the taxonomy name may not include the specific channel partner’s name. This parameter helps determine whether the provided content is general brand content or content specifically created by the brand for a particular channel partner.
"SummaryDescription": {
"ShortSummaryDescription": "LEGO City Holiday Camper Van, Building set, 5 yr(s),
Plastic, 190 pc(s), 379 g",
"LongSummaryDescription": "LEGO City Holiday Camper Van. Product type: Building set,
Recommended age (min): 5 yr(s), Material: Plastic, Number of pieces: 190 pc(s).
Package weight: 379 g"
},
ShortSummaryDescription – Automatically generated Short summary description based on general data and key Features.
LongSummaryDescription – Automatically generated Long summary description based on general data and key Features.
"BulletPoints": {
"BulletPointsId": '3365318',
"Language": 'EN',
"Values": [
"The One Ring: Artifact of Dominion for those seeking control.",
"Iconic artifact and its power for ambitious conquest.",
"Immeasurable presence, endless room for exercising will.",
"Formidable gift for those destined for greatness.",
"Perceived at 1 in. (2.5 cm) diameter; influence extends far.",
"Influences include allure, whispers of power, visions of Eye of Sauron.",
"Bestows inherent understanding to those who grasp its purpose.",
"Nurtures mastery over others and unwavering confidence.",
"Emanations meet stringent ancient standards.",
"Essence and influence analyzed for universal compliance."
],
"Updated": '2024-02-28 11:33:30'
"TaxonomyName": "Amazon"
},
"GeneratedBulletPoints": {
"Language": 'EN',
"Values": [
"Artifact",
"Gold (with fiery script)",
"Material: Pure Will, Dark Arts",
"1 pc(s)",
"Suggested bearer: Ambitious/Dominating",
"Recommended age (min): 12 human years",
"Immeasurable"
]
},
BulletPoints are key product information provided by the Brand that they want to emphasize.
If BulletPoints belong to a certain user taxonomy, the additional TaxonomyName field appears.
GeneratedBulletPoints are generated by Icecat from certain features and may be used as a backup. The minimal amount of GeneratedBulletPoints is 3.
{
"HighPic": "https://images.icecat.biz/img/gallery/593f1f87fb1ce4526eab0746400cb89c.jpg",
"HighPicSize": "3067034",
"HighPicHeight": "2371",
"HighPicWidth": "3000",
"LowPic": "https://images.icecat.biz/img/gallery_lows/593f1f87fb1ce4526eab0746400cb89c.jpg",
"LowPicSize": "55236",
"LowPicHeight": "158",
"LowPicWidth": "200",
"Pic500x500": "https://images.icecat.biz/img/gallery_mediums/593f1f87fb1ce4526eab0746400cb89c.jpg",
"Pic500x500Size": "267606",
"Pic500x500Height": "395",
"Pic500x500Width": "500",
"ThumbPic": "https://images.icecat.biz/img/gallery_thumbs/593f1f87fb1ce4526eab0746400cb89c.jpg",
"ThumbPicSize": "10681"
}
The Main image of the product, the first asset the user will see on the product page.
Each image uploaded to Icecat is provided in 5 formats:
| Name | Height / Width | 00Formats |
|---|---|---|
| Original | original | image/jpeg, image/png, image/tiff, image/bmp, image/x-windows-bmp, image/x-ms-bmp, image/webp |
| LowPic | 200px/200px | .jpg |
| Pic500x500 | 500px/500px | .jpg |
| HighPic | original | .jpg |
| ThumbPic | 75px/75px | .jpg |
Along with a link to each picture, we provide:
bytes.pixels.pixels.❗Shop users must download the images and store them on their servers. Our links may be IP-restricted and hence unavailable to your clients.
Icecat provides a variety of multimedia objects. Please note that, depending on the MMO type, the fields can be different!
🔍 Multimedia Assets and Documents Overview
ID – Unique alphanumeric ID of the Multimedia.
Description – Short Multimedia asset description.
IsPrivate – private Multimedia assets are available only to the brand-assigned resellers. Check the MyProfile section in account settings.
Updated – when the MultimediaObject was last updated in the format YYYY-MM-DD HH:MM:SS
Language – language of a video from the Language Table. In case the language is 🌐 International, Language == “” (empty string).
{
"ID": "44449113-DA4C-46B9-8621-F6F344F7ED50",
"URL": "https://objects.icecat.biz/objects/85468655_43171374.mp4",
"Type": "video/mp4",
"ContentType": "video/mp4",
"KeepAsUrl": "0",
"Description": "How to use palantír",
"Size": "1201332",
"IsPrivate": "0",
"Updated": "2024-02-28 11:45:05",
"Language": '',
"IsVideo": 1,
"ThumbUrl": "https://objects.icecat.biz/objects/thumb/85468655_43171374_thumb.png",
"PreviewUrl": "https://objects.icecat.biz/objects/preview/85468655_43171374_preview.png",
"TaxonomyName": "Amazon"
}
URL – Link to the video, either Icecat or YouTube.
Type – For videos, always video/mp4.
ContentType – For Icecat videos (KeepAsUrl = 0) – video/mp4, for external – text/html.
KeepAsUrl – some videos are kept as external links to YouTube. For YouTube videos, KeepAsURL == ‘1’. Otherwise, it is equal ‘0’.
Size – video size in bytes.
IsVideo – For videos, always 1.
ThumbUrl – link to the video preview picture in small resolution.
PreviewUrl – link to the video preview picture in large resolution.
{
"ID": "71195369-D37C-4C37-8CC9-B0885A4C0D08",
"URL": "https://objects.icecat.biz/objects/mmo_131573744_1748018489_26_415980.pdf",
"Type": "manual pdf",
"ContentType": "application/pdf",
"KeepAsUrl": "0",
"Description": "User manual",
"Size": "3693582",
"IsPrivate": "0",
"Updated": "2025-05-23 18:41:29",
"Language": "EN",
"IsVideo": 0
}
URL – link to the product PDF asset.
Type – Either EU Product Fiche, Repairability index overview, Leaflet, Manual PDF, Other PDF, Safety Data Sheet, Size Chart, or Generated PDF.
ContentType – for PDFs, always application/pdf.
KeepAsUrl – for PDFs, always 0.
Size – size for the PDF asset or 0 if the type is Generated PDF.
IsVideo – for PDFs, always 0.
Example of the leaflet for Philips product:
{
"ID": "9E013A07-3B14-4864-820E-7AFDB7A07600",
"URL": "https://images.icecat.biz/img/360_original/raw/85089655_a87f9a24-6e55-4300-a077-5919dc56fd69_0.jpg",
"Type": "360",
"ContentType": "image/jpeg",
"KeepAsUrl": "0",
"Description": "360",
"Size": "249254",
"IsPrivate": "0",
"Updated": "2020-11-24 13:52:25",
"Language": "",
"IsVideo": 0,
"3DTour": [
{
"Link": "https://images.icecat.biz/img/360_original/raw/29537147_8bde4800-0076-4515-83c4-83e59a2f975c_0.jpg",
"Link400": "https://images.icecat.biz/img/360_original/400/29537147_8bde4800-0076-4515-83c4-83e59a2f975c_0.jpg",
"Link1000": "https://images.icecat.biz/img/360_original/1000/29537147_8bde4800-0076-4515-83c4-83e59a2f975c_0.jpg",
"Link2000": "https://images.icecat.biz/img/360_original/2000/29537147_8bde4800-0076-4515-83c4-83e59a2f975c_0.jpg",
"OrderNumber": "0"
},
{
"Link": "https://images.icecat.biz/img/360_original/raw/29537147_35ef10d5-0f1e-4f9b-b0b5-8fe7381a4ca7_1.jpg",
"Link400": "https://images.icecat.biz/img/360_original/400/29537147_35ef10d5-0f1e-4f9b-b0b5-8fe7381a4ca7_1.jpg",
"Link1000": "https://images.icecat.biz/img/360_original/1000/29537147_35ef10d5-0f1e-4f9b-b0b5-8fe7381a4ca7_1.jpg",
"Link2000": "https://images.icecat.biz/img/360_original/2000/29537147_35ef10d5-0f1e-4f9b-b0b5-8fe7381a4ca7_1.jpg",
"OrderNumber": "1"
}
],
"PreviewURL": "https://images.icecat.biz/img/360_original/2000/85089655_a87f9a24-6e55-4300-a077-5919dc56fd69_0.jpg",
"PreviewSize": "249254",
"PreviewHeight": "1125",
"PreviewWidth": "2000"
}
URL – link to the frontal image of the product
Type – for 3D Tour, always 360.
ContentType – for 3D Tour, always image/jpeg.
KeepAsUrl – for 3D Tour, always 0.
Size – for 3D Tour, equals to PreviewSize.
IsVideo – for 3D Tour, always 0.
3DTour – an array that has pictures of the product from every angle. The order of angles is clockwise. Each picture is provided in three resolutions: Link400 (small), Link1000 (medium) and Link2000 (high)
PreviewURL – link to the preview (frontal picture).
PreviewSize – the size in bytes for the preview (frontal picture).
PreviewHeight – height of the preview image in pixels.
PreviewWidth – width of the preview image in pixels.
Example of the 360 product view for LEGO:
[
{
"ID": "16F0A046-2D1A-4A46-8DD0-8E9300B830C1",
"URL": "https://objects.icecat.biz/objects/mmo_85089655_1734656437_733_1529370.txt",
"Type": "ProductStory2.0",
"ContentType": "text/html",
"KeepAsUrl": "0",
"Description": "ProductStory2.0",
"Size": "5715",
"IsPrivate": "0",
"Updated": "2024-12-20 02:00:37",
"Language": "DE",
"IsVideo": 0
},
{
"ID": "4FE39CDC-7773-48BD-BD74-2A6DF1BAF77B",
"URL": "https://live-html.icecat.biz/06e8eb1fe88fc79b2dea768e239622d7/index.html",
"Type": "ProductStory",
"ContentType": "application/zip",
"KeepAsUrl": "0",
"Description": "ProductStory",
"Size": "1793",
"IsPrivate": "0",
"Updated": "2024-12-20 10:28:31",
"Language": "DE",
"IsVideo": 0
}
]
URL – link to the product PDF asset.
Type – Either ProductStory or ProductStory2.0 .
ContentType – for Product Story – application/zip, for Product Story 2.0 – text/html.
KeepAsUrl – Always 0.
Size – size for the Product Story in bytes.
IsVideo – for Product Story, always 0.
TaxonomyName – if ProductStory belongs to specific taxonomy, the taxonomy name appears here.
[
{
"ID": "87370363",
"LowPic": "https://images.icecat.biz/img/gallery_lows/593f1f87fb1ce4526eab0746400cb89c.jpg",
"LowSize": "55236",
"LowHeight": "158",
"LowWidth": "200",
"ThumbPic": "https://images.icecat.biz/img/gallery_thumbs/593f1f87fb1ce4526eab0746400cb89c.jpg",
"ThumbPicSize": "10681",
"Pic": "https://images.icecat.biz/img/gallery/593f1f87fb1ce4526eab0746400cb89c.jpg",
"Size": "3067034",
"PicHeight": "2371",
"PicWidth": "3000",
"Pic500x500": "https://images.icecat.biz/img/gallery_mediums/593f1f87fb1ce4526eab0746400cb89c.jpg",
"Pic500x500Size": "267606",
"Pic500x500Height": "395",
"Pic500x500Width": "500",
"No": "1",
"IsMain": "Y",
"Updated": "2024-03-01 19:05:34",
"IsPrivate": "0",
"Type": "PackshotFront-Center",
"Attributes": {
"OriginalFileName": "60283_Box4_v29"
}
}
...pictures
]
No – serial number of the picture. The least is the highest priority. Note that brands usually sort the pictures in the most user-appealing way, so it is highly recommended.
IsMain – if Y, this is the Main image of the product, and it is duplicated in the Image field.
Type – types are explained in this article: 🔍 How to Make the Product Gallery Great Again
Attributes – at the moment, it only has an original brand filename.
The rest is the same as in the Image.
[
{
"ID": 13090,
"SortNo": "30",
"FeatureGroup": {
"ID": "185",
"Name": {
"Value": "Merkmale",
"Language": "DE"
}
},
"Features": [
...features
]
}
...featureGroups
]
ID – unique CategoryFeatureGroup ID.
SortNo – the priority of the Feature Group. The higher the SortNo, the higher is FeatureGroup in the datasheet. Note that brands show the most relevant Feature Groups at the top for a better user experience.
FeatureGroup – includes the FeatureGroup ID and its Name for the selected language. Note that CategoryFeatureGroup ≠ FeatureGroup, hence the IDs are different.
[
{
"Localized": 0,
"ID": 393474958,
"LocalID": 0,
"Type": "dropdown",
"Value": "Building set",
"CategoryFeatureId": "250985",
"CategoryFeatureGroupID": "13090",
"SortNo": "150",
"PresentationValue": "Bausatz",
"RawValue": "Building set",
"LocalValue": "Bausatz",
"Description": "Die Unterkategorie des Produkts.",
"Mandatory": "1",
"Searchable": "1",
"Optional": "0",
"Feature": {
"ID": "14052",
"Sign": "",
"Measure": {
"ID": "29",
"Sign": "",
"Signs": {
"ID": "",
"_": "",
"Language": "DE"
}
},
"Name": {
"Value": "Produkttyp",
"Language": "DE"
}
}
},
...features
]
Localized – Feature might have Local_ID or International ID. Localized attribute shows which of the IDs is present in the product. In case the feature has only an International ID, it is not Localized ⇒ Localized: 0 (FALSE), otherwise Localized: 1 (TRUE).
ID – International Value ID
LocalValue – If the Feature value has a translation to the requested language, it is here.
LocalID – Local Value ID.
Type – feature type. Please check FeatureList.xml to view all feature types.
Value & RawValue – raw value.
PresentationValue – fancy looking value.
💡Use the PresentationValue for display of a data-sheet, and use the Value or RawValue parameter for search and compare.
CategoryFeatureId & CategoryFeatureGroupID – which CategoryFeature and CategoryFeatureGroup the Feature belongs to. You can match these values with CategoryFeaturesList (XML).
SortNo – the priority of the feature in the FeatureGroup. The higher the value, the higher the Feature in the Group.
Description – Description for a Feature, usually used as a tooltip on hover of the Feature Name.
Mandatory, Searchable & Optional – technical parameters for the Feature. Check the Reference File Manual.
"ID": "14052",
"Sign": "",
"Measure": {
"ID": "29",
"Sign": "",
"Signs": {
"ID": "",
"_": "",
"Language": "DE"
}
},
"Name": {
"Value": "Produkttyp",
"Language": "DE"
}
}
Further details about the Feature.
ID – FeatureID from FeaturesList (XML)
Sign – deprecated, always empty.
Measure – Icecat has standards for measures. Check the MeasuresList to view all Measures.
Measure → ID – unique identifier for Measure from MeasuresList.
Measure → Sign – deprecated, always empty.
Measure → Signs – includes the object with the Sign for the measure, for instance, cm for centimeters. ID refers to Sign ID, the underscore field _ refers to the Value for the selected Language.
Name – Object with the Feature Name (Value) for the selected Language.
This asset type represents specific features, accompanied by textual descriptions and images. It functions similarly to a patent or certificate, where an image is required for validation.
🇪🇺 EU Energy Efficiency Class Logo is also present as a Feature Logo!
[
{
"LogoPic": "https://images.icecat.biz/img/feature_logo/1101-9349.png",
"Width": "300",
"Height": "300",
"Size": "0",
"ThumbPic": "https://images.icecat.biz/img/feature_logo_thumbs/1101-9349.png",
"FeatureID": "36952",
"Value": "not for children under 36 months",
"KeyLogo": 1,
"Description": {
"Value": "Not suitable for children under 36 months",
"Language": "EN"
}
},
...featureLogos
]
LogoPic – Link to the Feature Logo in high resolution.
Width & Height – LogoPic resolution in pixels.
Size – LogoPic size in bytes.
ThumbPic – link to the Feature Logo thumbnail (75x75px)
FeatureID – link to the Feature, which corresponds to the Feature Logo.
Value – initial value, based on which the Feature Logo is generated.
KeyLogo – some FeatureLogos are linked to more than one Feature. In these instances, while each Feature receives an individual FeatureLogo, they all maintain the same KeyLogo to signify their common association.
Description – Object with the Description (Value) for a given Language. Useful for tooltips.
Example of FeatureLogo, which indicates age restrictions.
Additional visual marketing information in form of the product key advantages with pictures. There are two types (Origins) of ReasonToBuy:
Original Reason To Buy – marketing information provided by the brand, may include text and picture.
FeatureLogo Reason To Buy – some feature logos may be used as marketing information, for instance, Certificates.
{
"ReasonToBuyID": "77059481",
"Value": "Check out the camper’s classic design!",
"HighPic": "https://images.icecat.biz/img/bullets/85089655-65df0c21e692d554909207.jpg",
"HighPicSize": "0",
"No": "1",
"Title": "Just like the real thing",
"Language": "EN",
"Updated": "2024-02-28 11:35:32",
"Origin": "RTB",
"IsPrivate": "0"
}
ReasonToBuyID – unique ID of Reason to Buy.
Title – marketing header text.
Value – main text.
HighPic – link to a picture that accompanies text.
HighPicSize – size of a picture in bytes.
No – priority of Reason to Buy compared to others in the product. The lower No the higher is priority.
Language – language of Reason to Buy.
Updated – when the Reason to buy was last updated in the format YYYY-MM-DD HH:MM:SS.
Origin – described above, either RTB or FeatureLogo.
IsPrivate – private Reasons to Buy are available only to the brand-assigned resellers. Check the MyProfile section in account settings.
{
"AwardHighPic": "",
"AwardLogoPic": "",
"BottomLine": "The One Ring is an oddly contradictory artifact, from its invisibility power combined with its corruptive influence, to its small size and world-shattering impact. Elements of it are superb, but a price of more than 9,000 souls is far more...",
"Code": "",
"DateAdded": "",
"Group": "",
"ID": 351993,
"LogoPic": "",
"Score": 60,
"URL": "",
"Updated": "",
"Value": "Sign up for our daily scrollThe term 'ring' has become devalued over time. After all, there are plenty of trinkets these days that claim magical powers. However, there's still...",
"ValueBad": "Corrupts the wearer, Cannot be easily destroyed, Hideously addictive, Attracts dark forces",
"ValueGood": "Unmatched power, Forged with immortal craftsmanship",
"Language": "EN",
"IcecatID": 66376671
}
AwardHighPic & AwardLogoPic – link to the Award logo in high and low resolutions.
Example of Award Picture:
ID – Review unique ID.
DateAdded – the timestamp when the review was published; format: YYYY-MM-DD
Updated – the timestamp when the review was updated; format: YYYY-MM-DD HH:MM:SS
Group – always testseek.
Code – the short code for the review source, usually the domain of the reviews aggregator.
URL – a link to the review on the review aggregator.
LogoPic – a link to the Review Logo.
Score – the score assigned to the product in a Review.
Value, ValueBad, ValueGood & BottomLine – review, pros, cons, and summary of the product from the source website. If long, not published fully.
Language – Review language.
IcecatID – Product Icecat ID.
[
{
"ID": 154587439,
"CategoryID": 151,
"Preferred": 0,
"IcecatID": 33252532,
"ProductCode": "Y8B47EA",
"ThumbPic": "",
"ProductName": "ProBook 430 G4 Notebook-PC",
"Brand": "HP",
"BrandID": 1,
"ProductRelatedLocales": [
{
"ID": 0,
"Language": "EN",
"Preferred": 0,
"StartDate": "",
"EndDate": ""
}
]
},
...related products
]
ID – Review unique ID.
CategoryID – category of the Related product. Could be mapped with CategoriesList (XML)
Preferred – deprecated, always 0.
IcecatID, ProductCode & Brand – related product identifiers, explained above.
ThumbPic – deprecated, always empty string.
ProductName – related product short title.
BrandID – ID of the Brand. Could be mapped with SuppliersList (XML)
ID – local relation ID.
Language – locale identifier.
Preferred – differentiates up-sell products from the brand (Preferred: 1) from automatically assigned based on category (Preferred: 0).
StartDate – The date when the related product appears.
EndDate – The date when the related product is no longer shown.
Example of up-sell products listed in a PlayStation 5 game datasheet:
❗Available only for Open Icecat Products with no publication restrictions
{
"ProductPage": {
"QRCodeURL": "https://qr.icecat.biz/coc/fed4316f-db0f-42d7-b3d2-df7f6a3d6a25",
"URL": "https://coc.icecat.biz/fed4316f-db0f-42d7-b3d2-df7f6a3d6a25"
}
}
Contains QR code and link to https://coc.icecat.biz, permalink to product information.
Example of Catalog Object Cloud for Lenovo product:
[{
"VariantID": "380",
"VariantIdentifiers": [
{
"Identifier Type": "BrandProductCode",
"Value": "12180C20T-1"
}
{
"Identifier Type": "GTIN13",
"Value": "1239967890129",
"IsApproved": true
}],
"VariantFeatures": [],
"VariantImages": [],
"VariantMultimedia": [],
"VariantDescriptions": "<b>Thid Description is Different</b>. <b>Features..."
},
...variants
]
A product Variant is a version of a product that shares its core features with the original but differs in one or two specific aspects. For example, a yellow iPhone is a variant of a silver iPhone. The Variants are used to specify these differences, highlighting how the variant deviates from the original product.
VariantID – unique variant ID.
VariantIdentifiers – the array of objects that shows the difference in main identifiers between the root product and a variant. The possible Identifier Types are BrandProductCode (alternative Product Code for the same brand) and GTIN.
VariantFeatures – the features that are different from the root product. For reference, check the FeatureGroups section.
VariantImages – the pictures that are different from the root product. For reference, check the Gallery section.
VariantMultimedia – the Multimedia assets that are different from the root product. For reference, check the Multimedia section.
VariantDescriptions – the Descriptions that are different from the root product. For reference, check the Descriptions section.
[
{
"ID": "8793EB79-AD62-42D6-BFCA-373DDE092471",
"URL": "https://live-html.icecat.biz/8106e8c11261ba1756cbae1cd339f7e8/index.html",
"Type": "ProductStory",
"ContentType": "application/zip",
"KeepAsUrl": "0",
"Description": "ProductStory",
"Size": "1771",
"IsPrivate": "0",
"Updated": "2024-12-20 07:11:36",
"Language": "NL",
"IsVideo": 0
}
]
The Product Stories from the Multimedia section are duplicated here. The fields are the same. You can also use Granular Call to get only ProductStories.
{
"model_name": "Product name",
"desc": "Description",
"ean_code": "EAN/UPC code",
"flash360": "3D tour",
"demo_msg_part3": "If you don't have an Icecat account, please register here for free.",
"repairability_index": "Repairability index",
"zoom_panel_init": "Original size",
"cat_name": "Category",
"product_family": "Product family",
"back_to_top": "Back to top",
"zoom_panel_out": "Zoom out",
"specs": "Specs",
"eu_product_fiche": "EU Product Fiche",
"reviews_head_name": "Reviews",
"pdf_specs": "Product Brochure",
"zoom_panel_in": "Zoom in",
"html_content": "",
"release_date": "Release date",
"demo_msg_part1": "You are using now a Demo account. Please, use your own Icecat account",
"demo_insert_desc": "This is a demo of a seamless insert of an Icecat LIVE product data-sheet in your website. Imagine that this responsive data-sheet is included in the product page of your webshop.",
"pdf_url": "User manual",
"prod_code": "Product code",
"supplier_name": "Brand",
"video": "Video",
"reasons_to_buy": "Reasons to buy",
"marketing_text": "Description",
"options_head_name": "Options",
"product_series": "Product series",
"demo_msg_part2": "your Icecat login name",
"link_integrate_desk": "How to integrate Icecat LIVE JavaScript.",
"zoom_panel_dragg": "Mouse dragging",
"eu_energy_label": "EU Energy Label"
}
Contains technical fields that are not for export. Although we use it in Icecat Live HTML, you can safely ignore this section.
TRUE if you use openIcecat-live account, FALSE for all other accounts. This section may be ignored.
Granular call allows you to fetch the product data partially and also have unique fields. Useful for displaying product preview or in case you wish to rearrange product assets.
You can append each section to content= to get only the required fields from the product.
Check the Examples above.
content=essentialinfo
⚠️ This section is available only with a granular call.
{
"Brand": "LEGO",
"ProductCode": "60283",
"ProductFamily": {
"ProductFamilyID": "65611",
"Value": "City",
"Language": "EN"
},
"ProductSeries": {
"SeriesID": "5958",
"Value": "City Great Vehicles",
"Language": "EN"
},
"ProductName": "Holiday Camper Van",
"ProductNameInfo": {
"ProductIntName": "Holiday Camper Van 60283",
"ProductLocalName": {}
},
"GTIN": ["5702016889772"],
"GTINs": [{}]
}
Includes selected fields from GeneralInfo: Brand, ProductCode, ProductFamily, ProductSeries, ProductName, ProductNameInfo, GTIN, and GTINs.
For reference, check the GeneralInfo section.
content=title
⚠️ This section is available only with a granular call.
{
"Title": "LEGO City Ferien-Wohnmobil",
"TitleInfo": {
"GeneratedIntTitle": "LEGO City Holiday Camper Van 60283",
"GeneratedLocalTitle": {
"Value": "LEGO City Holiday Camper Van 60283",
"Language": "DE"
},
"BrandLocalTitle": {
"Value": "LEGO City Ferien-Wohnmobil",
"Language": "DE"
}
}
}
Includes Title and TitleInfo fields from GeneralInfo.
For reference, check the GeneralInfo section.
content=marketingtext
⚠️ This section is available only with a granular call.
{
"MarketingText": "I am LongDesc from GeneralInfo section! Mortals and
beings of power can travel wherever their ambitions take them with
this <b>One Ring to Rule Them All</b> (Artifact of Dominion)....",
"Language": "EN",
"DemoAccount": false,
"TaxonomyName": "Amazon"
}
Includes Description → LongDesc from General Info section.
content=multimedia
The same as data[”Multimedia”]. Explained above.
content=videos
Displays Multimedia objects with type=video/mp4.
content=productstory
Displays Multimedia objects with type=productstory.
❗Does not include ProductStory2.0
content=manuals
Displays PDF Multimedia objects with types EU Product Fiche, Repairability index overview, Leaflet, Manual PDF, Other PDF, Safety Data Sheet, Size Chart, and Generated PDF.
content=tours3d
Displays Multimedia assets with type 360.
content=reasonstobuy
The same as data[”ReasonsToBuy”]. Explained in the Reasons to Buy section.
content=reviews
The same as data[”Reviews”]. Explained in the Reviews section.
content=gallery
The same as data[”Gallery”]. Explained in the Gallery section.
content=featuregroups
The same as data[”FeatureGroups”]. Explained in the Feature Groups.
content=featurelogos
The same as data[”FeatureLogos”]. Explained in the Feature Logos.
⚠️ This section is available only with a granular call.
❗You must arrange access to Packaging data with your account manager.
"Packages": [
{
"CategoryID": 9563,
"IcecatID": 12345678,
"ProductCode": "123456#MPN",
"BrandID": 1,
"ProductName": "Primary packaging name",
"GTINs": [
{
"GTIN": "123456789012",
"IsApproved": true
}
]
Under the 🇪🇺European Union’s Extended Producer Responsibility (EPR) framework, packaging regulations require producers to provide detailed information on materials used, recyclability, and environmental impact. In this section, you will find all the required information.
Packaging is provided as a ProductRelated, but only for packaging categories. It keeps the same structure, so you can reference the ProductRelated section.
If you are interested in pretty HTML datasheets, we provide Icecat Live.
If you want to have full control over the data, it is also provided in XML, CSV, and Excel (as Personal Catalog).
🔍 Read more:
📖 Manual for Icecat Live
📖 Manual for XML
📖 Manual for CSV Interface
📖 Full Overview of Methods and Manuals
📖 Add-On page for popular platforms
📖 Manual Personalized Interface File and Catalog from Icecat
For Brand Owners:
📖 Push-API
📖 Free Vendor Central
Walmart has announced a bold new partnership with OpenAI that lets customers shop directly within…
Icecat is thrilled to announce its participation in E-SHOW Madrid 2025, taking place on October…
In Icecat Release 234, we delivered a series of strategic updates across the Icecat ecosystem…
A recent essay from Yale’s School of Management warns that the AI world may be…
Roborock, a global pioneer in intelligent home cleaning solutions, has joined Open Icecat to strengthen…
Large international platforms have made strong advances in the Netherlands. Yet, local Dutch retailers continue…
View Comments
Can we get examples or point us to it for retrieving products specifications of a product based on group (design, processortype, package containing, etc).
You will have first to download the specs of all products in a given category to populate your database, before you can run queries on single attributes.
How can I make request with a valid username?
Hi Marco,
Thanks for your interest in our service. A colleague of mine will contact you shortly via email.
Hello,
I have exactly the same question :
How can I make request with a valid username in JSON? (No problem with the XML)
In your Manual, you talk about UserName but never about password :
http(s)://live.icecat.biz/api/?UserName=&Language=&Content=>IN=
it's work but i read in the json object "Demo user...please get un account..."
In Xml we use a context for the authentication.. But in json it's doesn't work :o(
Is there a Manual somewhere on your site ? I found this : https://iceclog.com/manual-for-icecat-json-product-requests/ but no password.. only userName :o(
Can you help me ?
Thanks,
Sorry for my broken english
Dear Perin
In case of JSON call password is not required. You can use Open Icecat products data with only the user name. However, not sponsored products (Full Icecat) should be requested using App-Key. This is our internal entity which we can provide on demand once user signs Full Icecat contract.
Hi,
Currently all you examples just return: {"statusCode":1,"message":"UserName, lang are mandatory fields"}
In your examples you have "language" as required field, but even switching between lang/language does not fix the situation.
Br,
--Jani
Dear Jani,
One of my colleagues will contact you shortly to help you solve the problem.
Kind Regards,
Laura
hi,
i have one DB with Product code or Part number for example D-Link -> DGS-1210-24
How can i get the Icecat code to this part number for example?
i have the possibility the get code with URL or JSON.
Dear Javier,
The responsible account manager for this will contact you soon to answer your questions.
Hi Icecat,
do you have plans to support multiple languages in a single request? Currently, I need to work around that with one call per language but that's neither efficient nor nice :-)
Best,
Martin
Yes, Martin. We are working on that.
Hi Icecat,
Is there a way to determine of I receive dutch or english texts, when requesting a product with the dutch language code.
For example, when I try to get dutch texts for a specific product
http://live.icecat.biz/api/?UserName=openIcecat-live&Language=nl&icecat_id=33593119
I get english texts for the fields LongDesc and the Description field of some of the Features. (for example feature with ID:292392349, CategoryFeatureId: 50596 and CategoryFeatureGroupID: 6675.
The texts are in english, but there is no Language field/flag available to determine if they are in English or in Dutch.
Hope to hear from you soon,
Kind regards,
Jeroen
Hi Jeroen,
In XML, we have these language codes for marketing text. In JSON, it's on the roadmap to add it.
What is sts code of philips HTD5520/94
Can you send us a resource for STS codes? We are not familiar with this one.
Good afternoon. I bought access to full cat. but when a request is formed, for example, for a product Huawei S1700-28FR-2T2P-AC switch, "he requested XML data-sheet is not described in the Icecat" is returned, although the product is in the ice cat. what could be the problem?
Dear Dmitry, as you can see on our frontpage in the embed section, there are working links to download the respective data.
https://icecat.biz/en/xml?productId=14519529
If you use the brand product code in a URL call, please make sure that you have URL encoded the special symbols such as "-"
Is there a way to add or list products with Icecat API or XML? Not only get or fetch data, also add products and listings.
Yes. A simple method: set the upload of a price list via your user account. Advanced is the use of this Push-API: https://iceclog.com/manual-for-icecat-push-api-api-in/
The Push-API requires separate authorization.
Hi
I'm trying the JSON command in combination with the EAN code e.g. https://live.icecat.biz/api/?UserName=openIcecat-live&Language=en>IN=0882780751682
This works fine but not for all EAN codes, eg. https://live.icecat.biz/api/?UserName=openIcecat-live&Language=en>IN=5060301694013 does not work,(error: {"statusCode":4,"message":"Product identifier(s) is not correct"}) altough the ean code exist in your database. How come?
Hi John, the example is a Full Icecat product. This will require a Full Icecat subscription. With a free Open Icecat account you can access just the data of sponsoring brands. See https://icecat.biz/nl/p/nzxt/rl-krm22-01/computer+liquid+cooling-5060301694013-kraken+m22-52945173.html