Vendas

Pedidos

Ler a fila de trabalho, abrir um pedido com endereço e itens, cancelar o que não foi pago.

Todas as páginas▾

Comece aqui

Catálogo

Vendas

Inteligência artificial

Servidor MCP

Parceiros

Referência

GET/v1/ordersLista pedidos, do mais recente para o mais antigo. Filtros: status, search, page, pageSize.
GET/v1/orders/{id}Um pedido, com comprador, endereço estruturado e itens.
POST/v1/orders/{id}/cancelCancela um pedido ainda não pago. Idempotente.

A fila de trabalho

Enquanto não existem webhooks (veja o que ainda não existe), a integração consulta. O que separar vai para o galpão é status=paid:

curl "https://api.zankhapi.com.br/v1/orders?status=paid&pageSize=50" \
  -H "Authorization: Bearer zk_live_..."

Um intervalo de poucos minutos é suficiente e educado. Guarde o id do último pedido que você já processou — a lista vem ordenada do mais novo para o mais antigo, então basta parar de ler quando reencontrá-lo.

Status

Status	O que significa
`pending`	Criado, aguardando pagamento. O dinheiro ainda não entrou.
`paid`	Pago. É a hora de separar e despachar.
`cancelled`	Cancelado. Um pedido pago que for cancelado já foi estornado no painel.

Cancelar

POST /v1/orders/{id}/cancel cancela um pedido não pago e é idempotente. Um pedido pago responde 409 order_already_paid: cancelar algo com dinheiro dentro exige estorno, e estorno acontece no painel, por Cancelar e estornar — o estorno roda antes do cancelamento e, se falhar, o pedido não é cancelado. Trocar o status nunca move dinheiro.

O que vem no pedido

Resposta 200 (resumida)

{
  "data": {
    "id": "8c1d...",
    "status": "paid",
    "totalCents": 384980,
    "createdAt": "2026-09-18T12:04:00.000Z",
    "buyer": { "name": "Victor Zampieri", "email": "...", "phone": "+5511..." },
    "shippingAddress": {
      "street": "Rua Exemplo", "number": "100", "complement": null,
      "district": "Moema", "city": "São Paulo", "state": "SP",
      "postalCode": "05690-020"
    },
    "items": [
      { "productId": "1f2e...", "sku": "GPU-4070",
        "name": "Placa de vídeo RTX 4070",
        "quantity": 1, "unitPriceCents": 349990 }
    ]
  }
}