v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Retorna um pedido específico

Pedido único

get/pedidos/{pedidoId}

Path parameters

pedidoIdinteger required

Número do pedido que se deseja buscar

Query parameters

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 de Lançamento do pedido

isPreVendanumber double

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

Example response

{
  "tipoRastreamentoPedido": "SemRastreamento",
  "data": "2024-10-01T18:53:24.877Z",
  "dataPagamento": "2024-10-01T18:53:24.877Z",
  "dataUltimaAtualizacao": "2024-10-01T18:53:24.877Z",
  "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.877Z",
    "razaoSocial": "string",
    "cnpj": "string",
    "inscricaoEstadual": "string",
    "responsavel": "string",
    "dataCriacao": "2024-10-01T18:53:24.877Z",
    "dataAtualizacao": "2024-10-01T18:53:24.877Z",
    "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.877Z",
      "retiradaPeriodo": "string",
      "nome": "string",
      "documento": "string",
      "codigoRetirada": "string"
    },
    "agendamento": {
      "de": "2024-10-01T18:53:24.877Z",
      "ate": "2024-10-01T18:53:24.877Z"
    },
    "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"
        }
      ]
    }
  ],
  "assinatura": [
    {
      "tipoPeriodo": "string"
    }
  ],
  "pagamento": [
    {
      "boleto": {
        "urlBoleto": "string",
        "codigoDeBarras": "string"
      },
      "pix": {
        "qrCode": "string",
        "qrCodeExpiracao": "2024-10-01T18:53:24.878Z",
        "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.878Z",
          "dataUltimoStatus": "2024-10-01T18:53:24.878Z",
          "adquirente": "string",
          "tid": "string"
        }
      ],
      "informacoesAdicionais": [
        {
          "chave": "string",
          "valor": "string"
        }
      ]
    }
  ],
  "observacao": [
    {
      "observacao": "string",
      "usuario": "string",
      "data": "2024-10-01T18:53:24.878Z",
      "publica": true
    }
  ],
  "valido": true,
  "metadados": [
    {
      "chave": "string",
      "valor": "string"
    }
  ],
  "detalhesContaCorrente": [
    {
      "descricaoTipoConta": "string",
      "referencias": [
        "string"
      ]
    }
  ]
}