API для представительств
Для представительств
Для доступа к веб-сервису необходимо отправить запрос на добавление IP-адресов в нашу систему.
Методы веб-сервиса:
1.Получение списка клиентов: GetUsers
GetUsers(string login, string password, string userCode);
Входящие параметры (обязательные):
login - Ваш логин на сайте (string).
password - Ваш пароль на сайте (string).
Входящие параметры (не обязательные):
userCode - Код клиента (string). Не обязательный параметр. Если не указывать в ответе вы получите полный
список ваших клиентов.
Возвращаемые данные:
- UserInfo - объект содержащий информацию о ваших клиентах.
2. Получение списка заказов: GetOrders
GetOrders(string login, string password, int userId, int orderId, int orderItemId, string dateBegin, string dateEnd, int status, string number);
Входящие параметры (обязательные):
login - Ваш логин на сайте (string).
assword - Ваш пароль на сайте (string).
Входящие параметры (не обязательные):
userId - Id клиента из вашего списка клиентов, если необходимы заказы определённого клиента (int).
orderId - Id заказа из вашего списка заказов, если необходимы детали из определённого заказа (int).
orderItemId - Id детали из заказа, если необходима информация по определённого детали из заказов (int).
dateBegin - Дата начала периода, если не указана то заказы будут выбираться с самого первого вашего заказа (string в формате YYYY-MM-DD).
dateEnd - Дата конца периода, если не указана то дата конца периода будет установлена на дату запроса автоматически (string в формате YYYY-MM-DD).
status - Статус заказа, если необходимо выбрать детали с определённым статусом (int).
Допустимые значения:
0 - все
1 - в работе
3 - Закуплено
4 - Отгрузили
5 - Поступило
6 - Готов к выдаче
7 - Нет в наличии
8 - Выдано
number - Каталожный номер запчасти, если необходимо выбрать заказы содержащие определённую деталь.
Возвращаемые параметры:
- OrderItem - Объект содержащий онформацию о ваших заказах с применением всех указанных вами фильтров.
3. Получение баланса клиента: GetBalance
GetBalance(string login, string password, string client);
Входящие параметры:
login - Ваш логин на сайте (string).
password - Ваш пароль на сайте (string).
client - Код клиента (string).
Возвращаемые параметры:
- GetBalance - объект содержащий информацию о балансе указанного клиента.
4. Отправка заказа в АВД: SendToAvd
SendToAvd(string login, string password, long[] orderItemIds);
Входящие параметры:
login - Ваш логин на сайте (string).
password - Ваш пароль на сайте (string).
orderItemIds - Массив содержащий в себе в качестве элементов Id деталей которые необходимо отправить в заказ (long). Id деталей можно получить из метода GetOrders.
Возвращаемые параметры:
- SendToAvdResult[int] - объект содержащий в себе Id созданных заказов.
5.Получение списка доступных статусов: GetStatuses
GetStatuses();
Входящие параметры:
- Без параметров
Возвращаемые параметры:
- GetStatusesResult[StatusItem] - Список статусов, доступных для установки на деталь из заказа, с помощью метода SetStatus.
6. Установка статуса: SetStatus
SetStatus(string login, string password, long idItem, int idStatus);
Входящие параметры:
login - Ваш логин на сайте (string).
password - Ваш пароль на сайте (string).
idItem - Id детали из заказа (int).
Id детали можно получить из метода GetOrders.
idStatus - Id статуса который необходимо установить на деталь.
1 - Готов к выдаче
2 - Товар выдан
3 - В работе
4 - Заказан поставщику
5 - Отказ
6 - Обратите внимание
7 - Ожидает оплаты
8 - На складе дилера (Товар в магазине) *
9 - Отправлено дилеру (Отправлен в магазин)*
(*)переименовали
!!! При установке статуса "Выдано" будет автоматически произведено списание денежных средств с баланса клиента. Учтите списание будет произведено корректно только в том случае если корректно установлено значение в поле "come" (поступило). Иначе списание произойдет, но сумма списания будет равна нулю. Если списание произошло неверно, в связи с неверно установленным полем "come", вам необходимо, через дилерскую панель, удалить неверную запись, установить верное значение в поле "come" и еще раз установить статус "Выдано" для данной детали.
Возвращаемые параметры:
- SetStatusResult - "1" в случае если операция прошла успешно, "0" - в случае если произошла ошибка.
7. Изменение количества в полях "Заказано", "Поступило", "Выдано": SetQuantity
SetQuantity(string login, string password, long idItem, int quantity, string typeQuantity);
Входящие параметры:
login - Ваш логин на сайте (string).
password - Ваш пароль на сайте (string).
idItem - Id детали из заказа (int). Id детали можно получить из метода GetOrders.
quantity - Количество которое необходимо установить (int).
typeQuantity - Название поля которое необходимо изменить (int).
Допустимые значения:
quantity - Поле "Заказано".
come - Поле "Поступило".
done - Поле "Выдано".
Поле "Заказано" можно изменить только до отправки заказа в AVD. При попытке изменить это поле у уже заказанной детали никаких изменений не произойдет.
Возвращаемые параметры:
- SetQuantityResult - Количество измененных записей.