{ "openapi": "3.0.1", "info": { "title": "EAN GTIN Product Data API - Icecat Specs, Images, Descriptions", "description": "Look up product data by EAN, GTIN, UPC, MPN or Icecat id through the Icecat JSON API: titles, descriptions, specifications, images, videos, manuals, reasons to buy, reviews, related products and packaging in 80 locales. Bring your own Icecat token. Pay per product.", "version": "0.1", "x-build-id": "Pk53mW8Zb02wGJKIw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~ean-gtin-product-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-ean-gtin-product-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~ean-gtin-product-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-ean-gtin-product-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~ean-gtin-product-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-ean-gtin-product-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "products": { "title": "Products", "type": "array", "description": "One product per line. A 12 to 14 digit GTIN (UPC-A, EAN-13 or GTIN-14), an Icecat product id, or a brand and manufacturer product code written as \"Brand | ProductCode\", for example \"HP | RJ459AV\". Icecat serves one product per request, so each line is one call.", "items": { "type": "string" } }, "identifierType": { "title": "How to read each line", "enum": [ "auto", "gtin", "icecatId", "brandProductCode" ], "type": "string", "description": "Leave on automatic and each line is read by its shape: a line with a | is a brand and product code, 12 to 14 digits is a GTIN, and a shorter number is an Icecat product id. An 8 digit EAN-8 looks like an Icecat id, so choose GTIN explicitly for those.", "default": "auto" }, "language": { "title": "Language (locale)", "enum": [ "EN", "NL", "FR", "DE", "IT", "ES", "DK", "RU", "US", "BR", "PT", "ZH", "SV", "PL", "CZ", "HU", "FI", "EL", "NO", "TR", "BG", "KA", "RO", "SR", "UK", "JA", "CA", "ES_AR", "HR", "AR", "VI", "KO", "MK", "SL", "EN_SG", "EN_ZA", "ZH_TW", "HE", "LT", "LV", "EN_IN", "DE_CH", "ID", "SK", "FA", "ES_MX", "ET", "DE_BE", "FR_BE", "NL_BE", "TH", "RU_UA", "DE_AT", "FR_CH", "EN_NZ", "EN_SA", "EN_ID", "EN_MY", "HI", "FR_CA", "TE", "TA", "KN", "EN_IE", "ML", "EN_AE", "ES_CL", "ES_PE", "ES_CO", "MR", "BN", "MS", "EN_AU", "IT_CH", "EN_PH", "FL_PH", "EN_CA", "EN_EG", "AR_EG", "AR_SA" ], "type": "string", "description": "Icecat locale short code for the content. The international INT locale is not available on the JSON interface. A data sheet not yet released in the chosen locale comes back as its own row saying so.", "default": "EN" }, "sections": { "title": "Sections (granular call)", "type": "array", "description": "Leave empty for the full product data sheet. Pick sections to fetch only those parts, which Icecat calls a granular call. Essential info, title, marketing text, packaging, brand organisations and analytics are only available this way.", "items": { "type": "string", "enum": [ "essentialinfo", "title", "marketingtext", "gallery", "multimedia", "videos", "productstory", "tours3d", "manuals", "featuregroups", "featurelogos", "reviews", "packages", "reasonstobuy", "catalogobjectcloud", "brandorganizations", "analytics" ], "enumTitles": [ "Essential info - brand, code, name, GTINs (granular only)", "Title (granular only)", "Marketing text (granular only)", "Gallery - product images", "Multimedia - all multimedia objects", "Videos", "Product story", "3D tours", "Manuals - PDF documents", "Specifications - feature groups", "Feature logos", "Reviews", "Packaging (granular only)", "Reasons to buy", "Catalog object cloud", "Brand owner and representatives (granular only)", "Analytics - popularity (granular only)" ] } }, "relationsLimit": { "title": "Related products per relation type", "minimum": 1, "maximum": 3000, "type": "integer", "description": "How many alternatives, accessories, services, consumables and compatible products to return for each relation type. Icecat uses 500 when this is blank and accepts up to 3000." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. Each row is one product.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "Pacing ceiling for calls to the Icecat API. Icecat does not publish a rate limit for the JSON interface, so this stays moderate by default. A 429 answer is retried with backoff.", "default": 60 }, "username": { "title": "Icecat username", "type": "string", "description": "Your Icecat username, sent as the shopname parameter. It is shown at the top of My Profile on icecat.biz. Leave blank to use the DATA_API_USERNAME environment secret." }, "apiKey": { "title": "Icecat API access token", "type": "string", "description": "Your own Icecat API access token (My Icecat, Access Tokens), sent as the api-token header. It replaces IP whitelisting, which a cloud run cannot use. This actor is bring-your-own-key and never ships credentials of its own. Leave blank to use the DATA_API_KEY environment secret." }, "contentToken": { "title": "Icecat content access token", "type": "string", "description": "Optional. Your Icecat content access token, sent as the content-token header, so Icecat attaches it to every image and multimedia URL in the answer. Leave blank to use the DATA_API_CONTENT_TOKEN environment secret, or to skip it." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }