API

Все запросы к серверу формируются в виде GET-запросов с параметрами переданными в кодировке application/x-www-form-urlencoded. В каждом запросе должны присутствовать как минимум два обязательных параметра: login и password
В общем виде запросы выглядят следующим образом:

http://gaek.net/api/<имя функции>?login=<логин>&password=<пароль>&<другие параметры>
где Пример запроса:
http://gaek.net/api/getPrice?login=userlogin&password=userpassword&productName=12345&developerName=ford

Все функции возвращают данные в формате JSON, которые представляют с собой объект в котором как минимум есть один реквизит msg, содержащий описание ошибки:
    {
        msg: <сообщение об ошибке>,
    }
    


Список функций

Название функции getPrice
Параметры
login логин обязательный
password пароль обязательный
productName Номер детали обязательный
developerName Название производителя необязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "data": [
            "developerName": <код производителя>,
            "developerCaption": <название производителя>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "deliveryWork": <срок поставки в банковских днях>,
            "deliveryCalendar": <срок поставки в календарных днях>,
            "count": <доступное количество>,
            "countStep": <минимальная партия (кратность)>,
            "price": <цена>,
            "searchId": <идентификатор торгового предложения, используемый для заказа>,
        ]
    }
Название функции getBasketItems
Параметры
login логин обязательный
password пароль обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "data": [
            "id": <идентификатор позиции>,
            "developerCaption": <название производителя>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "deliveryWork": <срок поставки в банковских днях>,
            "deliveryCalendar": <срок поставки в календарных днях>,
            "count": <количество>,
            "price": <цена>,
            "maximum": <количество, доступное для заказа>,
        ]
    }
Название функции addBasketItem
Параметры
login логин обязательный
password пароль обязательный
searchId Идентификатор торгового предложения обязательный
count Количество обязательный
note Примечание необязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "id": <идентификатор добавленной позиции>
    } 
Название функции setBasketItem
Параметры
login логин обязательный
password пароль обязательный
id Идентификатор позиции в корзине обязательный
count Количество обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
    }
Название функции deleteBasketItem
Параметры
login логин обязательный
password пароль обязательный
id Идентификатор позиции в корзине обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
    }
Название функции createOrder
Параметры
login логин обязательный
password пароль обязательный
paymentTypeId идентификатор способа оплаты:
1 - безналичный расчет,
2 - наличый расчет
необязательный
deliveryTypeId идентификатор способа доставки:
1 - Самовывоз,
2 - Boxberry,
3 - Доставка до клиента,
4 - Транспортная компания
необязательный
deliveryAddress адрес доставки необязательный
note комментарий к заказу необязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "id": <идентификатор нового заказа>,
    }
Название функции createOrderByDocumentItems
ВНИМАНИЕ! Запрос отправляется методом POST!
Параметры
login логин обязательный
password пароль обязательный
paymentTypeId идентификатор способа оплаты:
1 - безналичный расчет,
2 - наличый расчет
необязательный
deliveryTypeId идентификатор способа доставки:
1 - Самовывоз,
2 - Boxberry,
3 - Доставка до клиента,
4 - Транспортная компания
необязательный
deliveryAddress адрес доставки необязательный
note комментарий к заказу необязательный
Тело запроса Массив идентификаторов позиций в корзине: [231, 232, 233] обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "id": <идентификатор нового заказа>,
        "list": <массив идентификаторов позиций в корзине не прошедших проверку (должны входить в заказ клиента)>,
    }
Название функции getOrders
Параметры
login логин обязательный
password пароль обязательный
dateFrom Начало периода в формате yyyymmdd обязательный
dateTo Окончание периода в формате yyyymmdd обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "data": [
            "documentId": <идентификатор документа>,
            "deliveryTypeId": <идентификатор способа доставки>,
            "paymentTypeId": <идентификатор способа оплаты>,
            "number": <номер документа>,
            "date": <дата документа>,
            "state": <статус документа>,
            "manager": <менеджер>,
            "debt": <задолженность по документу>,
            "sum": <сумма документа>,
            "items": [
                "documentId": <идентификатор документа>,
                "date": <дата документа>,
                "developerCaption": <производитель>,
                "productName": <номер детали>,
                "productCaption": <название детали>,
                "count": <количество>,
                "price": <цена>,
                "sum": <сумма>,
                "deliveryDate": <дата доставки>,
                "state": <статус позиции>, 
            ]
        ]
    }
Название функции getOrderItems
Параметры
login логин обязательный
password пароль обязательный
id идентификатор заказа обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "data": [
            "documentId": <идентификатор документа>,
            "documentItemId": <идентификатор позиции в заказе>,
            "date": <дата документа>,
            "developerCaption": <производитель>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "count": <количество>,
            "price": <цена>,
            "sum": <сумма>,
            "deliveryDate": <дата доставки>,
            "state": <статус позиции>, 
        ]
    }
Название функции getDevelopers
Параметры
login логин обязательный
password пароль обязательный
Возвращаемое значение
    {
        "msg": <описание ошибки>,
        "data": [
            "caption": наименование производителя,
            "name": код производителя,
        ]
    }

Статусы заказов


Статусы позиций в заказах


Примеры