GetCollections#

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

• Метод работает без авторизации инстанса через публичный GraphQL WhatsApp*.
• Если инстанс авторизован как бизнес-аккаунт – чтение происходит через Facebook GraphQL (видны коллекции со скрытыми, на модерации товарами).
• Если не авторизован – видны только коллекции, содержащие одобренные товары.

Запрос#

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

{{baseUrl}}/waInstance{{idInstance}}/getCollections/{{apiTokenInstance}}

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

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

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

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

Ответ#

Поля ответа#

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

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

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

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

Ошибки GetCollections#

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

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

import requests

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

payload = {
    "chatId": "79636191159@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": "79636191159@c.us",
    "collectionLimit": 10,
    "afterCollectionId": "",
    "productLimit": 3
}'