API ReferenceOrders

Get an order

Просмотр в формате Markdown

Returns the full, current state of one of your orders. Poll this (or rely on the webhook) to observe the terminal status, delivered codes and any refund_amount.

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

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

idstringОбязательныйformat: "uuid"

The order id returned by POST /api/v1/orders.

Ответ

The order.
idstringformat: "uuid"
The order id.
iteminteger
Numeric item id.
item_namestring
item_product_typeenum
quantitydouble
delivered_quantityinteger

Units delivered so far (relevant for key items / partials).

pricedouble
Amount charged, in major currency units.
refund_amountdouble

Amount refunded for undelivered units (partial / failed).

fieldsmap from strings to strings

The submitted input fields (choice values shown as their display name).

statusenum
errorstring

Machine error code when status = failed (e.g. OUT_OF_STOCK); otherwise empty.

error_messagestring

Human-readable error message when failed; otherwise empty.

codeslist of strings

Delivered key/code strings (key items only).

merchant_order_idstring
sourceenum
created_byobject or null
created_atdatetime
completed_atdatetime or null

Ошибки

401
Unauthorized Error
404
Not Found Error