# Upscrape Carrefour KSA LLM Integration Prompt

Give this to an LLM or coding agent. It must fetch the OpenAPI spec first and use this brief only for orientation.

## First Step

Fetch and read this OpenAPI spec before writing code:

https://data.upscrape.com/catalog/platforms/carrefourksa/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAxjYXJyZWZvdXJrc2FuBgDpYw2BnwFiAAFRgA.J3Vk5LhDq7f15mEDliWpuQjvX6CE5XJWWd0B3Z9276c
This signed OpenAPI URL is valid for approximately 7 days.

## Hard Rules

- Use the OpenAPI spec as the source of truth for endpoints, request bodies, response envelopes, errors, and input JSON schemas.
- Raw capability output is intentionally open-ended. Treat any included output example as illustrative, not as a fixed schema.
- Authenticate every request with `Authorization: Bearer YOUR_API_KEY`.
- Start runs with `POST /execute`; do not invent platform-specific execute endpoints.
- Poll `GET /jobs/{id}` or `GET /jobs/{id}/result` until `state` is `completed` or `failed`.
- Optionally send `Prefer: wait=N` on `POST /execute` to wait up to N seconds for inline results.
- If the response is `200`, the job completed — read `results[0].data`. If `202`, poll `GET /jobs/{id}`.

## API Base

- Base URL: `https://data.upscrape.com`
- OpenAPI spec: `https://data.upscrape.com/catalog/platforms/carrefourksa/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAxjYXJyZWZvdXJrc2FuBgDpYw2BnwFiAAFRgA.J3Vk5LhDq7f15mEDliWpuQjvX6CE5XJWWd0B3Z9276c`
- Execute endpoint: `POST /execute`
- Job poll endpoint: `GET /jobs/{id}`
- Result alias: `GET /jobs/{id}/result`
- Content-Type: `application/json`
- Optional header: `Idempotency-Key`
- Optional header: `Prefer: wait=N` (hold connection up to N seconds for synchronous result)

## Execution Flow

1. Send `POST /execute` with a platform capability ID and its `input` object.
2. The API responds with a queued `job_id`.
3. Poll the job endpoint until `state` becomes `completed` or `failed`.
4. If completed, read `results[0].data`; its raw JSON shape may evolve with the upstream source.

## Example Execute Request

```json
{
  "capability": "carrefourksa.categories.list",
  "input": {}
}
```

## Optional Request Fields

- `network.session_id`: explicit reusable session identifier
- `network.session_key`: stable key used to derive a reusable session
- `network.sticky`: reuse the resolved session when `true`
- `timeout_ms`: per-capability timeout override up to the capability maximum listed below

## Supported Capabilities

- `carrefourksa.categories.list` - Categories List. Fetch the Carrefour KSA category tree from the storefront menu, flattened into parent-linked rows with leaf flags; leaf ids feed carrefourksa.category.products.list. Max `timeout_ms`: 30000.
- `carrefourksa.category.products.list` - Category Products List. List one 0-based page of a leaf category shelf with SAR prices, discounts, availability, supplier (1P/3P), and product URLs. Max `timeout_ms`: 30000.
- `carrefourksa.product.detail.get` - Product Detail Get. Fetch the product detail record for a PDP URL, PDP path, or bare numeric product id: JSON-LD product data plus best-effort breadcrumbs and barcode. Max `timeout_ms`: 30000.