PATCH
/
2022-06-09
/
orders
/
{orderId}
curl --request PATCH \
  --url https://staging.crossmint.com/api/2022-06-09/orders/{orderId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "recipient": {
    "email": "jsmith@example.com",
    "physicalAddress": {
      "name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    }
  },
  "locale": "en-US",
  "payment": {
    "receiptEmail": "jsmith@example.com",
    "method": "arbitrum-sepolia",
    "currency": "eth",
    "payerAddress": "<string>"
  }
}'
{
  "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": "testy@crossmint.com",
          "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

Body

application/json
​
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.

​
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
Example:

"en-US"

​
payment
object

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[]
​
quote
object
​
payment
object

Was this page helpful?

Get OrderCheck Token Support