JioMart Sponsored Products Ads
jiomart.ads.sponsored.products
Read sponsored-product decisions for a keyword or inventory context for retail-media and placement analysis.
At a glance
- Endpoint ID
jiomart.ads.sponsored.products- Price
- 1–3 credits per call; failed calls are free
- Runs for up to
- 30 seconds
Request
Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.
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 '{ "capability": "jiomart.ads.sponsored.products", "input": { "num_ads": 5, "pincode": "400001", "query": "rice" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "jiomart.ads.sponsored.products", "input": { "num_ads": 5, "pincode": "400001", "query": "rice" }}''')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))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "jiomart.ads.sponsored.products", "input": { "num_ads": 5, "pincode": "400001", "query": "rice" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
Input
- Send a search term in query, an ad inventory value in inventory_value, or both. Ask for 1 to 100 ads. Store IDs, a pincode, a page ID and the channel are optional.
- Send store IDs as text, not numbers, and keep the inventory fields you sent with the ads they returned: they decide which ads come back.
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
inventory_value |
string | one of | ||
query |
string | one of | Search query. | rice |
channel_type |
string | no | ||
custom_id |
string | no | Custom identifier. | |
inventory_id |
string | no | Inventory identifier. | |
num_ads |
integer | no | From 1 to 100. | 5 |
page_id |
string | no | Page identifier. | |
pincode |
string | no | Postal code (PIN) that sets the delivery location. | 400001 |
request_origin |
string | no | ||
store_ids |
array<string> | no | ||
targeting_type |
string | no |
Response
A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.
This is results[0].data from a real run:
results[0].data
{ "raw": { "inventory_value": "rice", "request_id": "53def362-b9c8-4748-bced-910dee0c4ebe", "request_origin": "QUICK", "decisions": [ { "inventory_id": "Sponsored_SLP_quick", "decided_items": [ { "item_id": "490000003", "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6500000", "currency": "INR" } }, "product": { "name": "Daawat Super Basmati Rice 1 kg", "item_code": "490000003", "item_type": "standard", "journey": "quickcommerce", "sellable": true, "seller_id": 1, "tag": "ad", "uid": 7511407, "price": { "available": true, "seller_id": 1, "effective": { "max": 165, "min": 165 }, "marked": { "max": 200, "min": 200 } }, "action": { "type": "page", "page": { "type": "product", "params": { "slug": [] } } }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 } ], "identifiers": [ "8901537025127", "490000003" ], "medias": [ { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000031.jpg.0712465220.jpg" }, { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000032.jpg.6755d449c8.jpg" } ], "sizes": [ "1 KG" ], "store_ids": [ 1506, 1765 ], "tags": [ "kirana_1p", "QC" ] } }, { "item_id": "490005637", "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "7000000", "currency": "INR" } }, "product": { "name": "Daawat Super Basmati Rice 5 kg", "item_code": "490005637", "item_type": "standard", "journey": "quickcommerce", "sellable": true, "seller_id": 1, "tag": "ad", "uid": 7508056, "price": { "available": true, "seller_id": 1, "effective": { "max": 799, "min": 799 }, "marked": { "max": 995, "min": 995 } }, "action": { "type": "page", "page": { "type": "product", "params": { "slug": [] } } }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 } ], "identifiers": [ "490005637", "8901537025134" ], "medias": [ { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056371.jpg.0f70a2415c.jpg" }, { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056372.jpg.b839552efd.jpg" } ], "sizes": [ "5 KG" ], "store_ids": [ 2304, 2314 ], "tags": [ "GROCERIES", "rrl_fc" ] } } ] } ] }, "decisions": [ { "inventory_id": "Sponsored_SLP_quick", "decided_items": [ { "item_id": "490000003", "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6500000", "currency": "INR" } }, "product": { "name": "Daawat Super Basmati Rice 1 kg", "item_code": "490000003", "item_type": "standard", "journey": "quickcommerce", "sellable": true, "seller_id": 1, "tag": "ad", "uid": 7511407, "price": { "available": true, "seller_id": 1, "effective": { "max": 165, "min": 165 }, "marked": { "max": 200, "min": 200 } }, "action": { "type": "page", "page": { "type": "product", "params": { "slug": [] } } }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 } ], "identifiers": [ "8901537025127", "490000003" ], "medias": [ { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000031.jpg.0712465220.jpg" }, { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000032.jpg.6755d449c8.jpg" } ], "sizes": [ "1 KG" ], "store_ids": [ 1506, 1765 ], "tags": [ "kirana_1p", "QC" ] } }, { "item_id": "490005637", "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "7000000", "currency": "INR" } }, "product": { "name": "Daawat Super Basmati Rice 5 kg", "item_code": "490005637", "item_type": "standard", "journey": "quickcommerce", "sellable": true, "seller_id": 1, "tag": "ad", "uid": 7508056, "price": { "available": true, "seller_id": 1, "effective": { "max": 799, "min": 799 }, "marked": { "max": 995, "min": 995 } }, "action": { "type": "page", "page": { "type": "product", "params": { "slug": [] } } }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 } ], "identifiers": [ "490005637", "8901537025134" ], "medias": [ { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056371.jpg.0f70a2415c.jpg" }, { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056372.jpg.b839552efd.jpg" } ], "sizes": [ "5 KG" ], "store_ids": [ 2304, 2314 ], "tags": [ "GROCERIES", "rrl_fc" ] } } ] } ]}
Fields
| Field | Type | What it is | Example |
|---|---|---|---|
decisions[].decided_items |
array | The sponsored products in this placement. | 3 records |
decisions[].decided_items[].auction_result |
object | The ad's result: advertiser, campaign and winning bid. | 4 fields |
decisions[].decided_items[].item_id |
string | JioMart's product code for the sponsored product. | 490000003 |
decisions[].decided_items[].product |
object | The sponsored product's details. | 19 fields |
decisions[].inventory_id |
string | Sponsored-ad inventory identifier. It is not a catalogue product ID. | Sponsored_SLP_quick |
decisions |
array | The sponsored placements chosen. | 1 records |
raw |
object | JioMart's own response, as it came back. | 4 fields |
raw.decisions |
array | The sponsored placements chosen. | 1 records |
raw.decisions[].decided_items |
array | The sponsored products in this placement. | 3 records |
raw.decisions[].inventory_id |
string | JioMart's name for the ad slot, such as search results. | Sponsored_SLP_quick |
raw.inventory_value |
string | The search the sponsored placement was for. | rice |
raw.request_id |
string | JioMart's ID for this ad request. | 53def362-b9c8-4748-bced-910dee0c4ebe |
raw.request_origin |
string | The shopping mode the ads were for, such as QUICK. | QUICK |
What to know
- decisions holds the sponsored ads chosen for your request. An ad item's ID is not known to be the same kind of ID as a JioMart catalogue product ID.
- Do not read product stock or unpaid local rank from the sponsored response, or match an ad to a product's detail, unless you have checked separately that they are the same product.
If a call fails
A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.
Other JioMart endpoints
jiomart.autocomplete.searchAutocomplete searchjiomart.brands.listBrandsjiomart.categories.listCategoriesjiomart.category.filters.listCategory filtersjiomart.collection.products.listCollection productsjiomart.collections.listCollectionsjiomart.departments.listDepartmentsjiomart.fulfillment.getProduct fulfillmentjiomart.home.listingHome listingjiomart.location.pincode.lookupPincode locationjiomart.logistics.countriesLogistics countriesjiomart.navigations.listNavigationsjiomart.pages.listPagesjiomart.product.availability.scanMulti-location product availabilityjiomart.product.detail.getProduct detailjiomart.products.listProductsjiomart.products.searchProducts search
Something missing or unclear? Ask the team that builds the JioMart endpoints.