JioMart API Capability

Products List

List JioMart products for an arbitrary Vertex filter expression, such as department/category browse pages.

Capability ID jiomart.products.list

Cost 1 credit per request

Maximum runtime 30 seconds

# Products List

List JioMart products for an arbitrary Vertex filter expression, such as department/category browse pages.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.products.list`
- 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":{"filter":"journey:standard:::department:groceries","page_size":20,"pincode":"400001"},"capability":"jiomart.products.list"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filter` | `string` | No |  |
| `location` | `object` | No |  |
| `location.city` | `string` | No |  |
| `location.latitude` | `string` | No |  |
| `location.longitude` | `string` | No |  |
| `location.pincode` | `string` | No |  |
| `location.state` | `string` | No |  |
| `page` | `integer` | No |  |
| `page_id` | `string` | No |  |
| `page_size` | `integer` | No |  |
| `pincode` | `string` | No |  |
| `sort_on` | `string` | No |  |

### Example input

```json
{
  "filter": "journey:standard:::department:groceries",
  "page_size": 20,
  "pincode": "400001"
}
```

## 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.products.list/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/jiomart/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/jiomart/capabilities/jiomart.products.list/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required
`filter`	`string`	Optional
`location`	`object`	Optional
`location.city`	`string`	Optional
`location.latitude`	`string`	Optional
`location.longitude`	`string`	Optional
`location.pincode`	`string`	Optional
`location.state`	`string`	Optional
`page`	`integer`	Optional
`page_id`	`string`	Optional
`page_size`	`integer`	Optional
`pincode`	`string`	Optional
`sort_on`	`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":{"filter":"journey:standard:::department:groceries","page_size":20,"pincode":"400001"},"capability":"jiomart.products.list"}'

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":{"filter":"journey:standard:::department:groceries","page_size":20,"pincode":"400001"},"capability":"jiomart.products.list"}), }); 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":{"filter":"journey:standard:::department:groceries","page_size":20,"pincode":"400001"},"capability":"jiomart.products.list"}, ) print(response.json())