Histórico do pedido

Lista, em ordem cronológica, as mudanças de status de um pedido, com a letra de origem e a de destino.

Cada pedido guarda um registro do que aconteceu com ele. Use esse registro para auditar "quem moveu este pedido para cancelado e quando", para mostrar o andamento ao atendimento, ou para reconstruir o estado de um pedido em um momento passado.

O histórico de status guarda só as mudanças de status do pedido, com a letra de origem e a de destino, da mais antiga para a mais recente.

GET/api/v1.0/orders/{id}/status-historyAdmin

Histórico de status de um pedido

Devolve as mudanças de status, da mais antiga para a mais recente. Linhas que registram mudanças de pagamento (por exemplo "pendente para capturado") não entram: esse log é só de status do pedido.

Parâmetros de caminho

idstringobrigatório

Id do pedido (UUID; decimal em string em /api/orders/{id}/status-history).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/orders/$ORDER_ID/status-history"

Resposta

200Histórico de status

json

{
  "history": [
    { "from_status": "O", "to_status": "O", "changed_by": "", "changed_at": 1791749680, "notes": "order_created" },
    {
      "from_status": "O",
      "to_status": "P",
      "changed_by": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
      "changed_at": 1791749793,
      "notes": "Pagamento confirmado"
    }
  ]
}

Campos da resposta

historyarray

Mudanças de status. Vazio se o pedido não tem histórico.

history[].from_statusstring

Letra do status anterior. No primeiro registro (criação) é igual à de destino.

history[].to_statusstring

Letra do status novo.

history[].changed_bystring

Id do usuário que fez a mudança. Vazio quando a mudança veio de um sistema (gateway de pagamento, integração pela API 1.0 sem usuário, rotina automática).

history[].changed_atinteger

Quando, em Unix timestamp (segundos, UTC).

history[].notesstring

Observação da mudança. Mudanças feitas pela API 1.0 terminam com [actor=api_v1.0].

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave de API inválida	`{"message":"Invalid credentials","status":401}`
403	Usuário que não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
500	Pedido inexistente; falha interna	`{"error":"internal server error"}`

Veja também

Alterar o status

Histórico do pedido

Lista, em ordem cronológica, as mudanças de status de um pedido, com a letra de origem e a de destino.

O histórico de status guarda só as mudanças de status do pedido, com a letra de origem e a de destino, da mais antiga para a mais recente.

GET/api/v1.0/orders/{id}/status-historyAdmin

Histórico de status de um pedido

Parâmetros de caminho

idstringobrigatório

Id do pedido (UUID; decimal em string em /api/orders/{id}/status-history).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/orders/$ORDER_ID/status-history"

Resposta

200Histórico de status

json

{
  "history": [
    { "from_status": "O", "to_status": "O", "changed_by": "", "changed_at": 1791749680, "notes": "order_created" },
    {
      "from_status": "O",
      "to_status": "P",
      "changed_by": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
      "changed_at": 1791749793,
      "notes": "Pagamento confirmado"
    }
  ]
}

Campos da resposta

historyarray

Mudanças de status. Vazio se o pedido não tem histórico.

history[].from_statusstring

Letra do status anterior. No primeiro registro (criação) é igual à de destino.

history[].to_statusstring

Letra do status novo.

history[].changed_bystring

Id do usuário que fez a mudança. Vazio quando a mudança veio de um sistema (gateway de pagamento, integração pela API 1.0 sem usuário, rotina automática).

history[].changed_atinteger

Quando, em Unix timestamp (segundos, UTC).

history[].notesstring

Observação da mudança. Mudanças feitas pela API 1.0 terminam com [actor=api_v1.0].

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave de API inválida	`{"message":"Invalid credentials","status":401}`
403	Usuário que não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
500	Pedido inexistente; falha interna	`{"error":"internal server error"}`

Veja também

Alterar o status