GET api/OrdersList?UserGuid={UserGuid}&ApiKey={ApiKey}&DateFrom={DateFrom}&DateTo={DateTo}&ContragentGuid={ContragentGuid}

Возвращает список заказов за данный период для выбранного контрагента

Информация о запросе

URI параметры

ИмяОписаниеТипДополнительная информация
UserGuid

Ваш UserGuid

globally unique identifier

Required

ApiKey

Ваш ApiKey

string

Required

DateFrom

Дата "от" в формате yyyy-MM-dd. Если не задано, то устанавливается в минус 30 дней от текущей даты

date

Нет.

DateTo

Дата "до" в формате yyyy-MM-dd. Если не задано, то устанавливается в текущую дату

date

Нет.

ContragentGuid

Guid контрагента (необязательное)

string

Нет.

Параметры тела запроса

Нет.

Информация об ответе

Описание ресурсов

OrdersListResponse
ИмяОписаниеТипДополнительная информация
OrdersList

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

Коллекция OrderViewModel

Нет.

IsError

Указывает завершился ли запрос с ошибкой или нет

boolean

Нет.

ErrorMessage

Сообщение об ошибке

string

Нет.

Форматы ответа

application/json, text/json

Пример:
{
  "OrdersList": [
    {
      "OrderItemId": 1,
      "OrderGuid": "f2ac8238-d145-4122-9c32-c84f44690988",
      "OrderNumber": "sample string 2",
      "OrderDate": "2019-10-18T01:50:19.8058433+06:00",
      "UpdateDate": "2019-10-18T01:50:19.8058433+06:00",
      "Contragent": "sample string 5",
      "ContragentGuid": "sample string 6",
      "Count": 7,
      "Price": 8.0,
      "TotalSum": 9.0,
      "Status": "sample string 10",
      "CancelReason": "sample string 11",
      "StatusCode": 12,
      "WarehouseName": "sample string 13",
      "WarehouseId": "f2183081-40aa-4f65-a0a6-bad44c16de9e",
      "CategoryId": "6d997f7a-520c-4d69-97a1-28aa889266c0",
      "Article": "sample string 16",
      "Brand": "sample string 17",
      "Name": "sample string 18",
      "ExpectedDelivery": 19,
      "GuaranteedDelivery": 20,
      "Unit": "sample string 21",
      "Comment": "sample string 22"
    },
    {
      "OrderItemId": 1,
      "OrderGuid": "f2ac8238-d145-4122-9c32-c84f44690988",
      "OrderNumber": "sample string 2",
      "OrderDate": "2019-10-18T01:50:19.8058433+06:00",
      "UpdateDate": "2019-10-18T01:50:19.8058433+06:00",
      "Contragent": "sample string 5",
      "ContragentGuid": "sample string 6",
      "Count": 7,
      "Price": 8.0,
      "TotalSum": 9.0,
      "Status": "sample string 10",
      "CancelReason": "sample string 11",
      "StatusCode": 12,
      "WarehouseName": "sample string 13",
      "WarehouseId": "f2183081-40aa-4f65-a0a6-bad44c16de9e",
      "CategoryId": "6d997f7a-520c-4d69-97a1-28aa889266c0",
      "Article": "sample string 16",
      "Brand": "sample string 17",
      "Name": "sample string 18",
      "ExpectedDelivery": 19,
      "GuaranteedDelivery": 20,
      "Unit": "sample string 21",
      "Comment": "sample string 22"
    }
  ],
  "IsError": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Пример:
<OrdersListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PhaetonExternalApi.ViewModels">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsError>true</IsError>
  <OrdersList>
    <OrderViewModel>
      <Article>sample string 16</Article>
      <Brand>sample string 17</Brand>
      <CancelReason>sample string 11</CancelReason>
      <CategoryId>6d997f7a-520c-4d69-97a1-28aa889266c0</CategoryId>
      <Comment>sample string 22</Comment>
      <Contragent>sample string 5</Contragent>
      <ContragentGuid>sample string 6</ContragentGuid>
      <Count>7</Count>
      <ExpectedDelivery>19</ExpectedDelivery>
      <GuaranteedDelivery>20</GuaranteedDelivery>
      <Name>sample string 18</Name>
      <OrderDate>2019-10-18T01:50:19.8058433+06:00</OrderDate>
      <OrderGuid>f2ac8238-d145-4122-9c32-c84f44690988</OrderGuid>
      <OrderItemId>1</OrderItemId>
      <OrderNumber>sample string 2</OrderNumber>
      <Price>8</Price>
      <Status>sample string 10</Status>
      <StatusCode>12</StatusCode>
      <TotalSum>9</TotalSum>
      <Unit>sample string 21</Unit>
      <UpdateDate>2019-10-18T01:50:19.8058433+06:00</UpdateDate>
      <WarehouseId>f2183081-40aa-4f65-a0a6-bad44c16de9e</WarehouseId>
      <WarehouseName>sample string 13</WarehouseName>
    </OrderViewModel>
    <OrderViewModel>
      <Article>sample string 16</Article>
      <Brand>sample string 17</Brand>
      <CancelReason>sample string 11</CancelReason>
      <CategoryId>6d997f7a-520c-4d69-97a1-28aa889266c0</CategoryId>
      <Comment>sample string 22</Comment>
      <Contragent>sample string 5</Contragent>
      <ContragentGuid>sample string 6</ContragentGuid>
      <Count>7</Count>
      <ExpectedDelivery>19</ExpectedDelivery>
      <GuaranteedDelivery>20</GuaranteedDelivery>
      <Name>sample string 18</Name>
      <OrderDate>2019-10-18T01:50:19.8058433+06:00</OrderDate>
      <OrderGuid>f2ac8238-d145-4122-9c32-c84f44690988</OrderGuid>
      <OrderItemId>1</OrderItemId>
      <OrderNumber>sample string 2</OrderNumber>
      <Price>8</Price>
      <Status>sample string 10</Status>
      <StatusCode>12</StatusCode>
      <TotalSum>9</TotalSum>
      <Unit>sample string 21</Unit>
      <UpdateDate>2019-10-18T01:50:19.8058433+06:00</UpdateDate>
      <WarehouseId>f2183081-40aa-4f65-a0a6-bad44c16de9e</WarehouseId>
      <WarehouseName>sample string 13</WarehouseName>
    </OrderViewModel>
  </OrdersList>
</OrdersListResponse>