Skip to main content
GET
Read an owned order status and valid pending checkout resume link

Authorizations

Authorization
string
header
required

Dedicated expiring guest-session capability. Never a developer API key. No Batch Relay account or Studio membership required.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

session_id
string
required
Maximum string length: 100
order_id
string
required
Maximum string length: 100

Response

Success

currency
enum<string>
required
Available options:
usd
merchandise_amount
integer
required
Required range: 0 <= x <= 1000000
mode
enum<string>
required
Available options:
test,
live
order_id
string
required
shipping_amount
integer
required
Required range: 0 <= x <= 1000000
status
enum<string>
required
Available options:
checkout_pending,
paid,
processing,
shipped,
failed,
expired,
payment_processing
tax_amount
integer
required
Required range: 0 <= x <= 1000000
total_amount
integer
required
Required range: 0 <= x <= 1000000
checkout_expires_at
string<date-time>
checkout_url
string<uri>