{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Products Scraper: Variants, Prices & Inventory",
    "description": "Paste any Shopify store, collection or product URL and export every product with variants, SKUs, prices, sale prices, images, stock status and public inventory counts. CSV, Excel or JSON. No API key. $1 per 1,000 products.",
    "version": "0.6",
    "x-build-id": "f6BmhKZsMHTaXh6GH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/peerless_columbine~shopify-products-inventory-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-peerless_columbine-shopify-products-inventory-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/peerless_columbine~shopify-products-inventory-scraper/runs": {
      "post": {
        "operationId": "runs-sync-peerless_columbine-shopify-products-inventory-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/peerless_columbine~shopify-products-inventory-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-peerless_columbine-shopify-products-inventory-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": [
          "domains"
        ],
        "properties": {
          "domains": {
            "title": "Store, collection or product URLs",
            "maxItems": 100,
            "type": "array",
            "description": "Shopify stores to export (required, up to 100). Each item is a string: a store domain (e.g. `deathwishcoffee.com` or `https://shop.example.com`) for the whole catalogue, a collection URL (`https://store.com/collections/<handle>`) for that collection only, or a product URL (`https://store.com/products/<handle>`) for one product with all variants. A locale prefix such as `/fr/` is allowed. Other paths or filter query strings are rejected per store and reported in SUMMARY. Does not discover stores.",
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "monitorChanges": {
            "title": "Monitor changes (for scheduled runs)",
            "type": "boolean",
            "description": "Off (default) = normal export of all products. On = change monitoring for scheduled runs: the first run saves a baseline (all products output once, monitorStatus `baseline`); each later run with the same stores outputs ONLY new, removed, price-changed or stock-changed products with before/after values. Unchanged products are not output and not charged. Removed products are detected only when maxProducts=0 and the target is a store or collection. Schedule the same input daily in Apify.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor name (optional)",
            "type": "string",
            "description": "Optional name for this monitoring watch list (max 100 characters); only used when monitorChanges=true. Runs with the same name share one saved baseline. Leave empty to key the baseline on the store list, locale and includeInventoryDetails. Example: `competitor-prices`."
          },
          "resetMonitorBaseline": {
            "title": "Reset monitor baseline",
            "type": "boolean",
            "description": "Only used when monitorChanges=true. Set true once to ignore the saved state and save a fresh baseline in this run (all products are output again as `baseline`). Turn it off again for later runs.",
            "default": false
          },
          "maxProducts": {
            "title": "Maximum products per store",
            "minimum": 0,
            "maximum": 2147483647,
            "type": "integer",
            "description": "Maximum products saved per store (each product row is billed). 0 = the complete available catalogue (until the last page, the maxPagesPerStore safety limit, maxRunSeconds or budget). Use a small value such as 5 for a test; keep 0 for monitoring if you want removed products detected. Allowed range: 0–2,147,483,647.",
            "default": 0
          },
          "includeInventoryDetails": {
            "title": "Read public inventory and product details",
            "type": "boolean",
            "description": "Set true to also read each product's public product JSON, Ajax JSON and HTML page for extra fields: per-variant inventoryQuantity and total inventoryCount when the store exposes them, barcode/GTIN, inventory policy, subscription (selling plan) data, metafields, SEO title/description and brand. Slower (extra requests per product). Never adds to cart or probes quantities. Fields the store does not expose are omitted.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Optional proxy",
            "type": "object",
            "description": "Optional proxy. Default: direct connection, no proxy charges. Use Apify Proxy (e.g. {\"useApifyProxy\": true, \"apifyProxyGroups\": [\"RESIDENTIAL\"], \"apifyProxyCountry\": \"US\"}) or custom proxyUrls, not both; country must be a 2-letter uppercase code. Proxy traffic is billed separately. If a store blocks access it is reported in SUMMARY; there is no automatic switch between proxy and direct access.",
            "default": {
              "useApifyProxy": false
            }
          },
          "datasetId": {
            "title": "Existing dataset ID for a copy",
            "pattern": "^([A-Za-z0-9]{17})?$",
            "type": "string",
            "description": "Advanced, leave empty unless needed. ID of an existing Apify dataset (17 alphanumeric characters) that should receive a copy of every product in addition to the run's default dataset. The run fails at setup if the dataset cannot be accessed. Example: `aBcD1234EfGh5678i`."
          },
          "runId": {
            "title": "Parent run ID",
            "pattern": "^([A-Za-z0-9]{17})?$",
            "type": "string",
            "description": "Advanced, leave empty unless needed. Any 17-character alphanumeric ID (e.g. of a parent/orchestrating run) that is copied verbatim into the `runId` field of every product row, for joining results later. Omitted from output when empty. Example: `aBcD1234EfGh5678i`."
          },
          "locale": {
            "title": "Optional locale route",
            "pattern": "^([a-z]{2,3}(-[a-zA-Z]{2})?)?$",
            "type": "string",
            "description": "Optional Shopify locale route to read, e.g. `fr` or `en-gb` (lowercase language, optional region). The store must have that translated route; prices are returned in the currency the store shows for it, never converted. Empty (default) = store's default language. A locale prefix in a URL in domains is used too and must not conflict with this field.",
            "default": ""
          },
          "pageSize": {
            "title": "Products requested per page",
            "minimum": 1,
            "maximum": 250,
            "type": "integer",
            "description": "Advanced. Number of products requested per catalogue page; not a total limit (use maxProducts for that). Leave at 250 (Shopify's maximum) unless a store errors on large pages. Allowed range: 1–250.",
            "default": 250
          },
          "maxPagesPerStore": {
            "title": "Pagination safety ceiling",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Advanced, emergency stop. Maximum catalogue pages read per store; when reached, the store is marked partial in SUMMARY and the catalogue is not claimed complete. The default 10,000 pages × 250 products is effectively unlimited. Allowed range: 1–100,000.",
            "default": 10000
          },
          "requestTimeoutSecs": {
            "title": "Request timeout in seconds",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "Advanced. Timeout for each HTTP request attempt, in seconds. Allowed range: 5–120.",
            "default": 25
          },
          "maxRetries": {
            "title": "Transient retries",
            "minimum": 0,
            "maximum": 4,
            "type": "integer",
            "description": "Advanced. Retries for transient network failures, HTTP 429 and some 5xx responses. Access denials (e.g. 401/403) are not retried or bypassed. Allowed range: 0–4.",
            "default": 2
          },
          "requestIntervalSecs": {
            "title": "Minimum seconds between source requests",
            "minimum": 0.2,
            "maximum": 10,
            "type": "number",
            "description": "Minimum delay between the start of consecutive requests, in seconds (stores are crawled one request at a time, never in parallel). Lower = faster but more likely to hit rate limits. Allowed range: 0.2–10.",
            "default": 0.5
          },
          "maxRunSeconds": {
            "title": "Graceful runtime ceiling",
            "minimum": 10,
            "maximum": 86400,
            "type": "integer",
            "description": "Time budget for collection, in seconds; when reached, collection stops, saved products are kept and progress is recorded as incomplete in SUMMARY. Set it below the Actor run timeout so final results can be saved (default 3300 s fits a 1-hour timeout). Allowed range: 10–86,400.",
            "default": 3300
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}