Dev Console
Console (staging)
Dev Console

Headless Checkout

Create Order

Documentation

API Reference

Support

Changelog

Developer Console
Developer Blog

Headless Checkout

Create Order

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

POST

2022-06-09

orders

X-API-KEY

string

X-API-KEY

Required

string

object

recipient

Email · object

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.

string

Required

string

locale

enum<string>

locale

enum<string>

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.

Add Example Value

payment

EVM · object

payment

Required

object

receiptEmail

string

receiptEmail

string

Email that the receipt will be sent to.

method

enum<string>

method

Required

enum<string>

currency

enum<string>

currency

Required

enum<string>

payerAddress

string

payerAddress

string

An EVM wallet address.

lineItems

Single Line Item · object

lineItems

Required

object

collectionLocator

string

collectionLocator

Required

string

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

Add Example Value

callData

object

callData

object

Information that you pass to your contract mint function.

totalPrice

string

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

Authorizations

X-API-KEY

string

headerrequired

Body

application/json

recipient

object

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

payment

object

required

payment.receiptEmail

string

Email that the receipt will be sent to.

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

payment.payerAddress

string

An EVM wallet address.

lineItems

required

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.

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

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

order.orderId

string

order.phase

string

order.locale

string

order.lineItems

object[]

order.lineItems.chain

string

order.lineItems.quantity

number

order.lineItems.callData

object

order.lineItems.callData.quantity

number

order.lineItems.callData.ADDITIONAL_PROPERTIES

string

order.lineItems.metadata

object

order.lineItems.metadata.name

string

order.lineItems.metadata.description

string

order.lineItems.metadata.imageUrl

string

order.lineItems.quote

object

order.lineItems.quote.status

string

order.lineItems.quote.charges

object

order.lineItems.quote.charges.unit

object

order.lineItems.quote.charges.unit.amount

string

order.lineItems.quote.charges.unit.currency

string

order.lineItems.quote.totalPrice

object

order.lineItems.quote.totalPrice.amount

string

order.lineItems.quote.totalPrice.currency

string

order.lineItems.delivery

object

order.lineItems.delivery.status

string

order.lineItems.delivery.recipient

object

order.lineItems.delivery.recipient.locator

string

order.lineItems.delivery.recipient.email

string

order.lineItems.delivery.recipient.walletAddress

string

order.quote

object

order.quote.status

string

order.quote.quotedAt

string

order.quote.expiresAt

string

order.quote.totalPrice

object

order.quote.totalPrice.amount

string

order.quote.totalPrice.currency

string

order.payment

object

order.payment.status

string

order.payment.method

string

order.payment.currency

string

order.payment.preparation

object

order.payment.preparation.chain

string

order.payment.preparation.payerAddress

string

order.payment.preparation.serializedTransaction

string

Delete Template Get Order

website twitter github discord

API Reference

Wallets

NFTs

NFT Collections

NFT Templates

Headless Checkout

Action Status

Admin

Authorizations

Body

Response