IKEA API Capability

Get Store Stock

Check current cash-and-carry, click-and-collect, and delivery availability for an IKEA article by store.

Capability ID ikea.stock.get

Cost 1 credit per request

Maximum runtime 45 seconds

# Get Store Stock

Check current cash-and-carry, click-and-collect, and delivery availability for an IKEA article by store.

- Platform: [IKEA](https://docs.upscrape.com/docs/platforms/ikea)
- Capability ID: `ikea.stock.get`
- Cost: 1 credit 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 YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "item_id": "80275887",
    "locale": "fr/fr",
    "store_id": "018"
  },
  "capability": "ikea.stock.get"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `item_id` | `string` | Yes | Eight-digit IKEA article number, optionally formatted as 802.758.87. |
| `locale` | `string` | No | IKEA country/language storefront. |
| `max_records` | `integer` | No | Maximum store stock records to return when store_id is omitted. |
| `store_id` | `string` | No | Optional IKEA store code from ikea.stores.list. |

### Example input

```json
{
  "item_id": "80275887",
  "locale": "fr/fr",
  "store_id": "018"
}
```

## 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
{
  "checked_at": "2026-08-21T01:19:30.901Z",
  "item_id": "80275887",
  "locale": "fr/fr",
  "raw": {
    "availability": {
      "sample_store": "018"
    }
  },
  "stores": [
    {
      "cash_carry_available": true,
      "click_collect_available": true,
      "eligible_for_notification": false,
      "home_delivery_in_range": true,
      "in_range": true,
      "quantity": 56,
      "sales_locations": [
        {
          "aisle": "00",
          "bin": "01",
          "division": "SELF_SERVE",
          "type": "AISLE_AND_BIN"
        },
        {
          "aisle": "00",
          "bin": "04",
          "division": "SELF_SERVE",
          "type": "AISLE_AND_BIN"
        }
      ],
      "status": "HIGH_IN_STOCK",
      "store_id": "018",
      "store_name": "Avignon",
      "updated_at": "2026-08-20T19:51:08.649Z"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `checked_at` | `string` | 2026-08-21T01:19:30.901Z |
| `item_id` | `string` | 80275887 |
| `locale` | `string` | fr/fr |
| `raw` | `object` | 1 fields |
| `raw.availability` | `object` | 1 fields |
| `stores` | `array` | 1 items |
| `stores` | `array` | 1 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

item_id string required

Eight-digit IKEA article number, optionally formatted as 802.758.87.

Example 80275887

locale string optional

IKEA country/language storefront.

Example fr/fr

Available values fr/frgb/enie/ende/de

max_records integer optional

Maximum store stock records to return when store_id is omitted.

store_id string optional

Optional IKEA store code from ikea.stores.list.

Example 018

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
`checked_at`	`string`	2026-08-21T01:19:30.901Z
`item_id`	`string`	80275887
`locale`	`string`	fr/fr
`raw`	`object`	1 fields
`raw.availability`	`object`	1 fields
`stores`	`array`	1 items
`stores`	`array`	1 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 YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "item_id": "80275887", "locale": "fr/fr", "store_id": "018" }, "capability": "ikea.stock.get" }'

import json import requests payload = json.loads(r'''{ "input": { "item_id": "80275887", "locale": "fr/fr", "store_id": "018" }, "capability": "ikea.stock.get" }''') 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))

{ "checked_at": "2026-08-21T01:19:30.901Z", "item_id": "80275887", "locale": "fr/fr", "raw": { "availability": { "sample_store": "018" } }, "stores": [ { "cash_carry_available": true, "click_collect_available": true, "eligible_for_notification": false, "home_delivery_in_range": true, "in_range": true, "quantity": 56, "sales_locations": [ { "aisle": "00", "bin": "01", "division": "SELF_SERVE", "type": "AISLE_AND_BIN" }, { "aisle": "00", "bin": "04", "division": "SELF_SERVE", "type": "AISLE_AND_BIN" } ], "status": "HIGH_IN_STOCK", "store_id": "018", "store_name": "Avignon", "updated_at": "2026-08-20T19:51:08.649Z" } ] }