# List products

> Retrieve a paginated list of products, with channel- and country-aware pricing.

`GET /rest/api/products`

Retrieves the collection of Product resources.

Returns a paginated collection of products in the current organization, optionally filtered by channel, collection or status, and with pricing resolved against a given channel/country/time when `resolveContext` is set.

> **Polling for changes**
>
> Use `updatedAt[after]` with an ISO 8601 UTC timestamp to fetch only the products that have changed since your last sync. Combine with `order[updatedAt]=asc` to walk the change feed deterministically.

## Headers

| Name                         | Type      | Required | Description                                                                                                                                       |
| ---------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-Flowkiwi-Organization-Id` | `string`  | Yes      | The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.  |
| `X-Flowkiwi-Locale`          | `string`  | -        | Specifies the locale for properties that support localization. If not provided, the default locale will be used.                                  |
| `X-Flowkiwi-Locale-Fallback` | `boolean` | -        | Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from the default locale will be used. |

## 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: `variants`, `options`, `optionValues`, `medias`, `category`, `collections`, `channels`, `metafields`, `metaobject`. Tokens are independent; unknown values are silently ignored. `optionValues` only has a visible effect when combined with `variants`. `medias` and `metafields` apply to the product and, when combined with `variants`, to each variant. `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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `channels`                   | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `channels[]`                 | `string[]` | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `collections`                | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `collections[]`              | `string[]` | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `status`                     | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `status[]`                   | `string[]` | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `vendor`                     | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `order[vendor]`              | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `order[createdAt]`           | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `order[updatedAt]`           | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `createdAt[before]`          | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `createdAt[strictly_before]` | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `createdAt[after]`           | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `createdAt[strictly_after]`  | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `updatedAt[before]`          | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `updatedAt[strictly_before]` | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `updatedAt[after]`           | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `updatedAt[strictly_after]`  | `string`   | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `exists[variants]`           | `boolean`  | -        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## Response

**200** - Product collection

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

## Errors

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

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

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/rest/api/products' \
  -H 'Authorization: Bearer {token}' \
  -H 'X-Flowkiwi-Organization-Id: <org_id>' \
  -H 'Accept: application/ld+json'
```

### Example response

```json
{
  "hydra:member": [
    {
      "@context": "/rest/api/contexts/Product",
      "@id": "/rest/api/Products/0ce86414-c0c5-55af-96ff-cf298ebaf6fe",
      "@type": "Product",
      "id": "0ce86414-c0c5-55af-96ff-cf298ebaf6fe",
      "status": "/rest/api/statuses/DRAFT",
      "vendor": "EcoWear",
      "title": "Premium Organic Cotton T-Shirt",
      "description": "Comfortable and sustainable t-shirt made from 100% organic cotton. Available in multiple colors.",
      "tags": "organic,sustainable,cotton,apparel",
      "variants": [],
      "options": [],
      "images": [],
      "category": null,
      "attributeValues": [],
      "channels": [],
      "collections": [],
      "createdAt": "2024-01-01T00:00:00+00:00",
      "updatedAt": "2024-01-01T00:00:00+00:00"
    }
  ],
  "hydra:totalItems": 1
}
```