{ "openapi": "3.0.1", "info": { "title": "Macy's Product Scraper", "description": "Scrape macys.com products, prices, brands, categories, product details, ratings, images and availability into clean, structured data. Affordable and easy to use for ecommerce research, price monitoring, competitor analysis and product intelligence.", "version": "1.0", "x-build-id": "Ud5jVo9nkmi4vz3MP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdoe~macys-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdoe-macys-product-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/mrdoe~macys-product-scraper/runs": { "post": { "operationId": "runs-sync-mrdoe-macys-product-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/mrdoe~macys-product-scraper/run-sync": { "post": { "operationId": "run-sync-mrdoe-macys-product-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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search", "productDetails" ], "type": "string", "description": "Which Macy's data to scrape. One operation per run.", "default": "search" }, "query": { "title": "Search query (optional)", "type": "string", "description": "Keyword to search Macy's, e.g. \"shoes\". Used by the search operation. Defaults to a demo query if left blank.", "default": "shoes" }, "queries": { "title": "Search queries - batch (optional)", "type": "array", "description": "Many keywords in one run. Wins over \"query\" when filled. Duplicates and blanks are dropped.", "items": { "type": "string" } }, "productId": { "title": "Product ID or product URL (optional)", "type": "string", "description": "A Macy's numeric product ID (e.g. \"25155177\") or a full product URL (e.g. \"https://www.macys.com/shop/product/...?ID=25155177\"). Used by the productDetails operation. Defaults to a demo product if left blank.", "default": "25155177" }, "productIds": { "title": "Product IDs or product URLs - batch (optional)", "type": "array", "description": "Many product IDs or product URLs in one run. Wins over \"productId\" when filled.", "items": { "type": "string" } }, "maxItems": { "title": "Max items (optional)", "minimum": 1, "type": "integer", "description": "Caps total rows returned across the whole run (applies to search; productDetails always returns one row per product ID). The first 10 rows of any run are free. Defaults to 20 - raise it if you need more.", "default": 20 }, "sortBy": { "title": "Sort by (optional)", "enum": [ "ORIGINAL", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "TOP_RATED", "BEST_SELLERS", "NEW_ITEMS" ], "type": "string", "description": "Applies to search.", "default": "ORIGINAL" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is strongly recommended for sustained volume.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }