Waitrose API Capability

Offers

Browse products and offers in the public Waitrose promotions collection with published price and deal information.

Capability ID waitrose.promotions.list

Cost From $9.98 per 1,000 requests · 8 credits

Maximum runtime 45 seconds

# Offers

Browse products and offers in the public Waitrose promotions collection with published price and deal information.

- Platform: [Waitrose](https://docs.upscrape.com/docs/platforms/waitrose)
- Capability ID: `waitrose.promotions.list`
- Cost: 8 credits per request
- Maximum runtime: 45 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "collection": "mywaitrose"
  },
  "capability": "waitrose.promotions.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `collection` | `string` | No | Allowed values: `all`, `half_price`, `save_third`, `percentage_off`, `multibuy`, `mywaitrose`. |
| `offset` | `integer` | No | Zero-based number of results to skip. From 0 to 10000. |

### Example input

```json
{
  "collection": "mywaitrose"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "collection": "mywaitrose",
  "items": [
    {
      "available": null,
      "brand": "Waitrose Ltd",
      "gtin": null,
      "image": "https://ecom-su-static-prod.wtrecom.com/images/products/9/LN_065244_BP_9.jpg",
      "member_prices": [
        {
          "price": {
            "amount": 0,
            "currency": "GBP"
          },
          "promotion_id": "-900108360",
          "scheme": "mywaitrose"
        }
      ],
      "name": "Waitrose & Partners Food magazine",
      "pack_size": "Each",
      "price": {
        "amount": 5,
        "currency": "GBP"
      },
      "promotions": [
        {
          "buy_quantity": null,
          "description": "MW Free Food Magazine",
          "end": "2029-01-30",
          "for_price": null,
          "id": "-900108360",
          "start": null,
          "type": "member"
        }
      ],
      "rating_average": 4.2802,
      "rating_count": 1142,
      "retailer_product_id": "065244-33064-33065",
      "unit_price": {
        "amount": 5,
        "currency": "GBP",
        "unit": "each"
      },
      "url": "https://www.waitrose.com/ecom/products/waitrose-partners-food-magazine/065244-33064-33065"
    }
  ],
  "next_offset": null,
  "offset": 0,
  "returned": 1,
  "total_products": 1,
  "truncated": false
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `collection` | `string` | mywaitrose |
| `items` | `array` | 1 items |
| `items` | `array` | 1 items |
| `next_offset` | `null` | null |
| `offset` | `integer` | 0 |
| `returned` | `integer` | 1 |
| `total_products` | `integer` | 1 |
| `truncated` | `boolean` | false |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

collection string optional

Allowed values: `all`, `half_price`, `save_third`, `percentage_off`, `multibuy`, `mywaitrose`.

Example mywaitrose

Available values allhalf_pricesave_thirdpercentage_offmultibuymywaitrose

offset integer optional

Zero-based number of results to skip. From 0 to 10000.

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`collection`	`string`	mywaitrose
`items`	`array`	1 items
`items`	`array`	1 items
`next_offset`	`null`	null
`offset`	`integer`	0
`returned`	`integer`	1
`total_products`	`integer`	1
`truncated`	`boolean`	false

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "collection": "mywaitrose" }, "capability": "waitrose.promotions.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "collection": "mywaitrose" }, "capability": "waitrose.promotions.list" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "collection": "mywaitrose", "items": [ { "available": null, "brand": "Waitrose Ltd", "gtin": null, "image": "https://ecom-su-static-prod.wtrecom.com/images/products/9/LN_065244_BP_9.jpg", "member_prices": [ { "price": { "amount": 0, "currency": "GBP" }, "promotion_id": "-900108360", "scheme": "mywaitrose" } ], "name": "Waitrose & Partners Food magazine", "pack_size": "Each", "price": { "amount": 5, "currency": "GBP" }, "promotions": [ { "buy_quantity": null, "description": "MW Free Food Magazine", "end": "2029-01-30", "for_price": null, "id": "-900108360", "start": null, "type": "member" } ], "rating_average": 4.2802, "rating_count": 1142, "retailer_product_id": "065244-33064-33065", "unit_price": { "amount": 5, "currency": "GBP", "unit": "each" }, "url": "https://www.waitrose.com/ecom/products/waitrose-partners-food-magazine/065244-33064-33065" } ], "next_offset": null, "offset": 0, "returned": 1, "total_products": 1, "truncated": false }