Ocado API Capability

Category products

List products from a Ocado grocery category with published prices and supported listing continuation.

Capability ID ocado.category.products.list

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

Maximum runtime 45 seconds

# Category products

List products from a Ocado grocery category with published prices and supported listing continuation.

- Platform: [Ocado](https://docs.upscrape.com/docs/platforms/ocado)
- Capability ID: `ocado.category.products.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": {
    "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e"
  },
  "capability": "ocado.category.products.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category_id` | `string` | Yes | Category identifier. |
| `page` | `integer` | No | Legacy first-page selector; use page_token for continuation. |
| `page_token` | `string` | No | Opaque next_page_token returned by the preceding listing response. |

### Example input

```json
{
  "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e"
}
```

## 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
{
  "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e",
  "items": [
    {
      "available": true,
      "brand": "Dell' Ugo",
      "gtin": null,
      "image": "https://www.ocado.com/images-v3/eafa5127-d256-497b-9609-4869092accd6/56bddbc2-2e41-495f-8ac2-6d2f4e7ca0db/300x300.jpg",
      "member_prices": [],
      "name": "Dell'Ugo Fresh Spinach Gnocchi",
      "pack_size": "450g",
      "price": {
        "amount": 3.3,
        "currency": "GBP"
      },
      "promotions": [
        {
          "buy_quantity": 2,
          "description": "Buy 1, add 2nd Half Price.",
          "end": null,
          "for_price": null,
          "id": "e7c87595-a75d-4fa5-b635-2b68853826e5",
          "start": null,
          "type": "multibuy"
        }
      ],
      "retailer_product_id": "317265011",
      "unit_price": {
        "amount": 7.33,
        "currency": "GBP",
        "unit": "per_kg"
      },
      "url": "https://www.ocado.com/products/dell-ugo-fresh-spinach-gnocchi/317265011"
    }
  ],
  "returned": 1,
  "total_products": 290,
  "truncated": true
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `category_id` | `string` | 01f3d930-813f-4038-983b-51bfcc7cb44e |
| `items` | `array` | 1 items |
| `items` | `array` | 1 items |
| `returned` | `integer` | 1 |
| `total_products` | `integer` | 290 |
| `truncated` | `boolean` | true |

## 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 01f3d930-813f-4038-983b-51bfcc7cb44e

page integer optional

Legacy first-page selector; use page_token for continuation.

page_token string optional

Opaque next_page_token returned by the preceding listing response.

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
`category_id`	`string`	01f3d930-813f-4038-983b-51bfcc7cb44e
`items`	`array`	1 items
`items`	`array`	1 items
`returned`	`integer`	1
`total_products`	`integer`	290
`truncated`	`boolean`	true

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": { "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e" }, "capability": "ocado.category.products.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e" }, "capability": "ocado.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))

{ "category_id": "01f3d930-813f-4038-983b-51bfcc7cb44e", "items": [ { "available": true, "brand": "Dell' Ugo", "gtin": null, "image": "https://www.ocado.com/images-v3/eafa5127-d256-497b-9609-4869092accd6/56bddbc2-2e41-495f-8ac2-6d2f4e7ca0db/300x300.jpg", "member_prices": [], "name": "Dell'Ugo Fresh Spinach Gnocchi", "pack_size": "450g", "price": { "amount": 3.3, "currency": "GBP" }, "promotions": [ { "buy_quantity": 2, "description": "Buy 1, add 2nd Half Price.", "end": null, "for_price": null, "id": "e7c87595-a75d-4fa5-b635-2b68853826e5", "start": null, "type": "multibuy" } ], "retailer_product_id": "317265011", "unit_price": { "amount": 7.33, "currency": "GBP", "unit": "per_kg" }, "url": "https://www.ocado.com/products/dell-ugo-fresh-spinach-gnocchi/317265011" } ], "returned": 1, "total_products": 290, "truncated": true }