Описание

Сервис e-AutoPay.com дает возможность отправлять уведомления о следующих событиях с заказом:

  • Оформление заказа
  • Изменение заказа
  • Перевод заказа в статус
  • Оплата заказа
  • Удаление заказа

Уведомление передается методом POST в формате JSON

Настройка в e-AutoPay

Настройка Webhook производится в разделе "Настройки" - "Webhooks"

При настройке Webhook необходимо включить чек-бокс и указать следующие данные:

  • Название - это название будет отображаться в списке
  • URL - адрес, на который будет отправляться Webhook.
  • Объект - для какого объекта системы нужно добавить Webhook. На данный момент только "Заказ", в дальнейшем количество объектов будет увеличиваться
  • Событие - выберите событие, при наступлении которого нужно отправить Webhook.
  • Выберите товар - Если указанный товар будет в заказе, Webhook будет отправлен. Если Вы не выберете товары, то Webhook будет отправляться при заказе любого товара.
Настройка Webhook

Описание данных

Уведомление передается методом POST на указанный URL, см. "Пример"

Параметр Описание
order_id id заказа
status статус заказа
status_date дата попадания в статус
confirmed факт подтверждения заказа
customer массив с данными покупателя

surname Фамилия покупателя
given_name Имя покупателя
patronymic Отчество покупателя
country Страна, указанная покупателем
state Область, указанная покупателем
сity Город, указанный покупателем
zip Почтовый индекс, указанный покупателем
address Адрес, указанный покупателем
email e-mail, указанный покупателем
phone Телефон, указанный покупателем
credentials Массив с информацией о заказе

created Дата оформления заказа
currency Наименование валюты заказа. Например: руб
amount Сумма заказа в указанной валюте
delivery_cost Стоимость доставки
notes Комментарии клиента (все комментарии одно строкой)
comments Массив со всеми комментариями

logist Комментарий службы логистики (каждый комментарий отдельным элементом массива)
author Комментарии автора в заказе (каждый комментарий отдельным элементом массива)
ip IP-адрес клиента
rpo Почтовый идентификатор
rpo_shipment_date Дата отправки
utm utm-метки к заказу
pin_code Пин-код, отправленный клиенту
pay_mode Способ оплаты заказа
payed Факт оплаты заказа
additional_fields Массив с дополнительными полями к заказу
basket Массив с информацией о товарах
(массив объектов, где каждый объект - это товар с данными)
good_id id товара
good_name наименование товара
cost стоимость товара
quantity количество товара
partner массив с данными о партнерах
(массив объектов, где каждый объект - это партнер с данными)
login логин партнера
cost сумма комиссионных
currency валюта комиссионных

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

Код Описание
"archive" Архив
"new" Новый
"confirmed" Подтвержден оператором
"sent" Отправлен клиенту
"cancelled" Возврат
"in_hands_paid" Вручен и оплачен
"unconfirmed" Неподтвержден
"delayed" Отсрочен
"refused" Отказ
"delivered_unpaid" Доставлен к месту получения
"complectation" Комплектация
"ready_for_delivery" Подготовлен к отправке
"problem" Проблемный
"delivered_paid" Доставлен к месту получения и оплачен
"pending" Ожидает подтверждения (Call-центр)
"specified" Уточненный
"in_hands_unpaid" Вручен
"wanted" В розыске
"absence" Отсутствие продукта
"returned" Получен возврат
"notice1" Напоминание 1
"notice2" Напоминание 2

Пример

Пример Webhook.

Уведомление передается методом POST в формате JSON на указанный URL 


{
  "order_id": 1798,
  "status": "new",
  "status_date": "N/A",
  "confirmed": false,
  "customer": {
    "surname": "Ошуков",
    "given_name": "Сергей",
    "patronymic": "Александрович",
    "country": "Россия",
    "state": "Московская обл.",
    "city": "Москва",
    "zip": "111111",
    "address": "Ул. Ленина, Д. 1, Корп. , Кв. 2",
    "email": "testhook@test.ru",
    "phone": "+7 (903) 1111111"
  },
  "credentials": {
    "created": "2019-12-02 13:18:23",
    "currency": "руб",
    "amount": "140.00",
    "delivery_cost": "",
    "notes": "",
    "comments": {
      "logist": [],
      "author": []
    },
    "ip": "178.17.177.71",
    "rpo": "",
    "rpo_shipment_date": "",
    "utm": {
      "utm_source": "source",
      "utm_medium": "medium",
      "utm_campaign": "campaign"
    },
    "pin_code": null,
    "pay_mode": 26,
    "payed": 0
  },
  "additional_fields": [],
  "basket": [
    {
      "good_id": 111111,
      "good_name": "Товар №1",
      "cost": "140.00",
      "quantity": 1
    },
    {
      "good_id": 222222,
      "good_name": "Товар №2",
      "cost": "1150.00",
      "quantity": 2
    }
  ],
  "partner": [
    {
      "login": "test123",
      "cost": "450",
      "currency": "rub"
    },
    {
      "login": "test234",
      "cost": "120",
      "currency": "rub"
    }
  ],
}