Skip to main content
POST
PlaceOrder

Authorizations

X-API-Key
string
header
required

Your API key, prefixed sc_live_ or sc_test_.

Body

application/json
lines
OrderLine · object[]

lines are the products to buy and how many of each. At least one is required.

reference
string

reference is an optional identifier you attach to the order to correlate it with your own system and look it up later. Reusing an Idempotency-Key with a different reference is a conflict.

Response

200 - application/json

Success

order
order · object

order is the accepted order. Its status is pending until fulfillment completes; poll the order to follow it.