JioMart API Capability

Autocomplete Search

Fetch JioMart search autocomplete suggestions.

Capability ID jiomart.autocomplete.search

Cost 1 credit per request

Maximum runtime 30 seconds

# Autocomplete Search

Fetch JioMart search autocomplete suggestions.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.autocomplete.search`
- 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 --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": {
    "limit": 10,
    "pincode": "400001",
    "query": "rice"
  },
  "capability": "jiomart.autocomplete.search"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum number of results to return. |
| `location` | `object` | No | Location supplied for this request. |
| `location.city` | `string` | No | City supplied for this request. |
| `location.pincode` | `string` | No | Pincode supplied for this request. |
| `location.state` | `string` | No | State supplied for this request. |
| `pincode` | `string` | No | Pincode supplied for this request. |
| `query` | `string` | Yes | Search query. |

### Example input

```json
{
  "limit": 10,
  "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.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "raw": {
    "items": [
      {
        "_custom_json": {
          "result_type": "query_suggestion"
        },
        "display": "rice",
        "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004911738851.jpg.9f5a238d8d.jpg",
        "type": "product"
      },
      {
        "_custom_json": {
          "result_type": "query_suggestion"
        },
        "display": "rice 26 kg",
        "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004942604491.jpg.1f7e111cc1.jpg",
        "type": "product"
      },
      {
        "_custom_json": {
          "result_type": "query_suggestion"
        },
        "display": "rice 5kg",
        "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004904276691.jpg.0624440e8a.jpg",
        "type": "product"
      }
    ],
    "meta": {
      "attributionToken": "[redacted:attributiontoken]",
      "nextPageToken": "[redacted:nextpagetoken]",
      "provider": {
        "version": "0.0.1"
      }
    }
  },
  "suggestions": [
    {
      "_custom_json": {
        "result_type": "query_suggestion"
      },
      "display": "rice",
      "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004911738851.jpg.9f5a238d8d.jpg",
      "type": "product"
    },
    {
      "_custom_json": {
        "result_type": "query_suggestion"
      },
      "display": "rice 26 kg",
      "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004942604491.jpg.1f7e111cc1.jpg",
      "type": "product"
    },
    {
      "_custom_json": {
        "result_type": "query_suggestion"
      },
      "display": "rice 5kg",
      "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004904276691.jpg.0624440e8a.jpg",
      "type": "product"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `raw` | `object` | 2 fields |
| `raw.items` | `array` | 3 items |
| `raw.meta` | `object` | 3 fields |
| `suggestions` | `array` | 3 items |
| `suggestions` | `array` | 3 items |

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

limit integer optional

Maximum number of results to return.

Example 10

location object optional

Location supplied for this request.

location.city string optional

City supplied for this request.

location.pincode string optional

Pincode supplied for this request.

location.state string optional

State supplied for this request.

pincode string optional

Pincode supplied for this request.

Example 400001

query string required

Search query.

Example rice

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
`raw`	`object`	2 fields
`raw.items`	`array`	3 items
`raw.meta`	`object`	3 fields
`suggestions`	`array`	3 items
`suggestions`	`array`	3 items

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 YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "limit": 10, "pincode": "400001", "query": "rice" }, "capability": "jiomart.autocomplete.search" }'

import json import requests payload = json.loads(r'''{ "input": { "limit": 10, "pincode": "400001", "query": "rice" }, "capability": "jiomart.autocomplete.search" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "raw": { "items": [ { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004911738851.jpg.9f5a238d8d.jpg", "type": "product" }, { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice 26 kg", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004942604491.jpg.1f7e111cc1.jpg", "type": "product" }, { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice 5kg", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004904276691.jpg.0624440e8a.jpg", "type": "product" } ], "meta": { "attributionToken": "[redacted:attributiontoken]", "nextPageToken": "[redacted:nextpagetoken]", "provider": { "version": "0.0.1" } } }, "suggestions": [ { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004911738851.jpg.9f5a238d8d.jpg", "type": "product" }, { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice 26 kg", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004942604491.jpg.1f7e111cc1.jpg", "type": "product" }, { "_custom_json": { "result_type": "query_suggestion" }, "display": "rice 5kg", "image": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004904276691.jpg.0624440e8a.jpg", "type": "product" } ] }