Skip to main content
GET
Get Order

Path Parameters

orderId
string
required

Response

Order found successfully

lineItems
object[]
required
locale
enum<string>
required

Locale for the checkout, in IETF BCP 47. It impacts the email receipt language. Ensure your UI is set to the same language as specified here. Throws an error if passed an invalid language.

Available options:
Klingon,
de-DE,
en-US,
es-ES,
fr-FR,
it-IT,
ja-JP,
ko-KR,
pt-PT,
ru-RU,
th-TH,
tr-TR,
uk-UA,
vi-VN,
zh-CN,
zh-TW
orderId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
payment
object
required
phase
enum<string>
required
Available options:
completed,
delivery,
payment,
quote
quote
object
required
metadata
object