{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Store Intelligence: Apps, Catalogue & Pricing Signals",
    "description": "Paste store domains: find which are Shopify, then get store profile, theme, installed apps, catalogue size, price range, discounts, stock and new products from public storefront data. Optional product rows and a daily new-product / price-change monitor. No emails or phones.",
    "version": "0.1",
    "x-build-id": "iMqqGYp39zdVz7PLu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/signalscouter~shopify-store-intelligence/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-signalscouter-shopify-store-intelligence",
        "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/signalscouter~shopify-store-intelligence/runs": {
      "post": {
        "operationId": "runs-sync-signalscouter-shopify-store-intelligence",
        "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/signalscouter~shopify-store-intelligence/run-sync": {
      "post": {
        "operationId": "run-sync-signalscouter-shopify-store-intelligence",
        "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",
        "properties": {
          "domains": {
            "title": "Store domains or URLs",
            "type": "array",
            "description": "Domains or website URLs to check, e.g. allbirds.com or https://www.tentree.com. www., paths and subdomains of the same domain are merged and analysed once. Non-Shopify sites get a 'notShopify' row.",
            "items": {
              "type": "string"
            }
          },
          "datasetId": {
            "title": "Or read domains from a dataset",
            "type": "string",
            "description": "ID of an Apify dataset to read domains from, e.g. the output of signalscouter/company-tech-stack-signals filtered to Shopify. Combined with the list above."
          },
          "datasetField": {
            "title": "Dataset field",
            "type": "string",
            "description": "Field holding the domain in that dataset.",
            "default": "domain"
          },
          "includeCatalogStats": {
            "title": "Catalogue statistics",
            "type": "boolean",
            "description": "Read the public /products.json catalogue and add price range, discount share, in-stock share, vendors, product types and new-product counts to each store row.",
            "default": true
          },
          "maxProductPages": {
            "title": "Max catalogue pages per store",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "250 products per page. 10 pages = up to 2,500 products. The row says 'truncated' if a store has more.",
            "default": 10
          },
          "exportProducts": {
            "title": "Export product rows",
            "type": "boolean",
            "description": "Also output one row per product (charged per product row). In monitor mode, only new or changed products are output.",
            "default": false
          },
          "maxProductsPerStore": {
            "title": "Max product rows per store",
            "minimum": 0,
            "maximum": 25000,
            "type": "integer",
            "description": "Cap on product rows per store. 0 = no cap (everything scanned).",
            "default": 0
          },
          "includeDescription": {
            "title": "Include product descriptions",
            "type": "boolean",
            "description": "Plain-text description on product rows (max 3,000 characters).",
            "default": false
          },
          "includeVariants": {
            "title": "Include variant details",
            "type": "boolean",
            "description": "SKU, price, compare-at price and stock flag per variant on product rows.",
            "default": false
          },
          "monitorChanges": {
            "title": "Monitor mode: new products and price changes",
            "type": "boolean",
            "description": "Remember each store's catalogue between runs. Store rows get a 'changes' block; with 'Export product rows' on, only products that are new or changed price or stock since the last run are output and charged. Schedule it daily.",
            "default": false
          },
          "monitorId": {
            "title": "Monitor ID",
            "type": "string",
            "description": "Name for this monitor's memory. Use different IDs for separate watch lists. Don't run two runs with the same ID at the same time.",
            "default": "default"
          },
          "baselineOnFirstRun": {
            "title": "First run only records a baseline",
            "type": "boolean",
            "description": "On a store's first monitored run, save the catalogue without outputting every product as 'new'.",
            "default": true
          },
          "maxDomains": {
            "title": "Max domains",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many unique domains. 0 = all.",
            "default": 0
          },
          "maxConcurrency": {
            "title": "Stores in parallel",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Different stores checked at the same time. Requests to one store are always one at a time.",
            "default": 5
          },
          "requestDelaySecs": {
            "title": "Delay between requests to one store (s)",
            "minimum": 0.5,
            "maximum": 10,
            "type": "number",
            "description": "Minimum gap between two requests to the same store (robots.txt crawl-delay is honoured if longer). Catalogue pages are also paced by Shopify's own cost header.",
            "default": 1
          },
          "requestTimeoutSecs": {
            "title": "Request timeout (s)",
            "minimum": 5,
            "maximum": 60,
            "type": "number",
            "description": "Per-request timeout.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}