Перейти к основному содержанию
POST
/
api
/
seller
/
v1
/
orders
/
list
Возвращает список заказов с фильтрами и пагинацией.
curl --request POST \
  --url https://seller-api.teez.kz/api/seller/v1/orders/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageNumber": 123,
  "pageSize": 123,
  "sortBy": "<string>",
  "sortDirection": "<string>",
  "filters": {
    "orderStatus": [
      "<string>"
    ],
    "search": "<string>"
  }
}
'
{
  "orders": [
    {
      "orderId": 123,
      "orderGuid": "<string>",
      "orderNumber": "<string>",
      "createdDate": "<string>",
      "receivedDate": "<string>",
      "statusKey": "<string>",
      "statusLabel": "<string>",
      "barcode": "<string>",
      "productName": "<string>",
      "quantity": 123,
      "quantityReturned": 123,
      "commissionPercent": 123,
      "price": 123,
      "originalPrice": 123,
      "commissionAmount": 123,
      "payoutAmount": 123,
      "totalPrice": 123,
      "totalCommissionAmount": 123,
      "totalPayoutAmount": 123
    }
  ],
  "totalCount": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "totalPages": 123
}

Тело

application/json

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

pageNumber
integer<int32> | null

Номер страницы, начиная с 1. По умолчанию 1.

pageSize
integer<int32> | null

Количество элементов на странице. По умолчанию 20.

sortBy
string | null

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

sortDirection
string | null

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

filters
object

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

Ответ

Success

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

orders
object[] | null

Список заказов

totalCount
integer<int32>

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

pageNumber
integer<int32>

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

pageSize
integer<int32>

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

totalPages
integer<int32>

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