# List Promotions

List active Blinkit deal products, promotional banners, and flash-offer placements from the location-aware home feed.

- Platform: [Blinkit](https://docs.upscrape.com/docs/platforms/blinkit)
- Capability ID: `blinkit.promotions`
- Cost: 1 credit per request
- Maximum runtime: 60 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": {
    "latitude": 28.4583,
    "limit": 5,
    "longitude": 77.0728,
    "promotion_type": "all"
  },
  "capability": "blinkit.promotions"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `latitude` | `number` | No | Latitude for location-aware promotions; defaults to Gurugram when omitted. |
| `limit` | `integer` | No | Maximum promotions returned. |
| `longitude` | `number` | No | Longitude for location-aware promotions; defaults to Gurugram when omitted. |
| `max_pages` | `integer` | No | Maximum Blinkit home-feed pages fetched. |
| `offset` | `integer` | No | Number of deduplicated promotions to skip. |
| `promotion_type` | `string` | No | Promotion placement type to return. |

### Example input

```json
{
  "latitude": 28.4583,
  "limit": 5,
  "longitude": 77.0728,
  "promotion_type": "all"
}
```

## 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
{
  "count": 5,
  "has_more": true,
  "limit": 5,
  "promotion_type": "all",
  "results": [
    {
      "deeplink_url": "https://blinkit.com/prn/catch-cumin-seeds-jeera-seeds/prid/56692",
      "image_url": "https://cdn.grofers.com/da/cms-assets/cms/product/rc-upload-1773114156723-555.png",
      "product": {
        "brand": "Catch",
        "discount_text": "37%\nOFF",
        "group_id": 3037698,
        "image_url": "https://cdn.grofers.com/da/cms-assets/cms/product/rc-upload-1773114156723-555.png",
        "inventory": 41,
        "merchant_id": "34218",
        "merchant_type": "express",
        "mrp": 75,
        "name": "Catch - Cumin Seeds / Jeera Seeds",
        "price": 47,
        "product_id": 56692,
        "product_url": "https://blinkit.com/prn/catch-cumin-seeds-jeera-seeds/prid/56692",
        "rank": 1,
        "source_url": "https://blinkit.com/v1/layout/feed",
        "variant": "100 g"
      },
      "promotion_type": "deals",
      "rank": 1,
      "section": "Hot deals",
      "title": "Catch - Cumin Seeds / Jeera Seeds"
    }
  ],
  "source_url": "https://blinkit.com/v1/layout/feed"
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `count` | `integer` | 5 |
| `has_more` | `boolean` | true |
| `limit` | `integer` | 5 |
| `promotion_type` | `string` | all |
| `results` | `array` | 1 items |
| `results` | `array` | 1 items |
| `source_url` | `string` | https://blinkit.com/v1/layout/feed |

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