{
  "openapi": "3.0.1",
  "info": {
    "title": "Woolworths Australia Grocery Products Scraper",
    "description": "Scrape Woolworths Australia grocery products by keyword or URL: prices, specials, ingredients, nutrition, ratings and reviews.",
    "version": "1.0",
    "x-build-id": "4SAOfyqRHxGPpbDVp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parsebird~woolworths-au-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parsebird-woolworths-au-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/parsebird~woolworths-au-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parsebird-woolworths-au-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/parsebird~woolworths-au-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parsebird-woolworths-au-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Input mode",
            "enum": [
              "search",
              "url"
            ],
            "type": "string",
            "description": "Search by keyword/category, or paste Woolworths URLs directly.",
            "default": "search"
          },
          "queries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Search keywords for search mode. Each keyword is searched separately.",
            "items": {
              "type": "string"
            }
          },
          "specialsCategory": {
            "title": "Specials & offers category",
            "enum": [
              "",
              "half-price",
              "lower-shelf-price",
              "online-only-specials",
              "everyday-low-price",
              "seasonal-price",
              "buy-more-save-more",
              "bundles",
              "all-specials",
              "all-specials-complete"
            ],
            "type": "string",
            "description": "Browse a whole specials category (search mode) instead of a keyword. 'All specials (complete)' sweeps every department for anything currently discounted, including offers with no promotions-menu category. Leave blank to skip.",
            "default": ""
          },
          "excludeSpecialsCategories": {
            "title": "Exclude specials categories",
            "type": "array",
            "description": "Drop products in these specials categories instead of collecting them. Skipped listings are never fetched, so they cost nothing.",
            "items": {
              "type": "string",
              "enum": [
                "half-price",
                "lower-shelf-price",
                "online-only-specials",
                "everyday-low-price",
                "seasonal-price",
                "buy-more-save-more",
                "bundles",
                "all-specials",
                "all-specials-complete"
              ],
              "enumTitles": [
                "Half Price",
                "Lower Shelf Price",
                "Online Only Specials",
                "Everyday Low Price",
                "Seasonal Price",
                "Buy More Save More",
                "Bundles",
                "All specials (any)",
                "All specials (any)"
              ]
            },
            "default": []
          },
          "excludeCategories": {
            "title": "Exclude departments",
            "type": "array",
            "description": "Departments to skip entirely, e.g. beer-wine-spirits, everyday-market, pet. Accepts a browse-URL slug, display name, or full URL. Skipped products are never fetched, so they cost nothing.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "price_asc",
              "price_desc",
              "name",
              "savings"
            ],
            "type": "string",
            "description": "Order results are collected/kept in.",
            "default": "relevance"
          },
          "minRating": {
            "title": "Minimum rating",
            "enum": [
              "",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Keep only products rated at least this many stars. Requires product details (fetchDetails is turned on automatically if needed). Applied after Max products, so a small Max products combined with a rating filter can return fewer items than expected.",
            "default": ""
          },
          "specialsOnly": {
            "title": "Specials only",
            "type": "boolean",
            "description": "Keep only products currently on special / half price.",
            "default": false
          },
          "includeMarketplace": {
            "title": "Include Everyday Market (third-party) products",
            "type": "boolean",
            "description": "Also include products shipped by third-party Everyday Market sellers. Off by default: only products sold directly by Woolworths are returned, which is both faster and more complete for most departments.",
            "default": false
          },
          "minPrice": {
            "title": "Minimum price (AUD)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products priced at or above this amount."
          },
          "maxPrice": {
            "title": "Maximum price (AUD)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products priced at or below this amount."
          },
          "urls": {
            "title": "URLs",
            "type": "array",
            "description": "Product, category, specials, product-group or search URLs, or bare product codes (url mode). See the README for supported link shapes.",
            "items": {
              "type": "string"
            }
          },
          "fetchDetails": {
            "title": "Fetch product details",
            "type": "boolean",
            "description": "Collect full product detail (department/category, ingredients, nutrition, allergens) plus aggregate rating.",
            "default": true
          },
          "fetchReviews": {
            "title": "Fetch customer reviews",
            "type": "boolean",
            "description": "Also collect customer reviews for each product.",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Max reviews per product",
            "minimum": 0,
            "type": "integer",
            "description": "Cap reviews collected per product. 0 = all available reviews.",
            "default": 20
          },
          "maxItems": {
            "title": "Max products",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of products to return for the whole run. 0 = unlimited.",
            "default": 20
          },
          "maxPages": {
            "title": "Max pages per source",
            "minimum": 1,
            "type": "integer",
            "description": "Optional bound on result pages walked per keyword/category/URL (36 products per page). Leave empty to walk every result page (maxItems still caps the total)."
          },
          "resumeFromRunId": {
            "title": "Resume from run ID",
            "type": "string",
            "description": "ID of a previous run of this Actor (or a dataset ID). Products already in that dataset are skipped, so this run returns only new products."
          },
          "proxy": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Woolworths blocks most datacenter IPs, so Residential proxy is used by default.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "AU"
            }
          },
          "mcpConnectors": {
            "title": "Connectors (Notion / Linear / Airtable / Apify)",
            "type": "array",
            "description": "Optionally send results into apps you already use. Each entry needs a 'type' (notion, linear, airtable or apify) and a 'token'; Notion also needs the Notion parent page URL below, Linear needs 'teamId', Airtable needs 'baseId' and 'tableName', Apify needs 'datasetId'. Leave empty to skip - this never changes the dataset output.",
            "default": []
          },
          "notionParentPageUrl": {
            "title": "Notion parent page URL",
            "type": "string",
            "description": "Notion connector only: URL of the Notion page under which item pages are created."
          },
          "maxNotifyListings": {
            "title": "Max items sent to connectors",
            "minimum": 1,
            "type": "integer",
            "description": "Cap on items sent to each connector per run. Does not affect the dataset.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}