Objetos

Pedido

Um pedido feito na loja, com cliente, valores, entrega, itens e histórico.

Campos

campo	tipo	descrição
`id`	`integer`	Número do pedido.
`criado_em`	`string (ISO 8601)`	Data e hora da compra.
`status`	`string`	pendente, pago, aceito, enviado, pronto_retirada, concluido, cancelado ou reembolsado.
`status_nome`	`string`	Nome do status como aparece para o lojista.
`situacao_pagamento`	`string \| null`	pendente, em_analise, aprovado, recusado, estornado ou cancelado.
`situacao_entrega`	`string \| null`	aguardando, em_separacao, em_transito, pronto_retirada, entregue ou cancelada.
`cliente`	`object`	{ id, nome, email, whatsapp, documento }. id é null para compra sem conta.
`valores`	`object`	{ subtotal, desconto, frete, total } em reais.
`cupom`	`string \| null`	Código do cupom usado.
`pagamento`	`object`	{ forma, nome, informacao, pago_em, link }.
`entrega`	`object`	{ forma, nome, codigo_rastreio, endereco: { cep, rua, numero, complemento, bairro, referencia, cidade, estado } }.
`observacao`	`string \| null`	Recado do cliente no pedido.
`itens`	`object[]`	{ id, produto_id, sku, nome, variacao, quantidade, preco_unitario, total, peso_kg }. Só no detalhe (ou com incluir_itens=true na lista).
`notas_internas`	`string \| null`	Notas da loja, não visíveis para o cliente. Só no detalhe.
`historico`	`object[]`	{ status, origem, detalhe, em }. origem: cliente, loja, admin, pagamento, sistema ou api. Só no detalhe.

Exemplo

{
  "id": 2178,
  "criado_em": "2026-10-28T00:43:00-03:00",
  "status": "cancelado",
  "status_nome": "Cancelado",
  "situacao_pagamento": "aprovado",
  "situacao_entrega": "cancelada",
  "cliente": {
    "id": null,
    "nome": "Cliente Lançamentos",
    "email": "[email protected]",
    "whatsapp": "11999990000",
    "documento": ""
  },
  "valores": {
    "subtotal": 59.9,
    "desconto": 0.0,
    "frete": 0.0,
    "total": 59.9
  },
  "cupom": null,
  "pagamento": {
    "forma": "6",
    "nome": "Pix",
    "informacao": "",
    "pago_em": "2026-10-28T00:44:12-03:00",
    "link": null
  },
  "entrega": {
    "forma": "retirada",
    "nome": "Envio - retirada",
    "codigo_rastreio": "AA123456789BR",
    "endereco": {
      "cep": "01001000",
      "rua": "Rua Teste",
      "numero": "10",
      "complemento": "",
      "bairro": "Centro",
      "referencia": "",
      "cidade": "Florianópolis",
      "estado": "Santa Catarina"
    }
  },
  "observacao": "Deixar na portaria",
  "itens": [
    {
      "id": 769,
      "produto_id": 2496,
      "sku": "LIV-001",
      "nome": "O Farol das Horas Quietas",
      "variacao": "Edição: Brochura",
      "quantidade": 1,
      "preco_unitario": 59.9,
      "total": 59.9,
      "peso_kg": 0.4
    }
  ],
  "notas_internas": "[28/10/2026 00:44 · API] Nota fiscal 1234 emitida",
  "historico": [
    {
      "status": "pago",
      "origem": "api",
      "detalhe": null,
      "em": "2026-10-28T00:44:12-03:00"
    },
    {
      "status": "aceito",
      "origem": "api",
      "detalhe": null,
      "em": "2026-10-28T00:44:22-03:00"
    },
    {
      "status": "info",
      "origem": "api",
      "detalhe": "separando no ERP",
      "em": "2026-10-28T00:44:22-03:00"
    },
    {
      "status": "info",
      "origem": "api",
      "detalhe": "Código de rastreio: AA123456789BR",
      "em": "2026-10-28T00:44:23-03:00"
    },
    {
      "status": "cancelado",
      "origem": "api",
      "detalhe": null,
      "em": "2026-10-28T00:44:27-03:00"
    }
  ]
}