IKEA API Capability

List Category Products

Browse a live IKEA category by category key, with offset-based continuation.

Capability ID ikea.category.products.list

Cost 1 credit per request

Maximum runtime 30 seconds

# List Category Products

Browse a live IKEA category by category key, with offset-based continuation.

- Platform: [IKEA](https://docs.upscrape.com/docs/platforms/ikea)
- Capability ID: `ikea.category.products.list`
- Cost: 1 credit 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 YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "category_id": "10382",
    "limit": 10,
    "locale": "fr/fr",
    "max_records": 3
  },
  "capability": "ikea.category.products.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category_id` | `string` | Yes | IKEA storefront category key, such as 10382 for bookcases in France. |
| `limit` | `integer` | No | Upstream product window size. |
| `locale` | `string` | No | IKEA country/language storefront. |
| `max_records` | `integer` | No | Maximum normalized products to return; raw remains untruncated. |
| `offset` | `integer` | No | Zero-based product offset; pass next_offset from the previous response. |

### Example input

```json
{
  "category_id": "10382",
  "limit": 10,
  "locale": "fr/fr",
  "max_records": 3
}
```

## 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": "10382",
    "image_url": "https://www.ikea.com/global/assets/range-categorisation/images/bookcases-10382.jpeg",
    "name": "Bibliothèques",
    "url": "https://www.ikea.com/fr/fr/cat/bibliotheques-10382/"
  },
  "items": [
    {
      "categories": [
        {
          "key": "st001",
          "name": "Rangements"
        },
        {
          "key": "10382",
          "name": "Bibliothèques"
        }
      ],
      "colors": [
        "blanc"
      ],
      "currency": "EUR",
      "description": "blanc 80x28x202 cm",
      "id": "20522046",
      "name": "BILLY",
      "online_sellable": true,
      "price": 59.99,
      "rating_count": 51,
      "rating_value": 4.5,
      "type_name": "Bibliothèque",
      "url": "https://www.ikea.com/fr/fr/p/billy-bibliotheque-blanc-20522046/"
    },
    {
      "categories": [
        {
          "key": "st001",
          "name": "Rangements"
        },
        {
          "key": "10382",
          "name": "Bibliothèques"
        }
      ],
      "colors": [
        "blanc"
      ],
      "currency": "EUR",
      "description": "blanc 40x28x202 cm",
      "id": "50522040",
      "name": "BILLY",
      "online_sellable": true,
      "price": 49.99,
      "rating_count": 41,
      "rating_value": 4.7,
      "type_name": "Bibliothèque",
      "url": "https://www.ikea.com/fr/fr/p/billy-bibliotheque-blanc-50522040/"
    }
  ],
  "locale": "fr/fr",
  "next_offset": 10,
  "offset": 0,
  "raw": {
    "productListPage": {
      "productCount": 116
    }
  },
  "total": 116
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `category` | `object` | 4 fields |
| `category.id` | `string` | 10382 |
| `category.image_url` | `string` | https://www.ikea.com/global/assets/range-categorisation/images/bookcase… |
| `category.name` | `string` | Bibliothèques |
| `category.url` | `string` | https://www.ikea.com/fr/fr/cat/bibliotheques-10382/ |
| `items` | `array` | 2 items |
| `items` | `array` | 2 items |
| `locale` | `string` | fr/fr |
| `next_offset` | `integer` | 10 |
| `offset` | `integer` | 0 |
| `raw` | `object` | 1 fields |
| `raw.productListPage` | `object` | 1 fields |
| `total` | `integer` | 116 |

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

IKEA storefront category key, such as 10382 for bookcases in France.

Example 10382

limit integer optional

Upstream product window size.

Example 10

locale string optional

IKEA country/language storefront.

Example fr/fr

Available values fr/frgb/enie/ende/de

max_records integer optional

Maximum normalized products to return; raw remains untruncated.

Example 3

offset integer optional

Zero-based product offset; pass next_offset from the previous 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`	`object`	4 fields
`category.id`	`string`	10382
`category.image_url`	`string`	https://www.ikea.com/global/assets/range-categorisation/images/bookcase…
`category.name`	`string`	Bibliothèques
`category.url`	`string`	https://www.ikea.com/fr/fr/cat/bibliotheques-10382/
`items`	`array`	2 items
`items`	`array`	2 items
`locale`	`string`	fr/fr
`next_offset`	`integer`	10
`offset`	`integer`	0
`raw`	`object`	1 fields
`raw.productListPage`	`object`	1 fields
`total`	`integer`	116

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 YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "category_id": "10382", "limit": 10, "locale": "fr/fr", "max_records": 3 }, "capability": "ikea.category.products.list" }'

import json import requests payload = json.loads(r'''{ "input": { "category_id": "10382", "limit": 10, "locale": "fr/fr", "max_records": 3 }, "capability": "ikea.category.products.list" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "category": { "id": "10382", "image_url": "https://www.ikea.com/global/assets/range-categorisation/images/bookcases-10382.jpeg", "name": "Bibliothèques", "url": "https://www.ikea.com/fr/fr/cat/bibliotheques-10382/" }, "items": [ { "categories": [ { "key": "st001", "name": "Rangements" }, { "key": "10382", "name": "Bibliothèques" } ], "colors": [ "blanc" ], "currency": "EUR", "description": "blanc 80x28x202 cm", "id": "20522046", "name": "BILLY", "online_sellable": true, "price": 59.99, "rating_count": 51, "rating_value": 4.5, "type_name": "Bibliothèque", "url": "https://www.ikea.com/fr/fr/p/billy-bibliotheque-blanc-20522046/" }, { "categories": [ { "key": "st001", "name": "Rangements" }, { "key": "10382", "name": "Bibliothèques" } ], "colors": [ "blanc" ], "currency": "EUR", "description": "blanc 40x28x202 cm", "id": "50522040", "name": "BILLY", "online_sellable": true, "price": 49.99, "rating_count": 41, "rating_value": 4.7, "type_name": "Bibliothèque", "url": "https://www.ikea.com/fr/fr/p/billy-bibliotheque-blanc-50522040/" } ], "locale": "fr/fr", "next_offset": 10, "offset": 0, "raw": { "productListPage": { "productCount": 116 } }, "total": 116 }