GetCollections#

Метод предназначен для получения списка коллекций каталога с поддержкой пагинации по коллекциям и лимитированием количества продуктов внутри каждой коллекции.

Изменение поведения

Ранее метод работал без авторизации инстанса через публичный GraphQL WhatsApp*. Сейчас инстанс должен быть авторизован.
При вызове на неавторизованном инстансе возвращается ошибка авторизации.

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

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

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/getCollections/{{apiTokenInstance}}

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

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

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата продавца в формате `79876543210@c.us`
`collectionLimit`	integer	Нет	Максимальное количество коллекций в ответе (по умолчанию 10)
`afterCollectionId`	string	Нет	Курсор для пагинации. Используйте значение `paging.after` из предыдущего ответа
`productLimit`	integer	Нет	Максимальное количество продуктов внутри каждой коллекции (по умолчанию 3)

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

{
  "chatId": "79876543210@c.us",
  "collectionLimit": 10,
  "afterCollectionId": "значение из paging.after",
  "productLimit": 3
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`paging`	object	Объект пагинации, содержит поле after – курсор для получения следующей страницы
`collections`	array	Массив объектов коллекций

Объект коллекции (collections):

Поле	Тип	Описание
`id`	string	Уникальный идентификатор коллекции
`name`	string	Название коллекции
`status_info`	object	Информация о статусе (обычно null)
`products`	array	Массив продуктов внутри коллекции (ограничен productLimit)

Объект продукта внутри коллекции:

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

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

{
  "paging": {
    "after": ""
  },
  "collections": [
    {
      "id": "25790827003925602",
      "name": "Kitchen Essentials",
      "status_info": null,
      "products": [
        {
          "id": "26437451389197252",
          "name": "Handmade Ceramic Mug",
          "price": "100",
          "currency": "RUB",
          "media": {
            "images": [
              {
                "id": "26756491040611445",
                "original_image_url": "https://mmg.whatsapp.net/...",
                "request_image_url": "https://mmg.whatsapp.net/..."
              }
            ],
            "videos": []
          }
        }
      ]
    }
  ]
}

Ошибки GetCollections#

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

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

PythoncURL

import requests

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

payload = {
    "chatId": "79876543210@c.us",
    "collectionLimit": 10,
    "afterCollectionId": "",
    "productLimit": 3
}
headers = {
    'Content-Type': 'application/json'
}

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getCollections/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79876543210@c.us",
    "collectionLimit": 10,
    "afterCollectionId": "",
    "productLimit": 3
}'