{
  "openapi": "3.0.1",
  "info": {
    "title": "Woolworths Products Scraper | Prices, Specials and Nutrition",
    "description": "Woolworths scraper for Australian grocery prices: get 100 products in 8 seconds, 46 fields each, from just 1 keyword. Price, was price, unit price, specials and multibuys, barcode, brand, categories, ingredients, allergens, nutrition panel and Health Star Rating. No Woolworths account needed.",
    "version": "1.0",
    "x-build-id": "d8iCvqiMp1k2DU1M7"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~woolworths-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-woolworths-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/silentflow~woolworths-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-woolworths-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/silentflow~woolworths-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-woolworths-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",
        "properties": {
          "keywords": {
            "title": "🔎 Keywords",
            "type": "array",
            "description": "What you would type in the Woolworths search box, one per line: <code>milk</code>, <code>tim tam</code>, <code>coffee beans</code>, a brand like <code>Cadbury</code>. Every page of results is read, up to Max products. A woolworths.com.au link typed here is read as a link.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Woolworths links",
            "type": "array",
            "description": "Paste woolworths.com.au pages as you see them in your browser:<ul><li>a category or aisle, <code>https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk</code></li><li>a specials page, <code>https://www.woolworths.com.au/shop/browse/specials/half-price</code></li><li>a search, <code>https://www.woolworths.com.au/shop/search/products?searchTerm=coffee</code></li><li>a product, <code>https://www.woolworths.com.au/shop/productdetails/888140/woolworths-full-cream-milk</code></li></ul>The sort chosen on the page (<code>sortBy</code>) is kept.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "productIds": {
            "title": "🆔 Product ids or barcodes",
            "type": "array",
            "description": "Woolworths stockcodes, the number in a product link (<code>888140</code> for <code>/shop/productdetails/888140/...</code>), or barcodes printed on the pack (<code>9300633556150</code>). Product links work here too. Each id gives one complete row, country of origin included. Best for tracking a fixed basket over time.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "🔢 Max products",
            "minimum": 1,
            "type": "integer",
            "description": "The run stops after this many products, all inputs together. A product found twice is saved once. A search for <code>milk</code> lists about 2,700 products, 36 per page.",
            "default": 100
          },
          "sort": {
            "title": "↕️ Sort by",
            "enum": [
              "relevance",
              "price_asc",
              "price_desc",
              "unit_price_asc",
              "unit_price_desc",
              "name_asc",
              "name_desc",
              "newest"
            ],
            "type": "string",
            "description": "The order Woolworths lists products in, the same choices as on the site. <b>Unit price: low to high</b> puts the cheapest per litre or per kilo first, so a small cap gives you the best value of a search. A link that carries its own <code>sortBy</code> keeps it.",
            "default": "relevance"
          },
          "specialsOnly": {
            "title": "🏷️ Specials only",
            "type": "boolean",
            "description": "Keep only the products on special this week: half price, price drops, other reduced prices with their was price and savings, and multibuys (2 for a set price). Applies to keywords and links; product ids are always returned.",
            "default": false
          },
          "includeDetails": {
            "title": "🇦🇺 Add country of origin",
            "type": "boolean",
            "description": "Open each product's page to add its country of origin, its origin label (<code>Made in Australia from at least 90% Australian ingredients</code>) and its share of Australian ingredients. About one second more per product. Rows from product ids always include it.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}