commerce

GET /v1/orders/{orderId}

Get an order.

Todos os endpoints de commerce

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/orders/{orderId} \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Returns one order with its lines and payment summaries. RBAC + RLS scoped.

Parâmetros

NomeTipoObrigatórioO que é
orderId (path)UuidSimThe order's id.

Resposta

NomeTipoObrigatórioO que é
idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringSimHuman-friendly order reference.
statusOrderStatusSimAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeSimISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerSim
tax_minorintegerSim
discount_minorintegerSim
total_minorintegerSim
billing_countryobjectNão
placed_atobjectNão
created_atstringSim
updated_atstringNão
linesOrderLine[]Sim
paymentsPayment[]Sim

Erros que este endpoint pode retornar

401 · 403 · 404 · 429