Перейти к основному содержимому

WebApp каталог

API-методы для управления товарами в WebApp-каталоге и для удаления самого приложения.

Авторизация

Все запросы требуют API-ключа — см. Авторизация.


Поля товара

Все методы создания и изменения товаров принимают общий набор полей. Ниже — справочник. На конкретные методы будем ссылаться на эту таблицу.

ПолеТипОписание
titlestringНазвание товара.
descriptionstringОписание товара.
pricenumber | stringЦена товара.
oldpricestringСтарая цена (для отображения скидки).
hidebooleanВременно скрыть товар из каталога.
piecesstringОстатки товара.
codestringАртикул товара.
rubricstringРубрика / категория каталога.
szpiecesstringОстатки по размерам. Пример: S:10, M:15, L:20.
sizesstringДоступные размеры через запятую.
colorsstringДоступные цвета через запятую.
ordernumber | stringПорядковый номер в списке.
примечание

Все поля товара — необязательные. При создании указывайте только те, что нужны, при изменении — только те, что надо обновить.


Управление товарами

Добавить товар

ПараметрЗначение
МетодPOST
Endpoint/catalog/item/create

Параметры запроса: webappid (обязательный, number | string — ID приложения каталога) + любые поля товара.

Ответ

{
"id": 12345,
"result": "Item successfully created"
}
ПолеТипОписание
idnumberID созданного товара.
resultstringСообщение о результате.

Изменить товар

ПараметрЗначение
МетодPOST
Endpoint/catalog/item/edit

Параметры запроса: webappid + itemid (оба обязательны) + любые поля товара для обновления.

Ответ

{
"result": "Item successfully changed"
}

Удалить товар

ПараметрЗначение
МетодPOST
Endpoint/catalog/item/delete
ПолеТипОбязательныйОписание
itemidnumber | stringДаID товара.

Ответ

{
"result": "Item successfully deleted"
}

Удалить все товары

ПараметрЗначение
МетодPOST
Endpoint/catalog/items/delete
ПолеТипОбязательныйОписание
webappidnumber | stringДаID приложения каталога.
Операция необратима

Все товары выбранного каталога будут удалены без возможности восстановления.

Ответ

{
"result": "Items successfully deleted"
}

Массовые операции

Добавить товары массово

ПараметрЗначение
МетодPOST
Endpoint/catalog/item/bulk/create

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

ПолеТипОбязательныйОписание
webappidnumber | stringДаID приложения каталога.
itemsarrayДаМассив товаров — каждый элемент содержит поля товара.

Пример запроса

{
"webappid": 42,
"items": [
{ "title": "Кепка", "price": 990 },
{ "title": "Футболка", "price": 1490, "sizes": "S,M,L" }
]
}

Ответ

{
"id": [101, 102],
"result": "Items successfully created"
}
ПолеТипОписание
idarray of numberМассив ID созданных товаров — в том же порядке, что и в запросе.
resultstringСообщение о результате.

Изменить товары массово

ПараметрЗначение
МетодPOST
Endpoint/catalog/item/bulk/edit

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

ПолеТипОбязательныйОписание
webappidnumber | stringДаID приложения каталога.
itemsarrayДаМассив товаров. В каждом элементе — обязательный 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
ПолеТипОбязательныйОписание
webappidnumber | stringДаID приложения каталога.

Ответ

{
"link": "https://...",
"notice": "link is valid for 2 minutes"
}
Время жизни ссылки

Ссылка link действительна только 2 минуты. Если файл нужно использовать позже — сразу скачайте его и сохраните у себя.


Управление приложением

Удалить WebApp приложение

ПараметрЗначение
МетодGET, POST
Endpoint/webapp/delete
ПолеТипОбязательныйОписание
idnumber | stringДаID приложения.
Операция необратима

Удаляется само приложение со всеми товарами и настройками. Перед вызовом убедитесь, что выбран нужный ID.

Ответ

{
"result": "deleted"
}