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

Запрос статусов

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

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

  • 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

Результат запроса:
Результат запроса в виде массива элементов с параметрами

  • Number – номер заказа
  • State - состояние заказа
  • OrderStatus – статус заказа
  • StateDescription – текстовое представление состояния заказа
  • OrderStatusDescription - текстовое представление статуса заказа
  • StatusDate – дата и время установки текущего статуса и состояния заказа
  • ReturnPayment – признак перечисления денежных средств

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

  1. // url запроса
  2. $url = "http://api.iml.ru/Json/GetStatuses";
  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' => 999, // из справочника
  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. //для получения ответа в формате XML раскомментируйте строку ниже
  26. //curl_setopt($curl, CURLOPT_HTTPHEADER, array("Accept:application/xml; charset=utf-8"));  
  27. curl_setopt($curl, CURLOPT_POST, true);
  28. curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($content));
  29. curl_setopt($curl, CURLOPT_USERPWD, $login.":".$pass);
  30. curl_setopt($curl, CURLOPT_SSLVERSION, 3);
  31. curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  32. $response = curl_exec($curl);
  33. $result = json_decode($response, true); // результат запроса