Веб-сервис ML-AUTO v1.0. Описание.
В Веб-сервисе реализованы следующие функции:
|
Структура ответа веб-сервиса: STATUS – HTTP-код ответа вебсервиса MESSAGES – ошибки и сообщения RESPONSE – тело ответа |
Используемые HTTP-коды статуса: 200 ОК («успешно») 400 Bad Request («плохой, неверный запрос») 401 Unauthorized («не авторизован») 404 Not Found («не найдено») 407 Proxy Authentication Required («необходима аутентификация прокси») 500 Internal Server Error («внутренняя ошибка сервера») |
На каждый запрос наш веб-сервис возвращает ответ в установленном формате. Иногда этот ответ может быть полезно сохранить в Вашей системе для последующего использования. Как правило, время ответа составляет менее нескольких секунд. В редких случаях время ответа может достигать нескольких минут. Но ответ на Ваш запрос будет дан веб-сервисом в любом случае.
Рассмотрим подробнее каждую из функций веб-сервиса:
- Проверка отклика веб-сервиса (Ping)
Для запроса к этой функции не нужна регистрация. В ответе Вы увидите свой IP адрес и время отклика веб-сервиса. Все остальные функции требуют указания Ваших логина и пароля (параметры LOGIN и PASSWORD)
- Получение информации об аккаунте
В ответе Вы увидите текущие настройки вебсервис-аккаунта, а именно:
LOGIN - Ваш логин для веб-сервиса.
CURRENCY - Выбранная валюта для работы с веб-сервисом. Можно изменить через веб-сервис.
PARTIAL_ORDER - Неполная комплектация. По умолчанию она выставлена в значение Нет (NO). Можно изменить через веб-сервис.
ONLY_PRIMARY_STORAGE - Только основной склад. Если вы хотите делать заказы только с нашего основного склада, воспользуйтесь настройкой для аккаунта "Только основной склад". По умолчанию она выставлена в значение Нет (NO). При настройке YES вы будете видеть при проценке и сможете заказывать только товары основного склада. Можно изменить через веб-сервис.
REQUESTS_AVAL_CNT - Оставшееся количество запросов к сервису в текущие сутки.
WS_IP_LIST - Список IP, с которых разрешен доступ к веб-сервису. Указывается Вами по желанию при запросе доступа к веб-сервису.
CURRENT_IP - Ваш текущий IP-адрес.
RESPONSE_TYPE - Формат ответа веб-сервиса: JSON или XML. По умолчанию JSON. Можно изменить через веб-сервис.
- Изменение валюты работы с веб-сервисом
При работе с веб-сервисом есть возможность выбрать удобную Вам валюту. Доступные варианты: BYR, RUR, EUR, USD.
- Изменение формата ответа веб-сервиса Можно выбрать удобный Вам формат ответа веб-сервиса. Доступные варианты: JSON и XML.
- Изменение типа комплектации заказов
Полная или неполная комплектация заказа. Например, Вы хотите купить 5 фильтров MANN-FILTER C1343, а у нас в наличии только 4. Если у вас настройка YES (неполная комплектация), то в заказ попадет 4. Если настройка NO, то эта позиция в заказ не попадет, так как нет нужного количества для полной комплектации. По умолчанию NO.
- Изменение складов для заказов
Если вы хотите делать заказы только с нашего основного склада, воспользуйтесь настройкой для аккаунта Только основной склад (ONLY_PRIMARY_STORAGE). По умолчанию она выставлена в значение Нет (NO). При настройке YES вы будете видеть при проценке и сможете заказывать только товары основного склада.
Возможно также для заказа с основного склада указывать его код 201 как один из параметров POST запроса. Конкретно - это необязательный параметр STORAGE-CODE из массива ITEMS. То есть для каждой позиции в таком случае нужно указывать код склада.
- Получение актуального прайса основного склада
Вам нужен прайс по нашему основному складу с актуальными ценами и остатками в формате .CSV или .TXT? Просто укажите нужный формат, разделитель и кодировку файла. Веб-сервис сформирует прайс и отдаст Вам ссылку на его скачивание. Вы можете запросить прайс-лист через веб-сервис до 25 раз за последние 24 часа. Сформированный прайс хранится на нашем сервере сутки.
- Получение списка доступных складов
Информация о доступных складах. Можно получить код склада, сроки поставки, вероятность поставки, дату обновления прайса, описание. Код основного склада Монлибон: 201
- Получение списка брендов
Функция отдает список всех брендов, по которым есть предложения. Список может понадобиться, если в Вашей системе написание некоторых брендов отличается и вы захотите составить таблицу преобразований.
- Поиск по Артикулу (по ассортименту, без цен)
Информация по возможным брендам для данного артикула. Например, если вы подключили наш ассортимент к себе на сайт и клиент вводит в строке поиска артикул.
- Поиск по Артикулу и Бренду (проценка)
Функция отдает все предложения с количеством, Вашими ценами, примерным сроком поставки, вероятностью поставки и т.д. по указанной в запросе паре Артикул-Бренд. Дополнительный параметр SEARCH_TYPE задает тип поиска, с аналогами (1) или без (0 - по умолчанию).
- Просмотр адресов доставки клиента
Информация по Вашим адресам доставки. Код адреса доставки (ADDRESS_ID) необходим при создании заказа через веб-сервис.
- Создание заказа
Функция для автоматического создания заказов. В качестве входных параметров, помимо LOGIN и PASSWORD необходимо передать ADDRESS_ID - код адреса доставки и массив с позициями ITEMS. Также можно передать параметры BEZNAL (форма оплаты, по умолчанию 0 - Нал. Если 1, то безнал.) и ORDER-COMMENT - комменнтарий к заказу.
В качестве ответа веб-сервис вернет уникальный номер заказа и новый массив ITEMS, содержащий информацию по каждой заказываемой позиции.
- Просмотр заказа по номеру
Получение информации о заказе. В ответе возвращается массив ITEMS позиций заказа. По каждой позиции показан ее текущий статус, подтвержденное, отгруженное и отклоненное количество, цена, сумма, примерное время доставки.
- Просмотр списка заказов по массиву номеров (<=100)
Получение информации о массиве заказов. В ответе возвращается массив ORDERS заказов. По каждой позиции в заказе показан ее текущий статус, подтвержденное, отгруженное и отклоненное количество, цена, сумма, примерное время доставки.
- Просмотр списка заказов по указанному промежутку времени
Получение информации о заказах. В ответе возвращается массив ORDERS заказов. По каждой позиции в заказе показан ее текущий статус, подтвержденное, отгруженное и отклоненное количество, цена, сумма, примерное время доставки.
- Просмотр списка заказов клиента
Функция возвращает массив заказов ORDERS, содержащий по каждому заказу его номер (ORDER-NUMBER) и время создания заказа (DATE).
- Оформление возврата
Условия для оформления возврата можно прочитать здесь Чтобы оформить возврат, нужно передать следующие параметры:
REASON - Код причины возврата
SERIES_TTN - Серия ТТН (обязательно для возврата по безналу)
NUMBER_TTN - Номер ТТН (обязательно для возврата по безналу)
COMMENT - Комментарий (необязательный параметр)
ITEMS - Массив с позициями
Для каждой позиции массива ITEMS должен быть указан номер заказа, артикул, бренд и возвращаемое количество.
В качестве ответа веб-сервис вернет массив с номерами оформленных возвратов.
- Просмотр списка возвратов клиента
Функция возвращает массив возвратов RETURNS, содержащий по каждому возврату его номер, код причины возврата, серию и номер ТТН, время создания возврата.
- Просмотр возврата по номеру
Получение информации о возврате. В ответе возвращается массив ITEMS позиций возврата. По каждой позиции показан ее текущий статус, количество, процент комиссии, сумма.
Обращаем ваше внимание, что используются отдельные пары логин-пароль к сайту ML-AUTO и к веб-сервису.
Существуют некоторые ограничения на количество запросов:
- 1500 запросов к веб-сервису в календарные сутки
- 30 запросов к веб-сервису в минуту
- 25 запросов прайс-листа через веб-сервис за последние 24 часа
При необходимости мы можем предоставить Вам большее число запросов.
Подробное описание структуры запросов и ответов
Проверка отклика веб-сервиса (PING)
POST-запрос: https://www.ml-auto.ru/webservice/Ping/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| - | - | - | - | - |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Да |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| IP | IP-адрес | Строка (50) | Да | |
| EXEC_TIME | Время ответа | Строка (10) | Да |
Получение информации об аккаунте
POST-запрос: https://www.ml-auto.ru/webservice/ShowInfo/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Ваш логин для веб-сервиса | Строка (30) | Да | |
| CURRENCY | Ваша валюта для работы с веб-сервисом | Строка (3) | Да | BYR, EUR, RUR или USD |
| PARTIAL_ORDER | Неполная комплектация | Строка (3) | Да |
YES или NO. Пример: вы хотите купить 5 фильтров, а у нас в наличии 4. Если у вас настройка YES, то в заказ попадет 4. Если настройка NO, то эта позиция в заказ не попадет. По умолчанию NO. |
| ONLY_PRIMARY_STORAGE | Только основной склад | Строка (3) | Да |
YES или NO. Заказ только с основного или со всех доступных складов По умолчанию NO. |
| REQUESTS_AVAL_CNT | Оставшееся количество запросов к сервису в текущие сутки | Строка (4) | Да | |
| WS_IP_LIST | Список IP, с которых разрешен доступ к веб-сервису | Массив | Нет | |
| CURRENT_IP | Ваш IP-адрес | Строка (50) | Да | |
| RESPONSE_TYPE | Формат ответа | Строка (4) | Да | JSON или XML. По умолчанию JSON. |
Изменение валюты. Это настройка вашего вебсервис-аккаунта.
POST-запрос: https://www.ml-auto.ru/webservice/ChangeCurrency/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| NEW_CURRENCY | Новая валюта | Строка (3) | Да | Доступные варианты: BYR, RUR, EUR, USD. |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| SUCCESS | Сообщение об успешном изменении валюты | Строка (150) | Да |
Изменение формата ответа веб-сервиса. Это настройка вашего вебсервис-аккаунта.
POST-запрос: https://www.ml-auto.ru/webservice/ChangeResponseType/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| RESPONSE_TYPE | Формат ответа | Строка (4) | Да | Доступные варианты: JSON или XML. По умолчанию JSON. |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| SUCCESS | Сообщение об успешном изменении формата | Строка (150) | Да |
Изменение типа комплектации заказов (полная, неполная). Это настройка вашего вебсервис-аккаунта.
POST-запрос: https://www.ml-auto.ru/webservice/ChangeOrderType/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| PARTIAL_ORDER | Неполная комплектация | Строка (3) | Да | YES или NO. Пример: вы хотите купить 5 фильтров, а у нас в наличии 4. Если у вас настройка YES, то в заказ попадет 4. Если настройка NO, то эта позиция в заказ не попадет. По умолчанию NO. |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| SUCCESS | Сообщение об успешном изменении типа комплектации | Строка (150) | Да |
Изменение складов для заказа (только основной или все доступные). Это настройка вашего вебсервис-аккаунта.
POST-запрос: https://www.ml-auto.ru/webservice/ChangeStorageType/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ONLY_PRIMARY_STORAGE | Только основной склад | Строка (3) | Да | YES или NO. По умолчанию NO. |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| SUCCESS | Сообщение об успешном изменении складов для заказов | Строка (150) | Да |
Получение актуального прайса основного склада
POST-запрос: https://www.ml-auto.ru/webservice/Price/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| CHARSET | Кодировка | Строка (15) | Нет | По умолчанию WINDOWS-1251. Доступны также UTF-8 и UTF-16LE |
| FORMAT | Формат (расширение файла) | Строка (15) | Нет | По умолчанию CSV. Доступно также TXT |
| DELIMETER | Делиметр | Строка (15) | Нет | По умолчанию ;(SEMICOLON). Доступны также '(QUOTE), "(D_QUOTE) и табуляция(TAB) |
| ZIP | Архивировать | Строка (15) | Нет | По умолчанию Нет (NO_ZIP). Доступно также Да (ZIP) |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LINK | Ссылка для скачивания прайса | Строка (100) | Да | Действительна 24ч |
Получение списка доступных складов
POST-запрос: https://www.ml-auto.ru/webservice/ImportersSearch/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ID | Код склада | Строка (3) | Да | У основного склада Монлибон ID 201 |
| DELIVERY_TIME | Срок доставки, дней | Строка (14) | Да | |
| DESCR | Описание | Строка (500) | Да | |
| CHANCE | Вероятность поставки, % | Строка (6) | Да | |
| UP_DATE | Дата обновления прайса | Строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
Получение списка брендов
POST-запрос: https://www.ml-auto.ru/webservice/GetBrands/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с ответом | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| BRANDS | Массив с брендами | Массив | Да |
Поиск по Артикулу (по ассортименту, без цен)
POST-запрос: https://www.ml-auto.ru/webservice/ArticleSearch/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ARTICLE | Номер артикула | Строка (66) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | Строка (66) | Да | |
| BRAND | Бренд | Строка (66) | Да | |
| NAME | Наименование | Строка (150) | Нет |
Поиск по Артикулу и Бренду (проценка)
POST-запрос: https://www.ml-auto.ru/webservice/Search/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ARTICLE | Номер артикула | Строка (66) | Да | |
| BRAND | Бренд | Строка (66) | Да | |
| SEARCH_TYPE | Тип поиска | Строка (1), 0 или 1 | Нет | По умолчанию 0, без аналогов. Если 1, то с аналогами |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Да |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| NAME | Наименование | Строка (150) | Да | |
| QUANTITY | Количество доступно | строка (5) | Да | |
| PRICE | Цена | строка (10) | Да | |
| DATE | Дата поставки | строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
| STORAGE_CODE | Код склада | строка (3) | Да | |
| CHANCE | Вероятность поставки, % | строка (6) | Да | |
| MULT - планируется | Кратность | строка (5) | - | |
| MIN | Минимальное количество | строка (5) | Да | |
| ANALOG | Признак аналога | строка (3) | Да | YES или No |
| RETURN_PERIOD | Срок возврата, дней | строка (3) | Да | "0" или "" - возврат невозможен |
| isImporter | Являемся ли мы импортером по данной позиции | строка (1) | Да (для клиентов РБ) | |
| margin | Процент наценки | строка (3) | Да (для клиентов РБ) |
Просмотр адресов доставки клиента
POST-запрос: https://www.ml-auto.ru/webservice/MyDeliveryAddress/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ADDRESS_ID | Код адреса доставки | Строка (20) | Да | |
| ADDRESS_NAME | Адрес доставки | Строка (254) | Да |
Создание заказа
POST-запрос: https://www.ml-auto.ru/webservice/CreateOrder/
Для теста POST-запрос: https://www.ml-auto.ru/webservice/CreateOrderTest/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ADDRESS_ID | Код адреса доставки | Строка (20) | Да | |
| ONE-TIME-DELIVERY - планируется | Доставка одним заказом | Строка (1), 0 или 1 | - | По умолчанию 0 - Нет. Если 1, то Да |
| BEZNAL | Форма оплаты | Строка (1), 0 или 1 | Нет | По умолчанию 0 - Нал. Если 1, то безнал. |
| ORDER-COMMENT | Комментарий | Строка(150) | Нет | |
| ITEMS | Массив с позициями | Массив | Да |
Массив ITEMS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Количество | строка (5) | Да | |
| STORAGE-CODE | Код склада | строка (3) | Нет | Для заказа с основного склада Монлибон указывайте код 201 |
| MAX-DATE | Максимальная дата | строка (14) | Нет | YYYYMMDDHHIISS, например 20160401093000 |
| MAX-PRICE | Максимальная цена | строка (10) | Нет | |
| ITEM-COMMENT | Комментарий | строка (150) | Нет |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDER-NUMBER | Номер заказа на сайте | Строка (7) | Да | Например 123546 |
| ITEMS | Массив с информацией о распределении позиций | Массив | Да |
Массив ITEMS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Количество | строка (5) | Да | |
| PRICE | Цена | строка (10) | Да | |
| MSG | Сообщение о результате | строка (50) | Да |
Просмотр заказа по номеру
POST-запрос: https://www.ml-auto.ru/webservice/GetOrderByNumber/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ORDER-NUMBER | Номер заказа | Строка (7) | Да | Например 123546 |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ITEMS | Массив с позициями | Массив | Да |
Массив ITEMS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Количество | строка (5) | Да | |
| STATUS | Код статуса заказа | Строка (1) | Да |
0 - Новый 1 - В работе 2 - Заказан 3 - Задержка 4 - Закрыт 5 - Выполнен 6 - Отказ поставщика 7 - Возврат клиента 8 - Снято 9 - В архиве 10 - Подтверждено 11 - В пути на склад 12 - Получен на склад 13 - Готово к отгрузке 14 - Отправлено клиенту 15 - Частичная поставка 16 - На складе поставщика 17 - В резерве на складе 18 - Отбор товара по заказу 19 - Получен клиентом 20 - Отправлена заявка на отмену 21 - В отмене отказано |
| PRICE | Цена | строка (10) | Да | |
| BEZNAL | Форма оплаты | Строка (1), 0 или 1 | Да | 0 - Нал. 1 - безнал. |
| CONFIRMED | Количество подтверждено | строка (5) | Да | |
| HAS-SHIPPED | Количество отгружено | строка (5) | Да | |
| REJECTED | Количество отклонено | строка (5) | Да | |
| SUMM | Сумма | строка (10) | Да | |
| ESTIMATED-DELIVERY-DATE | Примерное время доставки | строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 или "Нет данных" |
| ITEM-COMMENT | Комментарий на позицию | строка (14) | Да | |
| ORDER-COMMENT | Комментарий на заказ | строка (14) | Да |
Просмотр списка заказов по массиву номеров (<=100)
POST-запрос: https://www.ml-auto.ru /webservice/getOrdersByIds/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| ORDERS-IDS | Массив номеров заказов | Массив | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDERS | Массив с заказами | Массив | Да |
Массив ORDERS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ID заказа | Массив с позициями | Массив | Да | Например: "859600" |
Массив ID заказа
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Количество | строка (5) | Да | |
| STATUS | Код статуса заказа | Строка (1) | Да |
0 - Новый 1 - В работе 4 - Закрыт 6 - Отказ поставщика 8 - Снято 9 - В архиве 10 - Подтверждено 11 - В пути на склад 12 - Получен на склад 13 - Готово к отгрузке 14 - Отправлено клиенту 15 - Частичная поставка |
| PRICE | Цена | строка (10) | Да | |
| BEZNAL | Форма оплаты | Строка (1), 0 или 1 | Да | 0 - Нал. 1 - безнал. |
| CONFIRMED | Количество подтверждено | строка (5) | Да | |
| HAS-SHIPPED | Количество отгружено | строка (5) | Да | |
| REJECTED | Количество отклонено | строка (5) | Да | |
| SUMM | Сумма | строка (10) | Да | |
| ESTIMATED-DELIVERY-DATE | Примерное время доставки | строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 или "Нет данных" |
| ITEM-COMMENT | Комментарий на позицию | строка (14) | Да | |
| ORDER-COMMENT | Комментарий на заказ | строка (14) | Да |
По данному методу лимит на запросы не установлен.
Просмотр списка заказов за указанный промежуток времени
POST-запрос: https://www.ml-auto.ru /webservice/getOrdersByDateRange/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| DATE-FROM | Дата от | Строка(14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
| DATE-TO | Дата до | Строка(14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDERS | Массив с заказами | Массив | Да |
Массив ORDERS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ID заказа | Массив с позициями | Массив | Да | Например: "859600" |
Массив ID заказа
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Количество | строка (5) | Да | |
| STATUS | Код статуса заказа | Строка (1) | Да |
0 - Новый 1 - В работе 4 - Закрыт 6 - Отказ поставщика 8 - Снято 9 - В архиве 10 - Подтверждено 11 - В пути на склад 12 - Получен на склад 13 - Готово к отгрузке 14 - Отправлено клиенту 15 - Частичная поставка |
| PRICE | Цена | строка (10) | Да | |
| BEZNAL | Форма оплаты | Строка (1), 0 или 1 | Да | 0 - Нал. 1 - безнал. |
| CONFIRMED | Количество подтверждено | строка (5) | Да | |
| HAS-SHIPPED | Количество отгружено | строка (5) | Да | |
| REJECTED | Количество отклонено | строка (5) | Да | |
| SUMM | Сумма | строка (10) | Да | |
| ESTIMATED-DELIVERY-DATE | Примерное время доставки | строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 или "Нет данных" |
| ITEM-COMMENT | Комментарий на позицию | строка (14) | Да | |
| ORDER-COMMENT | Комментарий на заказ | строка (14) | Да |
По данному методу лимит на запросы не установлен.
Просмотр списка заказов клиента
POST-запрос: https://www.ml-auto.ru/webservice/GetMyOrders/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDERS | Массив с результатами поиска | Массив | Да |
Массив ORDERS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDER-NUMBER | Номер заказа | Строка (7) | Да | Например 123546 |
| DATE | Время создания заказа | строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
Оформление возврата
POST-запрос: https://www.ml-auto.ru/webservice/CreateReturn/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| REASON | Код причины возврата | Строка (2) | Да |
10 - Брак. 04 - Не товарный вид. 15 - Некомплект. 09 - Отказ конечного потребителя. 08 - Ошибка клиента при заказе. 12 - Пересортица. |
| SERIES_TTN | Серия ТТН (обязательно для возврата по безналу) | Строка (2) | Нет | Только буквы без номера, например АБ |
| NUMBER_TTN | Номер ТТН (обязательно для возврата по безналу) | Строка (7) | Нет | Только цифры без серии, например 1234567 |
| COMMENT | Комментарий | Строка (256) | Нет | |
| ITEMS | Массив с позициями | Массив | Да |
Массив ITEMS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ORDER_NUMBER | Номер заказа | строка (7) | Да | Например 123546 |
| PIN | Номер артикула | строка (66) | Да | |
| BRAND | Бренд | строка (66) | Да | |
| QUANTITY | Возвращаемое количество | строка (5) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание | RETURN_NUMBERS | Массив с номерами возвратов | Массив | Да |
Просмотр списка возвратов клиента
POST-запрос: https://www.ml-auto.ru/webservice/GetMyReturns/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| RETURNS | Массив с результатами поиска | Массив | Да |
Массив RETURNS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| RETURN_NUMBER | Номер возврата | Строка (11) | Да | Например 123-1234567 |
| DATE | Время создания возврата | Строка (14) | Да | YYYYMMDDHHIISS, например 20160401093000 |
| REASON | Код причины возврата | Строка (2) | Да |
10 - Брак. 04 - Не товарный вид. 15 - Некомплект. 09 - Отказ конечного потребителя. 08 - Ошибка клиента при заказе. 12 - Пересортица. |
| COMMENT | Комментарий к возврату | Строка (256) | Нет | |
| NUMBER_TTN | Серия и номер ТТН | Строка (35) | Нет | Например, АБ1234567 |
Просмотр возврата по номеру
POST-запрос: https://www.ml-auto.ru/webservice/GetReturnByNumber/
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| LOGIN | Логин | Строка (30) | Да | |
| PASSWORD | Пароль | Строка (30) | Да | |
| RETURN_NUMBER | Номер возврата | Строка (11) | Да | Например 123-1234567 |
Ответ сервера
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| STATUS | Код ответа веб-сервиса | Строка (3) | Да | |
| MESSAGES | Сообщения и ошибки | Массив | Нет | |
| RESPONSE | Массив с результатами поиска | Массив | Нет |
Массив RESPONSE
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| ITEMS | Массив с позициями | Массив | Да |
Массив ITEMS
| Параметр | Наименование | Тип (макс. размер) | Обязательный | Примечание |
| PIN | Номер артикула | Строка (66) | Да | |
| BRAND | Бренд | Строка (66) | Да | |
| PRICE | Цена | Строка (10) | Да | |
| QUANTITY | Количество | Строка (5) | Да | |
| COMISSION | Комиссия, % | Строка (2) | Да | SUMM | Сумма возврата | Строка (10) | Да |
| RETURN_STATUS | Статус позиции возврата | Строка (2) | Да |
00 - Новый. 01 - В работе. 02 - Принят складом. 03 - Отказано |
Эмуляция вызова веб-сервиса.