MoveCollections#

Для работы с методом необходимо иметь WhatsApp* Business аккаунт.

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

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

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

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/moveCollections/{{apiTokenInstance}}

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

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

Параметр	Тип	Обязательный	Описание
`collections`	array	Да	Непустой массив объектов с информацией о перемещении каждой коллекции

Объект перемещения коллекции:

Поле	Тип	Обязательный	Описание
`collectionId`	string	Да	Уникальный идентификатор перемещаемой коллекции
`fromIndex`	integer	Да	Текущий индекс коллекции (целое число, начинается с 0)
`toIndex`	integer	Да	Новый индекс коллекции (целое число, начинается с 0)

Значения collectionId, fromIndex и toIndex не должны повторяться внутри массива: каждое из трёх полей проверяется на дубликаты отдельно.

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

{
  "collections": [
    { "collectionId": "2205593430194788", "fromIndex": 0, "toIndex": 1 },
    { "collectionId": "25790827003925602", "fromIndex": 1, "toIndex": 0 }
  ]
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`moved`	boolean	Возвращает true, если перемещение выполнено успешно
`collections`	array	Массив объектов с подтверждением перемещения для каждой коллекции

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

{
    "moved": true,
    "collections": [
        {
            "collectionId": "2205593430194788",
            "fromIndex": 0,
            "toIndex": 1
        },
        {
            "collectionId": "25790827003925602",
            "fromIndex": 1,
            "toIndex": 0
        }
    ]
}

Ошибки MoveCollections#

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

Код HTTP	Идентификатор ошибки	Описание
400	`Catalog mutations require a business account`	Ограничение со стороны WhatsApp при частом обращении к методам каталогов. Возвращается, даже если запрос выполняется от Business-аккаунта

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

PythoncURL

import requests

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

payload = {
"collections": [
    {"collectionId": "2205593430194788", "fromIndex": 0, "toIndex": 1},
    {"collectionId": "25790827003925602", "fromIndex": 1, "toIndex": 0}
]
}
headers = {
    'Content-Type': 'application/json'
}

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/moveCollections/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collections": [
        {"collectionId": "2205593430194788", "fromIndex": 0, "toIndex": 1},
        {"collectionId": "25790827003925602", "fromIndex": 1, "toIndex": 0}
    ]
}'