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

GetOrderDetails#

Test Postman Apidog

Метод предназначен для получения подробной информации о заказе, полученном через вебхук orderMessage.

Ограничения со стороны WhatsApp

WhatsApp* может временно ограничить доступ к Business Catalog API при частом обращении к методам каталогов.
Не выполняйте большое количество запросов к методам каталогов за короткий промежуток времени.

Запрос#

Для получения данных о заказе требуется выполнить запрос по адресу:

POST 
{{apiUrl}}/waInstance{{idInstance}}/getOrderDetails/{{apiTokenInstance}}

Для получения параметров запроса idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

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

Параметр Тип Обязательный Описание
orderId string Да Идентификатор заказа из вебхука orderMessage
token string Да Токен заказа из вебхука orderMessage
sellerJid string Нет JID продавца — владельца каталога, в формате 79876543210@c.us. Если не указан, используется JID самого инстанса. Обязателен при запросе заказа, оформленного покупателем — в этом случае значение берётся из поля sellerJid вебхука orderMessage

Пример тела запроса#

{
  "orderId": "1292422363001382",
  "token": "AeBD7tvosdPMN4rv276nLCiEHI+ce79oubkPDL7B8YXLOQ==",
  "sellerJid": "79876543210@c.us"
}

Ответ#

Поля ответа#

Поле Тип Описание
creation_time_stamp integer Временная метка создания заказа (Unix timestamp)
products array Массив продуктов, входящих в заказ
price_details object Информация о стоимости заказа

Объект продукта (products):

Поле Тип Описание
id string Идентификатор продукта в WhatsApp*
name string Название товара
price string Цена за единицу (в минимальных денежных единицах)
currency string Код валюты
quantity integer Количество единиц товара в заказе
variant_info object Информация о варианте товара (если есть)
media object Медиафайлы товара (изображения)

Объект цены (price_details):

Поле Тип Описание
subtotal_amount integer Сумма заказа без учета скидок и доставки
total_amount integer Итоговая сумма заказа
currency string Код валюты

Пример тела ответа#

{
  "creation_time_stamp": 1776746617,
  "products": [
    {
      "id": "26437451389197252",
      "name": "Handmade Ceramic Mug - Large+",
      "price": "1000",
      "currency": "RUB",
      "variant_info": {
        "variant_properties": []
      },
      "media": {
        "images": [
          {
            "id": "26756491040611445",
            "request_image_url": "https://mmg.whatsapp.net/v/t45.5328-4/675237262_26756491060611443_8396636402251856458_n.jpg?stp=dst-jpg_p110x80_tt6&ccb=1-7&_nc_sid=657aed&_nc_ohc=OR_UxF8HkhAQ7kNvwGT0Iz-&_nc_oc=AdoB9laMlKIU2Gkq8gMalfFEqG1gEqO-1qVuumBjOwQ7zYn8WuMh6Uri4TcLkvmZG4w&_nc_zt=23&_nc_ht=mmg.whatsapp.net&_nc_gid=lYlNvn2JD92bwcs5IHAfIA&_nc_ss=73120&oh=01_Q5Aa4QF3y2KR-dP2cBvLAT4KWB_m3aPQPqADaD0qWICzVtylTA&oe=69F616B9"
          }
        ]
      },
      "quantity": 1
    },
    {
      "id": "26316026244746883",
      "name": "Cotton Tote Bag",
      "price": "45000",
      "currency": "RUB",
      "variant_info": {
        "variant_properties": []
      },
      "media": {
        "images": [
          {
            "id": "2160393548084268",
            "request_image_url": "https://mmg.whatsapp.net/v/t45.5328-4/676524068_2160393551417601_2654589292030186593_n.jpg?stp=dst-jpg_s168x128_tt6&ccb=1-7&_nc_sid=657aed&_nc_ohc=7WzR_hoP1PMQ7kNvwE1d3CE&_nc_oc=AdoKHhXc3dIEtlh8sz53WgF3HfMaVOC2fiv_QO84JN44ivMRTQucrGChOyLn25SUW5w&_nc_zt=23&_nc_ht=mmg.whatsapp.net&_nc_gid=lYlNvn2JD92bwcs5IHAfIA&_nc_ss=73120&oh=01_Q5Aa4QExm1SyZ1jirayxqlTiP6ggIojSHC1um9dMG2NJ8q7xkg&oe=69F5FD10"
          }
        ]
      },
      "quantity": 1
    }
  ],
  "price_details": {
    "subtotal_amount": 140000,
    "currency": "RUB",
    "total_amount": 140000
  }
}

Ошибки GetOrderDetails#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Примеры кода#

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/getOrderDetails/{{apiTokenInstance}}"

payload = {
    "orderId": "1292422363001382",
    "token": "AeBD7tvosdPMN4rv276nLCiEHI+ce79oubkPDL7B8YXLOQ==",
    "sellerJid": "79876543210@c.us"
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getOrderDetails/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderId": "1292422363001382",
    "token": "AeBD7tvosdPMN4rv276nLCiEHI+ce79oubkPDL7B8YXLOQ==",
    "sellerJid": "79876543210@c.us"
}'