ObjednávkySeznam objednávek

Stránkovaný výpis objednávek

Filtrovatelný, stránkovaný seznam objednávek.


Základní info

  • URL: https://b2bapi-{INSTANCE}/api/orders-list
  • Povolené metody: POST
  • V těle dotazu je třeba vyplnit informace pro filtrování a stránkování

Parametry

ParametrInPovinnýPopis
filterbodyneFiltr (popsán níže)
pageNumberbodyanoČíslo stránky
pageSizebodyanoVelikost stránky
orderBybodynePole, podle kterého se řadí (např. ['dateOfOrder desc', 'formNumber desc'])
limitFieldsbodynePole, které se mají vrátit (např. ['formNumber', 'totalPrice'])

Filtr

  • Basic
ParametrTypPopis
Idint[]?Id objednávek
FormNumberstring?Čísla dokladů
DateFromDateTime?Datum pořízení od
DateToDateTime?Datum pořízení do
ProductIdint[]?Id produktů
PriceFromdecimal?Cena od
PriceTodecimal?Cena do
PriceTypeint?Typ ceny (0 = bez DPH, 1 = s DPH)
PaymentTypeIdint[]?Id typů plateb
TransportTypeIdint[]?Id typů dopravy

{
  "filter": {
    "basic": {
      "id": [0],
      "formNumber": "string",
      "dateFrom": "2024-06-25T11:43:53.790Z",
      "dateTo": "2024-06-25T11:43:53.790Z",
      "productId": [0],
      "priceFrom": 0,
      "priceTo": 0,
      "priceType": 0,
      "paymentTypeId": [0],
      "transportTypeId": [0]
    }
  },
  "pageNumber": 0,
  "pageSize": 0,
  "orderBy": ["string"],
  "limitFields": ["string"]
}