Skip to main content
POST
Create a checkout

Authorizations

Authorization
string
header
required

An API key from Settings → API keys in Arcade Studio.

Body

application/json
requestId
string
required

Caller-chosen idempotency key; a replay returns the original result

Required string length: 1 - 128
lines
object[]
required

The caller's products to order, one line each

Required array length: 1 - 50 elements
dropShip
boolean
default:false

Adds the drop-ship service to the order. A line with quantity 1 needs it unless the caller is subscribed.

Response

200 - application/json

OK

checkoutId
string
required

The checkout's draft order ID; orders.get finds the order once it is placed

Pattern: ^\d+$
checkoutUrl
string<uri>
required

Hosted checkout page; host not guaranteed