Listar e Filtrar Pedidos

Retorna a listagem de pedidos da loja, com suporte a filtros e paginação.

GET /pedidos/

🔎 Filtros disponíveis

Os filtros são enviados na Query da requisição. Todos são opcionais e podem ser combinados.

Parâmetro	Tipo	Descrição
DataDe	data	Retorna pedidos a partir desta data (Ano-Mês-Dia)
DataAte	data	Retorna pedidos até esta data (Ano-Mês-Dia)
CodigoReferencial	inteiro	Filtra pelo código referencial do pedido
CodigoStatus	inteiro	Filtra por um status específico
CodigoCliente	inteiro	Retorna apenas os pedidos de um cliente
StatusIndicacao	texto	Filtra por indicação de status (ex.: Pago)
Pagina	inteiro	Página desejada (paginação)
QtdPorPagina	inteiro	Registros por página (máx. 100)

📥 Exemplo de requisição

Buscando pedidos pagos entre duas datas, 50 por página:

curl -X GET "https://api.toplojas.com.br/pedidos/?DataDe=2025-01-01&DataAte=2025-01-31&StatusIndicacao=Pago&QtdPorPagina=50" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

A resposta segue o padrão de paginação (Dados + Paginacao):

{
  "Dados": [
    {
      "Codigo": 1000,
      "CodigoReferencial": 1,
      "Data": "2020-12-01 12:00:00",
      "Loja": "cmacetkoteste",
      "Cliente": {
        "Codigo": 1,
        "IsPessoa": "F",
        "Nome_RazaoSocial": "Paloma Macetko",
        "Contato": "",
        "DataNascimento": "1989-11-14",
        "Sexo": "M",
        "CPF_CNPJ": "000.000.000-00",
        "RG_IE": "",
        "Email": "[e-mail]",
        "Telefone01": "(47) 33224477",
        "Telefone02": "(47) 55447788",
        "Telefone03": "(47) 55886699",
        "Empresa": "",
        "End_Estado": "SC",
        "End_Cidade": "Brusque",
        "End_Bairro": "centro",
        "End_Endereco": "Rua Central",
        "End_Numero": "99",
        "End_Complemento": "",
        "End_CEP": "88355-000"
      },
      "Endereco": {
        "End_Estado": "SC",
        "End_Cidade": "Brusque",
        "End_Bairro": "centro",
        "End_Endereco": "Rua Central",
        "End_Numero": "99",
        "End_Complemento": "",
        "End_CEP": "88355-000"
      },
      "ValorTotal": 253.79,
      "ValorProdutos": 220,
      "ValorFrete": 33.79,
      "ValorDescontosCupom": 0,
      "ValorDescontosPagamento": 0,
      "FormaPagamento": {
        "Codigo": 78509,
        "Nome": "PagSeguro"
      },
      "FormaEntrega": {
        "Codigo": 27154,
        "Nome": "PAC"
      },
      "NumeroParcelas": 1,
      "Status": {
        "Codigo": 25,
        "Nome": "Pedido com Pagamento Confirmado, Aguardando Captura",
        "Indicacao": "Pago"
      },
      "Itens": [
        {
          "Codigo": 1187876,
          "SKU": "3017",
          "Nome": "Teste1",
          "Quantidade": 2,
          "ValorUnitario": 110,
          "ValorTotal": 220
        }
      ]
    }
  ],
  "Paginacao": {
    "PaginaAtual": 1,
    "QtdPaginas": 1,
    "QtdRegistros": 4
  }
}

Consulte a descrição de cada campo na referência:

Swagger UIapi.toplojas.com.br

Para entender o funcionamento da paginação, veja:

Paginação