Requiere un access token con el scope
orders:read. Consulta
Token para obtener un token.Parámetros de consulta
| Parámetro | Requerido | Descripción |
|---|---|---|
from | Sí | Índice inicial de paginación (base 0). |
to | Sí | Índice final (inclusivo). Debe ser mayor o igual que from. |
store_id | No | Filtra por identificador externo de tienda. |
channel_id | No | Filtra por identificador externo de canal. |
customer_id | No | Filtra por identificador externo de cliente. |
is_anonymous | No | Con true, solo pedidos guest checkout. Con false, solo clientes identificados. Omitir para ambos. |
Solicitud
curl "https://firespark.cloud/api/admin/v1/orders?from=0&to=24&customer_id=cust-001&is_anonymous=false" \
-H "Authorization: Bearer ACCESS_TOKEN"
Respuesta
La respuesta envuelve un arreglo de pedidos endata.
{
"data": [
{
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"id": "ord-48291",
"brand_id": "0001",
"store_id": "downtown",
"channel_id": "app",
"customer_id": "cust-001",
"is_anonymous": false,
"fulfillment_id": "delivery",
"status": "OPEN",
"payment_status": "PAID",
"fulfillment_status": "PREPARING",
"totals": {
"currency": "USD",
"total": 14.94
},
"issued_at": "2026-06-17T14:31:45.000Z"
}
]
}
Objeto pedido
| Campo | Requerido | Tipo | Descripción |
|---|---|---|---|
id | Sí | string | Identificador externo del pedido |
brand_id | No | string \ | null | Identificador externo de marca cuando aplica |
store_id | Sí | string | Identificador externo de tienda |
channel_id | Sí | string | Identificador externo de canal |
customer_id | Sí | string | Identificador externo del cliente vinculado al pedido |
is_anonymous | Sí | boolean | true cuando el cliente pagó como invitado sin perfil registrado |
fulfillment_id | Sí | string | Opción de fulfillment seleccionada |
status | Sí | string | OPEN, CLOSED, COMPLETED, VOIDED, REVERSED, REFUNDED o CANCELLED (legado) |
payment_status | Sí | string | Estado del procesamiento de pago |
fulfillment_status | Sí | string | Progreso en cocina y entrega |
lines | Sí | array | Líneas con precios, jerarquía de modificadores y metadata por línea |
customer | Sí | object | Snapshot de cliente, entrega y facturación al checkout |
payment_intents | Sí | array | Intents de pago. Los tenders[] de cada intent son los pagos (method, collect_at, status, amount, allocation). El amount de un tender es { currency, total }: lo que paga ese tender. |
redeem | Sí | array | Canjes del pedido: reward_id, quantity, payment_id, amount, before_taxes, expires_at. amount es el descuento que se muestra y lo paga el tender REDEMPTION de payment_id; totals queda completo. |
totals | Sí | object | Subtotal, impuesto, descuento y total del pedido |
metadata | No | object | Metadatos del partner. Por defecto {}. |
lines
lines
Cada entrada en
lines representa un producto, fee o fila de modificador:| Campo | Requerido | Tipo | Descripción |
|---|---|---|---|
type | Sí | string | PRODUCT o FEE |
uid | Sí | string (UUID) | Identificador interno de la línea |
id | Sí | string | Identificador externo de producto o modificador |
parent_uid | Sí | string (UUID) | null | uid de la línea padre para modificadores anidados. null en líneas raíz. |
parent_id | Sí | string | null | id externo de la línea padre. null en líneas raíz. |
name | Sí | string | Nombre mostrado en el ticket |
image_url | No | string | URL de imagen del producto. Opcional. |
menu_id | No | string | Menú desde el que se agregó el producto. Opcional. |
internal_attribution_source | No | string | Fuente en texto libre (SEARCH, CATEGORY, UPSELL, CROSS_SELL, DOWNSELL o custom). Opcional. |
internal_attribution_id | No | string | Id de la fuente (search, id de categoría, id de recommendation o custom). Opcional. |
metadata | No | object | Datos del partner para esta línea. Por defecto {}. |
quantity | Sí | number | Unidades pedidas. Mínimo 1. |
tax_rate | Sí | number | Tasa de impuesto como decimal (por ejemplo 0.15) |
discount_rate | Sí | number | Tasa de descuento como decimal |
unit_subtotal | Sí | number | Subtotal de una unidad, sin hijos |
unit_discount | Sí | number | Descuento de una unidad |
unit_tax_total | Sí | number | Impuesto de una unidad |
unit_total | Sí | number | Total de una unidad |
subtotal | Sí | number | Subtotal de la línea para quantity, sin hijos |
discount_total | Sí | number | Descuento total de la línea |
tax_total | Sí | number | Impuesto total de la línea |
total | Sí | number | Total de la línea para quantity |
unit_group_* | Sí | number | Mismos campos de precio incluyendo hijos a cantidad 1 |
group_* | Sí | number | Mismos campos de precio incluyendo hijos para quantity |
redeem | No | array | Canjes de esta línea raíz, con la misma forma que redeem del pedido. El dinero de la línea queda completo. |
Usa
customer_id para historial de un cliente conocido. Usa
is_anonymous=true para analizar checkout invitado por separado de clientes
registrados.Errores
| Estado | Descripción |
|---|---|
401 | Token ausente o inválido |
403 | El token no incluye el scope orders:read |