# Collections

Browse JioMart collection-directory records and discover slugs for collection-product requests.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.collections.list`
- 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": {
    "page_size": 5
  },
  "capability": "jiomart.collections.list"
}'
```

## Input

page starts at 1 when supplied. page_size must be a positive integer; the current schema does not declare a maximum.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `page` | `integer` | No | One-based result page to fetch. At least 1. |
| `page_size` | `integer` | No | Number of results per page. At least 1. |

### Example input

```json
{
  "page_size": 5
}
```

## Response

Successful output is returned in `results[0].data`.

Collection records can include slug, name, status, query metadata, filters and page information.

Use a returned collection slug with jiomart.collection.products.list. Do not infer a fixed collection count from one directory response.

### Illustrative sample output

This example shows one response. Values and optional fields vary with the data available.

```json
{
  "items": [
    {
      "_custom_json": {},
      "_id": "6a5b37377ff3da0bf303fb17",
      "_locale_language": {},
      "_schedule": {
        "end": "9998-01-30T23:59:00Z",
        "next_schedule": [
          {
            "end": "9998-01-30T23:59:00Z",
            "start": "2026-07-18T08:17:48.217000Z"
          }
        ],
        "start": "2026-07-18T08:17:48.217000Z"
      },
      "action": {
        "page": {
          "params": {
            "slug": [
              "personal-care-grocery"
            ]
          },
          "type": "collection"
        },
        "type": "page"
      },
      "allow_facets": true,
      "allow_sort": true,
      "badge": {
        "color": "#ffffff",
        "text": ""
      },
      "banners": {
        "landscape": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
        },
        "portrait": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
        }
      },
      "description": "Personal Care Grocery",
      "is_active": true,
      "is_visible": true,
      "logo": {
        "type": "image",
        "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
      },
      "meta": {},
      "name": "Personal Care Grocery",
      "priority": 1,
      "published": true,
      "query": [
        {
          "attribute": "department",
          "op": "in",
          "value": [
            "groceries"
          ]
        },
        {
          "attribute": "l1_category",
          "op": "in",
          "value": [
            "personal-care"
          ]
        }
      ],
      "seo": {
        "breadcrumbs": [
          {}
        ],
        "description": "Personal Care Grocery",
        "meta_tags": [],
        "sitemap": {
          "frequency": "never",
          "priority": 0.5
        },
        "title": "Personal Care Grocery"
      },
      "slug": "personal-care-grocery",
      "sort_on": "popular",
      "tags": [],
      "type": "query",
      "uid": "6a5b37377ff3da0bf303fb17",
      "visible_facets_keys": []
    },
    {
      "_custom_json": {},
      "_id": "6a54a6cebe7d82904c2c2584",
      "_locale_language": {},
      "_schedule": {
        "end": "9998-01-30T23:59:00Z",
        "next_schedule": [
          {
            "end": "9998-01-30T23:59:00Z",
            "start": "2026-07-13T08:50:18.142000Z"
          }
        ],
        "start": "2026-07-13T08:50:18.142000Z"
      },
      "action": {
        "page": {
          "params": {
            "slug": [
              "cothas-coffee"
            ]
          },
          "type": "collection"
        },
        "type": "page"
      },
      "allow_facets": true,
      "allow_sort": true,
      "badge": {
        "color": "#ffffff",
        "text": ""
      },
      "banners": {
        "landscape": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
        },
        "portrait": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
        }
      },
      "description": "Cothas Coffee",
      "is_active": true,
      "is_visible": true,
      "logo": {
        "type": "image",
        "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
      },
      "meta": {},
      "name": "Cothas Coffee",
      "priority": 2,
      "published": true,
      "query": [],
      "seo": {
        "breadcrumbs": [
          {}
        ],
        "description": "Cothas Coffee",
        "meta_tags": [],
        "sitemap": {
          "frequency": "never",
          "priority": 0.5
        },
        "title": "Cothas Coffee"
      },
      "slug": "cothas-coffee",
      "sort_on": "popular",
      "tags": [],
      "type": "items",
      "uid": "6a54a6cebe7d82904c2c2584",
      "visible_facets_keys": []
    },
    {
      "_custom_json": {},
      "_id": "6a46150a3025c0bfcb9f0a73",
      "_locale_language": {},
      "_schedule": {
        "end": "9998-01-30T23:59:00Z",
        "next_schedule": [
          {
            "end": "9998-01-30T23:59:00Z",
            "start": "2026-07-02T07:36:35.864000Z"
          }
        ],
        "start": "2026-07-02T07:36:35.864000Z"
      },
      "action": {
        "page": {
          "params": {
            "slug": [
              "dynamix-ghee"
            ]
          },
          "type": "collection"
        },
        "type": "page"
      },
      "allow_facets": true,
      "allow_sort": true,
      "badge": {
        "color": "#ffffff",
        "text": ""
      },
      "banners": {
        "landscape": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
        },
        "portrait": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
        }
      },
      "description": "Dynamix Ghee",
      "is_active": true,
      "is_visible": true,
      "logo": {
        "type": "image",
        "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
      },
      "meta": {},
      "name": "Dynamix Ghee",
      "priority": 3,
      "published": true,
      "query": [],
      "seo": {
        "breadcrumbs": [
          {}
        ],
        "description": "Dynamix Ghee",
        "meta_tags": [],
        "sitemap": {
          "frequency": "never",
          "priority": 0.5
        },
        "title": "Dynamix Ghee"
      },
      "slug": "dynamix-ghee",
      "sort_on": "popular",
      "tags": [],
      "type": "items",
      "uid": "6a46150a3025c0bfcb9f0a73",
      "visible_facets_keys": []
    }
  ],
  "page": {
    "current": 1,
    "has_next": true,
    "has_previous": false,
    "item_total": 26924,
    "total": 5385,
    "type": "number"
  },
  "raw": {
    "filters": {
      "tags": [
        {
          "display": "Andhra Pradesh",
          "is_selected": false,
          "name": "Andhra Pradesh"
        },
        {
          "display": "Arunachal Pradesh",
          "is_selected": false,
          "name": "Arunachal Pradesh"
        },
        {
          "display": "Assam",
          "is_selected": false,
          "name": "Assam"
        }
      ],
      "type": [
        {
          "display": "items",
          "is_selected": false,
          "name": "items"
        },
        {
          "display": "query",
          "is_selected": false,
          "name": "query"
        }
      ]
    },
    "items": [
      {
        "_custom_json": {},
        "_id": "6a5b37377ff3da0bf303fb17",
        "_locale_language": {},
        "_schedule": {
          "end": "9998-01-30T23:59:00Z",
          "next_schedule": [
            {
              "end": "9998-01-30T23:59:00Z",
              "start": "2026-07-18T08:17:48.217000Z"
            }
          ],
          "start": "2026-07-18T08:17:48.217000Z"
        },
        "action": {
          "page": {
            "params": {
              "slug": [
                "personal-care-grocery"
              ]
            },
            "type": "collection"
          },
          "type": "page"
        },
        "allow_facets": true,
        "allow_sort": true,
        "badge": {
          "color": "#ffffff",
          "text": ""
        },
        "banners": {
          "landscape": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
          },
          "portrait": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
          }
        },
        "description": "Personal Care Grocery",
        "is_active": true,
        "is_visible": true,
        "logo": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
        },
        "meta": {},
        "name": "Personal Care Grocery",
        "priority": 1,
        "published": true,
        "query": [
          {
            "attribute": "department",
            "op": "in",
            "value": [
              "groceries"
            ]
          },
          {
            "attribute": "l1_category",
            "op": "in",
            "value": [
              "personal-care"
            ]
          }
        ],
        "seo": {
          "breadcrumbs": [
            {}
          ],
          "description": "Personal Care Grocery",
          "meta_tags": [],
          "sitemap": {
            "frequency": "never",
            "priority": 0.5
          },
          "title": "Personal Care Grocery"
        },
        "slug": "personal-care-grocery",
        "sort_on": "popular",
        "tags": [],
        "type": "query",
        "uid": "6a5b37377ff3da0bf303fb17",
        "visible_facets_keys": []
      },
      {
        "_custom_json": {},
        "_id": "6a54a6cebe7d82904c2c2584",
        "_locale_language": {},
        "_schedule": {
          "end": "9998-01-30T23:59:00Z",
          "next_schedule": [
            {
              "end": "9998-01-30T23:59:00Z",
              "start": "2026-07-13T08:50:18.142000Z"
            }
          ],
          "start": "2026-07-13T08:50:18.142000Z"
        },
        "action": {
          "page": {
            "params": {
              "slug": [
                "cothas-coffee"
              ]
            },
            "type": "collection"
          },
          "type": "page"
        },
        "allow_facets": true,
        "allow_sort": true,
        "badge": {
          "color": "#ffffff",
          "text": ""
        },
        "banners": {
          "landscape": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
          },
          "portrait": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
          }
        },
        "description": "Cothas Coffee",
        "is_active": true,
        "is_visible": true,
        "logo": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
        },
        "meta": {},
        "name": "Cothas Coffee",
        "priority": 2,
        "published": true,
        "query": [],
        "seo": {
          "breadcrumbs": [
            {}
          ],
          "description": "Cothas Coffee",
          "meta_tags": [],
          "sitemap": {
            "frequency": "never",
            "priority": 0.5
          },
          "title": "Cothas Coffee"
        },
        "slug": "cothas-coffee",
        "sort_on": "popular",
        "tags": [],
        "type": "items",
        "uid": "6a54a6cebe7d82904c2c2584",
        "visible_facets_keys": []
      },
      {
        "_custom_json": {},
        "_id": "6a46150a3025c0bfcb9f0a73",
        "_locale_language": {},
        "_schedule": {
          "end": "9998-01-30T23:59:00Z",
          "next_schedule": [
            {
              "end": "9998-01-30T23:59:00Z",
              "start": "2026-07-02T07:36:35.864000Z"
            }
          ],
          "start": "2026-07-02T07:36:35.864000Z"
        },
        "action": {
          "page": {
            "params": {
              "slug": [
                "dynamix-ghee"
              ]
            },
            "type": "collection"
          },
          "type": "page"
        },
        "allow_facets": true,
        "allow_sort": true,
        "badge": {
          "color": "#ffffff",
          "text": ""
        },
        "banners": {
          "landscape": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
          },
          "portrait": {
            "type": "image",
            "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
          }
        },
        "description": "Dynamix Ghee",
        "is_active": true,
        "is_visible": true,
        "logo": {
          "type": "image",
          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
        },
        "meta": {},
        "name": "Dynamix Ghee",
        "priority": 3,
        "published": true,
        "query": [],
        "seo": {
          "breadcrumbs": [
            {}
          ],
          "description": "Dynamix Ghee",
          "meta_tags": [],
          "sitemap": {
            "frequency": "never",
            "priority": 0.5
          },
          "title": "Dynamix Ghee"
        },
        "slug": "dynamix-ghee",
        "sort_on": "popular",
        "tags": [],
        "type": "items",
        "uid": "6a46150a3025c0bfcb9f0a73",
        "visible_facets_keys": []
      }
    ],
    "page": {
      "current": 1,
      "has_next": true,
      "has_previous": false,
      "item_total": 26924,
      "total": 5385,
      "type": "number"
    }
  }
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `items` | `array` | 3 items |
| `items` | `array` | 3 items |
| `page` | `object` | 6 fields |
| `page.current` | `integer` | 1 |
| `page.has_next` | `boolean` | true |
| `page.has_previous` | `boolean` | false |
| `page.item_total` | `integer` | 26924 |
| `page.total` | `integer` | 5385 |
| `page.type` | `string` | number |
| `raw` | `object` | 3 fields |
| `raw.filters` | `object` | 2 fields |
| `raw.items` | `array` | 3 items |
| `raw.page` | `object` | 6 fields |

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