JioMart API Capability

Multi-location product availability

Compare one product across up to 20 Indian PINs, distinguishing local listings from national catalog presence, with observed prices, sellability, stores and ETA.

Capability ID jiomart.product.availability.scan

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 60 seconds

View raw

# Multi-location product availability

Compare one product across up to 20 Indian PINs, distinguishing local listings from national catalog presence, with observed prices, sellability, stores and ETA.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.product.availability.scan`
- 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 $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "locations": [
      {
        "pincode": "560001"
      },
      {
        "pincode": "400001"
      }
    ],
    "product_id": "7511070"
  },
  "capability": "jiomart.product.availability.scan"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `locations` | `array<object>` | Yes |  |
| `locations[].city` | `string` | No | City name. |
| `locations[].latitude` | `string` | No | Latitude in decimal degrees. |
| `locations[].longitude` | `string` | No | Longitude in decimal degrees. |
| `locations[].pincode` | `string` | Yes | Postal code (PIN) that sets the delivery location. |
| `locations[].state` | `string` | No | State or region name. |
| `product_id` | `string` | Yes | Product identifier. |

### Example input

```json
{
  "locations": [
    {
      "pincode": "560001"
    },
    {
      "pincode": "400001"
    }
  ],
  "product_id": "7511070"
}
```

## 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
{
  "locations": [
    {
      "currency": "INR",
      "delivery_message": "Delivery in 28 mins",
      "eta_minutes": 28,
      "journey": "quickcommerce",
      "listed": true,
      "mrp": 280,
      "pincode": "560001",
      "price": 265,
      "quick_delivery_tagged": true,
      "sellable": true,
      "serviceable": true,
      "store_ids": [
        "27608"
      ]
    },
    {
      "eta_minutes": null,
      "listed": false,
      "mrp": null,
      "pincode": "400001",
      "price": null,
      "quick_delivery_tagged": false,
      "sellable": null,
      "serviceable": true,
      "store_ids": []
    }
  ],
  "product_id": "7511070"
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `locations` | `array` | 2 items |
| `locations` | `array` | 2 items |
| `product_id` | `string` | 7511070 |

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

POST /execute Shared execution endpoint

Input parameters

locations array<object> required

Example [{"pincode":"560001"},{"pincode":"400001"}]

locations[].city string optional

City name.

locations[].latitude string optional

Latitude in decimal degrees.

locations[].longitude string optional

Longitude in decimal degrees.

locations[].pincode string required

Postal code (PIN) that sets the delivery location.

locations[].state string optional

State or region name.

product_id string required

Product identifier.

Example 7511070

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 The full redacted fixture is shown in the response panel.

Illustrative output fields

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

Path	Observed type	Example
`locations`	`array`	2 items
`locations`	`array`	2 items
`product_id`	`string`	7511070

Execution behavior

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

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "locations": [ { "pincode": "560001" }, { "pincode": "400001" } ], "product_id": "7511070" }, "capability": "jiomart.product.availability.scan" }'

import json import os import requests payload = json.loads(r'''{ "input": { "locations": [ { "pincode": "560001" }, { "pincode": "400001" } ], "product_id": "7511070" }, "capability": "jiomart.product.availability.scan" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "locations": [ { "currency": "INR", "delivery_message": "Delivery in 28 mins", "eta_minutes": 28, "journey": "quickcommerce", "listed": true, "mrp": 280, "pincode": "560001", "price": 265, "quick_delivery_tagged": true, "sellable": true, "serviceable": true, "store_ids": [ "27608" ] }, { "eta_minutes": null, "listed": false, "mrp": null, "pincode": "400001", "price": null, "quick_delivery_tagged": false, "sellable": null, "serviceable": true, "store_ids": [] } ], "product_id": "7511070" }