# Consultar pedidos

> Um pedido completo (por número na loja ou no ERP) ou listas por período ou por cliente.

Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/consultar · Atualizado em 18/11/2026


## O que faz

Consulta pedidos. O formato da resposta muda conforme o filtro:

| Filtro | Resposta |
|---|---|
| `pedido` | Um pedido completo: `cliente`, `pedido`, `produtos` |
| `numero_pedido_externo` | Um pedido: `cliente`, `pedido`, `produtos` (sem os dados do subpedido) |
| `data_inicial` + `data_final` | Lista paginada: `cabecalho`, `pedidos[]` (cada um com o cliente) |
| `cpf`, `cnpj` ou `email` | Lista paginada do cliente: `cabecalho`, `cliente`, `pedidos[]` |

## Requisição

| | |
|---|---|
| **Método** | `GET` |
| **URL** | `https://api.viashopmoda.com.br/via/pedido/consultar/{TOKEN}` |
| **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). |
| **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. |


## Parâmetros

Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar.

| Parâmetro | Descrição |
|---|---|
| `pedido` | Número do pedido na loja (6 dígitos). |
| `numero_pedido_externo` | Número do pedido no ERP. |
| `data_inicial` | Início do período (aaaa-mm-dd). Usar com data_final. |
| `data_final` | Fim do período (aaaa-mm-dd). |
| `horario_inicial` | Hora inicial (hh:mm:ss), com o período. |
| `horario_final` | Hora final (hh:mm:ss), com o período. |
| `data_alteracao` | data_alteracao=S busca pela data de alteração do pedido, não pela de criação. |
| `pagos` | pagos=S traz só pedidos pagos (com o período). |
| `remover_cancelados` | remover_cancelados=S tira os cancelados (com o período). |
| `cpf` | Pedidos do cliente com este CPF. |
| `cnpj` | Pedidos do cliente com este CNPJ. |
| `email` | Pedidos do cliente com este e-mail. |
| `pagina` | Página (20 registros por página). Ex.: pagina=2 |


## Campos úteis da resposta

| Campo | Significado |
|---|---|
| `pedido.numero_pedido` | Número na loja (6 dígitos). |
| `pedido.status_pedido` | Status com o nome da loja. "Pagamento efetuado, aguardando captura" aparece como "Pagamento em análise". |
| `pedido.status_pedido_externo` | Nome do status no ERP, se configurado com `status_pedido/associar`. |
| `pedido.numero_pedido_alterado` | Em pedido **cancelado por alteração**: número do pedido novo que o substituiu. |
| `pedido.foi_pago` | `S` ou `N`. |
| `pedido.url_pagamento` | Em "Aguardando Pagamento": link para o cliente pagar. |
| `produtos[]` | Itens, com `cod_barras`, grade, estampa, quantidade e preço. |

## Exemplo

```bash
curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?pedido=111111"
```

```bash
curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?data_inicial=2026-11-16&data_final=2026-11-16&data_alteracao=S&pagina=1"
```

## Regras

- O número do pedido precisa ter 6 dígitos.
- Pedido não encontrado → `retorno: false`.
- Para conferência periódica, use o período com `data_alteracao=S` — e não consulte pedido por pedido.

## Pode reenviar?

Sim (somente leitura). Cada página conta no limite.

## Onde entra no processo

Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#conferencia-periodica-reconciliacao).
