{ "openapi": "3.0.1", "info": { "title": "Americanas Brazil - Products, Prices, Sellers & Reviews", "description": "Scrape Americanas Brazil (americanas.com.br) by keyword, department or pasted link. Returns SKU, title, brand, seller (store or marketplace), price, PIX price, discount, instalments in BRL, stock, images, variants, specs and reviews. Incremental mode tracks changes.", "version": "1.0", "x-build-id": "spDivFaw8ldOQjwc6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~americanas-com-br-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-americanas-com-br-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/abotapi~americanas-com-br-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-americanas-com-br-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/abotapi~americanas-com-br-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-americanas-com-br-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "Choose 'search' to search the catalogue by keyword and filters, or 'url' to scrape pasted links: product pages, department pages and search result pages are all accepted.", "default": "search" }, "queries": { "title": "Search keywords", "type": "array", "description": "Only used when mode = search, ignored in url mode. One or more keywords, for example 'notebook dell', 'cafeteira' or 'tenis nike'. Leave empty to browse by Department, Brand or price alone.", "items": { "type": "string" } }, "urls": { "title": "Store links", "type": "array", "description": "Only used when mode = url, ignored in search mode. Mix freely: product pages ending in /p , department pages such as /computadores-e-informatica/notebook , and search pages such as /busca/notebook-dell .", "items": { "type": "string" } }, "categories": { "title": "Department", "uniqueItems": true, "type": "array", "description": "Optional. Keep only products in these store departments. Combine with a keyword, or use on its own to browse a whole department. Selecting several returns products from any of them. For a narrower category (for example Notebook inside Computers), paste that category page into url mode instead.", "items": { "type": "string", "enum": [ "agro-industria-e-comercio", "alimentos-e-bebidas", "artes-e-artesanato", "artigos-de-festa", "audio-e-video", "automotivo", "bebes-e-higiene-infantil", "beleza-e-perfumaria", "bem-estar-sexual", "brinquedos", "cabelos", "calcados", "cama-mesa-e-banho", "celulares-e-smartphones", "climatizacao", "computadores-e-informatica", "consoles-e-games", "construcao-e-ferramentas", "decoracao", "eletrodomesticos", "eletroportateis", "esporte-e-lazer", "instrumentos-musicais", "limpeza", "livros", "malas-mochilas-e-acessorios", "moda", "moveis", "musica-filmes-e-series", "papelaria", "pet-shop", "relogios-e-joias", "saude-e-bem-estar", "suplementos-e-vitaminas", "tablets", "telefonia", "utilidades-domesticas", "gift-card", "seguros", "vale-presente", "servicos", "shopnext" ], "enumTitles": [ "Agriculture, industry and trade", "Food and drink", "Arts and crafts", "Party supplies", "Audio and video", "Automotive", "Baby and infant care", "Beauty and perfume", "Sexual wellness", "Toys", "Hair care", "Footwear", "Bed, bath and table", "Mobile phones and smartphones", "Air conditioning", "Computers and IT", "Consoles and games", "Construction and tools", "Home decor", "Large appliances", "Small appliances", "Sports and leisure", "Musical instruments", "Cleaning", "Books", "Luggage, backpacks and accessories", "Fashion", "Furniture", "Music, films and series", "Stationery", "Pet shop", "Watches and jewellery", "Health and wellbeing", "Supplements and vitamins", "Tablets", "Telephony", "Household goods", "Gift cards", "Insurance", "Gift vouchers", "Services", "Shopnext" ] } }, "brands": { "title": "Brand", "type": "array", "description": "Optional. Keep only products from these brands, typed as the store writes them, for example 'Lenovo' or 'Samsung'. Accents and capitals do not matter. Selecting several returns products from any of them. A brand the store does not publish is reported by name and skipped; if none of your brands exist, the run stops instead of quietly returning unfiltered results.", "items": { "type": "string" } }, "sellerType": { "title": "Sold by", "enum": [ "any", "first_party", "marketplace" ], "type": "string", "description": "Optional. Americanas sells its own stock alongside marketplace sellers. 'Store itself' is applied by the store as a native filter. 'Marketplace sellers only' is applied to the results, because the store publishes no filter that excludes its own stock.", "default": "any" }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Optional. Keep only products priced at or above this amount, in Brazilian reais. Applied by the store itself, so it narrows the result count at the source." }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Optional. Keep only products priced at or below this amount, in Brazilian reais. Applied by the store itself, so it narrows the result count at the source." }, "minInterestFreeInstallments": { "title": "Minimum interest free instalments", "minimum": 0, "maximum": 24, "type": "integer", "description": "Optional. Keep only products that can be paid in at least this many interest free credit card instalments (parcelas sem juros). Applied to the results, because the store publishes no instalment filter. Use 0 for no instalment requirement.", "default": 0 }, "inStockOnly": { "title": "Only products that can be ordered", "type": "boolean", "description": "Optional. Keep only products the store will currently accept an order for. Applied to the results, because the store returns sold out listings alongside available ones on this route.", "default": false }, "onSaleOnly": { "title": "Only reduced price products", "type": "boolean", "description": "Optional. Keep only products whose current price is below their advertised original price. Applied to the results. Note that the PIX cash discount is not a price reduction and does not count here; it is returned separately in pixPrice.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_asc", "price_desc", "best_selling", "best_rated", "newest", "biggest_discount", "name_asc", "name_desc" ], "type": "string", "description": "The order the store returns results in. All nine are the store's own orderings, applied at the source.", "default": "relevance" }, "fetchDetails": { "title": "Fetch delivery details", "type": "boolean", "description": "Read the delivery estimate, shipping cost and pickup availability for each product at the postal code below. One extra request per product, billed as one Detail enrichment event per product returned.", "default": false }, "deliveryPostalCode": { "title": "Delivery postal code (CEP)", "type": "string", "description": "Used when Fetch delivery details is on. Defaults to central Sao Paulo (01310100) so the default enriched run works; replace it with your own 8 digit Brazilian CEP for destination-specific shipping cost and delivery time.", "default": "01310100" }, "fetchReviews": { "title": "Fetch customer reviews", "type": "boolean", "description": "Add each product's rating, review count, per star breakdown and individual reviews (author, date, rating, text, verified purchase, helpful count and any photos). Ratings are looked up for a whole page at once at no per-product cost; only a product that actually has reviews costs an extra request, and only those products are billed a Detail enrichment event. A product with no reviews returns an empty reviews list.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Cap on how many individual reviews are returned per product. The rating, review count and per star breakdown are always complete regardless of this cap. Use 0 for all reviews a product has.", "default": 20 }, "maxItems": { "title": "Max products", "minimum": 0, "type": "integer", "description": "Maximum number of products to return across the whole run. This is the run's cap. Use 0 for unlimited.", "default": 20 }, "maxPages": { "title": "Max result pages per keyword or link", "minimum": 0, "type": "integer", "description": "Maximum number of result pages read per keyword, department or link. 0 means no limit, which is the default: the run then stops only at Max products, at the end of the results, or when a page returns nothing new.", "default": 0 }, "resumeFromRunId": { "title": "Resume from a previous run", "type": "string", "description": "Paste a previous run ID or dataset ID to continue a large catalogue pull without returning or charging for products already collected there. Use this after an interrupted run. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns every matching product as NEW. Later runs normally return only NEW, UPDATED and REAPPEARED products. Turn on Emit unchanged or Emit expired only when you also want those rows returned (and billed). State is kept separately for each search, filter and lookup setup; use State key to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently configured runs. Leave empty to let the actor derive a key automatically from the search, filters and lookup settings, so different searches never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return products that have not changed since the last run, marked UNCHANGED. This returns, and bills, extra rows you already have, so leave it off unless you want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return products that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search, so never when Max products capped it or when Resume was used. This returns, and bills, extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended. The standard pool is the default and is sufficient for this store.", "default": { "useApifyProxy": true } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize one under Apify, Settings, API & Integrations, then select it here. Notion gets a rich page-per-item export; other connectors get a best-effort write or digest. Leave empty to skip; never changes the dataset output. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL or id of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }