IKEA API Capability

Products Search

Search IKEA products by keyword or article number in a supported locale.

Capability ID ikea.products.search

Cost 1 credit per request

Maximum runtime 30 seconds

# Products Search

Search IKEA products by keyword or article number in a supported locale.

- Platform: [IKEA](https://docs.upscrape.com/docs/platforms/ikea)
- Capability ID: `ikea.products.search`
- 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": {
    "locale": "fr/fr",
    "query": "kallax"
  },
  "capability": "ikea.products.search"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | `string` | No | Opaque next_cursor from a previous response. IKEA controls continuation-page size. |
| `limit` | `integer` | No | Initial upstream result window, including non-product content cards. Cannot be combined with cursor. |
| `locale` | `string` | No | IKEA country/language storefront. Defaults to France (fr/fr). |
| `max_records` | `integer` | No | Maximum normalized product records to return from the fetched page; raw remains untruncated. |
| `query` | `string` | Yes | Product keywords or an IKEA article number, such as kallax or 69491265. |

### Example input

```json
{
  "locale": "fr/fr",
  "query": "kallax"
}
```

## 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
{
  "items": [
    {
      "categories": [
        {
          "key": "st001",
          "name": "Rangements"
        },
        {
          "key": "st002",
          "name": "Bibliothèques et étagères"
        },
        {
          "key": "11465",
          "name": "Meubles étagères"
        }
      ],
      "colors": [
        "blanc"
      ],
      "currency": "EUR",
      "description": "blanc 77x147 cm",
      "id": "80275887",
      "name": "KALLAX",
      "online_sellable": true,
      "price": 74.99,
      "rating_count": 2747,
      "rating_value": 4.7,
      "type_name": "Étagère",
      "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/"
    },
    {
      "categories": [
        {
          "key": "st001",
          "name": "Rangements"
        },
        {
          "key": "st002",
          "name": "Bibliothèques et étagères"
        },
        {
          "key": "11465",
          "name": "Meubles étagères"
        }
      ],
      "colors": [
        "blanc"
      ],
      "currency": "EUR",
      "description": "blanc 77x77 cm",
      "id": "20275814",
      "name": "KALLAX",
      "online_sellable": true,
      "price": 39.99,
      "rating_count": 1795,
      "rating_value": 4.6,
      "type_name": "Étagère",
      "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-20275814/"
    },
    {
      "categories": [
        {
          "key": "st001",
          "name": "Rangements"
        },
        {
          "key": "st002",
          "name": "Bibliothèques et étagères"
        },
        {
          "key": "11465",
          "name": "Meubles étagères"
        }
      ],
      "colors": [
        "blanc"
      ],
      "currency": "EUR",
      "description": "blanc 42x147 cm",
      "id": "00275848",
      "name": "KALLAX",
      "online_sellable": true,
      "price": 64.99,
      "rating_count": 1215,
      "rating_value": 4.7,
      "type_name": "Étagère",
      "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-00275848/"
    }
  ],
  "locale": "fr/fr",
  "next_cursor": "[redacted:token]",
  "query": "kallax",
  "raw": {
    "searchResultPage": {
      "products": {
        "main": {
          "end": 24,
          "max": 108,
          "moreToken": "[redacted:moretoken]",
          "start": 0
        }
      }
    }
  },
  "total": 108
}
```
### 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 |
| `locale` | `string` | fr/fr |
| `next_cursor` | `string` | [redacted:token] |
| `query` | `string` | kallax |
| `raw` | `object` | 1 fields |
| `raw.searchResultPage` | `object` | 1 fields |
| `total` | `integer` | 108 |

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

cursor string optional

Opaque next_cursor from a previous response. IKEA controls continuation-page size.

limit integer optional

Initial upstream result window, including non-product content cards. Cannot be combined with cursor.

locale string optional

IKEA country/language storefront. Defaults to France (fr/fr).

Example fr/fr

Available values fr/frgb/enie/ende/de

max_records integer optional

Maximum normalized product records to return from the fetched page; raw remains untruncated.

query string required

Product keywords or an IKEA article number, such as kallax or 69491265.

Example kallax

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
`items`	`array`	3 items
`items`	`array`	3 items
`locale`	`string`	fr/fr
`next_cursor`	`string`	[redacted:token]
`query`	`string`	kallax
`raw`	`object`	1 fields
`raw.searchResultPage`	`object`	1 fields
`total`	`integer`	108

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": { "locale": "fr/fr", "query": "kallax" }, "capability": "ikea.products.search" }'

import json import requests payload = json.loads(r'''{ "input": { "locale": "fr/fr", "query": "kallax" }, "capability": "ikea.products.search" }''') 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))

{ "items": [ { "categories": [ { "key": "st001", "name": "Rangements" }, { "key": "st002", "name": "Bibliothèques et étagères" }, { "key": "11465", "name": "Meubles étagères" } ], "colors": [ "blanc" ], "currency": "EUR", "description": "blanc 77x147 cm", "id": "80275887", "name": "KALLAX", "online_sellable": true, "price": 74.99, "rating_count": 2747, "rating_value": 4.7, "type_name": "Étagère", "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/" }, { "categories": [ { "key": "st001", "name": "Rangements" }, { "key": "st002", "name": "Bibliothèques et étagères" }, { "key": "11465", "name": "Meubles étagères" } ], "colors": [ "blanc" ], "currency": "EUR", "description": "blanc 77x77 cm", "id": "20275814", "name": "KALLAX", "online_sellable": true, "price": 39.99, "rating_count": 1795, "rating_value": 4.6, "type_name": "Étagère", "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-20275814/" }, { "categories": [ { "key": "st001", "name": "Rangements" }, { "key": "st002", "name": "Bibliothèques et étagères" }, { "key": "11465", "name": "Meubles étagères" } ], "colors": [ "blanc" ], "currency": "EUR", "description": "blanc 42x147 cm", "id": "00275848", "name": "KALLAX", "online_sellable": true, "price": 64.99, "rating_count": 1215, "rating_value": 4.7, "type_name": "Étagère", "url": "https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-00275848/" } ], "locale": "fr/fr", "next_cursor": "[redacted:token]", "query": "kallax", "raw": { "searchResultPage": { "products": { "main": { "end": 24, "max": 108, "moreToken": "[redacted:moretoken]", "start": 0 } } } }, "total": 108 }