# Carrefour KSA API

Saudi grocery catalog data from Carrefour KSA: categories, shelf listings, SAR prices, and product detail.

- Platform ID: `carrefourksa`
- Capabilities: 3
- Execute endpoint: `POST https://data.upscrape.com/execute`
- OpenAPI: https://upscrape.com/scrapers/carrefourksa/openapi.json

## Capabilities

| Endpoint | Capability ID | Cost | Description |
| --- | --- | --- | --- |
| [Categories List](https://docs.upscrape.com/docs/platforms/carrefourksa/carrefourksa.categories.list) | `carrefourksa.categories.list` | 1 credit per request | 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. |
| [Category Products List](https://docs.upscrape.com/docs/platforms/carrefourksa/carrefourksa.category.products.list) | `carrefourksa.category.products.list` | 1 credit per request | List one 0-based page of a leaf category shelf with SAR prices, discounts, availability, supplier (1P/3P), and product URLs. |
| [Product Detail Get](https://docs.upscrape.com/docs/platforms/carrefourksa/carrefourksa.product.detail.get) | `carrefourksa.product.detail.get` | 1 credit per request | 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. |

## Common uses

- Price and discount monitoring across Saudi Arabia's largest grocery retailer
- Assortment and category-share analysis for CPG and own-label brands in KSA
- 1P vs 3P marketplace tracking via per-product supplier attribution
- Availability and stock monitoring at the Riyadh store level
- GTIN/barcode enrichment for Gulf retail data pipelines

## Integration contract

All capabilities use the shared `POST /execute` envelope. A `200` response completed inline; a `202` response must be polled through `GET /jobs/{id}`.

See [authentication](https://docs.upscrape.com/docs/api/authentication), [jobs and results](https://docs.upscrape.com/docs/api/jobs), and [errors and retries](https://docs.upscrape.com/docs/api/errors).
