---
title: "Gets a list of products"
method: POST
path: "/api/v{version}/products/search"
tags: ["catalog"]
---

# Gets a list of products

`POST /api/v{version}/products/search`

Gets a list of products with pagination and filtering support. Permissions requises : SupplierAdminRole, SupplierParcelsManagerRole.

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchProductsRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable

## Response `200`

OK

- PagedListSearchProductResponse
  - `items` SearchProductResponse[], nullable
    - `id` string, uuid
    - `tenantId` string, nullable
    - `name` string, nullable
    - `sku` string, nullable
    - `localStock` integer
    - `categoryName` string, nullable
    - `subCategoryName` string, nullable
    - `price` PriceResponse
      - `base` number, double
      - `promotional` number, double, nullable
      - `promotionStart` string, date-time, nullable
      - `promotionEnd` string, date-time, nullable
    - `purchasePrice` number, double, nullable
    - `dimensions` DimensionsResponse
      - `length` number, double, nullable
      - `width` number, double, nullable
      - `height` number, double, nullable
    - `warehouseStock` WarehouseStockResponse
      - `damageQuantity` integer
      - `availableQuantity` integer
      - `pendingReceptionQuantity` integer
      - `withdrawalQuantity` integer
      - `underDeliveryQuantity` integer
      - `deliveredQuantity` integer
      - `hubId` string, uuid, nullable
      - `hubName` string, nullable
    - `weight` number, double, nullable
    - `variants` VariantResponse[], nullable
      - `id` string, uuid
      - `color` string, nullable
      - `stockQuantity` integer
      - `price` PriceResponse
        - `base` number, double
        - `promotional` number, double, nullable
        - `promotionStart` string, date-time, nullable
        - `promotionEnd` string, date-time, nullable
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

---

[API](https://skmtc.dev/zrexpress/apis/zrexpress-api.md) · [All operations](https://skmtc.dev/zrexpress/apis/zrexpress-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zrexpress/zrexpress-api/revisions/99b075e0b641/schema)