ZapyFlow/Documentación de la APIopenapi.json

Orders

Pedidos

GET/api/orders

Listar los pedidos del equipo

Ámbito requerido: orders.read

ParámetroDóndeObligatorio
pagequeryno
limitqueryno
aiAgentIdqueryno
statusqueryno
sourcequeryno
sortqueryno
searchqueryno
dateFromqueryno
dateToqueryno
bash
curl "https://api.zapyflow.com.br/api/orders" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada

POST/api/orders

Crear un pedido manualmente

Ámbito requerido: orders.write

Cuerpo de la petición

CampoTipoObligatorioRestricciones
aiAgentIdstringsímin 1
clientNamestringsímin 1, max 100
clientPhonestringsímin 8, max 24
clientEmailstringnomax 160
itemsobject[]sí≥ 1 items, ≤ 50 items
totalnumbersí≥ 0, ≤ 9999999
paymentMethod"PIX" | "CREDIT_CARD" | "DEBIT_CARD" | "CASH" | "BOLETO"no—
paymentStatus"PENDING" | "PAID"no—
addressstringnomax 200
deliveryFeenumberno≥ 0, ≤ 9999999
notesstringnomax 500
bash
curl -X POST "https://api.zapyflow.com.br/api/orders" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 201 — Creado
  • 400 — Petición malformada

GET/api/orders/{id}

Detalles del pedido

Ámbito requerido: orders.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

PATCH/api/orders/{id}

Actualizar un pedido

Ámbito requerido: orders.write

ParámetroDóndeObligatorio
idpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
status"AWAITING_PAYMENT" | "PREPARING" | "READY_FOR_PICKUP" | "OUT_FOR_DELIVERY" | "COMPLETED" | "CANCELLED"no—
clientNamestringnomin 1, max 100
itemsobject[]no≥ 1 items, ≤ 50 items
totalnumberno≥ 0, ≤ 9999999
paymentMethod"PIX" | "CREDIT_CARD" | "DEBIT_CARD" | "CASH" | "BOLETO"no—
paymentStatus"PENDING" | "PAID"no—
addressstringnomax 200
deliveryFeenumberno≥ 0, ≤ 9999999
notesstringnomax 500
notifyClientbooleanno—
bash
curl -X PATCH "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
  • 409 — Conflicto con el estado actual

DELETE/api/orders/{id}

Eliminar un pedido

Ámbito requerido: orders.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X DELETE "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET/api/orders/overview

Resumen de pedidos del periodo (recuentos, ingresos y ticket medio)

Ámbito requerido: orders.read

ParámetroDóndeObligatorio
aiAgentIdqueryno
statusqueryno
searchqueryno
dateFromqueryno
dateToqueryno
bash
curl "https://api.zapyflow.com.br/api/orders/overview" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada

GET/api/orders/stats

Recuento de pedidos por estado

Ámbito requerido: analytics.read

bash
curl "https://api.zapyflow.com.br/api/orders/stats" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK