> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapeunblocker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scrape Woolworths (Australia) groceries

> Woolworths Australia (woolworths.com.au) products as JSON. `mode=search&query=`, `mode=category&category=` and `mode=specials` return `products`: `id` (stockcode), `name`, `brand`, `size`, `url`, `barcode`, `price`, `wasPrice`, `onSale`, `savings`, `promotion` (`type` half_price / special / multibuy / offer, `text`, multibuy `quantity` and `price`), `unitPrice` (`price`, `per`, `text`), `soldBy`, `inStock`, `available`, `purchaseLimit`, `isNew`, `sponsored`, `image`, `categories`, `healthStarRating` and `rating`, plus `totalResults`, `totalPages` and `nextPage`. `mode=product&product=` returns `product` with those fields and `description`, `ingredients`, `allergens` (`contains`, `mayContain`, `freeFrom`), `dietary`, `nutrition` (per serving and per 100 g / mL), `servingSize`, `servingsPerPack`, `storage`, `countryOfOrigin`, `department`, `aisle`, `images` and `variants`. Prices are Woolworths' online prices in AUD. Listings collect up to `max_results` from `page` on, billed one unit per page.



## OpenAPI

````yaml /api-reference/openapi.json post /groceries/woolworths
openapi: 3.1.0
info:
  title: ScrapeUnblocker API
  description: >-
    Public API for the ScrapeUnblocker proxy/anti-bot service. Authenticate
    every request with the `x-scrapeunblocker-key` header. Documented here:
    page-source extraction, Google SERP scraping, image fetch, and the dedicated
    plugin endpoints (search engines, marketplaces, reviews, travel, social and
    more). All other paths exist for internal operations and are intentionally
    hidden from this spec.
  version: 3.0.0
servers:
  - url: https://api.scrapeunblocker.com
    description: Production
security: []
paths:
  /groceries/woolworths:
    post:
      tags:
        - Plugins
      summary: Scrape Woolworths (Australia) groceries
      description: >-
        Woolworths Australia (woolworths.com.au) products as JSON.
        `mode=search&query=`, `mode=category&category=` and `mode=specials`
        return `products`: `id` (stockcode), `name`, `brand`, `size`, `url`,
        `barcode`, `price`, `wasPrice`, `onSale`, `savings`, `promotion` (`type`
        half_price / special / multibuy / offer, `text`, multibuy `quantity` and
        `price`), `unitPrice` (`price`, `per`, `text`), `soldBy`, `inStock`,
        `available`, `purchaseLimit`, `isNew`, `sponsored`, `image`,
        `categories`, `healthStarRating` and `rating`, plus `totalResults`,
        `totalPages` and `nextPage`. `mode=product&product=` returns `product`
        with those fields and `description`, `ingredients`, `allergens`
        (`contains`, `mayContain`, `freeFrom`), `dietary`, `nutrition` (per
        serving and per 100 g / mL), `servingSize`, `servingsPerPack`,
        `storage`, `countryOfOrigin`, `department`, `aisle`, `images` and
        `variants`. Prices are Woolworths' online prices in AUD. Listings
        collect up to `max_results` from `page` on, billed one unit per page.
      operationId: woolworths_groceries_woolworths_post
      parameters:
        - name: mode
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              'search' (default): products matching `query`. 'category': a
              category listing. 'specials': a specials page (Half Price unless
              `category` names another). 'product': one product with nutrition
              and ingredients. Defaults to 'product' when `product` is given and
              to 'category' when `category` is.
            title: Mode
          description: >-
            'search' (default): products matching `query`. 'category': a
            category listing. 'specials': a specials page (Half Price unless
            `category` names another). 'product': one product with nutrition and
            ingredients. Defaults to 'product' when `product` is given and to
            'category' when `category` is.
        - name: query
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              What to search for (mode=search), e.g. 'milk', 'tim tam', 'chicken
              breast'.
            title: Query
          description: >-
            What to search for (mode=search), e.g. 'milk', 'tim tam', 'chicken
            breast'.
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              mode=category: a browse link
              (https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk),
              its path ('dairy-eggs-fridge/milk') or a category id
              ('1_6E4F4E4'). mode=specials: the specials page - 'half-price'
              (default), 'lower-shelf-price', 'everyday-low-price',
              'seasonal-price', 'buy-more-save-more', 'online-only-specials' or
              a specials link.
            title: Category
          description: >-
            mode=category: a browse link
            (https://www.woolworths.com.au/shop/browse/dairy-eggs-fridge/milk),
            its path ('dairy-eggs-fridge/milk') or a category id ('1_6E4F4E4').
            mode=specials: the specials page - 'half-price' (default),
            'lower-shelf-price', 'everyday-low-price', 'seasonal-price',
            'buy-more-save-more', 'online-only-specials' or a specials link.
        - name: product
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              mode=product: a stockcode ('888137') or a product link
              (https://www.woolworths.com.au/shop/productdetails/888137/woolworths-full-cream-milk).
            title: Product
          description: >-
            mode=product: a stockcode ('888137') or a product link
            (https://www.woolworths.com.au/shop/productdetails/888137/woolworths-full-cream-milk).
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: >-
              Listing order: relevance, price_asc, price_desc, unit_price_asc,
              unit_price_desc, name.
            default: relevance
            title: Sort
          description: >-
            Listing order: relevance, price_asc, price_desc, unit_price_asc,
            unit_price_desc, name.
        - name: specials_only
          in: query
          required: false
          schema:
            type: boolean
            description: 'mode=search: only products on special.'
            default: false
            title: Specials Only
          description: 'mode=search: only products on special.'
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: 1-based listing page to start from (36 products per page).
            default: 1
            title: Page
          description: 1-based listing page to start from (36 products per page).
        - name: max_results
          in: query
          required: false
          schema:
            type: integer
            description: >-
              Products to collect across pages, 1-360. Each page fetched is
              billed one unit.
            default: 36
            title: Max Results
          description: >-
            Products to collect across pages, 1-360. Each page fetched is billed
            one unit.
        - name: proxy_country
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Proxy country the request is sent from (ISO-2, e.g. 'AU', 'US').
              Leave blank: Woolworths answers every country, so the load spreads
              over all exits.
            title: Proxy Country
          description: >-
            Proxy country the request is sent from (ISO-2, e.g. 'AU', 'US').
            Leave blank: Woolworths answers every country, so the load spreads
            over all exits.
      responses:
        '200':
          description: >-
            JSON with `products` (listings) or `product`. A search with no
            matches answers 200 with an empty `products` list; one Woolworths
            shows only to signed-in shoppers (tobacco) also carries `warnings`.
          content:
            application/json:
              schema: {}
        '400':
          description: >-
            Invalid parameters, or a product Woolworths shows only to signed-in
            shoppers.
        '404':
          description: Woolworths has no such product or category.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: >-
            Blocked by Woolworths on every attempt, an unusable answer, or no
            answer in time.
      security:
        - ScrapeUnblockerKey: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ScrapeUnblockerKey:
      type: apiKey
      in: header
      name: x-scrapeunblocker-key
      description: Your ScrapeUnblocker API key. Apply on every request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.