Skip to main content
POST
Quick buy

Authorizations

api-key
string
header
required

Your raw API key. Generate, rotate, and revoke keys from the merchant dashboard. Keys can optionally be bound to one or more allowed source IPs — requests from any other IP are rejected with API_KEY_IP_DENIED.

Headers

On-Behalf-Of
string

Sub-user UUID or the merchant's externalId for that sub-user. Required for sub-user-context routes; rejected (via requireMerchant) on merchant-context routes.

Required string length: 1 - 128

Body

application/json
itemId
string
required

Item id from catalog (SearchResultItem.id or ItemDetail.id).

maxPrice
string
required

Max acceptable unit price (decimal).

Pattern: ^\d+(\.\d{1,2})?$
amount
integer
required

Requested unit count. The server picks the cheapest matching listings.

Required range: 1 <= x <= 200
delivery
enum<string>
required
Available options:
standard,
instant
phase
enum<string>

Doppler phase to buy. Priced against the phase floor and allocated across the markets that carry it, cheapest first. Combines with either delivery mode; an instant phase order is filled only from the markets that list that phase for instant delivery.

Available options:
Phase 1,
Phase 2,
Phase 3,
Phase 4,
Ruby,
Sapphire,
Black Pearl,
Emerald
tradeUrl
string<uri>
externalId
string
Maximum string length: 128
externalIds
string[]

Your own reference for each requested unit, applied in order. Must contain exactly amount entries, all distinct. Fills arrive over time and in no fixed order, so this is what lets you tell your units apart afterwards and cancel a specific one.

Maximum array length: 200
Required string length: 1 - 128

Response

Created.

requestId
string
required
success
boolean
required
data
object

Present when success: true. Shape varies per endpoint.

error
object