Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
JioMart API Capability

Sponsored products ads

Read JioMart sponsored-product decisions for a query or inventory context.

Capability ID jiomart.ads.sponsored.products
Maximum runtime 30 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

Use query and/or the inventory fields required by your sponsored-placement workflow. num_ads accepts 1 to 100. Optional store_ids, pincode, page_id and channel fields provide additional request context.

Keep store IDs as strings and preserve the inventory context that produced the ad decision.

channel_type string optional
custom_id string optional

Custom identifier.

inventory_id string optional

Inventory identifier.

inventory_value string optional
num_ads integer optional

From 1 to 100.

Example 5
page_id string optional

Page identifier.

pincode string optional

Postal code (PIN) that sets the delivery location.

Example 400001
query string optional

Search query.

Example rice
request_origin string optional
store_ids array<string> optional
targeting_type string optional

Response

Successful output is returned in results[0].data.

decisions contain sponsored-ad data for the requested context. An ad item identifier is not established as the same namespace as a JioMart catalogue UID.

Do not infer product stock, local organic rank or a product-detail join from the sponsored response unless a separate verified mapping establishes it.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
decisions array 1 items
decisions array 1 items
raw object 4 fields
raw.decisions array 1 items
raw.inventory_value string rice
raw.request_id string 53def362-b9c8-4748-bced-910dee0c4ebe
raw.request_origin string QUICK

Execution behavior

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

Overview, pricing and sample data for every endpoint: JioMart API