{ "openapi": "3.0.1", "info": { "title": "Exito Colombia Grocery Price Scraper", "description": "Extract product data from Exito Colombia by keyword or category. Scrape prices, list prices, stock, installments, EAN, brand, seller and marketplace flag from the largest Colombian grocery and retail store.", "version": "0.1", "x-build-id": "ISfmG1xNtPhJakfcN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~exito-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-exito-scraper", "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/scrapers_lat~exito-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-exito-scraper", "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/scrapers_lat~exito-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-exito-scraper", "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": { "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of product offers to collect across all searches and categories. Each available SKU and seller is one record. Optional." }, "withDetails": { "title": "Include Details", "type": "boolean", "description": "When enabled, each record also includes the product description and technical specifications. Disable for a faster, lighter run.", "default": true }, "searchTerms": { "title": "Search Terms", "type": "array", "description": "Full-text queries to search the Exito catalog (e.g. \"arroz\", \"televisor lg\", \"pañales\"). Each term is searched separately. Maps to the VTEX ft parameter.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Restrict results to one or more Exito departments. Each selected department is scraped separately. Maps to the VTEX fq=C: filter.", "items": { "type": "string", "enum": [ "34185082", "34185083", "34185084", "34185085", "34185087", "34185088", "34185089", "34185090", "34185091", "34185093", "34185086", "34185095", "34185096", "34185780", "346098589", "348542968", "341066070" ], "enumTitles": [ "Mercado (Groceries)", "Cuidado personal (Personal Care)", "Tecnologia (Technology)", "Moda y accesorios (Fashion & Accessories)", "Electrodomesticos (Home Appliances)", "Hogar y decoracion (Home & Decor)", "Vehiculos (Vehicles)", "Papeleria y libros (Stationery & Books)", "Herramientas y ferreteria (Tools & Hardware)", "Deportes y fitness (Sports & Fitness)", "Bebes (Babies)", "Juguetes y juegos (Toys & Games)", "Instrumentos musicales (Musical Instruments)", "Vinos y licores (Wine & Spirits)", "Belleza (Beauty)", "Jardin y aire libre (Garden & Outdoor)", "Movilidad electrica (Electric Mobility)" ] }, "default": [] }, "sortOrder": { "title": "Sort Order", "enum": [ "", "OrderByPriceASC", "OrderByPriceDESC", "OrderByTopSaleDESC", "OrderByReviewRateDESC", "OrderByNameASC", "OrderByNameDESC", "OrderByReleaseDateDESC", "OrderByBestDiscountDESC" ], "type": "string", "description": "Order in which the catalog returns products. Maps to the VTEX O parameter.", "default": "" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Exito serves its catalog from Colombia and rate-limits or blocks foreign datacenter IPs, so Apify Proxy with Colombian residential IPs is enabled by default and recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CO" } } } }, "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 } } }, "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 } } } } } } } } } }