Skip to documentation
Browse documentation

Sponsored products ads

Fetch JioMart sponsored product ad placements for a keyword or inventory value.

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

POST /execute Shared execution endpoint

Input parameters

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