Skip to main content
POST
Freeze cart, recipient, retail price, authoritative shipping and tax

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

Body

application/json
destination
object
required

Response

Success

currency
enum<string>
required
Available options:
usd
expires_at
string<date-time>
required
items
object[]
required
merchandise_amount
integer
required
Required range: 0 <= x <= 1000000
quote_id
string
required
shipping_amount
integer
required
Required range: 0 <= x <= 1000000
shipping_service
enum<string>
required
Available options:
standard
tax_amount
integer
required
Required range: 0 <= x <= 1000000
total_amount
integer
required
Required range: 0 <= x <= 1000000