Skip to main content
GET
Get an account-scoped API print order

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

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

order_id
string
required
Pattern: ^bro_

Response

API order

api_account_id
string
required
channel
string
required
Allowed value: "api"
created_at
string<date-time>
required
external_order_id
string
required
id
string
required
Pattern: ^bro_
merchant_of_record
string
required
Allowed value: "batch_relay"
order_code
string
required

Batch Relay-owned human-facing order reference. It is always serialized, but may be empty for legacy records that predate allocation.

price
object
required
provider
object
required
provider_offer_lines
object[]
required

Immutable copy of the reserved quote's public offer evidence.

Minimum array length: 1
quote_id
string
required
status
string
required
updated_at
string<date-time>
required