•  
8 (800) 511-93-36
Войти

Работа веб хука и передача информации через API на платформе Всем еды

Веб Хук — это способ оповещения клиента о произошедшем в системе событии с помощью пользовательских обратных вызовов по HTTP. Простыми словами, это передача информации от системы до пользователя.

Возможности веб хука

  1. Передать информацию о заказе
  2. В информацию входят такие данные как: Номер заказа, состав заказа, статус заказа и так далее;
  3. Всю информацию можно изучить в примере передачи заказа и в Таблице №1
  4. Формат передачи данных через Веб Хук: JSON
Пример передачи заказа на доставку:

{
    "order_id": "2038469",
    "date_created": "2022-05-27T09:32:32",
    "trans_type": "delivery",
    "customer": {
        "phone": "+79003265238",
        "name": "Dev23"
    },
    "address": {
        "street": "пр-кт Мира, Набережные Челны, Татарстан",
        "house": "1",
        "apartment": "2",
        "entrance": "3",
        "floor": "4",
        "doorphone_code": "5",
        "housing": ""
    },
    "delivery_time": {
        "fast_delivery": "",
        "time_delivery": "13:00"
    },
    "payment_type": {
        "paymentProvider": "cod",
        "completed": "0.0000"
    },
    "comment": "",
    "items": [
        {
            "id": "101977797",
            "qty": "1",
            "name": "#Винегрет салат",
            "price": "64",
            "discount": 0
        },
        {
            "id": "101977749",
            "qty": "1",
            "name": "#Летний с яйцом Пашот салат",
            "price": "99",
            "discount": 0
        },
        {
            "id": "101977818",
            "qty": "1",
            "name": "#Мимоза с копченым лососем салат",
            "price": "104",
            "discount": 0
        },
        {
            "id": "101977759",
            "qty": "1",
            "name": "#Морковь тертая со сметаной салат",
            "price": "59",
            "discount": 0
        },
        {
            "id": "101977469",
            "qty": "1",
            "name": "Баварская, пицца",
            "price": "499",
            "discount": 0,
            "group_modifiers": {
                "85657": {
                    "modifiers": [
                        {
                            "id": "646544",
                            "qty": 1,
                            "name": "колбаски Пепперони 40гр",
                            "price": "60"
                        }
                    ]
                }
            }
        },
        {
            "id": "101934214",
            "qty": "1",
            "name": "Пончик",
            "price": "0",
            "discount": 0
        }
    ],
    "delivery_cost": "150.0000",
    "basket_total": "1035.0000",
    "count_person": "1",
    "discount": "0.00000",
    "voucher_discount": "0.0000",
    "order_change": "0.0000",
    "UTM_CAMPAIGN": null,
    "UTM_MEDIUM": null,
    "UTM_CONTENT": null,
    "UTM_TERM": null,
    "UTM_SOURCE": null
}
Таблица№1 Обозначение параметров передачи
Название параметра
Формат
Обозначение
Где используется
order_id
Число
Номер заказа
Во всех заказах на доставку, самовывоз, в заведении
date_created
Дата
Дата создание заказа
Год, месяц, день
Во всех заказах на доставку, самовывоз, в заведении
trans_type
Строка
Тип заказа: Доставка, самовывоз, в заведении.
Delivery, pickup, dinein соответственно
Во всех заказах на доставку, самовывоз, в заведении
customer
Строка
Имеет данные о покупателе: Телефон(phone) и Имя(name)
Во всех заказах на доставку, самовывоз, в заведении
address
Строка
Адрес доставки. Имеет формат Punycode
Во всех заказах на доставку
house
Строка
Номер дома
В параметре address
apartment
Строка
Номер квартиры
В параметре address
entrance
Строка
Подъезд
В параметре address
floor
Строка
Этаж
В параметре address
doorphone_code
Строка
Домофон
В параметре address
street
Строка
Улица
В параметре address
housing
Строка
Корпус
В параметре address
delivery_time
Строка
Время доставки заказа: Может принимать параметр: fast_delivery (как можно скорее), или точное значение (time_delivery): 13.00
Во всех заказах на доставку, самовывоз, в заведении
payment_type
Строка
Тип оплаты. Содержит в себе коды типов оплат:
cod - Наличными
pyr - Картой курьеру
vog - Cloud Payments
sber - Сбербанк
alfa - Альфабанк
tinkof - Тинькофф
yandex_kassa - Яндекс.Касса
prom-sv-bank - ПромСвязьБанк
gazprombank - Газпромбанк
uniteller - Uniteller
sbp_sberbank - СБП Сбербанк
sbp_tinkoff - СБП Тинькофф
Во всех заказах на доставку, самовывоз, в заведении
comment
Строка
Комментарий к заказу от гостя
Во всех заказах на доставку, самовывоз, в заведении
items
Строка
Содержит в себе информацию о товарах
Во всех заказах на доставку, самовывоз, в заведении
id
Число
Идентификатор товара в платформе Всем Еды
В параметре items
qty
Число
Количество товаров
В параметре items
name
Строка
Название товара. Формат: Punycode
В параметре items
price
Число
Цена товара
В параметре items
discount
Число
Скидка по товару
В параметре items
group_modifiers
Строка
Группа модификаторов
В параметре items
modifiers
Строка
Содержит параметры модификаторов: id, qty, name и price.
В параметре group_modifiers
delivery_cost
Число
Стоимость доставки
Во всех заказах на доставку
basket_total
Число
Итоговая стоимость корзины с учетом стоимости доставки и скидок
Во всех заказах на доставку, самовывоз, в заведении
count_person
Число
Количество персон
Во всех заказах на доставку, самовывоз, в заведении
discount
Число
Скидка на тип доставки
Во всех заказах на доставку, самовывоз, в заведении
voucher_discount
Число
Скидка по промокоду, если был применен
Во всех заказах на доставку, самовывоз, в заведении
voucher_name
Строка
Название промокода
Во всех заказах на доставку, самовывоз, в заведении
date_pre_order
Дата
Время предзаказа
Во всех заказах на доставку, самовывоз
point_id
Строка
Идентификатор точки самовывоза
Во всех заказах на самовывоз
point
Строка
Название точки самовывоза
Во всех заказах на самовывоз
order_change
Число
Сумма, с которой подготовить сдачу
Во всех заказах на доставку
UTM_CAMPAIGN
Строка
UTM-метка, которая передается если есть в заказе. Передает номер компании рекламного объявления
Во всех заказах на доставку, самовывоз, в заведении
UTM_MEDIUM
Строка
UTM-метка, которая передается если есть в заказе. Передает номер объявления
Во всех заказах на доставку, самовывоз, в заведении
UTM_CONTENT
Строка
UTM-метка, которая передается если есть в заказе. Передает содержание рекламного баннера или объявления
Во всех заказах на доставку, самовывоз, в заведении
UTM_TERM
Строка
UTM-метка, которая передается если есть в заказе. Передает условий поиска рекламной системы
Во всех заказах на доставку, самовывоз, в заведении
UTM_SOURCE
Строка
UTM-метка, которая передается если есть в заказе. Передает источник рекламы
Во всех заказах на доставку, самовывоз, в заведении

Порядок передачи информации через Веб Хук из Платформы Всем еды


При создании заказа на сайте или в приложении на платформе Всем еды Облако, отсылается информация на URL-адрес, который можно задать в административной панели в разделе Интеграции -> Вебхук & API
Важно! Без подключенного модуля, информация не будет передаваться
← В справочный центр