# Catalog filters

Return valid Meesho sort options and filter tokens for search or category listings.

- Platform: [Meesho Catalog](https://docs.upscrape.com/docs/platforms/meesho)
- Capability ID: `catalog.filters`
- Cost: 1 credit per request
- Maximum runtime: 45 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 YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "query": "kurti",
    "scope": "search"
  },
  "capability": "catalog.filters"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `page_id` | `string` | No |  |
| `query` | `string` | No |  |
| `scope` | `string` | Yes |  |

### Example input

```json
{
  "query": "kurti",
  "scope": "search"
}
```

## 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": 10000,
  "count_text": "1000+",
  "enabled": true,
  "filters": [
    {
      "label": "Category",
      "label_id": 1,
      "label_name": "Category",
      "search_enabled": false,
      "type": "list",
      "values": [
        {
          "display_name": "Feeding Kurtis And Kurta Sets",
          "id": 2274,
          "image_url": "https://images.meesho.com/images/marketing/1631697114913.png",
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Kids - Girls Kurta Sets",
          "id": 5144,
          "image_url": "https://images.meesho.com/images/marketing/1704455685544.jpg",
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Kurta Sets",
          "id": 306,
          "image_url": "https://images.meesho.com/images/marketing/1598859998166.png",
          "selected": false,
          "token": "[redacted:token]"
        }
      ]
    },
    {
      "label": "Gender",
      "label_id": 9,
      "label_name": "Gender",
      "search_enabled": false,
      "type": "pill",
      "values": [
        {
          "display_name": "Boys",
          "id": 446,
          "image_url": "https://images.meesho.com/images/marketing/7cafdc36-1b16-4cf8-84dc-1ed4f32fc9a4.png",
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Girls",
          "id": 445,
          "image_url": "https://images.meesho.com/images/marketing/1598808357482.png",
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Women",
          "id": 443,
          "image_url": "https://images.meesho.com/images/marketing/1598808287970.png",
          "selected": false,
          "token": "[redacted:token]"
        }
      ]
    },
    {
      "label": "Color",
      "label_id": 4,
      "label_name": "Color",
      "search_enabled": false,
      "type": "pill",
      "values": [
        {
          "display_name": "Beige",
          "id": 2322,
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Black",
          "id": 29,
          "image_url": "https://images.meesho.com/images/marketing/c39647e6-d742-4e4e-bee8-f53c4fe3cad0.png",
          "selected": false,
          "token": "[redacted:token]"
        },
        {
          "display_name": "Brown",
          "id": 32,
          "image_url": "https://images.meesho.com/images/marketing/ca1ae11b-875a-42b2-add8-ea7187d9c51b.png",
          "selected": false,
          "token": "[redacted:token]"
        }
      ]
    }
  ],
  "high_visibility_filters": [
    {
      "display_name": "New Arrival",
      "id": 613,
      "image_url": "https://images.meesho.com/images/marketing/1600158719009.jpeg",
      "selected": false,
      "token": "[redacted:token]"
    },
    {
      "display_name": "Top Rated",
      "id": 611,
      "image_url": "https://images.meesho.com/images/marketing/1718955619931.png",
      "selected": false,
      "token": "[redacted:token]"
    },
    {
      "display_name": "Kurtis",
      "id": 308,
      "image_url": "https://images.meesho.com/images/marketing/a31f02b1-04cf-401e-86a5-c265d95898c4.png",
      "selected": false,
      "token": "[redacted:token]"
    }
  ],
  "next_cursor": "[redacted:token]",
  "scope": "search",
  "session_state": "[redacted:token]",
  "sort_options": [
    {
      "default": true,
      "display_name": "Relevance",
      "selected": true,
      "sort_by": "most_relevant",
      "sort_order": "desc"
    },
    {
      "default": false,
      "display_name": "New Arrivals",
      "selected": false,
      "sort_by": "created",
      "sort_order": "desc"
    }
  ]
}
```
### 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` | 10000 |
| `count_text` | `string` | 1000+ |
| `enabled` | `boolean` | true |
| `filters` | `array` | 3 items |
| `filters` | `array` | 3 items |
| `high_visibility_filters` | `array` | 3 items |
| `high_visibility_filters` | `array` | 3 items |
| `next_cursor` | `string` | [redacted:token] |
| `scope` | `string` | search |
| `session_state` | `string` | [redacted:token] |
| `sort_options` | `array` | 2 items |
| `sort_options` | `array` | 2 items |

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