GetCollection#

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

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

Запрос#

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

{{baseUrl}}/waInstance{{idInstance}}/getCollection/{{apiTokenInstance}}

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

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

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

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

Ответ#

Поля ответа#

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

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

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

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

Ошибки GetCollection#

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

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

import requests

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

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