commerce

GET /v1/orders/{orderId}

Get an order.

Все эндпоинты commerce

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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

Параметры

ИмяТипОбязательноЧто это
orderId (path)UuidДаThe order's id.

Ответ

ИмяТипОбязательноЧто это
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringДаHuman-friendly order reference.
statusOrderStatusДаAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeДаISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerДа
tax_minorintegerДа
discount_minorintegerДа
total_minorintegerДа
billing_countryobjectНет
placed_atobjectНет
created_atstringДа
updated_atstringНет
linesOrderLine[]Да
paymentsPayment[]Да

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429