GetCollection#

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

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

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

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

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

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/getCollection/{{apiTokenInstance}}

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

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

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

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

{
  "chatId": "79876543210@c.us",
  "collectionId": "25790827003925602",
  "productLimit": 3,
  "afterProduct": "значение из paging.after"
}

Ответ#

Поля ответа#

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

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

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

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

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

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

{
  "paging": {
    "after": ""
  },
  "collection": {
    "id": "25790827003925602",
    "name": "Kitchen Essentials",
    "status_info": null,
    "products": [
      {
        "id": "26437451389197252",
        "name": "Handmade Ceramic Mug",
        "price": "100",
        "currency": "RUB"
      }
    ]
  }
}

Ошибки GetCollection#

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

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

PythoncURL

import requests

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

payload = {
    "chatId": "79876543210@c.us",
    "collectionId": "25790827003925602",
    "productLimit": 3,
    "afterProduct": ""
}
headers = {
    'Content-Type': 'application/json'
}

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getCollection/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79876543210@c.us",
    "collectionId": "25790827003925602",
    "productLimit": 3,
    "afterProduct": ""
}'