☰ Меню · Каталог
Справочник API

Каталог

Ваши товары и их категории для правил кэшбэка по категориям и товарных отчётов.

POST/v1/catalog/products/bulk
Право: catalog:write

Создаёт или обновляет до 1000 товаров по sku. Новый код категории создаёт категорию с правилами по умолчанию (начисляет кэшбэк, можно оплатить кэшбэком). category_name переименовывает категорию, а её денежные правила задаёт только владелец.

products[].skustring, обязательный
Ваш код товара, уникальный в пределах заведения.
products[].namestring
Название товара.
products[].categorystring
Ваш код категории.
products[].category_namestring
Название категории, которое увидит владелец.
products[].priceinteger
Цена в минимальных единицах.
products[].activeboolean
По умолчанию true.
curl
curl https://loyaltyfy.io/api/v1/catalog/products/bulk \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "products": [
      { "sku": "4840001", "name": "Marlboro Gold", "category": "TOB", "category_name": "Tobacco", "price": 6500 },
      { "sku": "1001", "name": "Latte", "category": "COF", "category_name": "Coffee", "price": 4500 },
      { "sku": "2040", "name": "Zeama", "category": "KIT", "category_name": "Kitchen", "price": 6500 }
    ]
  }'

# { "object": "catalog_sync", "upserted": 3 }
GET/v1/catalog/products
Право: catalog:read или catalog:write

Товары, отсортированные по sku. Фильтры: ?category=, ?sku=. Поддерживает пагинацию, starting_after принимает sku.

GET/v1/catalog/categories
Право: catalog:read или catalog:write

Все категории с правилами владельца: earn, redeem, earn_percent (null означает процент по уровню гостя).

Ответ · 200
{
  "object": "list",
  "url": "/v1/catalog/categories",
  "has_more": false,
  "data": [
    { "object": "catalog_category", "code": "COF", "name": "Coffee", "earn": true, "redeem": true, "earn_percent": 10, ... },
    { "object": "catalog_category", "code": "TOB", "name": "Tobacco", "earn": false, "redeem": false, "earn_percent": null, ... }
  ]
}
Вопросы по интеграции: api@loyaltyfy.io. Отвечаем в течение одного рабочего дня.