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

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

Запрос позволяет получить список заказов по параметрам. POST запрос по адресу http(s)://api.iml.ru/json/GetOrders

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

  • Test – тестовый режим, 'True' для тестового режима, иначе не указывайте
  • Job – услуга, Code из справочника услуг
  • CustomerOrder – номер заказа
  • DeliveryDateStart – дата доставки, запросы с датой доставки начиная с указанной (включительно), тип значения строка в формате ‘dd.MM.yyyy’
  • DeliveryDateEnd - дата доставки, запросы с датой доставки по указанную, тип значения строка в формате ‘dd.MM.yyyy’
  • State – состояние заказа, Code из таблицы состояний заказа
  • OrderStatus – статус заказа, Code из таблицы статусов заказа
  • CreationDateStart – дата создания, начиная с указанной (включительно), тип значения строка в формате ‘dd.MM.yyyy’
  • CreationDateEnd - конечная дата создания, тип значения строка в формате ‘dd.MM.yyyy’
  • RegionTo – регион получения, Code из таблицы регионов
  • RegionFrom – регион отправления, Code из таблицы регионов
  • BarCode – штрих код заказа в формате EAN-13

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

  • Job – услуга доставки
  • CustomerOrder – номер заказа
  • OrderStatus - статус заказа
  • State - состояние заказа
  • DeliveryDate – дата доставки в строковом представлении
  • Volume – количество мест
  • Weight – вес
  • BarCode – штрих код заказа в формате EAN-13
  • DeliveryPoint – пункта самовывоза, Code из таблицы пунктов самовывоза
  • Phone – телефон
  • Contact – контактное лицо
  • IndexFrom - служебные данные
  • IndexTo - служебные данные
  • RegionCodeFrom – код региона отправления
  • RegionCodeTo – код региона получения
  • Address – адрес доставки
  • TimeFrom – начало временного периода доставки
  • TimeTo – конец временного периода доставки
  • Amount – сумма заказа
  • ValuatedAmount – оценочная стоимость заказа
  • Comment – комментарий
  • Commission – комиссия
  • DeliveryAmount – стоимость доставки
  • GoodItems – позиции заказа, если указывались при создании заказа, тип значения – массив элементов с параметрами:
    • productNo – номер товара (артикул)
    • productName – наименование товара
    • productVariant – вариант товара (размер, цвет и т.д)
    • productBarCode – штрих код продукта
    • couponCode – номер купона
    • discount – скидка
    • weightLine – вес товара
    • amountLine – стоимость товара
    • statisticalValueLine – оценочная стоимость
    • deliveryService – услуга доставки, если позиция описывает оплату за услугу доставки, то заполнить значением 1

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

  1. // url запроса
  2. $url = "http://api.iml.ru/Json/GetOrders";
  3. //логин и пароль, подходят от личного кабинета
  4. $login = '';
  5. $pass = '';
  6. // параметры запроса, не нужные можно не добавлять в массив или заполнить пустым текстовым полем
  7. // не забываем при тесте этого файла про запятые в массиве
  8. $content =array(
  9. 'Test' => 'True', // для тестового режима, иначе не указывайте
  10. //'CustomerOrder' => '',                 // номер заказа
  11. //'BarCode' => '2624028597816',          // штрих код
  12. //'DeliveryDateStart' => '2014-01-15',   // с указанной даты и позднее
  13. //'DeliveryDateEnd' => '2014-07-15',     // до указанной даты
  14. //'State' => 3                           // из справочника
  15. //'OrderStatus' => 0,                    // из справочника
  16. 'Job' => 'С24КО', // из справочника услуг
  17. //'RegionFrom' => 'МОСКВА',              // из справочника регионов
  18. //'RegionTo' => 'МОСКВА',                // из справочника регионов
  19. 'CreationDateStart' => '2014-01-15' // с указанной даты и позднее
  20. //'CreationDateEnd' => '2014-07-15'      // до указанной даты
  21. );
  22. $curl = curl_init($url);
  23. curl_setopt($curl, CURLOPT_HEADER, false);
  24. curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  25. //curl_setopt($curl, CURLOPT_HTTPHEADER, array("Accept:application/xml; charset=utf-8"));  //для получения ответа в формате XML
  26. curl_setopt($curl, CURLOPT_POST, true);
  27. curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($content));
  28. curl_setopt($curl, CURLOPT_USERPWD, $login.":".$pass);
  29. curl_setopt($curl, CURLOPT_SSLVERSION, 3);
  30. curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  31. $response = curl_exec($curl);
  32. $result = json_decode($response, true); // результат запроса  

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

{
"Job": "24КО",
"CustomerOrder": "HL-50220-22",
"DeliveryDate": "08.03.2018 0:00:00",
"Volume": 1,
"Weight": 0,
"BarCode": "7500264684013",
"DeliveryPoint": "1",
"Phone": "79134551970",
"Contact": "ИГЛИНА ДИНА АЛЕКСЕЕВНА",
"IndexTo": "",
"IndexFrom": "",
"RegionCodeTo": "МОСКВА",
"RegionCodeFrom": "МОСКВА",
"Address": "МИКРОРАЙОН25 79",
"TimeTo": "",
"TimeFrom": "",
"ValuatedAmount": 1419.6,
"Amount": 1419.6,
"State": 999,
"OrderStatus": 0,
"Commission": 23.3,
"DeliveryAmount": 202.1,
"GoodItems": [
{
"productNo": "683655",
"productName": "парка с капюшоном светло-розовый",
"productVariant": "",
"productNote": "",
"productBarCode": "06836528584156",
"couponCode": "",
"discount": 0,
"weightLine": null,
"amountLine": 944.3,
"statisticalValueLine": 944.3,
"deliveryService": 0,
},
{
"productNo": "1043471",
"productName": "юбка в горошек",
"productVariant": "",
"productNote": "",
"productBarCode": "1043471000568050",
"couponCode": "",
"discount": 0,
"weightLine": null,
"amountLine": 475.3,
"statisticalValueLine": 475.3,
"deliveryService": 0,
}
],
}