---
search:
  tags:
    - Products
    - GET
seo:
  description: >-
    List products, or search with q. Reference for the GET /products endpoint in
    the scango.ch API.
sidebar:
  label: List or search products
  badge: GET
title: List or search products
type: openapi-operation
---
List products, or search with `q`.

Without `q`, products are ordered by `name`; page with `cursor`. With `q`, results are ranked by relevance and paged with `offset`; `limit` is capped at 250. A `q` that looks like a barcode (at least 8 letters, digits, `-` or `_`, including a digit) matches `barcode` and `barcodeAliases` exactly instead of searching text.

Search results carry a reduced set of fields: `id`, `name`, `price`, `barcode`, `supplier`, `category`, `externalId`, `taxCategory`, `margin`, `imageUrl`, `allowStore`, `hideStore`, the sale fields, `deactivated`, `ageRestriction`, `showOnScreen`, `openInput` and `showOnScale`. Fetch a product by id for the full record.

`GET /products`

**Responses**

- `200` — List of products with meta.
- `400` — Invalid query parameters.
- `403` — Missing, unknown or inactive API key, or a Read key on a write operation.
- `503` — Product search is temporarily unavailable.

Response example, 200 · Catalog page (no search):

```json
{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Mineral water 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6",
      "category": "cat_01",
      "supplier": "sup_01",
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "a1b2c3"
  }
}
```

Response example, 200 · Search with q:

```json
{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Mineral water 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6"
    }
  ],
  "meta": {
    "total": 42,
    "returned": 20,
    "limit": 20,
    "offset": 0
  }
}
```

Response example, 400:

```json
{
  "error": {
    "formErrors": [],
    "fieldErrors": {
      "limit": [
        "Number must be less than or equal to 5000"
      ]
    }
  }
}
```

Response example, 403:

```json
{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}
```

Response example, 503:

```json
{
  "error": "Product search failed"
}
```