Create Order

Creates a new order that can be used to complete a headless checkout.

API scope required: orders.create

Authorizations

X-API-KEY

string

headerrequired

Body

application/json

payment

object

required

• EVM
• Solana
• Fiat

Show child attributes

payment.method

enum<string>

required

Available options:

arbitrum-sepolia,

base-sepolia,

ethereum-sepolia,

optimism-sepolia,

arbitrum,

bsc,

ethereum,

optimism

payment.currency

enum<string>

required

Available options:

eth,

usdc,

degen,

brett,

toshi,

usdxm

payment.receiptEmail

string

Email that the receipt will be sent to.

payment.payerAddress

string

An EVM wallet address.

lineItems

required

Show child attributes

lineItems.collectionLocator

string

required

The collection locator of the line item. For example: 'crossmint:<collectionId>'. These fields can be retrieved from the Crossmint console.

lineItems.callData

object

Information that you pass to your contract mint function.

Show child attributes

lineItems.callData.totalPrice

string

The total price of the line item. It must be the same as the contract expects to receive. Read https://docs.crossmint.com/nft-checkout/advanced/component-properties#mintconfig

lineItems.callData.{key}

any

recipient

object

Recipient of the items being purchased. Crossmint will create a custodial wallet address for the user on the fly, that they can later log in to. If no recipient is passed, an order will be created with the status 'requires-recipient', until you pass one.

• Email
• Wallet

Show child attributes

recipient.email

string

required

locale

enum<string>

default: en-US

Locale for the checkout, in IETF BCP 47. It impacts the email receipt language. Ensure your UI is set to the same language as specified here. Throws an error if passed an invalid language.

Available options:

en-US,

es-ES,

fr-FR,

it-IT,

ko-KR,

pt-PT,

ja-JP,

zh-CN,

zh-TW,

de-DE,

ru-RU,

tr-TR,

uk-UA,

th-TH,

vi-VN,

Klingon

Response

201 - application/json

clientSecret

string

A token exclusively scoped to a particular order, allowing for the reading or updating of that order.

order

object

Show child attributes

order.orderId

string

order.phase

string

order.locale

string

order.lineItems

object[]

Show child attributes

order.lineItems.chain

string

order.lineItems.quantity

number

order.lineItems.callData

object

Show child attributes

order.lineItems.callData.quantity

number

order.lineItems.callData.ADDITIONAL_PROPERTIES

string

order.lineItems.metadata

object

Show child attributes

order.lineItems.metadata.name

string

order.lineItems.metadata.description

string

order.lineItems.metadata.imageUrl

string

order.lineItems.quote

object

Show child attributes

order.lineItems.quote.status

string

order.lineItems.quote.charges

object

Show child attributes

order.lineItems.quote.charges.unit

object

Show child attributes

order.lineItems.quote.totalPrice

object

Show child attributes

order.lineItems.quote.totalPrice.amount

string

order.lineItems.quote.totalPrice.currency

string

order.lineItems.delivery

object

Show child attributes

order.lineItems.delivery.status

string

order.lineItems.delivery.recipient

object

Show child attributes

order.lineItems.delivery.recipient.locator

string

order.lineItems.delivery.recipient.email

string

order.lineItems.delivery.recipient.walletAddress

string

order.quote

object

Show child attributes

order.quote.status

string

order.quote.quotedAt

string

order.quote.expiresAt

string

order.quote.totalPrice

object

Show child attributes

order.quote.totalPrice.amount

string

order.quote.totalPrice.currency

string

order.payment

object

Show child attributes

order.payment.status

string

order.payment.method

string

order.payment.currency

string

order.payment.preparation

object

Show child attributes

order.payment.preparation.chain

string

order.payment.preparation.payerAddress

string

order.payment.preparation.serializedTransaction

string