IKEA API Capability

List stores

List IKEA stores and planning locations for a supported storefront locale.

Capability ID ikea.stores.list

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 30 seconds

# List stores

List IKEA stores and planning locations for a supported storefront locale.

- Platform: [IKEA](https://docs.upscrape.com/docs/platforms/ikea)
- Capability ID: `ikea.stores.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 $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "locale": "fr/fr",
    "max_records": 3
  },
  "capability": "ikea.stores.list"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `locale` | `string` | No | IKEA country/language storefront. Allowed values: `fr/fr`, `gb/en`, `ie/en`, `de/de`. Default: `fr/fr`. |
| `max_records` | `integer` | No | Maximum normalized store records to return; raw remains untruncated. From 1 to 100. |

### Example input

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

```json
{
  "locale": "fr/fr",
  "raw": {
    "stores": {
      "sample_count": 3
    }
  },
  "stores": [
    {
      "address": {
        "city": "Seynod",
        "display": "71 Boulevard Costa de Beauregard, Seynod",
        "postal_code": "74600",
        "street": "71 Boulevard Costa de Beauregard",
        "timezone": "Europe/Paris"
      },
      "display_name": "Annecy",
      "id": "1315",
      "latitude": 45.8779,
      "longitude": 6.0952,
      "name": "IKEA Annecy - Seynod",
      "opening_hours": [
        {
          "close": "19:00",
          "day": "MON",
          "open": "10:00"
        }
      ],
      "treat_as_store": true,
      "type": "PAOP",
      "url": "https://www.ikea.com/fr/fr/stores/annecy/"
    },
    {
      "address": {
        "city": "Vedene",
        "display": "100 Chemin du Pont Blanc, Vedene",
        "postal_code": "84270",
        "street": "100 Chemin du Pont Blanc",
        "timezone": "Europe/Paris"
      },
      "display_name": "Avignon",
      "id": "018",
      "latitude": 43.97830544461172,
      "longitude": 4.891127345993009,
      "name": "IKEA Avignon",
      "opening_hours": [
        {
          "close": "20:00",
          "day": "MON",
          "open": "10:00"
        }
      ],
      "treat_as_store": false,
      "type": "STORE",
      "url": "https://www.ikea.com/fr/fr/stores/avignon/"
    },
    {
      "address": {
        "city": "Saint-Pierre-d'Irube",
        "display": "2-4 Avenue du Portou, Saint-Pierre-d'Irube",
        "postal_code": "64990",
        "street": "2-4 Avenue du Portou",
        "timezone": "Europe/Paris"
      },
      "display_name": "Bayonne",
      "id": "310",
      "latitude": 43.480561971611664,
      "longitude": -1.4449194303340758,
      "name": "IKEA Bayonne",
      "opening_hours": [
        {
          "close": "20:00",
          "day": "MON",
          "open": "10:00"
        }
      ],
      "treat_as_store": false,
      "type": "STORE",
      "url": "https://www.ikea.com/fr/fr/stores/bayonne-ametzondo/"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `locale` | `string` | fr/fr |
| `raw` | `object` | 1 fields |
| `raw.stores` | `object` | 1 fields |
| `stores` | `array` | 3 items |
| `stores` | `array` | 3 items |

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

locale string optional

IKEA country/language storefront. Allowed values: `fr/fr`, `gb/en`, `ie/en`, `de/de`. Default: `fr/fr`.

Example fr/fr

Available values fr/frgb/enie/ende/de

max_records integer optional

Maximum normalized store records to return; raw remains untruncated. From 1 to 100.

Example 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 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
`locale`	`string`	fr/fr
`raw`	`object`	1 fields
`raw.stores`	`object`	1 fields
`stores`	`array`	3 items
`stores`	`array`	3 items

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": { "locale": "fr/fr", "max_records": 3 }, "capability": "ikea.stores.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "locale": "fr/fr", "max_records": 3 }, "capability": "ikea.stores.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))

{ "locale": "fr/fr", "raw": { "stores": { "sample_count": 3 } }, "stores": [ { "address": { "city": "Seynod", "display": "71 Boulevard Costa de Beauregard, Seynod", "postal_code": "74600", "street": "71 Boulevard Costa de Beauregard", "timezone": "Europe/Paris" }, "display_name": "Annecy", "id": "1315", "latitude": 45.8779, "longitude": 6.0952, "name": "IKEA Annecy - Seynod", "opening_hours": [ { "close": "19:00", "day": "MON", "open": "10:00" } ], "treat_as_store": true, "type": "PAOP", "url": "https://www.ikea.com/fr/fr/stores/annecy/" }, { "address": { "city": "Vedene", "display": "100 Chemin du Pont Blanc, Vedene", "postal_code": "84270", "street": "100 Chemin du Pont Blanc", "timezone": "Europe/Paris" }, "display_name": "Avignon", "id": "018", "latitude": 43.97830544461172, "longitude": 4.891127345993009, "name": "IKEA Avignon", "opening_hours": [ { "close": "20:00", "day": "MON", "open": "10:00" } ], "treat_as_store": false, "type": "STORE", "url": "https://www.ikea.com/fr/fr/stores/avignon/" }, { "address": { "city": "Saint-Pierre-d'Irube", "display": "2-4 Avenue du Portou, Saint-Pierre-d'Irube", "postal_code": "64990", "street": "2-4 Avenue du Portou", "timezone": "Europe/Paris" }, "display_name": "Bayonne", "id": "310", "latitude": 43.480561971611664, "longitude": -1.4449194303340758, "name": "IKEA Bayonne", "opening_hours": [ { "close": "20:00", "day": "MON", "open": "10:00" } ], "treat_as_store": false, "type": "STORE", "url": "https://www.ikea.com/fr/fr/stores/bayonne-ametzondo/" } ] }