API atual/Referência completa/Pedidos e conta do cliente

GETStatus de pedido

Cadastro público de status da loja: código, letra, nome, cor e visibilidade para o cliente.

Devolve o cadastro de status de pedido da loja: o código, a letra, o nome em português, a cor e se aquele status é mostrado ao cliente. É a tabela que traduz o campo status (uma letra) de qualquer pedido em um rótulo legível, e que diz a quais fases o pedido pertence.

A rota é pública (não precisa de login) porque a vitrine precisa dela antes mesmo de o cliente entrar. Como cada loja renomeia, esconde e cria status, baixe esta lista uma vez por sessão e use-a para desenhar a linha do tempo e os filtros, em vez de fixar letras no seu código.

GET/api/v1/storefront/order-statusesPública

Lista o cadastro de status de pedido da loja

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/order-statuses"

Resposta

200Status da loja

json

{
  "statuses": [
    {
      "code": "pending",
      "letter_code": "O",
      "name": "Pendente",
      "name_pt": "Pendente",
      "color": "#f59e0b",
      "position": 20,
      "type": "initial",
      "notify_customer": false,
      "show_in_kanban": true,
      "is_active": true,
      "visible_to_customer": true,
      "flow_stage": ""
    },
    {
      "code": "shipped",
      "letter_code": "S",
      "name": "Enviado",
      "name_pt": "Enviado",
      "color": "#3b82f6",
      "position": 70,
      "type": "shipped",
      "notify_customer": true,
      "show_in_kanban": true,
      "is_active": true,
      "visible_to_customer": true,
      "flow_stage": ""
    }
  ],
  "total": 14
}

Campos da resposta

statusesarray

Todos os status cadastrados, mesmo os inativos ou escondidos do cliente. Filtre por is_active e visible_to_customer.

codestring

Código estável (pending, shipped...) ou o código próprio da loja. É o valor de status_text do pedido e o que o filtro status de Meus pedidos aceita.

letter_codestring

Letra de 1 caractere que o pedido guarda em status. Ela muda de loja para loja.

namestring

Nome em inglês do status. name_pt traz o nome em português, que é o que a loja mostra.

colorstring

Cor hexadecimal usada nas etiquetas.

positioninteger

Ordem de exibição.

typestring

Fase do status: initial, processing, shipped, complete, final, cancelled, refunded ou general (status criado pela loja).

notify_customerboolean

true quando a loja avisa o cliente por e-mail ao entrar nesse status.

visible_to_customerboolean

false quando o cliente não deve ver esse status (a loja o usa só internamente).

is_activeboolean

false quando o status foi desativado, mas ainda existe em pedidos antigos.

flow_stagestring

Etapa do fluxo de status da loja, quando o módulo order-status-flow está ligado. Vazio caso contrário.

totalinteger

Quantidade de status devolvidos.

A resposta traz ainda campos de uso interno da loja (notify_vendor, notify_admin, show_in_kanban, effective_inventory, inventory_locked_by_platform, created_at, updated_at) que um aplicativo de cliente não precisa ler.

Erros

Status	Quando	Corpo
500	Falha interna ao consultar a loja	`{"error":"failed to list order statuses","detail":"..."}`

Veja também