База знаний
Дерево страниц

Сравнение версий

Старая версия 12

changes.mady.by.user Ольга Чеснокова

Сохранено

по сравнению с

Новая версия 13

changes.mady.by.user Ольга Чеснокова

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Параметры запроса

Тип данных

Обязательный параметр

Возможные значения

Описание

user_full_name

String

Нет


Полное имя пользователя

user_phone

String

Нет


Телефон пользователя

reservation

Boolean

Да

True, False

Признак предварительного заказа

required_time


Нет

"2015-08-24T19:15:00"

Время подачи предварительного заказа

comment

String

Нет


Комментарий к заказу

minibus *

Boolean

Нет

True, False

Микроавтобус

wagon *

Boolean

Нет

True, False

Универсал

premium *

Boolean

Нет

True, False

Машина премиум-класса

flexible_tariff_name *

String

Нет


Гибкий тариф

baggage

Boolean

Нет

True, False

Загрузка салона. Параметр доступен при X-API-VERSION < 1.41.0.

animal

Boolean

Нет

True, False

Перевозка животного. Параметр доступен при X-API-VERSION < 1.41.0.

conditioner

Boolean

Нет

True, False

Кондиционер. Параметр доступен при X-API-VERSION < 1.41.0.

courier_delivery

Boolean

Нет

True, False

Курьер. Параметр доступен при X-API-VERSION < 1.41.0.

route_undefined

Boolean

Нет

True, False

По городу

terminal

Boolean

Нет

True, False

Терминал. Параметр доступен при X-API-VERSION < 1.41.0.

receipt

Boolean

Нет

True, False

Требование чека за поездку. Параметр доступен при X-API-VERSION < 1.41.0.

route


Да


Маршрут заказа. (См. Таблицу описания маршрута)

route_address_entrance_from

String

Нет

2а

Номер подъезда

client_sub_card

String

Нет


Номер доп карточки

add_cost

Decimal

Нет

10

Дополнительная стоимость к заказу

calc_with_rec_add_costBooleanНетTrue, FalseРассчитать стоимость с рекомендуемой дополнительной стоимостью

taxiColumnId

Int32

Да

0, 1 или 2

Номер колоны, в которую будут приходить заказы.

payment_type

Int32

Нет

Null, 0 или 1

Тип оплаты заказа (нал, безнал) (см. Приложение 4).

extra_charge_codesArray<String>Нет

["ENGLISH", "ANIMAL"]

Список кодов доп. услуг (api/settings). Параметр доступен при X-API-VERSION >= 1.41.0.

custom_extra_charges

Array<Int32>Нет[20, 12, 13]Список идентификаторов пользовательских доп. услуг (api/settings). Параметр добавлен в версии 1.46.0.

...

Параметры запроса

Тип данных

Обязательный параметр

Возможные значения

Описание

user_full_name

String

Нет


Полное имя пользователя

user_phone

String

Нет


Телефон пользователя

reservation

Boolean

Да

True, False

Признак предварительного заказа

required_time


Нет

"2015-08-24T19:15:00"

Время подачи предварительного заказа

comment

String

Нет


Комментарий к заказу

minibus

Boolean

Нет

True, False

Микроавтобус

wagon

Boolean

Нет

True, False

Универсал

premium

Boolean

Нет

True, False

Машина премиум-класса

flexible_tariff_name

String

Нет


Гибкий тариф

baggage

Boolean

Нет

True, False

Загрузка салона. Параметр доступен при X-API-VERSION < 1.41.0.

animal

Boolean

Нет

True, False

Перевозка животного. Параметр доступен при X-API-VERSION < 1.41.0.

conditioner

Boolean

Нет

True, False

Кондиционер. Параметр доступен при X-API-VERSION < 1.41.0.

courier_delivery

Boolean

Нет

True, False

Курьер. Параметр доступен при X-API-VERSION < 1.41.0.

route_undefined

Boolean

Нет

True, False

По городу

terminal

Boolean

Нет

True, False

Терминал. Параметр доступен при X-API-VERSION < 1.41.0.

receipt

Boolean

Нет

True, False

Требование чека за поездку.Параметр доступен при X-API-VERSION < 1.41.0.

route


Да


Маршрут заказа. (См. Таблицу описания маршрута)

route_address_entrance_from

String

Нет

2а

Номер подъезда

client_sub_card

String

Нет


Номер доп карточки

add_cost

Decimal

Нет

10

Дополнительная стоимость к заказу

calc_with_rec_add_costBooleanНетTrue, FalseРассчитать стоимость с рекомендуемой дополнительной стоимостью

taxiColumnId

Int32

Да

0, 1 или 2

Номер колоны, в которую будут приходить заказы.

payment_type

Int32

Нет

Null, 0 или 1

Тип оплаты заказа (нал, безнал) (см. Приложение 4).

calculated_tariff_namesString[]Да

[
"Базовый",
"Универсал",
"Бизнес-класс"
]

Список тарифов по которым нужно просчитать стоимость заказа
extra_charge_codesArrray<String>Нет

["ANIMAL", "ENGLISH"]

Список кодов доп. услуг (api/settings). Параметр доступен при X-API-VERSION >= 1.41.0.

custom_extra_charges

Array<Int32>Нет[20, 12, 13]Список идентификатов пользовательских доп. услуг (api/settings). Параметр добавлен в версии 1.46.0.

...

    ,"crew_average_rating": 4.99

    ,"rating":4

    ,"rating_comment":"Ok"

    ,"route_address_from":{

...

Параметры запроса

Обязательный параметр

Описание

id

Да

Уникальный идентификатор заказа.

amount

Decimal

Добавочная стоимость.

Response (ответ):

См. Описание ответа для информации по заказу

Response в случае ошибок (ответ):

...

Запрос на скрытие заказа (удалить поездку):


http://<ipaddress>:<port>/api/weborders/hide/44ebd09e5f224651bf3c8e2dd12ed890

Основные  параметры Http-запроса:


...


Request (запрос):


...


Response (ответ):

...

Название параметра

Возможные значения

Описание

id

37564

Уникальный идентификатор транзакции

amount

25.75

Сумма платежа

currency

UAH

Валюта платежа

description

Предоплата услуг.

Описание платежа

customer

10176

Уникальный идентификатор пользователя

statusCallbackURL

http://my_host.ua:6969/api/liqpay/status/

URL для получения изменеий изменений статуса платежа


{

"id":37564,

...

"customer":10176,

"statusCallbackURL":"http://my_host.ua:6969/api/liqpay/status/"

}

Response в случае ошибок (ответ):

...

Описание полей ответа см. в Получение транзакции оплаты


Получение избранных адресов


http://<ipaddress>:<port>/api/client/addresses

Основные параметры Http-запроса:

...


Response (ответ):

...

[
    {
        "favorite_address_uid":"da2ed520-488e-4824-b4bc-13bfb2b566e9",
        "alias":"Мой дом",
        "comment":"Домофон не работает",
        "type":1,
        "address":{
            "name":"КРЕЩАТИК УЛ.",
            "number":"7a",
            "lat":50.451063,
            "lng":50.451063
        },
        "entrance":1
    },
    {
        "favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
        "alias":"alias1",
        "comment":"Домофон не работает",
        "type":2,
        "address":{
            "name":"КРЕЩАТИК УЛ.",
            "number":"7a",
            "lat":50.451063,
            "lng":50.451063
        },
       "entrance":1
    }
]

Сохранение избранного адреса


http://<ipaddress>:<port>/api/client/addresses

Основные параметры Http-запроса:

...


Request (запрос):


...


    {
        "alias":"Мой дом",
        "comment":"Домофон не работает",
        "type":1,
        "address":{
            "name":"КРЕЩАТИК УЛ.",
            "number":"7a",
            "lat":50.451063,
            "lng":150.451063
        },
        "entrance":1
    }


Response (ответ):

Идентификатор избранного адреса : "7c0cae96-4510-41e6-997b-d564f62ba81f"


...

Изменение избранного адреса

http://<ipaddress>:<port>/api/client/addresses

Основные параметры Http-запроса:

...


Request (запрос):

...


    {
        "favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
        "alias":"дом",
        "comment":"Домофон не работает",
        "type":2,
        "address":{
            "name":"КРЕЩАТИК УЛ.",
            "number":"7a",
            "lat":50.451063,
            "lng":50.451063
        },
       "entrance":1
    }


Удаление избранного адреса


http://<ipaddress>:<port>/api/client/addresses/<favoriteAddressGuid>

Основные параметры Http-запроса:

...


Response (ответ):

...

Работает по тому же принципу что и "Поиск ближайших гео-данных (улиц и объектов) по географическим координатам (долгота-широта)." только возвращает один ближайшей объект или дом. Также если дом или объект не найден то свойства "geo_street" или "geo_object" будут содержать пустые масивы массивы вместо null.

Основные  параметры Http-запроса:

...

Название параметра

Возможные значения

Описание

currency

грн

Аббревиатура валюты

payment_terminal_permitted

True, false

Разрешена ли оплата заказа через платежный (экварийнговый) терминал для клиента.

payment_system_permitted0, 1Возможность оплаты через платежную систему
add_cost_increment_value1, 5Шаг изменения стоимости на widget.
extra_charge_codes

["BAGGAGE", "CONDIT"]

Список кодов доп. услуг. Параметр доступен при X-API-VERSION >= 1.41.0.

Возможные значения:

"BAGGAGE" - Загрузка салона,

"ANIMAL" - Животное,

"CONDIT" - Кондиционер,

"MEET" - Встреча с табличкой,

"COURIER" - Курьер. доставка,

"TERMINAL" - Терминал,

"CHECK" - Чек,

"BABY_SEAT" - Детское кресло,

"DRIVER" - Драйвер,

"NO_SMOKE" - Некурящий водитель,

"ENGLISH" - Англоговорящий водитель,

"CABLE" - Трос,

"FUEL" - Подвоз бензина,

"WIRES" - Провода,

"SMOKE" - Я буду курить

custom_extra_charges

[    {

        "Id": 20,

        "Name": "Cusotm charge name"

    },

    {

        "Id": 27,

        "Name": "Cusotm charge other name"

    }]

Список идентификторов идентификаторов пользовательских доп. услуг с названиями с учетом локализации

(используются только EN-US, UK-UA, RU-RU). Параметр добавлен в версии 1.46.0.

show_custom_extra_charges_before_systemtrue, falseПризнак отображения пользовательских доп. услуг перед системными. Параметр добавлен в версии 1.46.0.

...

{

    "currency":"грн",

    "payment_terminal_permitted":false,

...

        "ANIMAL",

        "CONDIT"
   ],

    "custom_extra_charges": [

    {

        "Id": 20,

        "Name": "Cusotm charge name"

    },

    {

        "Id": 27,

        "Name": "Cusotm charge other name"

    }

   ],

   "show_custom_extra_charges_before_system": true

}

...

http://<ipaddress>:<port>/api/settings/addCostIncrementValue

Основные  параметры Http-запроса:

...


Запрос серверного времени

http://<ipaddress>:<port>/api/time

Основные  параметры Http-запроса:

...

Установка версии API.

Header X-API-VERSION необходимо указывать для использования различных версий API, особенности в описании полей. Используемую версию WebOrders WebAPI можно запросить.

Если указывать версию в X-API-VERSION больше чем используемая версия бекенда, то будут задействованы контракты запроса/ответа используемой версии бекенда.

Если не указывать версию X-API-VERSION, то будет использованы контракты запроса/ответа которые были до введения заголовка версионности.


Response (ответ):

...