WebApp каталог
API-методы для управления товарами в WebApp-каталоге и для удаления самого приложения.
Все запросы требуют API-ключа — см. Авторизация.
Поля товара
Все методы создания и изменения товаров принимают общий набор полей. Ниже — справочник. На конкретные методы будем ссылаться на эту таблицу.
| Поле | Тип | Описание |
|---|---|---|
title | string | Название товара. |
description | string | Описание товара. |
price | number | string | Цена товара. |
oldprice | string | Старая цена (для отображения скидки). |
hide | boolean | Временно скрыть товар из каталога. |
pieces | string | Остатки товара. |
code | string | Артикул товара. |
rubric | string | Рубрика / категория каталога. |
szpieces | string | Остатки по размерам. Пример: S:10, M:15, L:20. |
sizes | string | Доступные размеры через запятую. |
colors | string | Доступные цвета через запятую. |
order | number | string | Порядковый номер в списке. |
Все поля товара — необязательные. При создании указывайте только те, что нужны, при изменении — только те, что надо обновить.
Управление товарами
Добавить товар
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/create |
Параметры запроса: webappid (обязательный, number | string — ID приложения каталога) + любые поля товара.
Ответ
{
"id": 12345,
"result": "Item successfully created"
}
| Поле | Тип | Описание |
|---|---|---|
id | number | ID созданного товара. |
result | string | Сообщение о результате. |
Изменить товар
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/edit |
Параметры запроса: webappid + itemid (оба обязательны) + любые поля товара для обновления.
Ответ
{
"result": "Item successfully changed"
}
Удалить товар
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/delete |
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
itemid | number | string | Да | ID товара. |
Ответ
{
"result": "Item successfully deleted"
}
Удалить все товары
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/items/delete |
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
webappid | number | string | Да | ID приложения каталога. |
Все товары выбранного каталога будут удалены без возможности восстановления.
Ответ
{
"result": "Items successfully deleted"
}
Массовые операции
Добавить товары массово
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/bulk/create |
Параметры запроса:
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
webappid | number | string | Да | ID приложения каталога. |
items | array | Да | Массив товаров — каждый элемент содержит поля товара. |
Пример запроса
{
"webappid": 42,
"items": [
{ "title": "Кепка", "price": 990 },
{ "title": "Футболка", "price": 1490, "sizes": "S,M,L" }
]
}
Ответ
{
"id": [101, 102],
"result": "Items successfully created"
}
| Поле | Тип | Описание |
|---|---|---|
id | array of number | Массив ID созданных товаров — в том же порядке, что и в запросе. |
result | string | Сообщение о результате. |
Изменить товары массово
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/bulk/edit |
Параметры запроса:
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
webappid | number | string | Да | ID приложения каталога. |
items | array | Да | Массив товаров. В каждом элементе — обязательный itemid и любые поля товара для обновления. |
Ответ
{
"result": "Items successfully changed"
}
Удалить товары массово
| Параметр | Значение |
|---|---|
| Метод | POST |
| Endpoint | /catalog/item/bulk/delete |
Пример запроса
{
"items": [
{ "itemid": 101 },
{ "itemid": 102 }
]
}
Ответ
{
"result": "Items successfully deleted"
}
Получение данных
Получить ссылку для скачивания каталога
| Параметр | Значение |
|---|---|
| Метод | GET, POST |
| Endpoint | /catalog/get |
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
webappid | number | string | Да | ID приложения каталога. |
Ответ
{
"link": "https://...",
"notice": "link is valid for 2 minutes"
}
Ссылка link действительна только 2 минуты. Если файл нужно использовать позже — сразу скачайте его и сохраните у себя.
Управление приложением
Удалить WebApp приложение
| Параметр | Значение |
|---|---|
| Метод | GET, POST |
| Endpoint | /webapp/delete |
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
id | number | string | Да | ID приложения. |
Удаляется само приложение со всеми товарами и настройками. Перед вызовом убедитесь, что выбран нужный ID.
Ответ
{
"result": "deleted"
}