CreateCollection#
Для работы с методом необходимо иметь WhatsApp* Business аккаунт.
Метод предназначен для создания коллекции продуктов в каталоге. Коллекции позволяют группировать товары по категориям (например, «Кухня», «Одежда»).
После создания коллекции её можно редактировать методом EditCollection (при этом id коллекции изменится).
Порядок коллекций можно изменять методом MoveCollections.
Ограничения со стороны WhatsApp*
WhatsApp* может временно ограничить доступ к Business Catalog API при частом обращении к методам каталогов.
Не выполняйте большое количество запросов к методам каталогов за короткий промежуток времени.
Запрос#
Для создания коллекции требуется выполнить запрос по адресу:
{{apiUrl}}/waInstance{{idInstance}}/createCollection/{{apiTokenInstance}}
Для получения параметров запроса idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
name | string | Да | Название коллекции |
productIds | array | Да | Массив идентификаторов продуктов, которые будут добавлены в коллекцию |
Пример тела запроса#
{
"name": "Kitchen Essentials",
"productIds": ["26437451389197252", "25789428137398187"]
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
id | string | Уникальный идентификатор созданной коллекции в WhatsApp* |
Пример тела ответа#
{
"id": "25790827003925602"
}
Ошибки CreateCollection#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код HTTP | Идентификатор ошибки | Описание |
|---|---|---|
| 400 | Catalog mutations require a business account | Ограничение со стороны WhatsApp* при частом обращении к методам каталогов. Возвращается, даже если запрос выполняется от Business-аккаунта |
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/createCollection/{{apiTokenInstance}}"
payload = {
"name": "Kitchen Essentials",
"productIds": ["26437451389197252", "25789428137398187"]
}
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload, headers=headers)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/createCollection/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Kitchen Essentials",
"productIds": ["26437451389197252", "25789428137398187"]
}'