Paste one public Shopify link per entry. Start with one product to check compatibility and cost.
\nChoose your scope:/products/shoe?variant=123 — one exact variant./products/shoe — all variants of that product./collections/shoes — that category.https://store.example — the whole public catalog.
Replace the example domain, handle and IDs with real values. Complete ?option_values=10,20 links also work when Shopify confirms their mapping.
For SKU/size filters, use the optional section below. Filtered collection and subscription selling_plan links are rejected with an explanation. Maximum 100 links; whole catalogs can exceed Free limits.
Enter the country where you want to compare offers: US, GB, DE or CA. Use two uppercase letters.
Leave empty to use the market returned by the store. A requested country must be confirmed by Shopify; a different country fails the check.
\nApplies to every link. An Advanced target can override it. Use the same country and currency when comparing competitors.
" }, "language": { "title": "Storefront language (optional)", "pattern": "^[A-Z]{2}(?:_[A-Z]{2})?$", "type": "string", "description": "Optional storefront language: EN, FR, or another Shopify language code in uppercase.
For localized links such as /fr-fr/products/shoe, explicitly set country or language. The path alone does not verify the market.
Use the language in which the store exposes the exact option names/values you select. Applies to all links unless an Advanced target overrides it.
" }, "expectedCurrency": { "title": "Expected currency (optional)", "pattern": "^[A-Z]{3}$", "type": "string", "description": "Enter the currency you expect: USD, GBP, EUR or CAD. Use three uppercase letters.
If the returned currency differs, the check fails and previous history is preserved. This field does not convert prices or switch markets; set Market country for that.
\nLeave empty if you only need the returned currency. Applies to every link unless an Advanced target overrides it.
" }, "mode": { "title": "What do you want to do?", "enum": [ "monitor", "snapshot", "preview" ], "type": "string", "description": "Track price and stock changes: save the first successful check as a baseline. Repeat runs compare with the last successful check. Save a Task and schedule it.
\nExport / discover variants: return current variants without changing monitor history. To find IDs, use a plain product link, clear SKU/options selectors, and choose One row per variant under Results.
\nDiscovery is billed as a normal check. Copy the desired variant URL into a monitor Task afterward.
\nPreview watchlist: validate and show parsed URLs, exact selectors and requested markets without source requests, product/catalog charges or history writes. Variant existence and actual cost remain unverified; the Apify start fee still applies.
", "default": "monitor" }, "outputMode": { "title": "Which results should be returned?", "enum": [ "changesOnly", "all" ], "type": "string", "description": "Changes only: later monitor runs return changes, source health and check receipts. The first run also shows current variants by default. No price change means no price-alert row.
\nAll observations and changes: include current selected variants on every successful monitor check.
\nExport/discovery mode always returns current variants. Quiet checks still scan the source and are billed. Notifications require a separate workflow.
", "default": "changesOnly" }, "watchlistCsv": { "title": "Import a CSV watchlist (optional)", "maxLength": 131072, "type": "string", "description": "Paste CSV exported from Excel or Google Sheets. Clear Shopify URLs and Advanced targets first. Up to 100 rows / 128 KiB; comma, semicolon, or tab delimiter.
\nurl,variantId,country,expectedCurrency,option:Sizehttps://example.com/products/shirt,123456,US,USD,M
Required column: url. Optional: targetId, variantId, sku, country, language, expectedCurrency, productId, comparisonGroup, role, and option:NAME or options JSON.
Format IDs and SKUs as text to preserve digits and leading zeros. Select Preview watchlist to check the parsed selections without requests to stores or history changes. Preview still has the Apify start fee.
" }, "skus": { "title": "Exact SKUs (optional)", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "Paste the merchant’s exact SKU, one per entry. Leave empty if the URL already selects the variant you need.
\nAny listed SKU can match. Size/color options and a URL variant are additional restrictions; all must agree.
\nApplies to every link unless an Advanced target overrides it. Different stores may use different SKUs. A complete no-match result includes reviewable variant links; the Actor does not guess a replacement.
", "items": { "type": "string" } }, "options": { "title": "Exact size, color or pack (optional JSON)", "maxProperties": 3, "type": "object", "description": "Enter the store’s exact option names and values, for example:{\"Size\":\"M\",\"Color\":\"Black\"}
For several sizes:{\"Size\":[\"M\",\"L\"]}
This matches M or L. With a Color field too, the color must also match.
Applies to every link unless an Advanced target overrides it. Leave empty for no extra option restriction. Choose Export / discover variants to see actual option names, SKUs and links.
", "additionalProperties": true }, "observationLayout": { "title": "Variant export format", "enum": [ "product", "variant" ], "type": "string", "description": "Compact products: group exact variants under their product. Recommended for catalogs and lower row counts. A single selected product variant stays a flat row.
\nOne row per variant: easier to read/export as CSV and to discover exact SKU/options/URLs. Large flat exports can use more check units.
\nBoth formats retain exact variant prices and stock. Change events always stay flat.
", "default": "product" }, "emitInitialSnapshot": { "title": "Show current variants on the first check", "type": "boolean", "description": "Keep enabled to see current selected variants on the first successful monitor check. The Actor saves a baseline without calling existing products “new”.
\nDisable for a quiet first baseline. Later output follows your chosen results mode. The first check is billed either way.
", "default": true }, "minimumPriceChangePercent": { "title": "Price change alert threshold (%)", "pattern": "^(?:100(?:\\.0{1,4})?|[0-9]{1,2}(?:\\.[0-9]{1,4})?)$", "type": "string", "description": "Enter 0 for every price move, 1 for 1%, or 0.5 for 0.5%. Do not type the % sign.
Small moves accumulate from the last price alert. A threshold reduces noise; successful quiet checks still save observed history.
\nSold-out and restock events do not depend on this price threshold.
", "default": "0" }, "emitNewLowAlerts": { "title": "Alert on a new observed 30-day low", "type": "boolean", "description": "Enable a separate alert when the price falls below previously retained samples from the last 30 days.
\nThis is an observed low, not proof of the lowest price at every moment. Sample count and retained history determine coverage.
", "default": false }, "includeMetadataChanges": { "title": "Alert on labels, SKU or URL changes", "type": "boolean", "description": "Enable alerts for changes to labels, SKU, selected options or product URL. Off by default to reduce cosmetic noise.
\nKnown product IDs continue to be tracked when the merchant renames a handle.
", "default": false }, "removalConfirmations": { "title": "Successful absence checks before a disappearance alert", "minimum": 2, "maximum": 5, "type": "integer", "description": "Require 2–5 consecutive successful absence checks before reporting disappearance. Default: 2.
\nFailed or incomplete checks do not count. Leaving a collection, losing a variant, and becoming unavailable in a verified market have separate events.
", "default": 2 }, "includeBackordersInComparison": { "title": "Include backorders in best-price ranking", "type": "boolean", "description": "Enable if backorder offers should participate in best-price ranking. Off by default because a purchasable backorder is not necessarily ready to ship.
\nBackorders remain visible in the offers either way. This setting affects reviewed competitor groups.
", "default": false }, "emitMatchCandidates": { "title": "Suggest equivalent variants for review", "type": "boolean", "description": "Find possible cross-store matches sharing a valid GTIN barcode in the same verified country/currency.
\nSuggestions include exact variants and copyable comparison targets. Review model, pack quantity and purchase terms first. Candidates are never automatically ranked.
", "default": false }, "maxMatchCandidates": { "title": "Maximum match suggestions", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum barcode-match suggestions to return. Default: 100.
\nOnly verified sources and checksum-valid barcodes are considered. Suggestion rows are separate from the product/change-row limit.
", "default": 100 }, "monitorId": { "title": "Separate watchlist ID (optional)", "pattern": "^[A-Za-z0-9_-]{1,80}$", "type": "string", "description": "For saved Tasks, leave empty: each Task keeps its own history automatically.
\nFor API/ad hoc checks, reuse a stable name such as competitor-watch. Give independent clients/watchlists different names.
Changing this ID starts a separate history. Keep the same Task or ID for repeat checks.
" }, "historyLimit": { "title": "Price history samples per variant", "minimum": 2, "maximum": 365, "type": "integer", "description": "Number of successful observations retained per variant. Default: 90; allowed: 2–365.
\nThis is samples, not days: 90 daily checks span about 90 days; 90 hourly checks span under 4 days.
\n30-day lows/highs use only retained samples. Inspect the sample count before interpreting them.
", "default": 90 }, "targets": { "title": "Advanced targets: exact variants and competitor groups", "maxItems": 100, "type": "array", "description": "Use this JSON list for different selections per store or competitor comparisons. Clear Shopify URLs first.
\nEach entry needs url. Optional fields: targetId, variantIds, skus, options, country, language and expectedCurrency.
For comparison, give equivalent offers the same comparisonGroup and select exactly one variant per target. Mark at most one offer role: \"own\". README has a full copyable example.
Maximum product/variant observations and change rows for the run. Default: 50,000.
\nA target that would exceed the limit is reported partial; its previous history is preserved. Source statuses and comparison rows are additional.
", "default": 50000 }, "advanced": { "title": "Coverage and request limits (optional JSON)", "type": "object", "description": "Leave empty for normal use. Adjust coverage/request limits only when needed. Example:{\"maxProducts\":500,\"maxRequests\":200,\"maxRunSeconds\":300}
Paid defaults: 5,000 products and 50,000 variants per target; 1,000 requests and 900 seconds per run.
\nFree ceilings: 100 check units/run; 100 products and 3,000 variants/target; 1,000 variants/product; 80 requests and 180 seconds/run. Input cannot raise these ceilings.
\nIncomplete checks preserve history. Set spending limits separately in Apify run options. A larger input limit does not provide more credits or memory.
", "additionalProperties": 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 } } } } } } } } } }