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

An ID you choose for this request, up to 128 characters. Retrying with the same requestId and body returns the original result.

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

The products to order. Each product can appear only once.

Required array length: 1 - 50 elements
expectedDropshippingCreditCost
integer

The per-item creditCost from checkouts/quoteDropshipping. Send it when dropShip is true.

Required range: 0 <= x <= 9007199254740991
expectedDropshippingPolicyRevision
integer

The revision from checkouts/quoteDropshipping, converted from a string to a number. Send it when dropShip is true.

Required range: -9007199254740991 < x <= 9007199254740991
dropShip
boolean
default:false

Whether the order uses dropshipping. Defaults to false. A dropshipped order ships with your branded receipt instead of the Arcade invoice, once your brand is set up in Arcade Studio. Set it to true when any line has quantity 1, unless you have a paid plan that includes dropshipping; otherwise the request returns 412 PRECONDITION_FAILED.

Response

200 - application/json

OK

checkoutId
string
required

The checkout's ID. After payment, pass it to orders/get to find the order.

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

The page where the checkout is paid. The host can change.