commerce

GET /v1/orders/{orderId}

Get an order.

Todos los endpoints de commerce

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Parámetros

NombreTipoObligatorio¿Qué es esto?
orderId (path)UuidThe order's id.

Respuesta

NombreTipoObligatorio¿Qué es esto?
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringHuman-friendly order reference.
statusOrderStatusAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorinteger
tax_minorinteger
discount_minorinteger
total_minorinteger
billing_countryobjectNo
placed_atobjectNo
created_atstring
updated_atstringNo
linesOrderLine[]
paymentsPayment[]

Errores que este endpoint puede devolver

401 · 403 · 404 · 429