☰ Menú · Catálogo
Referencia de la API

Catálogo

Tus productos y sus categorías, para las reglas de cashback por categoría y los informes de productos.

POST/v1/catalog/products/bulk
Permiso: catalog:write

Crea o actualiza hasta 1000 productos por sku. Un código de categoría nuevo crea una categoría con las reglas por defecto (genera cashback, se puede pagar con cashback). category_name cambia el nombre de la categoría; sus reglas de dinero solo las fija el propietario.

products[].skustring, obligatorio
Tu código de producto, único por local.
products[].namestring
Nombre del producto.
products[].categorystring
Tu código de categoría.
products[].category_namestring
Nombre de la categoría que verá el propietario.
products[].priceinteger
Precio, en unidades mínimas.
products[].activeboolean
Por defecto, 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
Permiso: catalog:read o catalog:write

Productos ordenados por sku. Filtros: ?category=, ?sku=. Con paginación; starting_after recibe un sku.

GET/v1/catalog/categories
Permiso: catalog:read o catalog:write

Todas las categorías con las reglas del propietario: earn, redeem, earn_percent (null significa el nivel del cliente).

Respuesta · 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, ... }
  ]
}
Dudas sobre una integración: api@loyaltyfy.io. Respondemos en un día hábil.