v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Headless

List Orders

Returns a paginated list of orders for your project, sorted by creation date (newest first by default). Use the nextCursor or previousCursor returned in the response to navigate between pages.

Optional filters accept comma-separated values and repeated query parameters (maximum 20 terms per filter). Keep the same filter params when following cursors.

API scope required: orders.read

get/2022-06-09/orders

Query parameters

cursorstring

Opaque cursor from a previous response's nextCursor or previousCursor. Omit on the first request.

limitinteger

Maximum number of orders to return. Minimum 1, maximum 100.

sort'asc' | 'desc'

Sort direction applied to createdAt.

paymentStatusstring[]

Comma-separated list of payment statuses. Orders matching any value are returned. Maximum 20 terms per parameter. Keep filter params stable when paginating with cursors.

deliveryStatusstring[]

Comma-separated list of delivery statuses. Orders matching any value are returned. Maximum 20 terms per parameter. Keep filter params stable when paginating with cursors.

paymentMethodstring[]

Comma-separated list of currencies matched against payment.totalPaid.currency. The fiat value matches all fiat payment methods. Maximum 20 terms per parameter.

recipientAddressstring[]

Exact match on buyer wallet address (buyer.mintTo). Supports EVM and Solana addresses. Maximum 20 terms per parameter.

orderIdstring[]

Exact match on order ID (orderIdentifier). Maximum 20 terms per parameter.

Response

Orders retrieved successfully.

nextCursorstring nullable

Cursor to fetch the next page. Absent when there are no more results.

previousCursorstring nullable

Cursor to fetch the previous page. Absent on the first page.

Example response

{
  "data": [
    {
      "orderId": "b2959ca5-65e4-466a-bd26-1bd05cb4f837",
      "phase": "payment",
      "locale": "en-US",
      "lineItems": [
        {
          "chain": "polygon-amoy",
          "executionMode": "exact-out",
          "quantity": 1,
          "callData": {
            "quantity": 1,
            "ADDITIONAL_PROPERTIES": "Your other mint function arguments"
          },
          "maxSlippageBps": "50",
          "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..."
            },
            "txId": "0x2e69f11dae7869b92e3d5eaf4cadd50c48b5c6803d1232815f979d744521ad4c",
            "tokens": [
              {
                "locator": "polygon:0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA:3",
                "contractAddress": "0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA",
                "tokenId": "3",
                "mintHash": "MintHashAbc123",
                "quantity": "1500000",
                "symbol": "USDC",
                "decimals": 6
              }
            ]
          }
        }
      ],
      "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....."
        },
        "receiptEmail": "user@example.com",
        "received": {
          "amount": "0.50",
          "currency": "usd"
        },
        "refunded": {
          "amount": "0.50",
          "currency": "usd"
        },
        "failureReason": {
          "code": "payment-declined",
          "message": "The payment was declined by the issuer."
        }
      }
    }
  ]
}

All 99 operations