Orders

Pedidos

GET`/api/orders`

Listar pedidos do time

Escopo exigido: orders.read

Parâmetro	Onde	Obrigatório
`page`	query	não
`limit`	query	não
`aiAgentId`	query	não
`status`	query	não
`source`	query	não
`sort`	query	não
`search`	query	não
`dateFrom`	query	não
`dateTo`	query	não

bash

curl "https://api.zapyflow.com.br/api/orders" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
400 — Requisição malformada

POST`/api/orders`

Criar pedido manual

Escopo exigido: orders.write

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`aiAgentId`	`string`	sim	min 1
`clientName`	`string`	sim	min 1, max 100
`clientPhone`	`string`	sim	min 8, max 24
`clientEmail`	`string`	não	max 160
`items`	`object[]`	sim	≥ 1 items, ≤ 50 items
`total`	`number`	sim	≥ 0, ≤ 9999999
`paymentMethod`	`"PIX" \| "CREDIT_CARD" \| "DEBIT_CARD" \| "CASH" \| "BOLETO"`	não	—
`paymentStatus`	`"PENDING" \| "PAID"`	não	—
`address`	`string`	não	max 200
`deliveryFee`	`number`	não	≥ 0, ≤ 9999999
`notes`	`string`	não	max 500

bash

curl -X POST "https://api.zapyflow.com.br/api/orders" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
201 — Criado
400 — Requisição malformada

GET`/api/orders/{id}`

Detalhes do pedido

Escopo exigido: orders.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH`/api/orders/{id}`

Atualizar pedido

Escopo exigido: orders.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`status`	`"AWAITING_PAYMENT" \| "PREPARING" \| "READY_FOR_PICKUP" \| "OUT_FOR_DELIVERY" \| "COMPLETED" \| "CANCELLED"`	não	—
`clientName`	`string`	não	min 1, max 100
`items`	`object[]`	não	≥ 1 items, ≤ 50 items
`total`	`number`	não	≥ 0, ≤ 9999999
`paymentMethod`	`"PIX" \| "CREDIT_CARD" \| "DEBIT_CARD" \| "CASH" \| "BOLETO"`	não	—
`paymentStatus`	`"PENDING" \| "PAID"`	não	—
`address`	`string`	não	max 200
`deliveryFee`	`number`	não	≥ 0, ≤ 9999999
`notes`	`string`	não	max 500
`notifyClient`	`boolean`	não	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
400 — Requisição malformada
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
409 — Conflito com o estado atual

DELETE`/api/orders/{id}`

Excluir pedido

Escopo exigido: orders.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/orders/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
403 — Proibido, ou a chave não tem este escopo
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET`/api/orders/overview`

Resumo de pedidos do periodo (contagens, receita e ticket medio)

Escopo exigido: orders.read

Parâmetro	Onde	Obrigatório
`aiAgentId`	query	não
`status`	query	não
`search`	query	não
`dateFrom`	query	não
`dateTo`	query	não

bash

curl "https://api.zapyflow.com.br/api/orders/overview" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
400 — Requisição malformada

GET`/api/orders/stats`

Contadores de pedidos por status

Escopo exigido: analytics.read

bash

curl "https://api.zapyflow.com.br/api/orders/stats" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

Orders

GET/api/orders

POST/api/orders

GET/api/orders/{id}

PATCH/api/orders/{id}

DELETE/api/orders/{id}

GET/api/orders/overview

GET/api/orders/stats

GET`/api/orders`

POST`/api/orders`

GET`/api/orders/{id}`

PATCH`/api/orders/{id}`

DELETE`/api/orders/{id}`

GET`/api/orders/overview`

GET`/api/orders/stats`