API de Órdenes

La API de Órdenes de Fenicia permite a los comerciantes gestionar el ciclo de vida completo de pedidos: desde la creación manual hasta el cumplimiento y envío, incluyendo integración con marketplaces.

¿Qué puedes hacer?

• Listar y buscar pedidos con filtros avanzados (estado, canal, fechas, cliente).
• Crear pedidos manuales desde el panel o POS.
• Consultar el detalle completo de un pedido con enlaces HATEOAS a acciones relacionadas.
• Actualizar información del pedido, estado de pago y etiquetas.
• Agregar métricas de conteo por estado y grupo de estado.

Conceptos clave

Ciclo de vida del pedido

Cada pedido transita por un conjunto de estados canónicos:

pending → accepted → preparing → shipped → delivered
                  ↘ cancelled

Grupos de estado

Los estados se agrupan para facilitar la visualización en dashboards:

Multi-tenant

Todos los endpoints están aislados automáticamente por tenantId (inferido de tu API key). Nunca verás datos de otro comerciante.

Envelope de respuesta

Todas las respuestas de la API siguen un formato consistente:

Éxito con lista:

{
  "orders": [ /* ... */ ],
  "pagination": {
    "page": 0,
    "limit": 20,
    "total": 142,
    "hasMore": true
  }
}

Éxito con recurso único:

{
  "order": { /* ... */ },
  "_links": {
    "self": { "href": "/orders/ord_123" },
    "cancel": { "href": "/orders/ord_123/cancel" }
  }
}

Error:

{
  "error": {
    "code": "ORDER_NOT_FOUND",
    "message": "Order not found",
    "details": { "orderId": "ord_123" }
  }
}

Límites de uso

Inicio rápido

curl -X GET 'https://api.fenicia.io/orders?limit=10' \
  -H 'Authorization: Bearer fn_live_xxxxxxxxxxxx'

Artículos relacionados

• Autenticación — Cómo autenticar tus peticiones con API keys.
• Listar pedidos — Paginación, filtros y proyección de campos.
• CRUD de pedidos — Crear, obtener y actualizar pedidos.
• Buscar pedidos — Búsqueda full-text por cliente, SKU o ID.