API ViaShopModa documentação

pedido/consultar

Consultar pedidos

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

Ver como Markdown Baixar coleção Postman Atualizado em 18/11/2026

O que faz #

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

FiltroResposta
pedidoUm pedido completo: cliente, pedido, produtos
numero_pedido_externoUm pedido: cliente, pedido, produtos (sem os dados do subpedido)
data_inicial + data_finalLista paginada: cabecalho, pedidos[] (cada um com o cliente)
cpf, cnpj ou emailLista paginada do cliente: cabecalho, cliente, pedidos[]

Requisição #

MétodoGET
URLhttps://api.viashopmoda.com.br/via/pedido/consultar/{TOKEN}
CorpoNenhum. Filtros vão na query string (?campo=valor&...).
TokenSubstitua {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âmetroDescrição
pedidoNúmero do pedido na loja (6 dígitos).
numero_pedido_externoNúmero do pedido no ERP.
data_inicialInício do período (aaaa-mm-dd). Usar com data_final.
data_finalFim do período (aaaa-mm-dd).
horario_inicialHora inicial (hh:mm:ss), com o período.
horario_finalHora final (hh:mm:ss), com o período.
data_alteracaodata_alteracao=S busca pela data de alteração do pedido, não pela de criação.
pagospagos=S traz só pedidos pagos (com o período).
remover_canceladosremover_cancelados=S tira os cancelados (com o período).
cpfPedidos do cliente com este CPF.
cnpjPedidos do cliente com este CNPJ.
emailPedidos do cliente com este e-mail.
paginaPágina (20 registros por página). Ex.: pagina=2

Campos úteis da resposta #

CampoSignificado
pedido.numero_pedidoNúmero na loja (6 dígitos).
pedido.status_pedidoStatus com o nome da loja. "Pagamento efetuado, aguardando captura" aparece como "Pagamento em análise".
pedido.status_pedido_externoNome do status no ERP, se configurado com status_pedido/associar.
pedido.numero_pedido_alteradoEm pedido cancelado por alteração: número do pedido novo que o substituiu.
pedido.foi_pagoS ou N.
pedido.url_pagamentoEm "Aguardando Pagamento": link para o cliente pagar.
produtos[]Itens, com cod_barras, grade, estampa, quantidade e preço.

Exemplo #

curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?pedido=111111"
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.