Документация

Запрос страницы списка заказов для ЛК

Запрос позволяет получить постраничный список заказов по параметрам фильтра ЛК POST запрос по адресу http(s)://api.iml.ru/Json/GetOrdersList

Параметры запроса, фильтр:

  • take – требуемое количество строк (заказов), целое число
  • skip – смещение, относительно первого элемента, целое число
  • property – свойство сортировки (наименование столбца, по-умолчанию ID), строка
  • direction – направление сортировки (по-умолчанию, по убыванию), строка, возможны значения "ASC", "DESC"
  • Job – услуга, Code из справочника услуг
  • CustomerOrder – номер заказа
  • DeliveryDateFrom – дата доставки, запросы с датой доставки начиная с указанной (включительно), тип значения строка в формате ‘dd.MM.yyyy’
  • DeliveryDateTo - дата доставки, запросы с датой доставки по указанную, тип значения строка в формате ‘dd.MM.yyyy’
  • Status – состояние заказа, Code из таблицы состояний заказа
  • OrderStatus – статус заказа, Code из таблицы статусов заказа
  • ReturnStatus – статус возврата, Code из таблицы статусов заказа
  • CreateDate – дата создания, тип значения строка в формате ‘dd.MM.yyyy’
  • RegionCodeTo – регион получения, Code из таблицы регионов
  • BarCode – штрих код заказа в формате EAN-13
  • Address – адрес, строка
  • Contact – контакт, строка
  • Phone – номер телефона, строка
  • Email – адрес электронной почты, строка
  • RegionFilterToInv – флаг инверсии региона доставки (при значении true будут отобраны заказы, в которых регион доставки не равен значению RegionCodeTo)
  • ReceiptFirstLocation – дата, тип значения строка в формате ‘dd.MM.yyyy’
  • Archive – флаг для выборки архивных записей, число (0, 1)

Результат запроса:

  • Result - статусное сообщение
  • Count - количество выбранных записей
  • TotalCount - всего количество записей в БД по текущему фильтру
  • InqueryPage - массив выбранных заказов:
    • Id - идентификатор заказа
    • InquiryNo - номер заявки заказа
    • Line - номер строки заявки заказа
    • Job - услуга
    • DeliveryDate - дата доставки
    • TimeFrom - время доставки от
    • TimeTo - время доставки до
    • CustomerOrder - номер заказа присвоенный интернет-магазином
    • Address - адрес
    • Comment - комментарий
    • Contact - контакт
    • Phone - номер телефона
    • Weight - вес
    • Volume - объём
    • Amount - сумма заказа
    • ValuatedAmount - оценочная стоимость заказа
    • EmployeeNo - номер сотрудника, на котором в настоящий момент числится заказ
    • CreationDate - дата создания заказа
    • ForStore - служебные данные
    • SelfDelivery - признак выдачи заказа на пункте самовывоза. 0 - доставка курьером или Почтой РФ, 1 - доставка на пункт выдачи заказов
    • Status - состояние доставки заказа
    • ValidationStatus - статус проверки
    • Posted - отправлено (0 - нет, 1 - да)
    • City - город
    • CustomerNo - идентификатор клиента
    • CashReceiptAmount - сумма прихода денежных средств по заказу
    • CashReceiptDate - дата прихода денежных средств по заказу в кассу
    • TransferredToDate - служебные данные
    • BarCode - штрих-код
    • SuburbService - служебные данные
    • DeliveryAmount - стоимость Доставки (рассчитывает в корпоративной системе IML)
    • Mileage - расстояние
    • ForLocation - для склада, определяет финальный склад назначения для доставки заказа
    • InquiryType - тип инвентаризации (используется для инвентаризации ячейки, после того как заказы отправлены на доставку)
    • Archive - архивный
    • AddressValidationState - служебные данные
    • ApprovedAddress - подтверждённый адрес
    • RegionHint - служебные данные
    • CityHint - служебные данные
    • StreetHint - служебные данные
    • PostCode - почтовый код
    • RegionCodeFrom - код региона отправки
    • SpecialCode - специальный код
    • OrderStatus - статус заказа
    • RegionCodeTo - код региона доставки
    • UploadDateTime - служебные данные
    • SourceCode - код источника, опредяет с помощью какого метода заказ был добавлен в базу
    • LocationCode - текущий склад месторасположения заказа
    • Region - служебные данные
    • LastModified - дата последнего изменения
    • ReturnCashDate - дата возврата денег
    • RemainAmount - служебные данные
    • AmountKM - стоимость (км), рассчитывается, например в зависимости МКАД
    • FactorAmount - служебные данные
    • Commission - комиссия, стоимость услуг (рассчитывает в корпоративной системе IML)
    • AddedAmountForTransfer - служебные данные
    • Approved - служебные данные
    • ApprovedDateTime - служебные данные
    • AgreementNo - номер договора клиента
    • ExpectedCostDelivered - служебные данные
    • ExpectedCostPartDelivered - служебные данные
    • ExpectedCostCanceled - служебные данные
    • InvoiceNo - номер приглашения
    • TimeAddFactor - служебные данные
    • PrevalenceFactor - служебные данные
    • ReturnStatus - состояние возврата (отображает текущее состояние возвращаемого заказа интернет магазину)
    • ReceiptFirstLocation - дата приёма заказа на первичном складе (например заказ следует Москва - Санкт-Петербург, в поле будет отображаться дата приема заказа на складе Москва)
    • ReceiptLastLocation - дата приёма заказа на последнем складе (например заказ следует Москва - Санкт-Петербург, в поле будет отображаться дата приема заказа на склад Санкт -Петербурга)
    • PaymentType - тип оплаты
    • VolumePrint - количество мест для печати этикетки
    • SourceFileId - служебные данные
    • PostIdentifier - уникальный идентификатор почты
    • ExternalBarcode - служебные данные
    • PostRegion - регион почтовой доставки
    • PostArea - зона почтовой доставки
    • PostContentType - тип почтового отправления
    • FinalConditions - служебные данные
    • Floor - этаж
    • ReturnWeight - служебные данные
    • ReturnCashNo - служебные данные
    • Contact_ID - служебные данные
    • PostCounty - служебные данные
    • Note - примечание (Код ПВЗ для самовывозных заказов )
    • ApiActionLogID - служебные данные
    • Email - адрес электронной почты
    • SenderName - ФИО отправителя
    • UndeliveryOption - служебные данные
    • CargoID - номер груза
    • IndexFrom - служебные данные
    • IndexTo - служебные данные
    • ReturnAmount - служебные данные
    • OversizeCargo - служебные данные
    • TransferedFromBarcode - служебные данные
    • DeliveryStatusUpdateDate - служебные данные
    • ConsignorPhone - служебные данные

Пример запроса на PHP:

  1. // url запроса
  2. $url = "http://api.iml.ru/Json/GetOrderList";
  3. //логин и пароль, подходят от личного кабинета
  4. $login = '';
  5. $pass = '';
  6. // параметры запроса, не нужные можно не добавлять в массив или заполнить пустым текстовым полем
  7. $content =array(
  8. 'take' => 1,
  9. 'skip' => 20,
  10. );
  11. $curl = curl_init($url);
  12. curl_setopt($curl, CURLOPT_HEADER, false);
  13. curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  14. //curl_setopt($curl, CURLOPT_HTTPHEADER, array("Accept:application/xml; charset=utf-8"));  //для получения ответа в формате XML
  15. curl_setopt($curl, CURLOPT_POST, true);
  16. curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($content));
  17. curl_setopt($curl, CURLOPT_USERPWD, $login.":".$pass);
  18. curl_setopt($curl, CURLOPT_SSLVERSION, 3);
  19. curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  20. $response = curl_exec($curl);
  21. $result = json_decode($response, true); // результат запроса  

Пример ответа:

При успешном создании:

{
"Result": "OK"
"Count": 1,
"TotalCount": 18,
"InqueryPage": [
{
"Id": 17661604,
"InquiryNo": null,
"Line": null,
"Job": "С24КО",
"DeliveryDate": "2017-12-20T00:00:00",
"TimeFrom": null,
"TimeTo": null,
"CustomerOrder": "ПИ_0151",
"Address": "",
"Comment": null,
"Contact": "С24КО, подробности, ООД",
"Phone": "89991235566",
"Weight": 1,
"Volume": 1,
"Amount": 5,
"ValuatedAmount": 800,
"EmployeeNo": null,
"CreationDate": "2017-12-19T11:39:39.44",
"ForStore": null,
"SelfDelivery": "1",
"Status": 999,
"ValidationStatus": 1,
"Posted": false,
"City": null,
"CustomerNo": "03361",
"CashReceiptAmount": null,
"CashReceiptDate": null,
"TransferredToDate": null,
"BarCode": "",
"SuburbService": null,
"DeliveryAmount": null,
"Mileage": null,
"ForLocation": "МСК_ПС24",
"InquiryType": 0,
"Archive": false,
"AddressValidationState": 0,
"ApprovedAddress": null,
"RegionHint": null,
"CityHint": null,
"StreetHint": null,
"PostCode": "125130",
"RegionCodeFrom": "МОСКВА",
"SpecialCode": "24",
"OrderStatus": null,
"RegionCodeTo": "МОСКВА",
"UploadDateTime": null,
"SourceCode": "WEB EXCEL",
"LocationCode": null,
"Region": null,
"LastModified": null,
"ReturnCashDate": null,
"RemainAmount": null,
"AmountKM": null,
"FactorAmount": null,
"Commission": null,
"AddedAmountForTransfer": null,
"Approved": null,
"ApprovedDateTime": null,
"AgreementNo": "0000718А",
"ExpectedCostDelivered": null,
"ExpectedCostPartDelivered": null,
"ExpectedCostCanceled": null,
"InvoiceNo": null,
"TimeAddFactor": null,
"PrevalenceFactor": null,
"ReturnStatus": null,
"ReceiptFirstLocation": null,
"ReceiptLastLocation": null,
"PaymentType": null,
"VolumePrint": null,
"SourceFileId": 315660,
"PostIdentifier": null,
"ExternalBarcode": "",
"PostRegion": "",
"PostArea": "",
"PostContentType": null,
"FinalConditions": null,
"Floor": null,
"ReturnWeight": null,
"ReturnCashNo": null,
"Contact_ID": null,
"PostCounty": null,
"Note": "24",
"ApiActionLogID": null,
"Email": "t.derfel@iml.ru",
"SenderName": null,
"UndeliveryOption": null,
"CargoID": null,
"IndexFrom": null,
"IndexTo": null,
"ReturnAmount": null,
"OversizeCargo": null,
"TransferedFromBarcode": null,
"DeliveryStatusUpdateDate": null,
"ConsignorPhone": null
}
]
}

С ошибками:

{
"Result": "Error",
"Errors": [
{
"Message": "Не указано количество строк для выборки",
"Code": "Take"
}
]
}