Ir al contenido

Planes y niveles de API

La extensión x-api-tier define el nivel mínimo de cada operación. El contrato actual usa dos niveles: basic y advanced.

Incluye 12 operaciones: lecturas de productos, categorías, órdenes e imágenes; sincronización de stock; y administración de webhooks.

Incluye 15 operaciones: escrituras de catálogo, variantes, imágenes y categorías; creación o actualización de órdenes; y lectura de carritos abandonados.

La referencia API muestra x-api-tier en cada operación y es la lista definitiva.

El único límite numérico por plan declarado en x-plan-limits corresponde a webhooks:

Nivel Webhooks por tienda
basic 2
advanced 10
enterprise Sin límite numérico declarado (null)

Las operaciones de lectura no declaran efectos secundarios. Las operaciones siguientes sí los publican en x-side-effects:

Operación Efectos declarados
Sincronizar stock por SKU Actualiza stock de productos o variantes; puede emitir eventos de stock.
Crear un producto Crea el producto; puede crear una categoría por nombre; actualiza la galería; invalida caché pública.
Actualizar un producto Actualiza catálogo; puede reemplazar la galería; invalida caché pública.
Crear o actualizar una variante Crea o actualiza la variante y registra historial de producto.
Agregar una imagen Agrega la imagen y reordena la galería cuando se indica una posición.
Reemplazar imágenes Elimina y reemplaza la galería completa.
Reordenar imágenes Reordena la galería.
Actualizar una imagen Actualiza la imagen y puede reordenar la galería.
Eliminar una imagen Elimina la imagen y reordena la galería restante.
Crear una categoría Crea la categoría e invalida la caché de categorías.
Actualizar una categoría Actualiza la categoría e invalida la caché de categorías.
Eliminar una categoría Puede desasignar productos; elimina la categoría; invalida la caché de categorías.
Crear una venta externa Crea orden y pago externo; puede descontar stock; puede crear o actualizar comprador; encola eventos; puede notificar al seller o cliente.
Actualizar una orden Actualiza el estado operativo o el seguimiento.
Registrar un webhook Crea una suscripción durable y genera un secret de firma.
Actualizar o eliminar un webhook Actualiza o elimina la suscripción, respectivamente.