---
title: "List products"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/product"
tags: ["Product"]
---

# List products

`GET /api/business/{businessId}/branch/{branchId}/product`

Get a list of products for the specified business id and branch id. List can be filtered by product type, DateTime of update, name and barcode and possibility to include archived products in the list or only to list archived, low in stock or out of stock products

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `productType` string
- `searchQuery` string
- `archivedOnly` boolean
- `outOfStock` boolean
- `lowStock` boolean
- `includeArchived` boolean
- `updated_from` string
- `updated_to` string

## Response `200`

Products listed

- DataPagedModelProduct
  - `_embedded` object
    - `products` Product[]
      - `productId` string
      - `parentProductId` string
      - `name` string
      - `brandId` string
      - `brandName` string
      - `categoryId` string
      - `categoryName` string
      - `archived` boolean
      - `price` number
      - `minQuantity` number
      - `maxQuantity` number
      - `type` string
      - `barcode` string
      - `measurementQuantity` number
      - `measurementUnit` string
      - `reorderCount` integer
      - `reorderCost` number
      - `quantityInStock` number
      - `code` string
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400` — Bad Request
- `404` — Business or branch with the specified ids don't exist
- `429` — Request rate limit exceeded. Current limit set to 100 rps.
- `500` — Internal Server Error

---

[API](https://skmtc.net/phorest/apis/third-party-api.md) · [All operations](https://skmtc.net/phorest/apis/third-party-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phorest/third-party-api/revisions/2218bc90d39c/schema)