# List all variants

> Retrieve variants across every product, with search, sync filters and channel-aware pricing.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`GET /api/variants`

Retrieves the collection of Product Variant resources.

Returns the paginated collection of variants across **all** products, rather than the variants of a single product. Use it to sync your catalog, to search by `sku` or `barcode` without knowing the parent product, or to price many variants in one pass.

For the variants of one known product, use [List variants](/api/product-management/variants/list/) instead.

## Searching

`search` matches, case-insensitively and partially, against the variant `sku`, the variant `barcode`, and the parent product `title` in the current locale.

## Polling for changes

`createdAt` and `updatedAt` accept `[after]`, `[before]`, `[strictly_after]` and `[strictly_before]` bounds. Pass ISO 8601 UTC timestamps and keep the high-water mark of the last run to fetch only what changed:

```
?updatedAt[after]=2026-08-01T00:00:00Z&order[updatedAt]=asc
```

> **Always set an order**
>
> Without an explicit `order[...]`, rows can reshuffle between pages as records are written. For a stable sync, order by `updatedAt` or `sku`.

## Embedding relations

`expand` takes a comma-separated list of tokens, each replacing an IRI reference with the full object: `optionValues`, `medias`, `metafields`, `metaobject` and `product`. Tokens are independent, except `metaobject`, which only takes visible effect combined with `metafields`.

> **Scopes shape the result**
>
> This endpoint requires `products:read` or `products:org:read`. With `products:org:read`, only records created by your organization are returned - embedded relations and counts included. See [Permissions](/authentication/#permissions).

## Query parameters

| Name                         | Type       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ---------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resolveContext[channel]`    | `string`   | -        | Channel IRI used to resolve the variant price. Required together with `resolveContext[country]`.                                                                                                                                                                                                                                                                                                                                  |
| `resolveContext[country]`    | `string`   | -        | Country IRI used to resolve the variant price. Required together with `resolveContext[channel]`.                                                                                                                                                                                                                                                                                                                                  |
| `resolveContext[at]`         | `string`   | -        | ISO 8601 UTC timestamp at which the price is resolved. Defaults to the current time when omitted.                                                                                                                                                                                                                                                                                                                                 |
| `expand`                     | `string`   | -        | Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: `optionValues`, `medias`, `metafields`, `metaobject`, `product`. Tokens are independent; unknown values are silently ignored. `metaobject` only has a visible effect when combined with `metafields` (it embeds the referenced metaobject on each metafield of type `metaobject_reference` or `list__metaobject_reference`). |
| `page`                       | `integer`  | -        | The collection page number                                                                                                                                                                                                                                                                                                                                                                                                        |
| `itemsPerPage`               | `integer`  | -        | The number of items per page                                                                                                                                                                                                                                                                                                                                                                                                      |
| `properties[]`               | `string[]` | -        | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}                                                                                                                                              |
| `id[]`                       | `string[]` | -        | Only the items with one of these ids, each a UUID or the item IRI.                                                                                                                                                                                                                                                                                                                                                                |
| `createdAt[after]`           | `string`   | -        | Product Variant createdAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `createdAt[before]`          | `string`   | -        | Product Variant createdAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `createdAt[strictly_after]`  | `string`   | -        | Product Variant createdAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `createdAt[strictly_before]` | `string`   | -        | Product Variant createdAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `updatedAt[after]`           | `string`   | -        | Product Variant updatedAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `updatedAt[before]`          | `string`   | -        | Product Variant updatedAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `updatedAt[strictly_after]`  | `string`   | -        | Product Variant updatedAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `updatedAt[strictly_before]` | `string`   | -        | Product Variant updatedAt                                                                                                                                                                                                                                                                                                                                                                                                         |
| `sku`                        | `string`   | -        | Product Variant sku                                                                                                                                                                                                                                                                                                                                                                                                               |
| `sku[]`                      | `string[]` | -        | Product Variant sku                                                                                                                                                                                                                                                                                                                                                                                                               |
| `barcode`                    | `string`   | -        | Product Variant barcode                                                                                                                                                                                                                                                                                                                                                                                                           |
| `barcode[]`                  | `string[]` | -        | Product Variant barcode                                                                                                                                                                                                                                                                                                                                                                                                           |
| `metafield`                  | `object`   | -        | Filter owners by metafield value. Each key is a `namespace.key` pair from a metafield definition of this owner type; pairs are combined with AND. Scalar types match exactly on the stored string; list types match when the stored array contains the requested value. An unknown `namespace.key` returns an empty collection. Example: ?metafield[specs.material]=leather.                                                      |
| `search`                     | `string`   | -        | Free-text search across: sku, barcode, product.title (case-insensitive, partial match)                                                                                                                                                                                                                                                                                                                                            |
| `order[sku]`                 | `string`   | -        | Product Variant order[sku]                                                                                                                                                                                                                                                                                                                                                                                                        |
| `order[barcode]`             | `string`   | -        | Product Variant order[barcode]                                                                                                                                                                                                                                                                                                                                                                                                    |
| `order[createdAt]`           | `string`   | -        | Product Variant order[createdAt]                                                                                                                                                                                                                                                                                                                                                                                                  |
| `order[updatedAt]`           | `string`   | -        | Product Variant order[updatedAt]                                                                                                                                                                                                                                                                                                                                                                                                  |

## Response

**200** - Product Variant collection

| Property     | Type                | Required | Description |
| ------------ | ------------------- | -------- | ----------- |
| `search`     | `object`            | -        |             |
| `totalItems` | `integer`           | -        |             |
| `view`       | `object`            | -        |             |
| `member`     | `Product.Variant[]` | Yes      |             |

## Errors

**403** - Access denied. The caller is missing one or more permissions required for this operation.

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/variants' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json'
```

### Example response

```json
{
  "member": [
    {
      "@context": "/api/contexts/Product%20Variant",
      "@id": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/variants/67ac49d4-c3d3-560d-ad66-fb3321801edf",
      "@type": "Product Variant",
      "barcode": "BAR-001-A",
      "createdAt": "2024-01-01T00:00:00+00:00",
      "id": "67ac49d4-c3d3-560d-ad66-fb3321801edf",
      "measurement": {
        "measuredType": "volume",
        "quantityUnit": "cl",
        "quantityValue": 70,
        "referenceUnit": "l",
        "referenceValue": 1
      },
      "medias": [],
      "optionValues": [
        "/api/product_options/019af941-6b7c-7d8e-9f0a-2b3c4d5e6f70/option_values/48e92020-a038-589d-977b-4ad9bdf9e8ec",
        "/api/product_options/019af941-6b7c-7d8e-9f0a-2b3c4d5e6f70/option_values/2558340c-6c44-50c2-a47d-ea9b96d273a0"
      ],
      "product": "/api/products/019af93e-420e-79f8-800b-6680f03dce20",
      "sku": "SKU-ABC-001",
      "updatedAt": "2024-01-01T00:00:00+00:00"
    }
  ],
  "totalItems": 1
}
```
