EditProduct#

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

Метод предназначен для редактирования существующего продукта в каталоге.

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

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

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/editProduct/{{apiTokenInstance}}

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

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

Параметр	Тип	Обязательный	Описание
`productId`	string	Да	Уникальный идентификатор редактируемого продукта
`name`	string	Нет	Новое название продукта
`price`	string	Нет	Новая цена (обычный формат, например "950" = 950 руб)
`description`	string	Нет	Новое описание продукта
`imageUrl`	string	Нет	Новая ссылка на изображение продукта
`currency`	string	Нет	Код валюты в формате ISO 4217 (например, RUB). Если не указан, определяется по `countryCode`, иначе остаётся текущая валюта продукта
`retailerId`	string	Нет	Идентификатор продукта у продавца
`url`	string	Нет	Ссылка на страницу продукта. Должна начинаться с `http://` или `https://`
`countryCode`	string	Нет	Код страны происхождения в формате ISO 3166-1 alpha-2 (например, RU)
`isHidden`	boolean	Нет	Скрыт ли продукт (по умолчанию false)

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

{
  "productId": "26304465135919794",
  "name": "Handmade Ceramic Mug - Large",
  "price": "950",
  "description": "Hand-painted ceramic mug, 450ml. New larger size.",
  "imageUrl": "https://images.unsplash.com/photo-1514228742587-6b1558fcca3d?w=800",
  "currency": "RUB",
  "retailerId": "12345",
  "url": "https://example.com",
  "countryCode": "RU",
  "isHidden": true
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`edited`	boolean	Возвращает true, если редактирование прошло успешно
`productId`	string	ID отредактированного продукта (совпадает с переданным в запросе)

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

{
  "edited": true,
  "productId": "26304465135919794"
}

Ошибки EditProduct#

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

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

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

PythoncURL

import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/editProduct/{{apiTokenInstance}}"
payload = {
    "productId": "26304465135919794",
    "name": "Handmade Ceramic Mug - Large",
    "price": "950",
    "description": "Hand-painted ceramic mug, 450ml. New larger size.",
    "imageUrl": "https://images.unsplash.com/photo-1514228742587-6b1558fcca3d?w=800",
    "currency": "RUB",
    "retailerId": "12345",
    "url": "https://example.com",
    "countryCode": "RU",
    "isHidden": True
}
headers = {
    'Content-Type': 'application/json'
}
response = requests.post(url, json=payload, headers=headers)
print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/editProduct/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productId": "26304465135919794",
    "name": "Handmade Ceramic Mug - Large",
    "price": "950",
    "description": "Hand-painted ceramic mug, 450ml. New larger size.",
    "imageUrl": "https://images.unsplash.com/photo-1514228742587-6b1558fcca3d?w=800",
    "currency": "RUB",
    "retailerId": "12345",
    "url": "https://example.com",
    "countryCode": "RU",
    "isHidden": true
}'