# Brands

Browse JioMart brand-directory records with numbered-page controls.

- Platform: [JioMart](https://docs.upscrape.com/docs/platforms/jiomart)
- Capability ID: `jiomart.brands.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": 10
  },
  "capability": "jiomart.brands.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": 10
}
```

## Response

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

Brand records can include name, slug, identifier, description and media where present.

Use the returned page metadata for the directory’s own continuation; do not apply product-list cursor rules to this endpoint.

### Illustrative sample output

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

```json
{
  "items": [
    {
      "action": {
        "page": {
          "query": {
            "brand": [
              "lysoft"
            ]
          },
          "type": "products"
        },
        "type": "page"
      },
      "banners": {
        "portrait": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        }
      },
      "description": "LYSOFT",
      "logo": {
        "type": "image",
        "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
      },
      "name": "LYSOFT",
      "slug": "lysoft",
      "uid": 45400
    },
    {
      "action": {
        "page": {
          "query": {
            "brand": [
              "kohinoor"
            ]
          },
          "type": "products"
        },
        "type": "page"
      },
      "banners": {
        "portrait": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        }
      },
      "description": "kohinoor",
      "logo": {
        "type": "image",
        "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
      },
      "name": "kohinoor",
      "slug": "kohinoor",
      "uid": 2
    },
    {
      "action": {
        "page": {
          "query": {
            "brand": [
              "parle"
            ]
          },
          "type": "products"
        },
        "type": "page"
      },
      "banners": {
        "portrait": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        }
      },
      "description": "parle",
      "logo": {
        "type": "image",
        "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
      },
      "name": "parle",
      "slug": "parle",
      "uid": 3
    }
  ],
  "page": {
    "current": 1,
    "has_next": true,
    "has_previous": false,
    "item_total": 22088,
    "type": "number"
  },
  "raw": {
    "items": [
      {
        "action": {
          "page": {
            "query": {
              "brand": [
                "lysoft"
              ]
            },
            "type": "products"
          },
          "type": "page"
        },
        "banners": {
          "portrait": {
            "type": "image",
            "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
          }
        },
        "description": "LYSOFT",
        "logo": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        },
        "name": "LYSOFT",
        "slug": "lysoft",
        "uid": 45400
      },
      {
        "action": {
          "page": {
            "query": {
              "brand": [
                "kohinoor"
              ]
            },
            "type": "products"
          },
          "type": "page"
        },
        "banners": {
          "portrait": {
            "type": "image",
            "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
          }
        },
        "description": "kohinoor",
        "logo": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        },
        "name": "kohinoor",
        "slug": "kohinoor",
        "uid": 2
      },
      {
        "action": {
          "page": {
            "query": {
              "brand": [
                "parle"
              ]
            },
            "type": "products"
          },
          "type": "page"
        },
        "banners": {
          "portrait": {
            "type": "image",
            "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
          }
        },
        "description": "parle",
        "logo": {
          "type": "image",
          "url": "https://cdn.pixelbin.io/v2/catalog-cloud-non-prod/original/BizbZdLqn-logo.png"
        },
        "name": "parle",
        "slug": "parle",
        "uid": 3
      }
    ],
    "page": {
      "current": 1,
      "has_next": true,
      "has_previous": false,
      "item_total": 22088,
      "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` | 5 fields |
| `page.current` | `integer` | 1 |
| `page.has_next` | `boolean` | true |
| `page.has_previous` | `boolean` | false |
| `page.item_total` | `integer` | 22088 |
| `page.type` | `string` | number |
| `raw` | `object` | 2 fields |
| `raw.items` | `array` | 3 items |
| `raw.page` | `object` | 5 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)