Skip to main content
POST
Create a server-calculated API order quote

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

Idempotency-Key
string
required

Stable key for this quote request. Reuse it only with the same request.

Required string length: 1 - 200
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

Body

application/json
order
object
required
routing
object
required
acknowledgements
string[]

Response

Immutable account-scoped quote

api_account_id
string
required
channel
string
required
Allowed value: "api"
environment
enum<string>
required
Available options:
staging,
production
expires_at
string<date-time>
required
id
string
required
merchant_of_record
string
required
Allowed value: "batch_relay"
price
object
required
provider
object
required
provider_offer_lines
object[]
required

Line subtotals always reconcile exactly to price.merchandise_cents.

Minimum array length: 1