{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Products API — Catalogue, Prices & Stock",
    "description": "Scrape any Shopify store's catalogue as data. One row per product or per variant: title, handle, SKU, price, compare-at price, stock, options, images, tags, vendor and collections. Give it a domain — no API key, no app install, no store password.",
    "version": "0.1",
    "x-build-id": "Fq73RRH1nkQ0pRONT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/insight.solutions~shopify-products-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-insight.solutions-shopify-products-api",
        "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/insight.solutions~shopify-products-api/runs": {
      "post": {
        "operationId": "runs-sync-insight.solutions-shopify-products-api",
        "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/insight.solutions~shopify-products-api/run-sync": {
      "post": {
        "operationId": "run-sync-insight.solutions-shopify-products-api",
        "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": [
          "stores"
        ],
        "properties": {
          "stores": {
            "title": "Shopify stores",
            "type": "array",
            "description": "One entry per store. A bare domain (`allbirds.com`), a full URL (`https://www.allbirds.com`) and a `myshopify.com` domain all work, and so does a link to any page of the shop — a product page, a collection page, a link with tracking parameters glued on. A collection URL such as `https://www.allbirds.com/collections/mens` narrows that entry to that collection. Redirects are followed, so `example.com` and `www.example.com` are the same job written twice, and duplicates are read, and billed, once.",
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerStore": {
            "title": "Products per store",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "How many products to read from each store. Shopify serves up to 250 per request, so a smaller number here is also a smaller download: ask for 100 and the Actor asks the shop for 100. Set 0 for the whole catalogue, which on a large shop means thousands of rows and a run bounded only by your time and charge budgets. With `rowPerVariant` on this still counts products, not rows — one product can be twenty variants.",
            "default": 250
          },
          "rowPerVariant": {
            "title": "One row per variant",
            "type": "boolean",
            "description": "Return one row for every buyable variant — each size, colour and SKU on its own line, with `variantId`, `sku`, its own `price` and its own `available`, plus every product column repeated. Off, each product is one row and its variants ride along in the `variants` array. Variant rows are billed like product rows, and a shoe with thirteen sizes is thirteen of them, so this is off by default.",
            "default": false
          },
          "includeCollections": {
            "title": "Include collections",
            "type": "boolean",
            "description": "Also return one row per collection in the store — handle, title, description, product count and image — read from the shop's public collection list. These are `rowType: \"collection\"` rows and they are billed at $0.0005 each. A large shop can have thousands of collections, which is why this is off by default.",
            "default": false
          },
          "maxCollectionsPerStore": {
            "title": "Collections per store",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "How many collection rows to return per store, when `includeCollections` is on. Ignored otherwise. Large shops keep far more collections than anyone expects — three or four thousand on a big catalogue, most of them merchandising rules rather than anything a shopper sees — and each one is a billable row, so this is capped by default. It is also the page size, so asking for 40 downloads 40. Set 0 for every collection the store has.",
            "default": 250
          },
          "collectionHandle": {
            "title": "Collection handle",
            "type": "string",
            "description": "Read only one collection from every store, instead of the whole catalogue. Give the handle (`mens`), the path (`/collections/mens`) or the whole collection URL — all three work. A `stores` entry that already names a collection keeps its own; this applies to the ones that do not. Leave it empty for the full catalogue."
          },
          "includeDescriptionHtml": {
            "title": "Include description HTML",
            "type": "boolean",
            "description": "Add `descriptionHtml`, the merchant's raw description markup, alongside the plain-text `description` that every row already carries. Themes and page-builder apps can make that markup many times the size of the words in it, so it is opt-in.",
            "default": false
          },
          "includeImages": {
            "title": "Include images",
            "type": "boolean",
            "description": "Fill in the `images` array — every image of the product with its src, size and position. Turn it off and rows keep `imageUrl`, the first image, which is a link rather than a payload. Nothing extra is fetched either way; the images are already in the feed.",
            "default": true
          },
          "onlyAvailable": {
            "title": "In-stock products only",
            "type": "boolean",
            "description": "Skip products with nothing in stock — and, with `rowPerVariant` on, skip sold-out variants too. \"In stock\" is Shopify's own flag, so a shop that lets customers buy past zero reports its products as available. Skipped products do not count towards `maxProductsPerStore`.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Stores in parallel",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many stores are read at once. Each parallel worker keeps its own proxy session, so a store that gets blocked burns only its own exit IP. Pages *within* one store are sequential and spaced 250–600 ms apart, so this is the only lever on speed for a long list. Three is the balance that holds up in practice.",
            "default": 3
          },
          "maxRunSecs": {
            "title": "Maximum run time (seconds)",
            "minimum": 30,
            "maximum": 3600,
            "type": "integer",
            "description": "Wall-clock budget for the whole run. When it is reached the Actor stops walking, keeps and bills for every product it already wrote, and files a free diagnostic row for each store it never reached. A store stopped part-way keeps its rows and is not marked as failed. Nothing is charged for work that did not happen.",
            "default": 240
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Shopify serves `/products.json` to anyone, so this Actor defaults to Apify's datacenter proxy — the cheap one — and its cost is already inside the per-product price. Some large brands sit behind a bot filter that refuses datacenter address ranges; those come back as free `blocked` rows, and switching this to the RESIDENTIAL group is the fix. Sessions rotate automatically when an exit IP is refused.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}