JioMart API Capability

Sponsored Products Ads

Fetch JioMart sponsored product ad placements for a keyword or inventory value.

Capability ID jiomart.ads.sponsored.products

Cost 1 credit per request

Maximum runtime 30 seconds

# Sponsored Products Ads

Fetch JioMart sponsored product ad placements for a keyword or inventory value.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.ads.sponsored.products`
- 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 -X POST https://data.upscrape.com/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"num_ads":5,"pincode":"400001","query":"rice"},"capability":"jiomart.ads.sponsored.products"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `channel_type` | `string` | No |  |
| `custom_id` | `string` | No |  |
| `inventory_id` | `string` | No |  |
| `inventory_value` | `string` | No |  |
| `num_ads` | `integer` | No |  |
| `page_id` | `string` | No |  |
| `pincode` | `string` | No |  |
| `query` | `string` | No |  |
| `request_origin` | `string` | No |  |
| `store_ids` | `array<string>` | No |  |
| `targeting_type` | `string` | No |  |

### Example input

```json
{
  "num_ads": 5,
  "pincode": "400001",
  "query": "rice"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability.


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

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

## Machine-readable contract

- [Capability OpenAPI 3.1](https://docs.upscrape.com/docs/platforms/jiomart/jiomart.ads.sponsored.products/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/jiomart/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/jiomart/capabilities/jiomart.ads.sponsored.products/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required
`channel_type`	`string`	Optional
`custom_id`	`string`	Optional
`inventory_id`	`string`	Optional
`inventory_value`	`string`	Optional
`num_ads`	`integer`	Optional
`page_id`	`string`	Optional
`pincode`	`string`	Optional
`query`	`string`	Optional
`request_origin`	`string`	Optional
`store_ids`	`array<string>`	Optional
`targeting_type`	`string`	Optional

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Resources

OpenAPI 3.1 Markdown Platform OpenAPI

curl -X POST https://data.upscrape.com/execute \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"input":{"num_ads":5,"pincode":"400001","query":"rice"},"capability":"jiomart.ads.sponsored.products"}'

const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"input":{"num_ads":5,"pincode":"400001","query":"rice"},"capability":"jiomart.ads.sponsored.products"}), }); console.log(await response.json());

import requests response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={"input":{"num_ads":5,"pincode":"400001","query":"rice"},"capability":"jiomart.ads.sponsored.products"}, ) print(response.json())