Skip to documentation
Browse documentation

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
View raw

POST /execute Shared execution endpoint

Input parameters

filter string optional

Filter supplied for this request.

Example journey:standard:::department:groceries
location object optional

Location supplied for this request.

location.city string optional

City supplied for this request.

location.latitude string optional

Latitude supplied for this request.

location.longitude string optional

Longitude supplied for this request.

location.pincode string optional

Pincode supplied for this request.

location.state string optional

State supplied for this request.

page integer optional

One-based result page to fetch.

page_id string optional

Page identifier.

page_size integer optional

Page size supplied for this request.

Example 20
pincode string optional

Pincode supplied for this request.

Example 400001
sort_on string optional

Sort on supplied for this request.

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.

PathObserved typeExample
items array 3 items
items array 3 items
page object 5 fields
page.has_next boolean true
page.has_previous boolean false
page.item_total integer 188000
page.next_id string 2
page.type string cursor
raw object 5 fields
raw.filters array 3 items
raw.items array 3 items
raw.meta object 4 fields
raw.page object 5 fields
raw.sort_on 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.