Visão Geral

Através da API de Pedidos você pode consultar e gerenciar todo o ciclo de vida de um pedido: listar, ver os detalhes, alterar o status, informar o código de rastreio e informar a nota fiscal.

Estas páginas são guias práticos. A referência completa de cada campo, tipo e schema está no simulador online:

Swagger UIapi.toplojas.com.br

🔄 Fluxo típico

Um fluxo comum de integração de pedidos costuma seguir esta ordem:

1. Listar os pedidos, filtrando por data, status ou cliente.

2. Consultar os detalhes de um pedido específico (itens, cliente, valores).

3. Alterar o status conforme o andamento (ex.: separação, enviado).

4. Informar o código de rastreio quando o pedido for despachado.

5. Informar a nota fiscal emitida para o pedido.

🧭 Endpoints de Pedidos

Ação	Método	Rota
Listar e filtrar pedidos	GET	/pedidos/
Detalhes de um pedido	GET	/pedidos/{Codigo}/
Alterar status	PUT	/pedidos/{Codigo}/alterar-status/
Informar código de rastreio	PUT	/pedidos/{Codigo}/informar-codigo-rastreio/
Informar nota fiscal	PUT	/pedidos/{Codigo}/informar-nota-fiscal/

🛒 E os carrinhos abandonados?

A listagem de /pedidos/ retorna apenas as compras finalizadas pelo cliente. Os carrinhos que ficaram pelo caminho têm um módulo próprio:

Visão Geral

🔔 Recebendo pedidos automaticamente

Em vez de consultar a listagem repetidamente, você pode ser notificado quando um pedido é criado, pago, enviado ou concluído, usando o recurso de Webhook:

Webhook