Zepto API Capability

List Ads

List current Zepto sponsored product, campaign, and banner placements for a location or page.

Capability ID zepto.ads

Cost 1 credit per request

Maximum runtime 180 seconds

# List Ads

List current Zepto sponsored product, campaign, and banner placements for a location or page.

- Platform: [Zepto](https://docs.upscrape.com/docs/platforms/zepto)
- Capability ID: `zepto.ads`
- Cost: 1 credit per request
- Maximum runtime: 180 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl -X POST https://data.upscrape.com/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"latitude":12.96902,"limit":5,"longitude":77.75395,"page_type":"HOME"},"capability":"zepto.ads"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category_id` | `string` | No | Category ID (relevant when page_type is CATEGORY). |
| `latitude` | `number` | No | Latitude for location-based store resolution. |
| `limit` | `integer` | No | Maximum number of ad placements to return. |
| `longitude` | `number` | No | Longitude for location-based store resolution. |
| `page_type` | `string` | No | Type of page to fetch ads for. |
| `query` | `string` | No | Search query (relevant when page_type is SEARCH). |
| `store_id` | `string` | No | Zepto store ID. Defaults to the public Bangalore sample store. |
| `subcategory_id` | `string` | No | Subcategory ID (relevant when page_type is CATEGORY). |
| `url` | `string` | No | Direct URL to a Zepto page for ad context. |

### Example input

```json
{
  "latitude": 12.96902,
  "limit": 5,
  "longitude": 77.75395,
  "page_type": "HOME"
}
```

## 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 output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "count": 5,
  "location_eta_in_minutes": 4,
  "location_eta_serviceable": true,
  "location_latitude": 12.96902,
  "location_longitude": 77.75395,
  "location_secondary_store_ids": [
    "0059ff6a-7eb0-477a-a7f5-69256f2c444b"
  ],
  "location_serviceable": true,
  "location_source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?latitude=12.96902&longitude=77.75395&page_type=HOME&version=v2&show_new_eta_banner=true&page_size=3&enforce_platform_type=DESKTOP",
  "location_store_id": "b4dc8d65-ed2e-4142-81b6-373982b13500",
  "location_store_ids": [
    "b4dc8d65-ed2e-4142-81b6-373982b13500",
    "0059ff6a-7eb0-477a-a7f5-69256f2c444b"
  ],
  "page_type": "HOME",
  "results": [
    {
      "element_id": "422c1cbe-a5b5-4118-9c6b-f7c6251fced3",
      "element_name": "Everyday lowest price",
      "element_position_inside_widget": 1,
      "element_type": "BANNER",
      "image_path": "inventory/banner/601180a6-b82f-499b-a24f-c079904e9f53.png",
      "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/inventory/banner/601180a6-b82f-499b-a24f-c079904e9f53.png",
      "page_type": "HOME",
      "placement_type": "banner",
      "position_in_list": 1,
      "rank": 1,
      "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2",
      "widget_id": "100000357",
      "widget_name": "WEB_PAAN_OLSX",
      "widget_position": 80,
      "widget_type": "BANNER_GRID"
    },
    {
      "deeplink_url": "https://www.zepto.com/cn/paan-corner/cigarettes/cid/cd50825e-baf8-47fe-9abc-ed9556122a9a/scid/5bcbee47-7c83-4279-80f0-7ecc068496df",
      "element_id": "bad6912d-f8a8-4fa6-9bd7-b5cc63a521ef",
      "element_name": "Paan",
      "element_position_inside_widget": 2,
      "element_type": "BANNER",
      "image_path": "inventory/banner/85b9411e-fa0e-427f-96ec-97fd4d13aaed.png",
      "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/inventory/banner/85b9411e-fa0e-427f-96ec-97fd4d13aaed.png",
      "page_type": "HOME",
      "placement_type": "banner",
      "position_in_list": 2,
      "rank": 2,
      "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2",
      "widget_id": "100000357",
      "widget_name": "WEB_PAAN_OLSX",
      "widget_position": 80,
      "widget_type": "BANNER_GRID"
    },
    {
      "discount_amount_paise": 4000,
      "is_sponsored": true,
      "discounted_selling_price_paise": 22000,
      "element_position_inside_widget": 1,
      "pc_tags_json": "{}",
      "image_path": "cms/product_variant/17235b1c-37cf-4232-8a0b-c12784b07e17.jpg",
      "pricing_campaigns_json": "{\"pricingEntityPrices\":[{\"discountedSellingPrice\":22000,\"pricingEntity\":\"SUPER_SAVER\"}]}",
      "element_id": "8f5eb151-9e1a-5f53-a171-299f6f539d9e",
      "items_left": 4,
      "store_product_id": "8f5eb151-9e1a-5f53-a171-299f6f539d9e",
      "primary_category_name": "Cleaning Essentials",
      "element_type": "PRODUCT",
      "product_name": "Rin Matic Top Load Detergent Liquid | Pouch",
      "discount_percent": 15,
      "widget_name": "Laundry_Care_HORIZONTAL_LIST",
      "campaign_name": "bachat",
      "mrp_paise": 26000,
      "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2",
      "primary_subcategory_name": "Liquid Detergents & Additives",
      "category_id": "1a7e46a8-e627-450f-8960-490b550eeee6",
      "rank": 3,
      "brand": "Rin",
      "formatted_pack_size": "1 pack (2 kg)",
      "widget_id": "24238",
      "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/cms/product_variant/17235b1c-37cf-4232-8a0b-c12784b07e17.jpg",
      "product_variant_id": "5f54bb83-f3e0-4d8d-89b0-6339f3312089",
      "store_id": "b4dc8d65-ed2e-4142-81b6-373982b13500",
      "placement_type": "sponsored_product",
      "primary_subcategory_id": "dfb37880-b40f-4783-9502-a56e12edbabc",
      "product_id": "4ad95205-6122-41b2-b5af-f18f187f924b",
      "selling_price_paise": 22000,
      "page_type": "HOME",
      "product_url": "https://www.zepto.com/pn/rin-matic-top-load-detergent-liquid-pouch/pvid/5f54bb83-f3e0-4d8d-89b0-6339f3312089",
      "widget_type": "HORIZONTAL_LIST",
      "widget_position": 270,
      "position_in_list": 1
    }
  ],
  "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2"
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `count` | `integer` | 5 |
| `location_eta_in_minutes` | `integer` | 4 |
| `location_eta_serviceable` | `boolean` | true |
| `location_latitude` | `number` | 12.96902 |
| `location_longitude` | `number` | 77.75395 |
| `location_secondary_store_ids` | `array` | 1 items |
| `location_secondary_store_ids` | `array` | 1 items |
| `location_serviceable` | `boolean` | true |
| `location_source_url` | `string` | https://bff-gateway.zepto.com/lms/api/v2/get_page?latitude=12.96902&lon… |
| `location_store_id` | `string` | b4dc8d65-ed2e-4142-81b6-373982b13500 |
| `location_store_ids` | `array` | 2 items |
| `location_store_ids` | `array` | 2 items |
| `page_type` | `string` | HOME |
| `results` | `array` | 3 items |
| `results` | `array` | 3 items |
| `source_url` | `string` | https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type… |

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

See [jobs and results](https://docs.upscrape.com/docs/api/jobs), [errors and retries](https://docs.upscrape.com/docs/api/errors), and [idempotency](https://docs.upscrape.com/docs/api/idempotency).

## Machine-readable contract

- [Capability OpenAPI 3.1](https://docs.upscrape.com/docs/platforms/zepto/zepto.ads/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/zepto/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/zepto/capabilities/zepto.ads/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required	Description
`category_id`	`string`	Optional	Category ID (relevant when page_type is CATEGORY).
`latitude`	`number`	Optional	Latitude for location-based store resolution.
`limit`	`integer`	Optional	Maximum number of ad placements to return.
`longitude`	`number`	Optional	Longitude for location-based store resolution.
`page_type`	`string`	Optional	Type of page to fetch ads for.
`query`	`string`	Optional	Search query (relevant when page_type is SEARCH).
`store_id`	`string`	Optional	Zepto store ID. Defaults to the public Bangalore sample store.
`subcategory_id`	`string`	Optional	Subcategory ID (relevant when page_type is CATEGORY).
`url`	`string`	Optional	Direct URL to a Zepto page for ad context.

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.

Path	Observed type	Example
`count`	`integer`	5
`location_eta_in_minutes`	`integer`	4
`location_eta_serviceable`	`boolean`	true
`location_latitude`	`number`	12.96902
`location_longitude`	`number`	77.75395
`location_secondary_store_ids`	`array`	1 items
`location_secondary_store_ids`	`array`	1 items
`location_serviceable`	`boolean`	true
`location_source_url`	`string`	https://bff-gateway.zepto.com/lms/api/v2/get_page?latitude=12.96902&lon…
`location_store_id`	`string`	b4dc8d65-ed2e-4142-81b6-373982b13500
`location_store_ids`	`array`	2 items
`location_store_ids`	`array`	2 items
`page_type`	`string`	HOME
`results`	`array`	3 items
`results`	`array`	3 items
`source_url`	`string`	https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type…

Execution behavior

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

Resources

OpenAPI 3.1 Markdown Platform OpenAPI

curl -X POST https://data.upscrape.com/execute \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"input":{"latitude":12.96902,"limit":5,"longitude":77.75395,"page_type":"HOME"},"capability":"zepto.ads"}'

const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"input":{"latitude":12.96902,"limit":5,"longitude":77.75395,"page_type":"HOME"},"capability":"zepto.ads"}), }); console.log(await response.json());

import requests response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={"input":{"latitude":12.96902,"limit":5,"longitude":77.75395,"page_type":"HOME"},"capability":"zepto.ads"}, ) print(response.json())

{ "count": 5, "location_eta_in_minutes": 4, "location_eta_serviceable": true, "location_latitude": 12.96902, "location_longitude": 77.75395, "location_secondary_store_ids": [ "0059ff6a-7eb0-477a-a7f5-69256f2c444b" ], "location_serviceable": true, "location_source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?latitude=12.96902&longitude=77.75395&page_type=HOME&version=v2&show_new_eta_banner=true&page_size=3&enforce_platform_type=DESKTOP", "location_store_id": "b4dc8d65-ed2e-4142-81b6-373982b13500", "location_store_ids": [ "b4dc8d65-ed2e-4142-81b6-373982b13500", "0059ff6a-7eb0-477a-a7f5-69256f2c444b" ], "page_type": "HOME", "results": [ { "element_id": "422c1cbe-a5b5-4118-9c6b-f7c6251fced3", "element_name": "Everyday lowest price", "element_position_inside_widget": 1, "element_type": "BANNER", "image_path": "inventory/banner/601180a6-b82f-499b-a24f-c079904e9f53.png", "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/inventory/banner/601180a6-b82f-499b-a24f-c079904e9f53.png", "page_type": "HOME", "placement_type": "banner", "position_in_list": 1, "rank": 1, "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2", "widget_id": "100000357", "widget_name": "WEB_PAAN_OLSX", "widget_position": 80, "widget_type": "BANNER_GRID" }, { "deeplink_url": "https://www.zepto.com/cn/paan-corner/cigarettes/cid/cd50825e-baf8-47fe-9abc-ed9556122a9a/scid/5bcbee47-7c83-4279-80f0-7ecc068496df", "element_id": "bad6912d-f8a8-4fa6-9bd7-b5cc63a521ef", "element_name": "Paan", "element_position_inside_widget": 2, "element_type": "BANNER", "image_path": "inventory/banner/85b9411e-fa0e-427f-96ec-97fd4d13aaed.png", "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/inventory/banner/85b9411e-fa0e-427f-96ec-97fd4d13aaed.png", "page_type": "HOME", "placement_type": "banner", "position_in_list": 2, "rank": 2, "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2", "widget_id": "100000357", "widget_name": "WEB_PAAN_OLSX", "widget_position": 80, "widget_type": "BANNER_GRID" }, { "discount_amount_paise": 4000, "is_sponsored": true, "discounted_selling_price_paise": 22000, "element_position_inside_widget": 1, "pc_tags_json": "{}", "image_path": "cms/product_variant/17235b1c-37cf-4232-8a0b-c12784b07e17.jpg", "pricing_campaigns_json": "{\"pricingEntityPrices\":[{\"discountedSellingPrice\":22000,\"pricingEntity\":\"SUPER_SAVER\"}]}", "element_id": "8f5eb151-9e1a-5f53-a171-299f6f539d9e", "items_left": 4, "store_product_id": "8f5eb151-9e1a-5f53-a171-299f6f539d9e", "primary_category_name": "Cleaning Essentials", "element_type": "PRODUCT", "product_name": "Rin Matic Top Load Detergent Liquid | Pouch", "discount_percent": 15, "widget_name": "Laundry_Care_HORIZONTAL_LIST", "campaign_name": "bachat", "mrp_paise": 26000, "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2", "primary_subcategory_name": "Liquid Detergents & Additives", "category_id": "1a7e46a8-e627-450f-8960-490b550eeee6", "rank": 3, "brand": "Rin", "formatted_pack_size": "1 pack (2 kg)", "widget_id": "24238", "image_url": "https://cdn.zeptonow.com/production/tr:w-600,ar-1000-1000,pr-true,f-auto,q-80/cms/product_variant/17235b1c-37cf-4232-8a0b-c12784b07e17.jpg", "product_variant_id": "5f54bb83-f3e0-4d8d-89b0-6339f3312089", "store_id": "b4dc8d65-ed2e-4142-81b6-373982b13500", "placement_type": "sponsored_product", "primary_subcategory_id": "dfb37880-b40f-4783-9502-a56e12edbabc", "product_id": "4ad95205-6122-41b2-b5af-f18f187f924b", "selling_price_paise": 22000, "page_type": "HOME", "product_url": "https://www.zepto.com/pn/rin-matic-top-load-detergent-liquid-pouch/pvid/5f54bb83-f3e0-4d8d-89b0-6339f3312089", "widget_type": "HORIZONTAL_LIST", "widget_position": 270, "position_in_list": 1 } ], "source_url": "https://bff-gateway.zepto.com/lms/api/v2/get_page?enforce_platform_type=DESKTOP&latitude=12.96902&longitude=77.75395&page_size=20&page_type=HOME&show_new_eta_banner=true&version=v2" }