Список товаров

Возвращает общую информацию о товарах. Доступен поиск по ID, названию, статусу товара и статусу модерации товара, а также по категории последнего уровня.

POST /api/seller/v1/products/list

Пример запроса

{
  "pageNumber": 1,
  "pageSize": 20,
  "sortBy": "id",
  "sortDirection": "Asc",
  "filters": {
    "categoryIds": [
      10,
      20
    ],
    "productStatus": [
      "created",
      "availableonstock"
    ],
    "moderationProductStatus": [
      "approved"
    ],
    "search": "iphone",
    "shopId": 55
  }
}

200

{
  "products": [
    {
      "productId": 123,
      "productName": {
        "rus": "<string>",
        "kaz": "<string>"
      },
      "categoryId": 123,
      "categoryName": {
        "rus": "<string>",
        "kaz": "<string>"
      },
      "productStatus": "<string>",
      "moderationStatus": "<string>",
      "totalWmsQuantity": 123,
      "salesCount": 123,
      "photo": {
        "url": "<string>"
      }
    }
  ],
  "totalCount": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "totalPages": 123
}

Пример запроса

{
  "pageNumber": 1,
  "pageSize": 20,
  "sortBy": "id",
  "sortDirection": "Asc",
  "filters": {
    "categoryIds": [
      10,
      20
    ],
    "productStatus": [
      "created",
      "availableonstock"
    ],
    "moderationProductStatus": [
      "approved"
    ],
    "search": "iphone",
    "shopId": 55
  }
}

Тело

application/json

Запрос на получение списка товаров с фильтрацией и пагинацией

pageNumber · integer<int32> | null

Номер страницы, начиная с 1

pageSize · integer<int32> | null

Количество элементов на странице

sortBy · string | null

Название поля для сортировки (id, name, status)

sortDirection · string | null

Направление сортировки (Asc или Desc)

filters · object

Объект с фильтрами товаров

Show child attributes

Ответ

200

application/json

Success

Ответ на запрос списка товаров

products · object[] | null

Список товаров

Show child attributes

totalCount · integer<int32>

Общее количество товаров

pageNumber · integer<int32>

Текущий номер страницы

pageSize · integer<int32>

Размер страницы (кол-во элементов на странице)

totalPages · integer<int32>

Общее количество страниц