Tesco API Capability

Category products list

List one page of a Tesco category shelf for a taxonomy facet id, with prices, promotions, ratings, and GTINs.

Capability ID tesco.category.products.list

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

Maximum runtime 30 seconds

# Category products list

List one page of a Tesco category shelf for a taxonomy facet id, with prices, promotions, ratings, and GTINs.

- Platform: [Tesco](https://docs.upscrape.com/docs/platforms/tesco)
- Capability ID: `tesco.category.products.list`
- Cost: 1–8 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": {
    "count": 24,
    "facet": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==",
    "page": 1,
    "sort_by": "relevance"
  },
  "capability": "tesco.category.products.list"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `count` | `integer` | No | Products per page. Defaults to 24. From 1 to 48. Default: `24`. |
| `facet` | `string` | Yes | Opaque category facet id from tesco.categories.list, e.g. b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA== (Fresh Fruit). |
| `include_raw` | `boolean` | No | Include the faithful GraphQL response envelope under `raw`. Defaults to false (normalized `items` only). Default: `false`. |
| `page` | `integer` | No | 1-based shelf page. Defaults to 1. At least 1. Default: `1`. |
| `sort_by` | `string` | No | Upstream sort key. Observed values: relevance (default), price-ascending, price-descending. Allowed values: `relevance`, `price-ascending`, `price-descending`. Default: `relevance`. |

### Example input

```json
{
  "count": 24,
  "facet": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==",
  "page": 1,
  "sort_by": "relevance"
}
```

## 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 example shows one response. Values and optional fields vary with the data available.

```json
{
  "items": [
    {
      "gtin": "00000003249833",
      "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==",
      "departmentName": "Fresh Fruit",
      "adId": null,
      "isRestrictedOrderAmendment": null,
      "isNew": false,
      "reviews": {
        "stats": {
          "noOfReviews": 191,
          "overallRating": 2.9,
          "overallRatingRange": 5
        }
      },
      "isInFavourites": null,
      "typename": "ProductType",
      "brandName": "TESCO",
      "tpnb": "77091643",
      "minWeight": 0,
      "modelMetadata": null,
      "description": [],
      "id": "284477542",
      "baseProductId": "77091643",
      "increment": 0,
      "maxQuantityAllowed": 99,
      "timeRestrictedDelivery": null,
      "restrictions": [],
      "details": {
        "components": [
          {
            "isLowEverydayPricing": false
          }
        ]
      },
      "images": {
        "display": [
          {
            "default": {}
          }
        ]
      },
      "shortDescription": null,
      "averageWeight": 0,
      "sellers": {
        "results": [
          {
            "fulfilment": null,
            "id": "284477542",
            "isForSale": true,
            "price": {
              "actual": 2.9,
              "price": 2.9,
              "unitOfMeasure": "each",
              "unitPrice": 0.58
            },
            "promotions": [
              {
                "attributes": [
                  "CLUBCARD_PRICING"
                ],
                "description": "£1.99 Clubcard Price",
                "endDate": "2026-08-10T23:00:00Z",
                "id": "101748027",
                "price": {
                  "afterDiscount": 2.9,
                  "beforeDiscount": null
                },
                "promotionType": null,
                "startDate": "2026-07-27T23:00:00Z",
                "unitSellingInfo": "£0.40/each"
              }
            ],
            "seller": null,
            "status": "AvailableForSale"
          }
        ]
      },
      "displayType": "Quantity",
      "restrictedDelivery": null,
      "quantityInBasket": null,
      "bulkBuyLimitGroupId": null,
      "media": {
        "defaultImage": {
          "aspectRatio": 1
        }
      },
      "shelfId": "b;[redacted:token]",
      "superDepartmentId": "b;RnJlc2glMjBGb29k",
      "maxWeight": 0,
      "aisleId": "b;[redacted:token]==",
      "aisleName": "Apples & Pears",
      "context": null,
      "bulkBuyLimit": 99,
      "groupBulkBuyLimit": 0,
      "productType": "SingleProduct",
      "bulkBuyLimitMessage": null,
      "title": "Tesco Pink Lady Apples 5 Pack",
      "catchWeightList": null,
      "tpnc": "284477542",
      "shelfName": "Pink & Red Apples",
      "superDepartmentName": "Fresh Food"
    },
    {
      "gtin": "00000003330654",
      "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==",
      "departmentName": "Fresh Fruit",
      "adId": null,
      "isRestrictedOrderAmendment": null,
      "isNew": false,
      "reviews": {
        "stats": {
          "noOfReviews": 99,
          "overallRating": 3.2,
          "overallRatingRange": 5
        }
      },
      "isInFavourites": null,
      "typename": "ProductType",
      "brandName": "ROSEDENE FARMS",
      "tpnb": "87739508",
      "minWeight": 0,
      "modelMetadata": null,
      "description": [],
      "id": "305831903",
      "baseProductId": "87739508",
      "increment": 0,
      "maxQuantityAllowed": 99,
      "timeRestrictedDelivery": null,
      "restrictions": [],
      "details": {
        "components": [
          {
            "isLowEverydayPricing": false
          },
          {
            "competitors": [
              {
                "id": "ALDI",
                "priceMatch": {
                  "isMatching": true
                }
              }
            ]
          }
        ]
      },
      "images": {
        "display": [
          {
            "default": {}
          }
        ]
      },
      "shortDescription": null,
      "averageWeight": 0,
      "sellers": {
        "results": [
          {
            "fulfilment": null,
            "id": "305831903",
            "isForSale": true,
            "price": {
              "actual": 1.59,
              "price": 1.59,
              "unitOfMeasure": "each",
              "unitPrice": 0.26
            },
            "promotions": [],
            "seller": null,
            "status": "AvailableForSale"
          }
        ]
      },
      "displayType": "Quantity",
      "restrictedDelivery": null,
      "quantityInBasket": null,
      "bulkBuyLimitGroupId": null,
      "media": {
        "defaultImage": {
          "aspectRatio": 1
        }
      },
      "shelfId": "b;[redacted:token]",
      "superDepartmentId": "b;RnJlc2glMjBGb29k",
      "maxWeight": 0,
      "aisleId": "b;[redacted:token]==",
      "aisleName": "Apples & Pears",
      "context": null,
      "bulkBuyLimit": 99,
      "groupBulkBuyLimit": 0,
      "productType": "SingleProduct",
      "bulkBuyLimitMessage": null,
      "title": "Rosedene Farms Gala Apples 6 Pack",
      "catchWeightList": null,
      "tpnc": "305831903",
      "shelfName": "Pink & Red Apples",
      "superDepartmentName": "Fresh Food"
    },
    {
      "gtin": "00000003260531",
      "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==",
      "departmentName": "Fresh Fruit",
      "adId": null,
      "isRestrictedOrderAmendment": null,
      "isNew": false,
      "reviews": {
        "stats": {
          "noOfReviews": 255,
          "overallRating": 2.7,
          "overallRatingRange": 5
        }
      },
      "isInFavourites": null,
      "typename": "ProductType",
      "brandName": "TESCO finest",
      "tpnb": "78911934",
      "minWeight": 0,
      "modelMetadata": null,
      "description": [],
      "id": "288115395",
      "baseProductId": "78911934",
      "increment": 0,
      "maxQuantityAllowed": 99,
      "timeRestrictedDelivery": null,
      "restrictions": [],
      "details": {
        "components": [
          {
            "isLowEverydayPricing": false
          }
        ]
      },
      "images": {
        "display": [
          {
            "default": {}
          }
        ]
      },
      "shortDescription": null,
      "averageWeight": 0,
      "sellers": {
        "results": [
          {
            "fulfilment": null,
            "id": "288115395",
            "isForSale": true,
            "price": {
              "actual": 2.5,
              "price": 2.5,
              "unitOfMeasure": "kg",
              "unitPrice": 4.17
            },
            "promotions": [],
            "seller": null,
            "status": "AvailableForSale"
          }
        ]
      },
      "displayType": "Quantity",
      "restrictedDelivery": null,
      "quantityInBasket": null,
      "bulkBuyLimitGroupId": null,
      "media": {
        "defaultImage": {
          "aspectRatio": 1
        }
      },
      "shelfId": "b;[redacted:token]=",
      "superDepartmentId": "b;RnJlc2glMjBGb29k",
      "maxWeight": 0,
      "aisleId": "b;[redacted:token]",
      "aisleName": "Oranges, Lemons & Citrus Fruit",
      "context": null,
      "bulkBuyLimit": 99,
      "groupBulkBuyLimit": 0,
      "productType": "SingleProduct",
      "bulkBuyLimitMessage": null,
      "title": "Tesco Finest Sweet Easy Peelers 600g",
      "catchWeightList": null,
      "tpnc": "288115395",
      "shelfName": "Clementines & Easy Peelers",
      "superDepartmentName": "Fresh Food"
    }
  ],
  "page": {
    "count": 24,
    "matchType": null,
    "offset": 0,
    "pageId": null,
    "pageNo": 1,
    "pageSize": 24,
    "query": {
      "actualTerm": null,
      "queryPhase": "primary",
      "searchTerm": null
    },
    "totalCount": 185
  },
  "total_count": 185
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `items` | `array` | 3 items |
| `items` | `array` | 3 items |
| `page` | `object` | 8 fields |
| `page.count` | `integer` | 24 |
| `page.matchType` | `null` | null |
| `page.offset` | `integer` | 0 |
| `page.pageId` | `null` | null |
| `page.pageNo` | `integer` | 1 |
| `page.pageSize` | `integer` | 24 |
| `page.query` | `object` | 3 fields |
| `page.totalCount` | `integer` | 185 |
| `total_count` | `integer` | 185 |

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

count integer optional

Products per page. Defaults to 24. From 1 to 48. Default: `24`.

Example 24

facet string required

Opaque category facet id from tesco.categories.list, e.g. b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA== (Fresh Fruit).

Example b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==

include_raw boolean optional

Include the faithful GraphQL response envelope under `raw`. Defaults to false (normalized `items` only). Default: `false`.

page integer optional

1-based shelf page. Defaults to 1. At least 1. Default: `1`.

Example 1

sort_by string optional

Upstream sort key. Observed values: relevance (default), price-ascending, price-descending. Allowed values: `relevance`, `price-ascending`, `price-descending`. Default: `relevance`.

Example relevance

Available values relevanceprice-ascendingprice-descending

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 example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

Path	Observed type	Example
`items`	`array`	3 items
`items`	`array`	3 items
`page`	`object`	8 fields
`page.count`	`integer`	24
`page.matchType`	`null`	null
`page.offset`	`integer`	0
`page.pageId`	`null`	null
`page.pageNo`	`integer`	1
`page.pageSize`	`integer`	24
`page.query`	`object`	3 fields
`page.totalCount`	`integer`	185
`total_count`	`integer`	185

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: Tesco 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": { "count": 24, "facet": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==", "page": 1, "sort_by": "relevance" }, "capability": "tesco.category.products.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "count": 24, "facet": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==", "page": 1, "sort_by": "relevance" }, "capability": "tesco.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))

{ "items": [ { "gtin": "00000003249833", "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==", "departmentName": "Fresh Fruit", "adId": null, "isRestrictedOrderAmendment": null, "isNew": false, "reviews": { "stats": { "noOfReviews": 191, "overallRating": 2.9, "overallRatingRange": 5 } }, "isInFavourites": null, "typename": "ProductType", "brandName": "TESCO", "tpnb": "77091643", "minWeight": 0, "modelMetadata": null, "description": [], "id": "284477542", "baseProductId": "77091643", "increment": 0, "maxQuantityAllowed": 99, "timeRestrictedDelivery": null, "restrictions": [], "details": { "components": [ { "isLowEverydayPricing": false } ] }, "images": { "display": [ { "default": {} } ] }, "shortDescription": null, "averageWeight": 0, "sellers": { "results": [ { "fulfilment": null, "id": "284477542", "isForSale": true, "price": { "actual": 2.9, "price": 2.9, "unitOfMeasure": "each", "unitPrice": 0.58 }, "promotions": [ { "attributes": [ "CLUBCARD_PRICING" ], "description": "£1.99 Clubcard Price", "endDate": "2026-08-10T23:00:00Z", "id": "101748027", "price": { "afterDiscount": 2.9, "beforeDiscount": null }, "promotionType": null, "startDate": "2026-07-27T23:00:00Z", "unitSellingInfo": "£0.40/each" } ], "seller": null, "status": "AvailableForSale" } ] }, "displayType": "Quantity", "restrictedDelivery": null, "quantityInBasket": null, "bulkBuyLimitGroupId": null, "media": { "defaultImage": { "aspectRatio": 1 } }, "shelfId": "b;[redacted:token]", "superDepartmentId": "b;RnJlc2glMjBGb29k", "maxWeight": 0, "aisleId": "b;[redacted:token]==", "aisleName": "Apples & Pears", "context": null, "bulkBuyLimit": 99, "groupBulkBuyLimit": 0, "productType": "SingleProduct", "bulkBuyLimitMessage": null, "title": "Tesco Pink Lady Apples 5 Pack", "catchWeightList": null, "tpnc": "284477542", "shelfName": "Pink & Red Apples", "superDepartmentName": "Fresh Food" }, { "gtin": "00000003330654", "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==", "departmentName": "Fresh Fruit", "adId": null, "isRestrictedOrderAmendment": null, "isNew": false, "reviews": { "stats": { "noOfReviews": 99, "overallRating": 3.2, "overallRatingRange": 5 } }, "isInFavourites": null, "typename": "ProductType", "brandName": "ROSEDENE FARMS", "tpnb": "87739508", "minWeight": 0, "modelMetadata": null, "description": [], "id": "305831903", "baseProductId": "87739508", "increment": 0, "maxQuantityAllowed": 99, "timeRestrictedDelivery": null, "restrictions": [], "details": { "components": [ { "isLowEverydayPricing": false }, { "competitors": [ { "id": "ALDI", "priceMatch": { "isMatching": true } } ] } ] }, "images": { "display": [ { "default": {} } ] }, "shortDescription": null, "averageWeight": 0, "sellers": { "results": [ { "fulfilment": null, "id": "305831903", "isForSale": true, "price": { "actual": 1.59, "price": 1.59, "unitOfMeasure": "each", "unitPrice": 0.26 }, "promotions": [], "seller": null, "status": "AvailableForSale" } ] }, "displayType": "Quantity", "restrictedDelivery": null, "quantityInBasket": null, "bulkBuyLimitGroupId": null, "media": { "defaultImage": { "aspectRatio": 1 } }, "shelfId": "b;[redacted:token]", "superDepartmentId": "b;RnJlc2glMjBGb29k", "maxWeight": 0, "aisleId": "b;[redacted:token]==", "aisleName": "Apples & Pears", "context": null, "bulkBuyLimit": 99, "groupBulkBuyLimit": 0, "productType": "SingleProduct", "bulkBuyLimitMessage": null, "title": "Rosedene Farms Gala Apples 6 Pack", "catchWeightList": null, "tpnc": "305831903", "shelfName": "Pink & Red Apples", "superDepartmentName": "Fresh Food" }, { "gtin": "00000003260531", "departmentId": "b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==", "departmentName": "Fresh Fruit", "adId": null, "isRestrictedOrderAmendment": null, "isNew": false, "reviews": { "stats": { "noOfReviews": 255, "overallRating": 2.7, "overallRatingRange": 5 } }, "isInFavourites": null, "typename": "ProductType", "brandName": "TESCO finest", "tpnb": "78911934", "minWeight": 0, "modelMetadata": null, "description": [], "id": "288115395", "baseProductId": "78911934", "increment": 0, "maxQuantityAllowed": 99, "timeRestrictedDelivery": null, "restrictions": [], "details": { "components": [ { "isLowEverydayPricing": false } ] }, "images": { "display": [ { "default": {} } ] }, "shortDescription": null, "averageWeight": 0, "sellers": { "results": [ { "fulfilment": null, "id": "288115395", "isForSale": true, "price": { "actual": 2.5, "price": 2.5, "unitOfMeasure": "kg", "unitPrice": 4.17 }, "promotions": [], "seller": null, "status": "AvailableForSale" } ] }, "displayType": "Quantity", "restrictedDelivery": null, "quantityInBasket": null, "bulkBuyLimitGroupId": null, "media": { "defaultImage": { "aspectRatio": 1 } }, "shelfId": "b;[redacted:token]=", "superDepartmentId": "b;RnJlc2glMjBGb29k", "maxWeight": 0, "aisleId": "b;[redacted:token]", "aisleName": "Oranges, Lemons & Citrus Fruit", "context": null, "bulkBuyLimit": 99, "groupBulkBuyLimit": 0, "productType": "SingleProduct", "bulkBuyLimitMessage": null, "title": "Tesco Finest Sweet Easy Peelers 600g", "catchWeightList": null, "tpnc": "288115395", "shelfName": "Clementines & Easy Peelers", "superDepartmentName": "Fresh Food" } ], "page": { "count": 24, "matchType": null, "offset": 0, "pageId": null, "pageNo": 1, "pageSize": 24, "query": { "actualTerm": null, "queryPhase": "primary", "searchTerm": null }, "totalCount": 185 }, "total_count": 185 }