{ "openapi": "3.0.1", "info": { "title": "Shift4Shop Scraper - 3dcart Product Catalog", "description": "Export product catalogs from public Shift4Shop and legacy 3dcart stores. Export JSON or CSV and monitor changes. $0.75 per 1,000 rows plus $0.001 per run.", "version": "0.3", "x-build-id": "DSsFEKgK3Ol0JWz6b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clintsa~shift4shop-product-catalog-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clintsa-shift4shop-product-catalog-extractor", "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/clintsa~shift4shop-product-catalog-extractor/runs": { "post": { "operationId": "runs-sync-clintsa-shift4shop-product-catalog-extractor", "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/clintsa~shift4shop-product-catalog-extractor/run-sync": { "post": { "operationId": "run-sync-clintsa-shift4shop-product-catalog-extractor", "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": [ "targets" ], "properties": { "targets": { "title": "Shift4Shop storefront or product URLs", "type": "array", "description": "Public Shift4Shop/3dcart store home, category or product URLs; hostnames also work. A product URL makes the daily example a one-product run.", "items": { "type": "string" } }, "maxItemsPerTarget": { "title": "Maximum rows per target", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Limit exported dataset rows per storefront; 0 returns all. Monitoring still compares every fetched product. The daily example exports one row.", "default": 0 }, "includeRss": { "title": "Include RSS feeds", "type": "boolean", "description": "Read on-sale, new-release and bestseller RSS feeds and emit separate rows for feed entries; also add feed flags to product rows.", "default": true }, "categoryDepth": { "title": "Category depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Follow nested category links from the storefront home page up to this depth; the sitemap is also checked for product URLs.", "default": 2 }, "maxProductPages": { "title": "Maximum product pages", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Cap product detail requests per target; 0 visits every discovered product. Capped runs suppress removal events.", "default": 0 }, "maxCategoryPages": { "title": "Maximum category pages", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap category and listing page requests; 0 has no category cap. Capped runs suppress removal events.", "default": 0 }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Pause between storefront requests to reduce load on the merchant site.", "default": 200 }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Persistent snapshot namespace for comparing scheduled runs of the same storefront and settings.", "default": "default" }, "onlyChangesSince": { "title": "Only changes since", "pattern": "^\\d{4}-\\d{2}-\\d{2}T.*$", "type": "string", "description": "Optional ISO 8601 timestamp; return only new, updated or removed records detected since that time." } } }, "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 } } } } } } } } } }