Consultando uma listagem de pedido por situação

📘

Recomendamos a inscrição nos tópicos de pedido do nosso Webhook para uma melhor performance da integração.

Para realizar a consulta de uma listagem de pedidos, baseando-se nas situações, utilize o endpoint
Retorna uma lista de pedido baseado nas situações de pedidos.

Parâmetros para consulta:

  • situacoesPedido - Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações;
  • dataInicial - Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss);
  • dataFinal - Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss);
  • enumTipoFiltroData - Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido);
  • formasPagamento - Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento;
  • pagina - Página da lista (padrão: 1);
  • quantidadeRegistros - Quantidade de registros que deverão retornar (max: 50);
  • apenasAssinaturas - Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos;

Response body:

[
  {
    "pedidoId": 325520,
    "situacaoPedidoId": 1,
    "tipoRastreamentoPedido": "SemRastreamento",
    "transacaoId": 28099823,
    "data": "2022-07-01T09:35:28",
    "dataPagamento": "2022-07-01T09:35:28",
    "dataUltimaAtualizacao": "2022-07-01T09:35:28",
    "valorFrete": 6,
    "valorTotalPedido": 0,
    "valorDesconto": 8.55,
    "valorDebitoCC": 0,
    "cupomDesconto": null,
    "marketPlacePedidoId": "",
    "marketPlacePedidoSiteId": "",
    "canalId": 0,
    "canalNome": "",
    "canalOrigem": "Loja",
    "retiradaLojaId": 0,
    "isPedidoEvento": false,
    "usuario": {
      "usuarioId": 304928,
      "grupoInformacaoCadastral": null,
      "tipoPessoa": "Fisica",
      "origemContato": "Outro",
      "tipoSexo": "Feminino",
      "nome": "Maria TrayCorp - Teste",
      "cpf": "11111111111",
      "email": "[email protected]",
      "rg": "12123456-1",
      "telefoneResidencial": "41333333339",
      "telefoneCelular": "41999988989",
      "telefoneComercial": "",
      "dataNascimento": "1987-03-24T00:00:00",
      "razaoSocial": "",
      "cnpj": "",
      "inscricaoEstadual": null,
      "responsavel": "",
      "dataCriacao": "2018-05-18T13:52:38",
      "dataAtualizacao": "2021-04-28T16:40:22",
      "revendedor": true,
      "listaInformacaoCadastral": null
    },
    "pedidoEndereco": [
      {
        "tipo": "Entrega",
        "nome": " TrayCorp - Teste",
        "endereco": "Nunes Machado",
        "numero": "68",
        "complemento": "",
        "referencia": "",
        "cep": "80250000",
        "tipoLogradouro": "",
        "logradouro": "Nunes Machado",
        "bairro": "Centro",
        "cidade": "Curitiba",
        "estado": "PR",
        "pais": "Brasil"
      }
    ],
    "frete": {
      "freteContratoId": 41190,
      "freteContrato": "Teste",
      "referenciaConector": null,
      "valorFreteEmpresa": 6,
      "valorFreteCliente": 6,
      "peso": 50,
      "pesoCobrado": 0,
      "volume": 11,
      "volumeCobrado": 0,
      "prazoEnvio": 2,
      "prazoEnvioTexto": "2 dias úteis",
      "retiradaLojaId": 0,
      "centrosDistribuicao": [
        {
          "freteContratoId": 41190,
          "freteContrato": "Teste",
          "valorFreteEmpresa": 6,
          "valorFreteCliente": 6,
          "peso": 50,
          "pesoCobrado": 0,
          "volume": 11,
          "volumeCobrado": 0,
          "prazoEnvio": 2,
          "prazoEnvioTexto": "2 dias úteis",
          "centroDistribuicaoId": 25
        }
      ],
      "servico": null,
      "retiradaAgendada": null,
      "agendamento": null,
      "informacoesAdicionais": null
    },
    "itens": [
      {
        "produtoVarianteId": 258335,
        "sku": "EXP.163016",
        "nome": "CANETA",
        "quantidade": 1,
        "precoCusto": 0,
        "precoVenda": 2.55,
        "isBrinde": false,
        "valorAliquota": 0,
        "isMarketPlace": false,
        "precoPor": 2.55,
        "desconto": 0,
        "totais": {
          "precoCusto": 0,
          "precoVenda": 2.55,
          "precoPor": 2.55,
          "desconto": 0
        },
        "ajustes": [
          {
            "tipo": 1,
            "valor": 6,
            "observacao": "Teste",
            "nome": "Frete"
          },
          {
            "tipo": 6,
            "valor": -8.55,
            "observacao": "{\"id\":10496, \"nome\": \"Teste 2\", \"cupom\": \"\"}",
            "nome": "Promocao"
          }
        ],
        "centroDistribuicao": [
          {
            "centroDistribuicaoId": 25,
            "quantidade": 1,
            "situacaoProdutoId": 1,
            "valorFreteEmpresa": 6,
            "valorFreteCliente": 6
          }
        ],
        "valoresAdicionais": [],
        "atributos": [
          {
            "produtoVarianteAtributoValor": "Única",
            "produtoVarianteAtributoNome": "COR"
          },
          {
            "produtoVarianteAtributoValor": "Único",
            "produtoVarianteAtributoNome": "Tamanho"
          }
        ],
        "embalagens": [],
        "personalizacoes": [],
        "frete": [],
        "dadosProdutoEvento": null,
        "formulas": [],
        "seller": null
      }
    ],
    "assinatura": [
      {
        "assinaturaId": 3490769,
        "grupoAssinaturaId": 241,
        "tipoPeriodo": "Semanal",
        "tempoPeriodo": 7,
        "percentualDesconto": 0
      }
    ],
    "pagamento": [
      {
        "formaPagamentoId": 3988,
        "numeroParcelas": 1,
        "valorParcela": 0,
        "valorDesconto": 0,
        "valorJuros": 0,
        "valorTotal": 0,
        "boleto": null,
        "cartaoCredito": [],
        "pagamentoStatus": [
          {
            "numeroAutorizacao": null,
            "numeroComprovanteVenda": null,
            "dataAtualizacao": "1900-01-01T00:00:00",
            "dataUltimoStatus": "1900-01-01T00:00:00",
            "adquirente": null,
            "tid": null
          }
        ],
        "informacoesAdicionais": []
      }
    ],
    "observacao": [],
    "valorCreditoFidelidade": 0,
    "valido": true,
    "valorSubTotalSemDescontos": 2.55,
    "pedidoSplit": []
  }
]

Para consultar os Ids de todas as situações de pedidos da loja, utilize o endpoint Retorna todas as situações de pedido da loja.

📘

Atenção!

O retorno de consulta de pedidos possui limite de 10.000 registros. Para não exceder ao limite de registros, faça consultas com intervalos e períodos menores, de acordo com a volumetria de pedidos de sua loja.