Sainsbury's Groceries API Capability

List category products

List products from a Sainsbury's grocery category with published prices and supported listing continuation.

Capability ID sainsburys.category.products.list

Cost From $1.25 per 1,000 requests · 1–15 credits

Maximum runtime 30 seconds

# List category products

List products from a Sainsbury's grocery category with published prices and supported listing continuation.

- Platform: [Sainsbury's Groceries](https://docs.upscrape.com/docs/platforms/sainsburys)
- Capability ID: `sainsburys.category.products.list`
- Cost: 1–15 credits per request
- Maximum runtime: 30 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": {
    "category_id": "1020694",
    "page_size": 5
  },
  "capability": "sainsburys.category.products.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category_id` | `string` | Yes | Category identifier. |
| `page` | `integer` | No | One-based result page to fetch. From 1 to 1000. Default: `1`. |
| `page_size` | `integer` | No | Number of results per page. From 1 to 90. Default: `30`. |

### Example input

```json
{
  "category_id": "1020694",
  "page_size": 5
}
```

## 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
{
  "count": 1,
  "has_more": false,
  "next_page": null,
  "page": 1,
  "page_size": 5,
  "products": [
    {
      "available": true,
      "brand": "Clean & Clear",
      "gtin": "5000207007159",
      "image": "https://assets.sainsburys-groceries.co.uk/gol/6010343/image.jpg",
      "member_prices": [
        {
          "price": {
            "amount": 2.6,
            "currency": "GBP"
          },
          "promotion_id": "10757348",
          "scheme": "nectar"
        }
      ],
      "name": "Clean & Clear Dual Action Moisturiser Face Cream 100ml",
      "pack_size": "100ml",
      "price": {
        "amount": 3.5,
        "currency": "GBP"
      },
      "promotions": [
        {
          "buy_quantity": null,
          "description": "Save 25% with Nectar",
          "end": "2026-10-12T23:00:00Z",
          "for_amount": null,
          "id": "10757348",
          "member_scheme": "nectar",
          "start": "2026-09-01T23:00:00Z",
          "type": "member"
        }
      ],
      "retailer_product_id": "6010343",
      "unit_price": {
        "amount": 35,
        "currency": "GBP",
        "measure_amount": 1,
        "unit": "per_litre"
      },
      "url": "https://www.sainsburys.co.uk/gol-ui/product/[redacted:token]"
    }
  ],
  "total": 1
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `count` | `integer` | 1 |
| `has_more` | `boolean` | false |
| `next_page` | `null` | null |
| `page` | `integer` | 1 |
| `page_size` | `integer` | 5 |
| `products` | `array` | 1 items |
| `products` | `array` | 1 items |
| `total` | `integer` | 1 |

## 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

category_id string required

Category identifier.

Example 1020694

page integer optional

One-based result page to fetch. From 1 to 1000. Default: `1`.

page_size integer optional

Number of results per page. From 1 to 90. Default: `30`.

Example 5

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
`count`	`integer`	1
`has_more`	`boolean`	false
`next_page`	`null`	null
`page`	`integer`	1
`page_size`	`integer`	5
`products`	`array`	1 items
`products`	`array`	1 items
`total`	`integer`	1

Execution behavior

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

Overview, pricing and sample data for every endpoint: Sainsbury's Groceries API

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": { "category_id": "1020694", "page_size": 5 }, "capability": "sainsburys.category.products.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "category_id": "1020694", "page_size": 5 }, "capability": "sainsburys.category.products.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))

{ "count": 1, "has_more": false, "next_page": null, "page": 1, "page_size": 5, "products": [ { "available": true, "brand": "Clean & Clear", "gtin": "5000207007159", "image": "https://assets.sainsburys-groceries.co.uk/gol/6010343/image.jpg", "member_prices": [ { "price": { "amount": 2.6, "currency": "GBP" }, "promotion_id": "10757348", "scheme": "nectar" } ], "name": "Clean & Clear Dual Action Moisturiser Face Cream 100ml", "pack_size": "100ml", "price": { "amount": 3.5, "currency": "GBP" }, "promotions": [ { "buy_quantity": null, "description": "Save 25% with Nectar", "end": "2026-10-12T23:00:00Z", "for_amount": null, "id": "10757348", "member_scheme": "nectar", "start": "2026-09-01T23:00:00Z", "type": "member" } ], "retailer_product_id": "6010343", "unit_price": { "amount": 35, "currency": "GBP", "measure_amount": 1, "unit": "per_litre" }, "url": "https://www.sainsburys.co.uk/gol-ui/product/[redacted:token]" } ], "total": 1 }