# Sponsored products ads Read JioMart sponsored-product decisions for a query or inventory context. - Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart) - Capability ID: `jiomart.ads.sponsored.products` - 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 $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "num_ads": 5, "pincode": "400001", "query": "rice" }, "capability": "jiomart.ads.sponsored.products" }' ``` ## Input 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. | Field | Type | Required | Description | | --- | --- | --- | --- | | `channel_type` | `string` | No | | | `custom_id` | `string` | No | Custom identifier. | | `inventory_id` | `string` | No | Inventory identifier. | | `inventory_value` | `string` | No | | | `num_ads` | `integer` | No | From 1 to 100. | | `page_id` | `string` | No | Page identifier. | | `pincode` | `string` | No | Postal code (PIN) that sets the delivery location. | | `query` | `string` | No | Search query. | | `request_origin` | `string` | No | | | `store_ids` | `array` | No | | | `targeting_type` | `string` | No | | ### Example input ```json { "num_ads": 5, "pincode": "400001", "query": "rice" } ``` ## 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 output This example shows one response. Values and optional fields vary with the data available. ```json { "decisions": [ { "decided_items": [ { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6500000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490000003", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "8901537025127", "490000003" ], "item_code": "490000003", "item_type": "standard", "journey": "quickcommerce", "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" }, { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000033.jpg.c471f031bb.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Super Basmati Rice 1 kg", "price": { "available": true, "effective": { "max": 165, "min": 165 }, "marked": { "max": 200, "min": 200 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "1 KG" ], "slug": "[redacted:token]", "store_ids": [ 1506, 1765, 1799 ], "tag": "ad", "tags": [ "kirana_1p", "QC", "1p" ], "uid": 7511407 }, "track_id": "[redacted:token]" }, { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "7000000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490005637", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "490005637", "8901537025134" ], "item_code": "490005637", "item_type": "standard", "journey": "quickcommerce", "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" }, { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056373.jpg.176d37404e.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Super Basmati Rice 5 kg", "price": { "available": true, "effective": { "max": 799, "min": 799 }, "marked": { "max": 995, "min": 995 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "5 KG" ], "slug": "[redacted:token]", "store_ids": [ 2304, 2314, 2257 ], "tag": "ad", "tags": [ "GROCERIES", "rrl_fc", "kirana_1p" ], "uid": 7508056 }, "track_id": "[redacted:token]" }, { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6400000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490863678", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "490863678", "8901537074231" ], "item_code": "490863678", "item_type": "standard", "journey": "quickcommerce", "medias": [ { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636781.jpg.d804bd4322.jpg" }, { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636782.jpg.751327b5ed.jpg" }, { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636783.jpg.5779379c84.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Pulav Basmati Rice 1 kg", "price": { "available": true, "effective": { "max": 145, "min": 145 }, "marked": { "max": 177, "min": 177 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "1 KG" ], "slug": "[redacted:token]", "store_ids": [ 3330, 14086, 13831 ], "tag": "ad", "tags": [ "NON-RX", "GROCERIES", "QC" ], "uid": 7529957 }, "track_id": "[redacted:token]" } ], "inventory_id": "Sponsored_SLP_quick" } ], "raw": { "decisions": [ { "decided_items": [ { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6500000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490000003", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "8901537025127", "490000003" ], "item_code": "490000003", "item_type": "standard", "journey": "quickcommerce", "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" }, { "alt": "Daawat Super Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900000033.jpg.c471f031bb.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Super Basmati Rice 1 kg", "price": { "available": true, "effective": { "max": 165, "min": 165 }, "marked": { "max": 200, "min": 200 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "1 KG" ], "slug": "[redacted:token]", "store_ids": [ 1506, 1765, 1799 ], "tag": "ad", "tags": [ "kirana_1p", "QC", "1p" ], "uid": 7511407 }, "track_id": "[redacted:token]" }, { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "7000000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490005637", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "490005637", "8901537025134" ], "item_code": "490005637", "item_type": "standard", "journey": "quickcommerce", "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" }, { "alt": "Daawat Super Basmati Rice 5 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004900056373.jpg.176d37404e.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Super Basmati Rice 5 kg", "price": { "available": true, "effective": { "max": 799, "min": 799 }, "marked": { "max": 995, "min": 995 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "5 KG" ], "slug": "[redacted:token]", "store_ids": [ 2304, 2314, 2257 ], "tag": "ad", "tags": [ "GROCERIES", "rrl_fc", "kirana_1p" ], "uid": 7508056 }, "track_id": "[redacted:token]" }, { "auction_result": { "ad_account_id": "daawat", "campaign_id": "AicznAgziVcP7jUu", "campaign_text_entry": "", "win_price": { "amount_micro": "6400000", "currency": "INR" } }, "click_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/c/JIOMART?source=[redacted:token]" ], "imp_trackers": [ "https://jiomart-evt.mcm-api.moloco.com/t/i/JIOMART?source=[redacted:token]" ], "item_id": "490863678", "product": { "action": { "page": { "params": { "slug": [ "[redacted:token]" ] }, "type": "product" }, "type": "page" }, "attributes": { "food-type": "green_dot", "vertical-code": "GROCERIES" }, "brand": { "name": "Daawat", "slug": null, "uid": 696 }, "categories": [ { "name": "Cooking Essentials", "slug": "cooking-essentials", "uid": 116 }, { "name": "Rice", "slug": "rice", "uid": 339 }, { "name": "Basmati Rice", "slug": "basmati-rice", "uid": 2672 } ], "identifiers": [ "490863678", "8901537074231" ], "item_code": "490863678", "item_type": "standard", "journey": "quickcommerce", "medias": [ { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636781.jpg.d804bd4322.jpg" }, { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636782.jpg.751327b5ed.jpg" }, { "alt": "Daawat Pulav Basmati Rice 1 kg", "type": "image", "url": "https://cdn1.jiomartjcp.com/v2/catalog-cloud/jiomar/original/images/othe/egurhk/.j/pg/0000000004908636783.jpg.5779379c84.jpg" } ], "moq": { "increment_unit": 1, "maximum": null, "minimum": 1 }, "name": "Daawat Pulav Basmati Rice 1 kg", "price": { "available": true, "effective": { "max": 145, "min": 145 }, "marked": { "max": 177, "min": 177 }, "seller_id": 1 }, "sellable": true, "seller_id": 1, "sizes": [ "1 KG" ], "slug": "[redacted:token]", "store_ids": [ 3330, 14086, 13831 ], "tag": "ad", "tags": [ "NON-RX", "GROCERIES", "QC" ], "uid": 7529957 }, "track_id": "[redacted:token]" } ], "inventory_id": "Sponsored_SLP_quick" } ], "inventory_value": "rice", "request_id": "53def362-b9c8-4748-bced-910dee0c4ebe", "request_origin": "QUICK" } } ``` ### Illustrative output fields Derived from the sample above for orientation only. These fields are not a fixed response schema. | Path | Observed type | Example | | --- | --- | --- | | `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`. 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)