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": "b6f4c012-0080-4399-a767-e567a2254835", "OrderNumber": "sample string 2", "OrderDate": "2025-04-07T20:09:32.2300226+05:00", "UpdateDate": "2025-04-07T20:09:32.2300226+05: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": "64097e6b-be33-4ae2-80f4-1c773d9abc2a", "CategoryId": "3a645532-dd78-4725-a5b8-e3532e761987", "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": "b6f4c012-0080-4399-a767-e567a2254835", "OrderNumber": "sample string 2", "OrderDate": "2025-04-07T20:09:32.2300226+05:00", "UpdateDate": "2025-04-07T20:09:32.2300226+05: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": "64097e6b-be33-4ae2-80f4-1c773d9abc2a", "CategoryId": "3a645532-dd78-4725-a5b8-e3532e761987", "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" }
multipart/form-data
Пример:
{"OrdersList":[{"OrderItemId":1,"OrderGuid":"b6f4c012-0080-4399-a767-e567a2254835","OrderNumber":"sample string 2","OrderDate":"2025-04-07T20:09:32.2300226+05:00","UpdateDate":"2025-04-07T20:09:32.2300226+05: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":"64097e6b-be33-4ae2-80f4-1c773d9abc2a","CategoryId":"3a645532-dd78-4725-a5b8-e3532e761987","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":"b6f4c012-0080-4399-a767-e567a2254835","OrderNumber":"sample string 2","OrderDate":"2025-04-07T20:09:32.2300226+05:00","UpdateDate":"2025-04-07T20:09:32.2300226+05: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":"64097e6b-be33-4ae2-80f4-1c773d9abc2a","CategoryId":"3a645532-dd78-4725-a5b8-e3532e761987","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:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <IsError>true</IsError> <ErrorMessage>sample string 2</ErrorMessage> <OrdersList> <OrderViewModel> <OrderItemId>1</OrderItemId> <OrderGuid>b6f4c012-0080-4399-a767-e567a2254835</OrderGuid> <OrderNumber>sample string 2</OrderNumber> <OrderDate>2025-04-07T20:09:32.2300226+05:00</OrderDate> <UpdateDate>2025-04-07T20:09:32.2300226+05:00</UpdateDate> <Contragent>sample string 5</Contragent> <ContragentGuid>sample string 6</ContragentGuid> <Count>7</Count> <Price>8</Price> <TotalSum>9</TotalSum> <Status>sample string 10</Status> <CancelReason>sample string 11</CancelReason> <StatusCode>12</StatusCode> <WarehouseName>sample string 13</WarehouseName> <WarehouseId>64097e6b-be33-4ae2-80f4-1c773d9abc2a</WarehouseId> <CategoryId>3a645532-dd78-4725-a5b8-e3532e761987</CategoryId> <Article>sample string 16</Article> <Brand>sample string 17</Brand> <Name>sample string 18</Name> <ExpectedDelivery>19</ExpectedDelivery> <GuaranteedDelivery>20</GuaranteedDelivery> <Unit>sample string 21</Unit> <Comment>sample string 22</Comment> </OrderViewModel> <OrderViewModel> <OrderItemId>1</OrderItemId> <OrderGuid>b6f4c012-0080-4399-a767-e567a2254835</OrderGuid> <OrderNumber>sample string 2</OrderNumber> <OrderDate>2025-04-07T20:09:32.2300226+05:00</OrderDate> <UpdateDate>2025-04-07T20:09:32.2300226+05:00</UpdateDate> <Contragent>sample string 5</Contragent> <ContragentGuid>sample string 6</ContragentGuid> <Count>7</Count> <Price>8</Price> <TotalSum>9</TotalSum> <Status>sample string 10</Status> <CancelReason>sample string 11</CancelReason> <StatusCode>12</StatusCode> <WarehouseName>sample string 13</WarehouseName> <WarehouseId>64097e6b-be33-4ae2-80f4-1c773d9abc2a</WarehouseId> <CategoryId>3a645532-dd78-4725-a5b8-e3532e761987</CategoryId> <Article>sample string 16</Article> <Brand>sample string 17</Brand> <Name>sample string 18</Name> <ExpectedDelivery>19</ExpectedDelivery> <GuaranteedDelivery>20</GuaranteedDelivery> <Unit>sample string 21</Unit> <Comment>sample string 22</Comment> </OrderViewModel> </OrdersList> </OrdersListResponse>