Get Order

Get specific order by ID.

Authentication: Use either a server-side API key with orders.read scope, or the clientSecret from order creation as an authorization header.

GET /2022-06-09/orders/{orderId}

Try it

Get Order

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/orders/{orderId} \
  --header 'X-API-KEY: <api-key>'

200

{
  "orderId": "b2959ca5-65e4-466a-bd26-1bd05cb4f837",
  "phase": "payment",
  "locale": "en-US",
  "lineItems": [
    {
      "chain": "polygon-amoy",
      "quantity": 1,
      "callData": {
        "quantity": 1,
        "ADDITIONAL_PROPERTIES": "Your other mint function arguments"
      },
      "metadata": {
        "name": "Headless Checkout Demo",
        "description": "NFT Description",
        "imageUrl": "https://cdn.io/image.png"
      },
      "quote": {
        "status": "valid",
        "charges": {
          "unit": {
            "amount": "0.0001",
            "currency": "eth"
          },
          "salesTax": {
            "amount": "0.34",
            "currency": "usdc"
          },
          "shipping": {
            "amount": "0",
            "currency": "usdc"
          }
        },
        "totalPrice": {
          "amount": "0.0001",
          "currency": "eth"
        }
      },
      "delivery": {
        "status": "awaiting-payment",
        "recipient": {
          "locator": "email:<email_address>:<chain>",
          "email": "[e-mail]",
          "walletAddress": "0x1234abcd..."
        }
      }
    }
  ],
  "quote": {
    "status": "valid",
    "quotedAt": "2024-06-07T16:55:44.653Z",
    "expiresAt": "2024-06-07T17:55:44.653Z",
    "totalPrice": {
      "amount": "0.0001375741",
      "currency": "eth"
    }
  },
  "payment": {
    "status": "awaiting-payment",
    "method": "base-sepolia",
    "currency": "eth",
    "preparation": {
      "chain": "base-sepolia",
      "payerAddress": "0x1234abcd...",
      "serializedTransaction": "0x02f90....."
    }
  }
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

orderId · string · required

This is the identifier for the order with UUID format.

Example: 9c82ef99-617f-497d-9abb-fd355291681b

Response

200

application/json

Order successfully created.

orderId · string

Example:

"b2959ca5-65e4-466a-bd26-1bd05cb4f837"

phase · string

Example:

"payment"

locale · string

Example:

"en-US"

lineItems · object[]

Show child attributes

lineItems. chain · string

Example:

"polygon-amoy"

lineItems. quantity · number

Example:

1

lineItems. callData · object

Show child attributes

lineItems.callData. quantity · number

Example:

1

lineItems.callData. ADDITIONAL_PROPERTIES · string

Example:

"Your other mint function arguments"

lineItems. metadata · object

Show child attributes

lineItems.metadata. name · string

Example:

"Headless Checkout Demo"

lineItems.metadata. description · string

Example:

"NFT Description"

lineItems.metadata. imageUrl · string

Example:

"https://cdn.io/image.png"

lineItems. quote · object

Show child attributes

lineItems.quote. status · string

Example:

"valid"

lineItems.quote. charges · object

Show child attributes

lineItems.quote.charges. unit · object

Show child attributes

lineItems.quote.charges.unit. amount · string

Example:

"0.0001"

lineItems.quote.charges.unit. currency · string

Example:

"eth"

lineItems.quote.charges. salesTax · object

Sales tax applied to physical product purchases

Show child attributes

lineItems.quote.charges.salesTax. amount · string

Example:

"0.34"

lineItems.quote.charges.salesTax. currency · string

Example:

"usdc"

lineItems.quote.charges. shipping · object

Shipping costs for physical product purchases

Show child attributes

lineItems.quote.charges.shipping. amount · string

Example:

"0"

lineItems.quote.charges.shipping. currency · string

Example:

"usdc"

lineItems.quote. totalPrice · object

Show child attributes

lineItems.quote.totalPrice. amount · string

Example:

"0.0001"

lineItems.quote.totalPrice. currency · string

Example:

"eth"

lineItems. delivery · object

Show child attributes

lineItems.delivery. status · enum<string>

Status of the delivery. 'awaiting-payment': Initial state before payment is made. 'in-progress': Payment received, transaction submitted but not yet completed. 'completed': Successfully delivered with transaction ID and tokens. 'failed': Delivery failed, typically for refunded transactions.

Available options: awaiting-payment, in-progress, completed, failed

Example:

"awaiting-payment"

lineItems.delivery. recipient · object

Show child attributes

lineItems.delivery.recipient. locator · string

Example:

"email:<email_address>:<chain>"

lineItems.delivery.recipient. email · string

Example:

"[e-mail]"

lineItems.delivery.recipient. walletAddress · string

Example:

"0x1234abcd..."

quote · object

Show child attributes

quote. status · enum<string>

Status of the quote. 'requires-physical-address' indicates that a shipping address is required for physical products.

Available options: valid, expired, all-line-items-unavailable, requires-physical-address

Example:

"valid"

quote. quotedAt · string

Example:

"2024-06-07T16:55:44.653Z"

quote. expiresAt · string

Example:

"2024-06-07T17:55:44.653Z"

quote. totalPrice · object

Show child attributes

quote.totalPrice. amount · string

Example:

"0.0001375741"

quote.totalPrice. currency · string

Example:

"eth"

payment · object

Show child attributes

payment. status · enum<string>

Status of the payment. View the status codes for more information.

Available options: requires-kyc, failed-kyc, manual-kyc, awaiting-payment, requires-recipient, requires-crypto-payer-address, failed, in-progress, completed

Example:

"awaiting-payment"

payment. method · string

Example:

"base-sepolia"

payment. currency · string

Example:

"eth"

payment. preparation · object

Show child attributes

payment.preparation. chain · string

Example:

"base-sepolia"

payment.preparation. payerAddress · string

Example:

"0x1234abcd..."

payment.preparation. serializedTransaction · string

Example:

"0x02f90....."