{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Store Scraper & API - Products, Prices, Variants",
    "description": "Shopify store scraper and products API: give it Shopify store, collection or product URLs. One row per product or variant: title, price, compare-at price, discount, stock flag, variants with SKU and options, vendor, type, tags, images, dates. No login; failed stores free. $0.50 per 1,000 results.",
    "version": "1.0",
    "x-build-id": "DPkKmKqjnnydwUHLT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rel8ble~shopify-store-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rel8ble-shopify-store-products-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/rel8ble~shopify-store-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rel8ble-shopify-store-products-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/rel8ble~shopify-store-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rel8ble-shopify-store-products-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": [
          "storeUrls"
        ],
        "properties": {
          "storeUrls": {
            "title": "Shopify stores, collections or products",
            "type": "array",
            "description": "Required. One per line, any mix of: a store domain or URL (\"allbirds.com\", \"https://www.deathwishcoffee.com\") = every product in that store; a collection URL (\"https://www.allbirds.com/collections/mens\") = only that collection; a product URL (\"https://www.allbirds.com/products/mens-tree-runners\") = that one product. Works for any store built on Shopify, on its own domain or on *.myshopify.com. Paste hundreds of stores for bulk runs. Sites that are not Shopify, password-protected stores and stores that block their product feed are listed as failed in the run summary and are never charged.",
            "items": {
              "type": "string"
            }
          },
          "outputMode": {
            "title": "Output: one row per product or per variant",
            "enum": [
              "product",
              "variant"
            ],
            "type": "string",
            "description": "Optional. \"product\" (default) = one result per product with all its variants nested in a variants array; best for catalog exports and product research. \"variant\" = one flat result per variant (size / colour) with its own price, SKU and in-stock flag; best for price and stock monitoring in spreadsheets. In variant mode every variant row is one billed result.",
            "default": "product"
          },
          "maxProductsPerStore": {
            "title": "Max products per store",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Products to save per store or collection URL, integer. Default 250 (one feed page, a few seconds). 0 or empty = every product in the store. Counted after the filters below. Typical cost: 250 products = $0.125, a 5,000-product store = $2.50.",
            "default": 250
          },
          "onlyAvailable": {
            "title": "In stock only",
            "type": "boolean",
            "description": "Optional boolean. true = keep only products with at least one variant in stock (in variant mode: only in-stock variants). Default false.",
            "default": false
          },
          "onSaleOnly": {
            "title": "On sale only",
            "type": "boolean",
            "description": "Optional boolean. true = keep only products where a variant has a compare-at (strike-through) price above its price (in variant mode: only discounted variants). Default false.",
            "default": false
          },
          "titleKeywords": {
            "title": "Title keywords",
            "type": "array",
            "description": "Optional. Keep only products whose title contains at least one of these words or phrases, case-insensitive: \"hoodie\", \"gift card\". Empty = all products.",
            "items": {
              "type": "string"
            }
          },
          "vendors": {
            "title": "Vendors (brands)",
            "type": "array",
            "description": "Optional. Keep only products whose vendor equals one of these, case-insensitive: \"Nike\", \"Allbirds\". Empty = all vendors. Useful for multi-brand stores.",
            "items": {
              "type": "string"
            }
          },
          "productTypes": {
            "title": "Product types",
            "type": "array",
            "description": "Optional. Keep only products whose Shopify product type equals one of these, case-insensitive: \"Shoes\", \"Socks\". Empty = all types. Product types are set by each store, so check a first run for the exact names.",
            "items": {
              "type": "string"
            }
          },
          "updatedAfter": {
            "title": "Updated after",
            "type": "string",
            "description": "Optional. Keep only products the store changed on or after this date: an absolute date \"2026-09-01\" or a relative one \"7 days\", \"2 weeks\", \"1 month\". Use with a schedule to collect only new and changed products. Empty = no date filter."
          },
          "includeDescriptionHtml": {
            "title": "Include description HTML",
            "type": "boolean",
            "description": "Optional boolean. false (default) = description as plain text only. true = also add descriptionHtml with the original HTML (larger output), for re-importing products into another store.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Optional, advanced. Parallel requests across stores, integer 1-50. Default 10. Pages of one store are always read one after another, so a store is never hit in parallel.",
            "default": 10
          },
          "maxRequestRetries": {
            "title": "Max retries per page",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Optional, advanced. Retries per page on a new IP when Shopify rate-limits (HTTP 429 / 430) or times out, integer 0-20. Default 6. Waits grow between attempts.",
            "default": 6
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Apify Proxy (datacenter) is the default and works for most Shopify stores. A store that answers HTTP 403 to the proxy is retried once over a direct connection automatically. If it still comes back as failed with \"access denied (HTTP 403)\", switch to the RESIDENTIAL group for that store.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}