> For the complete documentation index, see [llms.txt](https://apidoc.toplojas.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.toplojas.com.br/pedidos-abandonados/visao-geral.md).

# Visão Geral

Através da API de **Pedidos Abandonados** você consulta os **carrinhos abandonados** da sua loja — ou seja, as compras que o cliente iniciou mas **não finalizou**.

É o mesmo conteúdo que o painel exibe em **Pedidos → Pedidos Abandonados**, agora disponível para integração.

{% hint style="info" %}
Estas páginas são **guias práticos**. A referência completa de cada campo, tipo e schema está no simulador online:

{% embed url="<https://api.toplojas.com.br/doc/#/PedidosAbandonados>" %}
{% endhint %}

## 🛒 O que é um pedido abandonado

Quando um cliente monta o carrinho mas não conclui a compra, o registro fica na loja como **abandonado**. Se ele voltar e finalizar, o pedido passa a ser um pedido normal e **deixa de aparecer** nesta listagem.

| Situação do cliente                   | Onde aparece            |
| ------------------------------------- | ----------------------- |
| Montou o carrinho e **não** finalizou | `/pedidos-abandonados/` |
| Finalizou a compra                    | `/pedidos/`             |

{% hint style="warning" %}
Um mesmo código **nunca** aparece nos dois lugares ao mesmo tempo. Se você consultar `/pedidos-abandonados/{Codigo}/` de um carrinho que já foi finalizado, a API retorna **404**.
{% endhint %}

## 🧭 Endpoints de Pedidos Abandonados

| Ação                                 | Método | Rota                             |
| ------------------------------------ | ------ | -------------------------------- |
| Listar e filtrar pedidos abandonados | GET    | `/pedidos-abandonados/`          |
| Detalhes de um pedido abandonado     | GET    | `/pedidos-abandonados/{Codigo}/` |

{% hint style="info" %}
Este módulo é **somente leitura**. Não há ações de criação, edição ou exclusão de carrinhos abandonados pela API.
{% endhint %}

## ⚠️ Diferenças em relação ao módulo Pedidos

O carrinho abandonado **não foi fechado**, então alguns blocos que existem em `/pedidos/` **não são retornados** aqui:

| Bloco                           | Retornado? | Motivo                                             |
| ------------------------------- | ---------- | -------------------------------------------------- |
| `Cliente`                       | ✅          | O cliente já estava identificado                   |
| `EnderecoEntrega`               | ✅          | Endereço informado até o momento do abandono       |
| `Itens`                         | ✅          | Produtos que estavam no carrinho                   |
| `Valores.Produtos`              | ✅          | Valor **estimado** (soma dos itens)                |
| `FormaPagamento`                | ❌          | O cliente não chegou a escolher                    |
| `FormaEntrega` / `PrazoEntrega` | ❌          | O cliente não chegou a escolher                    |
| `NumeroParcelas`                | ❌          | Depende da forma de pagamento                      |
| `Status`                        | ❌          | Carrinho abandonado não percorre o fluxo de status |
| `NotaFiscal`                    | ❌          | Não existe nota para uma compra não concluída      |
| `Marketplace`                   | ❌          | Não se aplica                                      |

{% hint style="warning" %}
**O valor é estimado.** `Valores.Produtos` é a soma dos itens (`Quantidade × ValorUnitario`) e **não inclui frete**, já que não existe forma de entrega escolhida. Não use este valor como valor de venda.
{% endhint %}

## 💡 Para que usar

O uso mais comum é a **recuperação de carrinho**: identificar quem abandonou a compra e entrar em contato oferecendo um cupom, lembrete ou atendimento.

Um fluxo comum:

1. **Listar** os carrinhos abandonados do período que te interessa.
2. **Consultar os detalhes** para saber o que havia no carrinho.
3. Usar os dados de contato do `Cliente` para a ação de recuperação.
4. Reconsultar mais tarde os mesmos códigos em `/pedidos-abandonados/{Codigo}/`: quem passou a retornar **404** voltou e finalizou a compra.

{% hint style="info" %}
Guarde de sua parte os códigos já trabalhados. A API não marca quais carrinhos já receberam uma ação de recuperação — o controle de "já contatei este cliente" fica com a sua integração.
{% endhint %}

{% content-ref url="/pages/gPo4oa8dZ6wjbhQtqb2R" %}
[Listar e Filtrar Pedidos Abandonados](/pedidos-abandonados/listar-pedidos-abandonados.md)
{% endcontent-ref %}

{% content-ref url="/pages/yEI8qtisx6Clr6yZSqMf" %}
[Detalhes do Pedido Abandonado](/pedidos-abandonados/detalhes-do-pedido-abandonado.md)
{% endcontent-ref %}