list
Список всех доступных к использованию системных вэб-хуков.
Ресурс
https://selena-online.ru/rest/v1/hook/list [GET]
| ID | Имя | Событие |
|---|---|---|
| 1 | create_private | Создание нового покупателя - частного лица |
| 2 | update_private | Правка данных покупателя - частного лица |
| 3 | delete_private | Удаление покупателя - частного лица |
| 4 | create_agent | Создание нового покупателя - агента |
| 5 | update_agent | Правка данных покупателя - агента |
| 6 | delete_agent | Удаление покупателя - агента |
| 7 | create_order | Создание заявки |
| 8 | update_order | Изменение данных заявки |
| 9 | add_tourist | Добавление туриста в заявку |
| 10 | update_tourist | Правка данных туриста |
| 11 | delete_tourist | Удаление туриста из заявки |
| 12 | add_order_service | Добавление услуги в заявку |
| 13 | update_order_service | Изменение информации об услуге в заявке |
| 14 | delete_order_service | Удаление услуги из заявки |
| 15 | create_payment_incoming | Создание платежа от покупателя |
| 16 | update_payment_incoming | Изменение платежа от покупателя |
| 17 | delete_payment_incoming | Удаление платежа от покупателя |
| 18 | create_bill_incoming | Создание счёта поставщика |
| 19 | update_bill_incoming | Изменение счёта поставщика |
| 20 | delete_bill_incoming | Удаление счёта поставщика |
| 21 | create_payment_outgoing | Создание платежа поставщику |
| 22 | update_payment_outgoing | Изменение платежа поставщику |
| 23 | delete_payment_outgoing | Удаление платежа поставщику |
| 24 | create_refund_outgoing | Создание возврата покупателю |
| 25 | update_refund_outgoing | Изменение возврата покупателю |
| 26 | delete_refund_outgoing | Удаление возврата покупателю |
| 30 | send_chat | Отправка сообщения в чате |
create_private
hook_id: 1
Событие: cоздание нового покупателя - частного лица. Покупатель - это лицо, выступающее контрагентом в договоре купли-продажи путёвки. Не следует путать его с туристом (туристами), который отправляется в тур.
Передаваемые данные:
id - ID покупателя.
firstname - имя покупателя.
lastname - фамилия покупателя.
middlename - отчество имя покупателя.
birthdate - дата рождения покупателя.
sex - пол покупателя: 1 - мужчина, 2 - женщина.
citizenship - гражданство: код по ОКСМ.
postcode - почтовый индекс (в адресе).
city - город, посёлок, деревня (в адресе).
street - улица (в адресе).
build - номер дома (в адресе).
flat - номер квартиры (в адресе).
phone - номер телефона покупателя.
email - email.
identity - код основного документа, удостоверяющего личность: 1 - паспорт РФ, 2 - загранпаспорт, 3 - свидетельство о рождении, 100 - другой документ.
identity_sn - номер основного документа, удостоверяющего личность.
identity_issuer - орган, выдавший основной документ, удостоверяющий личность.
identity_issued - дата выдачи основного документа, удостоверяющего личность.
expired - дата окончания срока действия основного документа, удостоверяющего личность.
ex_passport - номер загранпаспорта.
ex_issuer - орган, выдавший загранпаспорт.
ex_expired - дата окончания срока действия загранпаспорта.
activated - флаг, указывающий на наличие у покупателя доступа в личный кабинет.
maillist - флаг, указывающий на то, включён ли покупатель в список рассылки.
update_private
hook_id: 2
Событие: правка данных покупателя - частного лица.
Передаваемые данные:
id - ID покупателя.
... - изменённые свойства.
delete_private
hook_id: 3
Событие: удаление покупателя - частного лица.
Передаваемые данные:
id - ID покупателя.
create_agent
hook_id: 4
Событие: Создание нового покупателя - агента.
Передаваемые данные:
id - ID компании.
fullname - полное имя компании.
shortname - краткое имя компании (для внутреннего использования)
taxcode - ИНН.
kpp - КПП.
ogrn - ОГРН.
okpo - ОКПО.
city - город нахождения компании.
post_address - почтовый адрес компании.
juridical_address - юридический адрес компании.
phone - номер телефона компании.
email - email компании.
site - сайт компании.
bank - банк.
bankid - БИК.
bank_account - расчётный счёт в банке.
bank_corr_account - коррсчёт в банке.
director - ФИО руководителя.
director_declension - ФИО руководителя в родительном падеже (для документов).
position - должность руководителя.
position_declension - должность руководителя в родительном падеже (для документов)
main_accountant - ФИО главного бухгалтера.
main_accountant_declension - ФИО главного бухгалтера в родительном падеже (для документов).
manager_email - email контактного менеджера.
manager_name - имя контактного менеджера.
manager_phone - номер телефона контактного менеджера.
activated - флаг, указывающий на наличие у покупателя доступа в личный кабинет.
update_agent
hook_id: 5
Событие: правка данных покупателя - агента
Передаваемые данные:
id - ID покупателя.
... - изменённые свойства.
delete_agent
hook_id: 6
Событие: удаление покупателя - агента.
Передаваемые данные:
id - ID покупателя.
create_order
hook_id: 7
Событие: Создание заявки
Передаваемые данные:
ID - уникальный ID заявки.
OrderID - уникальный ID заявки (устаревшее).
OrderDate - дата создания заявки.
OrderNumber - номер заявки.
OrderStatus - статус заявки:
0 - бронь
1 - жёсткая бронь
2 - снят (аннулирован)
3 - оплачен
5 - запрос на бронирование, ожидание подтверждения заказа
6 - зачтено, например по акции, или бонус, или что-то ещё
SupplierID - ID поставщика. См. agents раздела DocAPI.
OperatorID - ID оператора. См. agents раздела DocAPI.
AgentID - ID покупателя-агента. См. agents раздела DocAPI.
CustomerID - ID покупателя-частного лица. См. customers раздела FrontAPI.
ManagerID - ID менеджера.
ObjectID - ID объекта размещения. См. objectlist раздела FrontAPI.
TourID - ID тура. См. tourlist раздела FrontAPI.
TourName - Название тура. Опционально.
BeginDate - Дата начала тура.
EndDate - Дата окончания тура.
CheckInDate - Дата вселения в гостиницу.
CheckOutDate - Дата выселения из гостиницы.
Duration - Продолжительность тура.
ConfirmDate - Дата подтверждения заявки.
ShippingDate - Дата отгрузки (передачи документов покупателю).
DateToPay - Крайний срок (дата) платежа.
OrderSum - Сумма заявки к оплате.
Discount - Скидка (описание).
DiscountSum - Сумма скидки.
Bonus - Комиссия (описание).
BonusSum - Сумма комиссии.
FullSum - Полная сумма заявки без учёта скидок и комиссий.
BuyerRefundSum - Сумма возврата покупателю.
PaygateFee - Добавленная к счёту покупателю сумма компенсации за платёж картой через интернет-эквайринг.
BonusDelayed - Флаг "Счёт выставляется на полную сумму, скидка/комиссия возвращается позже".
NoBonusForAdd - Флаг "Нет комиссии на доп.места."
NoBonusForChild - Флаг "Нет комиссии на ребёнка без места."
NoDiscountForAdd - Флаг "Нет скидки на доп.места."
NoDiscountForChild - Флаг "Нет скидки на ребёнка без места."
Passed - Флаг "Документы переданы покупателю".
Events - Список событий, связанных с заказом.
Details - список туристов:
RecID - уникальный ID туриста в заявке. Не путать с ID покупателя. Этот же реальный турист в другой заявке будет иметь другой ID.
Firstname - имя туриста.
Lastname - фамилия туриста.
Middlename - отчество туриста.
Birthdate - дата рождения туриста.
Sex - пол туриста: 1 - мужской, 2 - женский.
Passport - номер документа, удостоверяющего личность туриста
Issued - дата выдачи документа, удостоверяющего личность.
Whoissue - орган, выдавший документ, удостоверяющий личность.
Category - возрастная категория туриста. Число от 1 до 5, характеризующее категорию, в которой находится турист в соответствии с определением границ возрастов, указанных для объекта размещения или категории номера. Дополнительная информация есть в описании objectlist раздела FrontAPI.
Citizenship - гражданство: код по ОКСМ.
City - город проживания.
CityID - ID города проживания. См. citylist раздела FrontAPI.
Address - адрес.
Email - email туриста.
Phone - номер телефона туриста.
Number - номер комнаты (каюты, апартамента, ...), в который заселён турист.
RoomID - ID комнаты (каюты, апартамента, ...), в который заселён турист. См. roomlist раздела FrontAPI.
SocialDiscountID - ID скидки по социальной льготе. См. discountlist раздела FrontAPI.
SocialDiscountDoc - документ, подтверждающий право на социальную льготу.
Type - Тип размещения: 1 - основное место, 2 - дополнительное место, 3 - детское (ребёнок без места)
Locked - место зарезервировано (выкуплено без размещения)
UnitID - ID корпуса, гостиницы, ... См. unitlist раздела FrontAPI.
ApartmentID - ID категории размещения. См. apartmentlist раздела FrontAPI.
Sum - стоимость размещения без учёта скидок и комиссий.
update_order
hook_id: 8
Событие: изменение данных заявки.
Передаваемые данные:
... - см. create_order
add_tourist
hook_id: 9
Событие: добавление туриста в заявку
Передаваемые данные:
ApartmentID - ID категории размещения. См. apartmentlist раздела FrontAPI.
Duration - Продолжительность тура.
ID - уникальный ID заявки.
RecID - уникальный ID туриста в заявке. Не путать с ID покупателя. Этот же реальный турист в другой заявке будет иметь другой ID.
UnitID - ID корпуса, гостиницы, ... См. unitlist раздела FrontAPI.
update_tourist
hook_id: 10
Событие: правка данных туриста
Передаваемые данные:
... - см. add_tourist
delete_tourist
hook_id: 11
Событие: удаление туриста из заявки
Передаваемые данные:
ID - уникальный ID заявки.
RecID - уникальный ID туриста в заявке.
add_order_service
hook_id: 12
Событие: добавление услуги в заявку
Передаваемые данные:
ID - уникальный ID заявки.
RecID - уникальный ID туриста в заявке.
ServiceID - ID услуги. См. servicelist раздела FrontAPI.
Sum - стоимость услуги.
update_order_service
hook_id: 13
Событие: изменение информации об услуге в заявке
Передаваемые данные:
... - см. add_order_service
delete_order_service
hook_id: 14
Событие: удаление услуги из заявки
Передаваемые данные:
ID - уникальный ID заявки.
RecID - уникальный ID туриста в заявке.
ServiceID - ID услуги. См. servicelist раздела FrontAPI.
create_payment_incoming
hook_id: 15
Событие: создание платежа от покупателя
Передаваемые данные:
ID - уникальный ID заявки.
CarrySum - сумма в валюте платежа.
Sum - сумма в алюте заказа.
Rate - курс валюты.
Number - номер платёжного документа.
Date - дата платежа.
Way - способ платежа:
0 - Платеж наличными
1 - Платеж банковским переводом
2 - Платеж взаимозачетом
3 - Платеж он-лайн, средства списаны
4 - Платеж он-лайн, средства заблокированы (hold)
5 - Платеж бонусами
Note - примечание к платежу.
RecID - уникальный ID платежа.
update_payment_incoming
hook_id: 16
Событие: изменение платежа от покупателя
Передаваемые данные:
... - см. create_payment_incoming
delete_payment_incoming
hook_id: 17
Событие: удаление платежа от покупателя
Передаваемые данные:
ID - уникальный ID заявки.
RecID - уникальный ID платежа.
create_bill_incoming
hook_id: 18
Событие: создание счёта поставщика
Передаваемые данные:
ID - уникальный ID заявки.
BillID - уникальный ID счёта.
BillSum - полная сумма счёта.
PaySum - сумма к оплате (за вычетом возможной комиссии).
ConfirmedBonus - комиссия.
Currency - валюта счёта.
Date - дата счёта.
Note - примечание к счёту.
Number - номер счёта.
RecID - уникальный ID туриста в заявке в случае, если счёт выставляется на конкретного туриста.
SupplierID - ID поставщика. См. agents раздела DocAPI.
update_bill_incoming
hook_id: 19
Событие: изменение счёта поставщика
Передаваемые данные:
... - см. create_bill_incoming
delete_bill_incoming
hook_id: 20
Событие: удаление счёта поставщика
Передаваемые данные:
BillID - уникальный ID счёта.
create_payment_outgoing
hook_id: 21
Событие: создание платежа поставщику
Передаваемые данные:
PaymentID - уникальный ID платежа.
CarrySum - сумма в валюте платежа.
Date - дата платежа.
ID - уникальный ID заявки.
Note - примечание к платежу.
Number - номер платежа.
PaySum - сумма в валюте счёта.
Rate - курс валюты.
SupplierID - ID поставщика. См. agents раздела DocAPI.
update_payment_outgoing
hook_id: 22
Событие: изменение платежа поставщику
Передаваемые данные:
... - см. create_payment_outgoing
delete_payment_outgoing
hook_id: 23
Событие: удаление платежа поставщику
Передаваемые данные:
PaymentID - уникальный ID платежа.
create_refund_outgoing
hook_id: 24
Событие: создание возврата покупателю
Передаваемые данные:
ID - уникальный ID заявки.
RefundID - уникальный ID возврата.
Date - дата возврата.
Number - номер документа.
CarrySum - сумма в валюте платежа.
Sum - сумма в валюте заявки.
Currency - валюта заявки.
Rate - курс валюты.
Way - способ платежа:
Note - примечание к возврату.
0 - Платеж наличными
1 - Платеж банковским переводом
2 - Платеж взаимозачетом
3 - Платеж он-лайн, средства списаны
4 - Платеж он-лайн, средства заблокированы (hold)
5 - Платеж бонусами
update_refund_outgoing
hook_id: 25
Событие: изменение возврата покупателю
Передаваемые данные:
... - см. create_refund_outgoing
delete_refund_outgoing
hook_id: 26
Событие: удаление возврата покупателю
Передаваемые данные:
ID - уникальный ID заявки.
RefundID - уникальный ID возврата.
send_chat
hook_id: 30
Событие: отправка сообщения в чате
Передаваемые данные:
ID - уникальный ID заявки.
ManagerID - ID менеджера.
Message - сообщение.
Who - отправитель сообщения: operator - оператор, buyer - покупатель.