v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas

Lista de pedidos

get/pedidos

Query parameters

dataInicialstring date

Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)

dataFinalstring date

Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)

enumTipoFiltroData'DataPedido' | 'DataAprovacao' | 'DataModificacaoStatus' | 'DataAlteracao' | 'DataCriacao' | 'DataStatus'

Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido)

situacoesPedidostring

Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações

formasPagamentostring

Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento

paginainteger

Página da lista (padrão: 1)

quantidadeRegistrosinteger

Quantidade de registros que deverão retornar (max: 50)

listaPedidosIdsstring

Lista com IDs dos pedidos desejados no retorno. Se este campo for informado, os filtros de data serão ignorados. (max: 50), (lista separada por "," ex.: 1,2,3);

emailstring

Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado

validoboolean

Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado)

skustring

Deverá retornar apenas pedidos que o produto de determinado sku foi comprado

apenasAssinaturasboolean

Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.

direcaoOrdenacao'ASC' | 'DESC'

Define se a ordenação deverá ser feita de forma Ascendente ou Descendente. Caso não seja informado o comportamento padrão é Descendente

camposAdicionaisstring[]

Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados do pedido, valores aceitos: ProdutoAtributos, ProdutoEan, ProdutoImagens, ProdutoCategorias, PagamentosInformacoes.

Response

200

pedidoIdinteger
situacaoPedidoIdinteger
tipoRastreamentoPedidostring
transacaoIdinteger
datastring
dataPagamentostring
dataUltimaAtualizacaostring
valorFreteinteger
valorTotalPedidointeger
valorDescontointeger
valorDebitoCCinteger
cupomDescontostring
marketPlacePedidoIdstring
marketPlacePedidoSiteIdstring
canalIdinteger
canalNomestring
canalOrigemstring
retiradaLojaIdinteger
isPedidoEventoboolean
valorCreditoFidelidadeinteger
validoboolean
valorSubTotalSemDescontosinteger
pedidoSplitinteger[]
usuarioMasterIdinteger
transacaoPaiIdinteger
pedidoPaiinteger
isChangeOrderboolean

Indica se o pedido é uma alteração (change order) de um pedido original

primeiraCompraboolean

Indica se é a primeira compra do usuário

identificadorstring

Identificador de agrupamento externo

dataEstimadaEntregastring

Data estimada de entrega do pedido (ISO 8601). Calculada a partir da data de pagamento somada ao prazo de envio em dias. Retorna null quando não disponível.

dataLancamentostring date-time

Data estimada de entrega do pedido. Calculada a partir da data de pagamento somada ao prazo de envio em dias. Retorna null quando não disponível.

isPreVendaboolean

Tag para identificação se o pedido é do tipo Pré Venda

Example response

[
  {
    "tipoRastreamentoPedido": "SemRastreamento",
    "data": "2024-10-01T18:53:24.846Z",
    "dataPagamento": "2024-10-01T18:53:24.846Z",
    "dataUltimaAtualizacao": "2024-10-01T18:53:24.846Z",
    "cupomDesconto": "string",
    "marketPlacePedidoId": "string",
    "marketPlacePedidoSiteId": "string",
    "canalNome": "string",
    "canalOrigem": "string",
    "isPedidoEvento": true,
    "usuario": {
      "grupoInformacaoCadastral": [
        {
          "chave": "string",
          "valor": "string"
        }
      ],
      "tipoPessoa": "Fisica",
      "origemContato": "Google",
      "tipoSexo": "Undefined",
      "nome": "string",
      "cpf": "string",
      "email": "string",
      "rg": "string",
      "telefoneResidencial": "string",
      "telefoneCelular": "string",
      "telefoneComercial": "string",
      "dataNascimento": "2024-10-01T18:53:24.846Z",
      "razaoSocial": "string",
      "cnpj": "string",
      "inscricaoEstadual": "string",
      "responsavel": "string",
      "dataCriacao": "2024-10-01T18:53:24.846Z",
      "dataAtualizacao": "2024-10-01T18:53:24.846Z",
      "revendedor": true,
      "listaInformacaoCadastral": [
        {
          "chave": "string",
          "valor": "string"
        }
      ]
    },
    "pedidoEndereco": [
      {
        "tipo": "Entrega",
        "nome": "string",
        "endereco": "string",
        "numero": "string",
        "complemento": "string",
        "referencia": "string",
        "cep": "string",
        "tipoLogradouro": "string",
        "logradouro": "string",
        "bairro": "string",
        "cidade": "string",
        "estado": "string",
        "pais": "string"
      }
    ],
    "frete": {
      "freteContrato": "string",
      "referenciaConector": "string",
      "prazoEnvioTexto": "string",
      "centrosDistribuicao": [
        {
          "freteContrato": "string",
          "prazoEnvioTexto": "string",
          "cotacoesFilhas": [
            {
              "freteContrato": "string"
            }
          ]
        }
      ],
      "servico": {
        "nome": "string",
        "transportadora": "string",
        "servicoNome": "string",
        "servicoMeta": "string",
        "token": "string"
      },
      "retiradaAgendada": {
        "retiradaData": "2024-10-01T18:53:24.847Z",
        "retiradaPeriodo": "string",
        "nome": "string",
        "documento": "string",
        "codigoRetirada": "string"
      },
      "agendamento": {
        "de": "2024-10-01T18:53:24.847Z",
        "ate": "2024-10-01T18:53:24.847Z"
      },
      "informacoesAdicionais": [
        {
          "chave": "string",
          "valor": "string"
        }
      ]
    },
    "itens": [
      {
        "sku": "string",
        "ean": "string",
        "nome": "string",
        "isBrinde": true,
        "isMarketPlace": true,
        "ajustes": [
          {
            "tipo": "Frete",
            "observacao": "string",
            "nome": "string"
          }
        ],
        "valoresAdicionais": [
          {
            "tipo": "Acrescimo",
            "origem": "string",
            "texto": "string"
          }
        ],
        "atributos": [
          {
            "produtoVarianteAtributoValor": "string",
            "produtoVarianteAtributoNome": "string"
          }
        ],
        "embalagens": [
          {
            "nomeTipoEmbalagem": "string",
            "mensagem": "string",
            "descricao": "string"
          }
        ],
        "personalizacoes": [
          {
            "nomePersonalizacao": "string",
            "valorPersonalizacao": "string"
          }
        ],
        "frete": [
          {
            "freteContrato": "string",
            "prazoEnvioTexto": "string"
          }
        ],
        "dadosProdutoEvento": {
          "tipoPresenteRecebimento": "None",
          "texto": "string"
        },
        "formulas": [
          {
            "chaveAjuste": "string",
            "nome": "string",
            "expressao": "string",
            "expressaoInterpretada": "string",
            "endPoint": "string"
          }
        ],
        "seller": {
          "sellerNome": "string"
        },
        "metadados": [
          {
            "chave": "string",
            "valor": "string"
          }
        ],
        "imagens": [
          {
            "nomeArquivo": "string",
            "url": "string"
          }
        ],
        "categorias": [
          {
            "categoria": "string",
            "hierarquia": "string",
            "categoriaPrincipal": true
          }
        ]
      }
    ],
    "assinatura": [
      {
        "tipoPeriodo": "string"
      }
    ],
    "pagamento": [
      {
        "boleto": {
          "urlBoleto": "string",
          "codigoDeBarras": "string"
        },
        "pix": {
          "qrCode": "string",
          "qrCodeExpiracao": "2024-10-01T18:53:24.847Z",
          "qrCodeUrl": "string",
          "qrCodeUrlPagamento": "string"
        },
        "cartaoCredito": [
          {
            "numeroCartao": "string",
            "nomeTitular": "string",
            "dataValidade": "string",
            "codigoSeguranca": "string",
            "documentoCartaoCredito": "string",
            "token": "string",
            "info": "string",
            "bandeira": "string"
          }
        ],
        "pagamentoStatus": [
          {
            "numeroAutorizacao": "string",
            "numeroComprovanteVenda": "string",
            "dataAtualizacao": "2024-10-01T18:53:24.847Z",
            "dataUltimoStatus": "2024-10-01T18:53:24.847Z",
            "adquirente": "string",
            "tid": "string"
          }
        ],
        "informacoesAdicionais": [
          {
            "chave": "string",
            "valor": "string"
          }
        ]
      }
    ],
    "observacao": [
      {
        "observacao": "string",
        "usuario": "string",
        "data": "2024-10-01T18:53:24.847Z",
        "publica": true
      }
    ],
    "valido": true,
    "metadados": [
      {
        "chave": "string",
        "valor": "string"
      }
    ],
    "detalhesContaCorrente": [
      {
        "descricaoTipoConta": "string",
        "referencias": [
          "string"
        ]
      }
    ]
  }
]