v1
latestOpenAPI 3.1.02026-08-044330906.8 KBRetorna uma lista de pedido baseado nas situações de pedidos
Lista de pedidos de acordo com uma situação específica
get/pedidos/situacaoPedido/{situacoesPedido}
Path parameters
situacoesPedidostring required
Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3). Obrigatório informar ao menos uma situação
Query parameters
dataInicialstring date required
Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)
dataFinalstring date required
Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)
enumTipoFiltroData'DataPedido' | 'DataAprovacao' | 'DataModificacaoStatus' | 'DataAlteracao' | 'DataCriacao'
Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido)
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)
apenasAssinaturasboolean
Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.
Response
200
Example response
[
{
"tipoRastreamentoPedido": "SemRastreamento",
"data": "2022-06-28T11:18:19.146Z",
"dataPagamento": "2022-06-28T11:18:19.146Z",
"dataUltimaAtualizacao": "2022-06-28T11:18:19.146Z",
"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": "2022-06-28T11:18:19.146Z",
"razaoSocial": "string",
"cnpj": "string",
"inscricaoEstadual": "string",
"responsavel": "string",
"dataCriacao": "2022-06-28T11:18:19.146Z",
"dataAtualizacao": "2022-06-28T11:18:19.146Z",
"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"
}
],
"servico": {
"nome": "string",
"transportadora": "string",
"servicoNome": "string",
"servicoMeta": "string",
"token": "string"
},
"retiradaAgendada": {
"retiradaData": "2022-06-28T11:18:19.146Z",
"retiradaPeriodo": "string",
"nome": "string",
"documento": "string",
"codigoRetirada": "string"
},
"agendamento": {
"de": "2022-06-28T11:18:19.146Z",
"ate": "2022-06-28T11:18:19.146Z"
},
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
},
"itens": [
{
"sku": "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"
},
"formulas": [
{
"chaveAjuste": "string",
"nome": "string",
"expressao": "string",
"expressaoInterpretada": "string",
"endPoint": "string"
}
],
"seller": {
"sellerNome": "string"
}
}
],
"assinatura": [
{
"tipoPeriodo": "string"
}
],
"pagamento": [
{
"boleto": {
"urlBoleto": "string",
"codigoDeBarras": "string"
},
"cartaoCredito": [
{
"numeroCartao": "string",
"nomeTitular": "string",
"dataValidade": "string",
"codigoSeguranca": "string",
"documentoCartaoCredito": "string",
"token": "string",
"info": "string",
"bandeira": "string"
}
],
"pagamentoStatus": [
{
"numeroAutorizacao": "string",
"numeroComprovanteVenda": "string",
"dataAtualizacao": "2022-06-28T11:18:19.146Z",
"dataUltimoStatus": "2022-06-28T11:18:19.146Z",
"adquirente": "string",
"tid": "string"
}
],
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
}
],
"observacao": [
{
"observacao": "string",
"usuario": "string",
"data": "2022-06-28T11:18:19.146Z",
"publica": true
}
],
"valido": true,
"metadados": [
{
"chave": "string",
"valor": "string"
}
],
"detalhesContaCorrente": [
{
"descricaoTipoConta": "string",
"referencias": [
"string"
]
}
],
"isChangeOrder": true,
"primeiraCompra": true,
"identificador": "string",
"omnichannel": {
"pedidoIdPublico": "string",
"pedidoIdPrivado": "string",
"integrador": {
"nome": "string",
"pedidoId": "string",
"pedidoUrl": "string"
}
},
"dataEstimadaEntrega": "2026-07-08T19:04:20.944Z",
"dataLancamento": "2026-07-08T19:04:20.944Z",
"isPreVenda": true
}
]