Перейти к содержанию

Отправленное сообщение с заказом#

В данном разделе описывается формат уведомления объекта messageData для отправленного сообщения с заказом (корзиной). Для получения описания общего формата уведомлений обратитесь к разделу Отправленные сообщения.

Для получения уведомлений данного вида требуется выполнение двух условий:

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = orderMessage

Настройка инстанса

Чтобы получать уведомления об отправленных сообщениях с заказом, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройки Получать уведомления о сообщениях, отправленных с телефона и Получать уведомления о сообщениях, отправленных через API, а также настройку получения уведомлений о каталогах

  2. Через метод SetSettings включить настройки outgoingMessageWebhook, outgoingAPIMessageWebhook и catalogWebhook

Получение подробностей заказа

Поля orderId, token и sellerJid из этого уведомления содержат данные, необходимые для вызова метода GetOrderDetails, который возвращает полный состав заказа.

Уведомление#

Формат уведомления#

Поля объекта messageData

Параметр Тип Описание
typeMessage string Тип отправленного сообщения. Для сообщений данного типа поле принимает значение: orderMessage
orderMessage object Объект данных о заказе

Поля объекта orderMessage

Параметр Тип Описание
orderId string Идентификатор заказа. Используется в методе GetOrderDetails
token string Токен доступа к заказу. Используется в методе GetOrderDetails
totalPrice string Итоговая стоимость заказа (в минимальных денежных единицах, например 250000 = 2500.00 RUB)
totalCurrencyCode string Код валюты заказа в формате ISO 4217 (например, RUB)
sellerJid string JID продавца — владельца каталога, в формате 79876543210@c.us. Используется в методе GetOrderDetails
itemsCount integer Количество товаров в заказе
jpegThumbnail string Предпросмотр изображения заказа в base64

Пример тела уведомления#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "idMessage": "3EB00DAD87A9587390FE46",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1783335526,
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79876543210@c.us",
    "senderName": "Продавец",
    "senderContactName": "Продавец",
    "chatName": "Иван"
  },
  "messageData": {
    "typeMessage": "orderMessage",
    "orderMessage": {
      "orderId": "1300936245456254",
      "token": "AeBZD0f8NlE/H8JVglqhlYLaQq4r9PoaTKCJmT9csclblQ==",
      "totalPrice": "250000",
      "totalCurrencyCode": "RUB",
      "sellerJid": "79876543210@c.us",
      "itemsCount": 1,
      "jpegThumbnail": "/9j/2wCEAAEBAQ="
    }
  }
}