# List a product's variants

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/product/{hash_id}/variant
```

- API version: v1
- Operation ID: `v1_public_product_variant_index`
- Section: Products and catalog › [Product variants](https://developer.yoprint.com/reference/product-variants.md)
- Web page: https://developer.yoprint.com/reference/product-variants/v1-product-variant-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Lists the live variants (size and color combinations) of a variant product, paged. Each variant has its `id` (use it as the `db_variant` id on sales order lines), `size_id`, `size_label`, `color_id`, `color_label`, `color_hex`, `default_price`, `price_data`, `weight`, `vendor_id` and `supplier_id`.

Each variant has its own `phased_out`, `phased_out_at` and `phased_out_by` (`{id, name}` or null: on sale, or nobody recorded), loaded for the whole list in one query. The list is paged: `pagination` gives `total`, `count`, `perPage`, `currentPage` and `totalPages`. Ask for the next page with `page`; the page size is the team's setting (50 unless changed), and `per_page` is ignored.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The product's id (`id` from List products). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.

## Query parameters

- `page` (integer, optional): The page to return. Pages hold the team's page size (`pagination_per_page` in team settings: 50 unless changed, 5 to 100). `per_page` is not read here. Default `1`. Minimum 1. Example `1`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/product/EDhVUaC6jbLbed/variant' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `type` (string, required): Always `"variant_option"`.
    - `default_price` (integer | number | string, required): This variant's selling price. Never null. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
    - `id` (string, required): The variant id: the `db_variant` line's product id.
    - `phased_out` (boolean, required)
    - `trashed` (boolean, required)
    - `barcode` (string | null, optional)
    - `brand` (string | null, optional): The parent product's brand.
    - `color_hex` (string | null, optional)
    - `color_id` (string | null, optional)
    - `color_label` (string | null, optional)
    - `description` (string | null, optional): The parent product's description.
    - `enable` (boolean, optional)
    - `phased_out_at` (string (date-time) | null, optional)
    - `phased_out_by` (object | null, optional): Who did it, as `{id, name}`; null when on sale or nobody was recorded.
      - `id` (string, optional)
      - `name` (string, optional)
    - `price_data` (object | array, optional): Prices for pricing groups, as saved: keyed by the pricing group's internal number (not its hash id), each `{"price": <thousandths>}`. An empty list `[]` when there are none.
    - `size_id` (string | null, optional)
    - `size_label` (string | null, optional)
    - `supplier_id` (string | null, optional)
    - `taxable` (boolean, optional): The parent product's `taxable`.
    - `title` (string | null, optional): The parent product's title.
    - `track_inventory` (boolean, optional)
    - `vendor_id` (string, optional): The vendor id, or an empty string when none.
    - `weight` (number | string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)
- `pagination` (object, optional)
  - `count` (integer, required)
  - `currentPage` (integer, required)
  - `links` (object | array of any, required): Links to the neighbouring pages: `previous` and `next`, each present only when that page exists. An empty list, `[]`, when there is only one page.
    - `next` (string (uri), optional): The next page.
    - `previous` (string (uri), optional): The previous page.
  - `perPage` (integer, required)
  - `total` (integer, required)
  - `totalPages` (integer, required)

Example response:

```json
{
  "data": [
    {
      "barcode": null,
      "brand": "Northwind",
      "color_hex": "#000000",
      "color_id": "black",
      "color_label": "Black",
      "default_price": 9000,
      "description": null,
      "enable": true,
      "id": "nFsgC7x4kiFeXu",
      "phased_out": false,
      "phased_out_at": null,
      "phased_out_by": null,
      "price_data": [],
      "size_id": "M",
      "size_label": "M",
      "supplier_id": null,
      "taxable": true,
      "title": "Classic Tee",
      "track_inventory": true,
      "trashed": false,
      "type": "variant_option",
      "vendor_id": "",
      "weight": null
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- Amounts here use thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).

## Related

- [Add a variant to a product](https://developer.yoprint.com/reference/product-variants/v1-product-variant-store.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant`
- [Phase out variants (stop selling them)](https://developer.yoprint.com/reference/product-variants/v1-product-variant-phase-out.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/phase_out`
- [Add a line item to a sales order or quote](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item`