{
  "openapi": "3.0.1",
  "info": {
    "title": "Coles Scraper — Bulk Prices & CSV API",
    "description": "Collect Coles products, specials and basket prices; track delivered observations with explicit store context. Bulk export: JSON, CSV, Excel and API. PPE: $1/1K product results; usage extra.",
    "version": "0.1",
    "x-build-id": "5ato2chifj7OSDId5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apivault_labs~coles-basket-price-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apivault_labs-coles-basket-price-monitor",
        "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/apivault_labs~coles-basket-price-monitor/runs": {
      "post": {
        "operationId": "runs-sync-apivault_labs-coles-basket-price-monitor",
        "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/apivault_labs~coles-basket-price-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-apivault_labs-coles-basket-price-monitor",
        "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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Keywords for Coles Australia product search. Leave empty for category/product/basket-only runs. If no targets are supplied, a small milk search is used.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "categoryUrls": {
            "title": "Category URLs",
            "type": "array",
            "description": "Public Coles browse or specials URLs. No complete catalogue guarantee.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "Full public Coles product URLs.",
            "items": {
              "type": "string"
            }
          },
          "basket": {
            "title": "Selected basket",
            "type": "array",
            "description": "Explicit product URLs and positive quantities. Unknown prices remain unknown. Optional applyMultibuy supports validated repeated-SKU offers.",
            "items": {
              "type": "object"
            }
          },
          "comparisonProducts": {
            "title": "Woolworths reference products",
            "type": "array",
            "description": "User-provided dated AUD reference prices mapped by colesProductId. Requires samePackConfirmed=true. This is not live collection of Woolworths.",
            "items": {
              "type": "object"
            }
          },
          "incrementalMode": {
            "title": "Track observations",
            "type": "boolean",
            "description": "Output only changes by default. Advance the campaign baseline only after a complete cycle and fully delivered output.",
            "default": false
          },
          "emitUnchanged": {
            "title": "Include unchanged products",
            "type": "boolean",
            "description": "Return unchanged observations in monitoring runs.",
            "default": false
          },
          "stateKey": {
            "title": "Campaign name",
            "type": "string",
            "description": "Use a different key for different products, quantities or filters.",
            "default": "default"
          },
          "specialsOnly": {
            "title": "Specials only",
            "type": "boolean",
            "description": "Keep explicit source promotion flags.",
            "default": false
          },
          "inStockOnly": {
            "title": "Available online only",
            "type": "boolean",
            "description": "Keep only explicit online availability values.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum products",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Products collected per run, including unchanged observations before incremental output filtering. Partial scans can checkpoint with resume.",
            "default": 100
          },
          "maxPages": {
            "title": "Maximum pages per target",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum newly collected listing pages per target per run. Continuations may also deliver observations saved by a previous run.",
            "default": 3
          },
          "requestTimeoutSecs": {
            "title": "Request timeout",
            "minimum": 5,
            "maximum": 60,
            "type": "integer",
            "description": "Bounded collection limit; an incomplete scan does not advance monitoring state.",
            "default": 45
          },
          "collectionTimeoutSecs": {
            "title": "Collection time budget",
            "minimum": 30,
            "maximum": 600,
            "type": "integer",
            "description": "Bounded collection limit; an incomplete scan does not advance monitoring state.",
            "default": 240
          },
          "includeDetails": {
            "title": "Full product cards",
            "type": "boolean",
            "description": "Fetch GTIN, ingredients, allergens, nutrition, origin, images and variants where supplied. Additional product requests consume time.",
            "default": false
          },
          "trackHistory": {
            "title": "Save dated price history",
            "type": "boolean",
            "description": "Retain observed completed cycles in a named campaign. No synthetic daily history.",
            "default": false
          },
          "resume": {
            "title": "Resume incomplete scans",
            "type": "boolean",
            "description": "Continue an incomplete collection with the same stateKey and targets. Previously delivered observations are skipped after a successful checkpoint.",
            "default": false
          },
          "applyMultibuy": {
            "title": "Apply supported multibuy",
            "type": "boolean",
            "description": "Apply explicit validated N-for-price or Pick-any offers to repeated integer units of the same SKU. Excludes mixed SKU groups, members and weighted checkout pricing.",
            "default": false
          },
          "excludeSponsored": {
            "title": "Exclude sponsored placements",
            "type": "boolean",
            "description": "Remove products explicitly marked as sponsored.",
            "default": false
          },
          "compareWoolworths": {
            "title": "Compare live Woolworths prices",
            "type": "boolean",
            "description": "Fetch details and match valid GTIN plus equal physical pack. Without explicit reference URLs, starts the Woolworths Products Price Monitor Actor; its Actor/resource charges are additional and capped by comparisonBudgetUsd.",
            "default": false
          },
          "brands": {
            "title": "Exact brands",
            "type": "array",
            "description": "Case-insensitive exact brand names, not a fuzzy keyword match.",
            "items": {
              "type": "string"
            }
          },
          "woolworthsProductUrls": {
            "title": "Live Woolworths candidate URLs",
            "type": "array",
            "description": "Optional explicit public product detail URLs for compareWoolworths. Reads live pages without a child Actor. Identity still requires matching valid GTIN and equal pack.",
            "items": {
              "type": "string"
            }
          },
          "historyDays": {
            "title": "History statistics window",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Days included in statistics for actual collected observations; this does not retrieve past prices.",
            "default": 30
          },
          "historyRetentionDays": {
            "title": "History retention days",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Retain actual completed-cycle observations for this many days, subject to the per-product entry limit.",
            "default": 365
          },
          "maxHistoryEntries": {
            "title": "Maximum observations per product",
            "minimum": 2,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum retained dated observations per product and shopping basket.",
            "default": 100
          },
          "maxComparisonProducts": {
            "title": "Coles products to compare per run",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum collected Coles products used for bounded live Woolworths candidate discovery.",
            "default": 5
          },
          "maxComparisonCandidates": {
            "title": "Woolworths candidates per product",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Maximum candidate count per selected comparison product. Exact matches are not guaranteed.",
            "default": 3
          },
          "maxCampaignProducts": {
            "title": "Maximum campaign identities",
            "minimum": 100,
            "maximum": 20000,
            "type": "integer",
            "description": "Maximum unique products in a monitoring campaign. Narrow targets if the campaign reaches its storage limit.",
            "default": 10000
          },
          "minPrice": {
            "title": "Minimum AUD price",
            "minimum": 0,
            "type": "number",
            "description": "Unknown values are excluded when this filter is supplied."
          },
          "maxPrice": {
            "title": "Maximum AUD price",
            "minimum": 0,
            "type": "number",
            "description": "Unknown values are excluded when this filter is supplied."
          },
          "minDiscountPercent": {
            "title": "Minimum discount percent",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Unknown values are excluded when this filter is supplied."
          },
          "comparisonBudgetUsd": {
            "title": "Maximum child comparison charge USD",
            "minimum": 0.01,
            "maximum": 1,
            "type": "number",
            "description": "Per-run cap for the optional Woolworths Actor. Includes its charges under Apify limits; this Coles run has separate resource usage.",
            "default": 0.1
          },
          "sortBy": {
            "title": "Sort collected output batch",
            "enum": [
              "source",
              "priceAscending",
              "priceDescending",
              "nameAscending",
              "unitPriceAscending"
            ],
            "type": "string",
            "description": "Sorts only the collected output batch. Unit sorting separates $/kg and $/L, with unknown values last; it is not a global catalogue ranking.",
            "default": "source"
          },
          "promotionFilter": {
            "title": "Promotion type",
            "enum": [
              "all",
              "halfprice",
              "multibuy"
            ],
            "type": "string",
            "description": "Half-price requires an observed previous/current discount or an explicitly reported percentage of at least 50%. Multibuy requires a reported promotion.",
            "default": "all"
          },
          "storeId": {
            "title": "Coles store ID",
            "type": "string",
            "description": "Select online prices and online availability for a known Coles store, such as 839 (Broadway) or 481 (Perth). Each product page must confirm the store. Physical shelf stock and member prices are not verified."
          },
          "postcode": {
            "title": "Postcode (verification pending)",
            "type": "string",
            "description": "Automatically select a listed Coles supermarket in this exact four-digit postcode, then verify its identity with Coles. No nearby/default-store fallback; unlisted postcodes fail explicitly. If several stores match, the lowest numeric ID is chosen. Choose postcode or storeId, not both."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}