For the complete documentation index, see llms.txt. This page is also available as Markdown.

Detalhes do Pedido

Retorna os dados completos de um pedido específico, identificado pelo seu Código.

GET /pedidos/{Codigo}/

O {Codigo} é o código do pedido, obtido na listagem de pedidos.

📥 Exemplo de requisição

curl -X GET "https://api.toplojas.com.br/pedidos/1000/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 O que é retornado

Os detalhes de um pedido incluem, entre outros:

Grupo
Conteúdo

Cliente

Nome/Razão Social, documento, contato e endereço

Endereço

Endereço de entrega do pedido

Itens

Produtos do pedido (SKU, nome, quantidade e valores)

Valores

Total, produtos, frete e descontos

Formas

Forma de pagamento e forma de entrega

Status

Código, nome e indicação do status atual

Exemplo completo de um pedido retornado:

{
  "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": "suporte2@web4business.com.br",
    "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
    }
  ]
}

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

Last updated