For the complete documentation index, see llms.txt. This page is also available as Markdown.

Processar um Pedido

Este guia mostra um fluxo completo de processamento de um pedido, do recebimento até a entrega, combinando vários endpoints da API.

Cada passo abaixo tem uma página dedicada com todos os detalhes. Aqui mostramos como eles se encaixam em um processo real.

1️⃣ Seja notificado de um novo pedido pago

Em vez de consultar a listagem repetidamente, configure um Webhook para o evento Pedidos_Pagos. Assim, sua aplicação é avisada assim que um pedido tem o pagamento confirmado.

Webhook

O webhook envia o código do pedido (CodigoPedido), que você usa nos próximos passos.

2️⃣ Consulte os detalhes do pedido

Com o código em mãos, obtenha os dados completos (cliente, itens, valores, endereço):

Detalhes do Pedido

3️⃣ Descubra o código do próximo status

Os status possuem códigos. Consulte a lista para saber qual código usar (por exemplo, "Em separação" ou "Enviado"):

Informações

4️⃣ Atualize o status do pedido

Conforme o pedido avança, altere o status (opcionalmente notificando o cliente por e-mail):

Alterar Status

5️⃣ Informe o código de rastreio

Ao despachar o pedido, registre o código de rastreio para o cliente acompanhar a entrega:

Informar Código de Rastreio

6️⃣ Informe a nota fiscal

Registre os dados da NF-e emitida para o pedido:

Informar Nota Fiscal

🔄 Resumo do fluxo

Passo
Ação
Endpoint

1

Ser notificado do pedido pago

Webhook Pedidos_Pagos

2

Consultar detalhes

GET /pedidos/{Codigo}/

3

Descobrir código do status

GET /informacoes/status/

4

Alterar status

PUT /pedidos/{Codigo}/alterar-status/

5

Informar rastreio

PUT /pedidos/{Codigo}/informar-codigo-rastreio/

6

Informar nota fiscal

PUT /pedidos/{Codigo}/informar-nota-fiscal/

Last updated