---
title: "List Orders"
method: GET
path: "/2022-06-09/orders"
tags: ["Headless"]
---

# List Orders

`GET /2022-06-09/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`

## Query parameters

- `cursor` string
- `limit` integer
- `sort` 'asc' | 'desc'
- `paymentStatus` string[]
- `deliveryStatus` string[]
- `paymentMethod` string[]
- `recipientAddress` string[]
- `orderId` string[]

## Response `200`

Orders retrieved successfully.

- ListOrdersResponse
  - `data` OrderObject[], required — Page of orders in the requested sort order.
    - `orderId` string
    - `phase` string
    - `locale` string
    - `lineItems` object[]
      - `chain` string
      - `executionMode` 'exact-out' | 'exact-in' — Execution mode for the line item. 'exact-out' is used for NFT purchases. 'exact-in' is used for token or memecoin purchases.
      - `quantity` number
      - `callData` object
        - `quantity` number
        - `ADDITIONAL_PROPERTIES` string
      - `executionParams` object — Raw mint arguments for exact-in token or memecoin purchases. Only present when executionMode is 'exact-in'.
      - `maxSlippageBps` string — Slippage tolerance in basis points. Only present when executionMode is 'exact-in'.
      - `metadata` object
        - `name` string
        - `description` string
        - `imageUrl` string
      - `quote` object
        - `status` string
        - `charges` object
          - `unit` object
            - `amount` string
            - `currency` string
          - `salesTax` object — Sales tax applied to physical product purchases
            - `amount` string
            - `currency` string
          - `shipping` object — Shipping costs for physical product purchases
            - `amount` string
            - `currency` string
        - `totalPrice` object
          - `amount` string
          - `currency` string
      - `delivery` object
        - `status` 'awaiting-payment' | 'in-progress' | 'completed' | 'failed' — 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.
        - `rail` 'rtp' | 'fednow' | 'ach-same-day' | 'ach-us' | 'wire' | 'sepa-instant' | 'sepa' | 'spei' | 'ach-co' — Bank rail the payout was routed over. Present on offramp orders once routing has resolved; immutable thereafter.
        - `recipient` object
          - `locator` string
          - `email` string
          - `walletAddress` string
        - `txId` string — The blockchain transaction ID. Only present when status is 'completed'.
        - `tokens` object[] — Array of tokens delivered. Only present when status is 'completed'.
          - `locator` string — Universal token locator in the format chain:address:tokenId
          - `contractAddress` string — The contract address (EVM chains)
          - `tokenId` string — The token ID (EVM chains)
          - `mintHash` string — The mint hash or address (Solana)
          - `quantity` string — The quantity of tokens delivered in smallest units (optional, only for fungible tokens in exact-in mode)
          - `symbol` string — The token symbol (optional, only when quantity is present)
          - `decimals` number — The number of decimals for the token (optional, only when quantity is present)
    - `quote` object
      - `status` 'valid' | 'expired' | 'all-line-items-unavailable' | 'requires-physical-address' — Status of the quote. 'requires-physical-address' indicates that a shipping address is required for physical products.
      - `quotedAt` string
      - `expiresAt` string
      - `totalPrice` object
        - `amount` string
        - `currency` string
    - `payment` object
      - `status` 'requires-kyc' | 'failed-kyc' | 'manual-kyc' | 'awaiting-payment' | 'requires-recipient' | 'requires-crypto-payer-address' | 'failed' | 'in-progress' | 'completed' — Status of the payment. View the status codes for more information.
      - `method` string
      - `currency` string
      - `preparation` object
        - `chain` string
        - `payerAddress` string
        - `serializedTransaction` string
      - `receiptEmail` string — Email address that the receipt will be sent to.
      - `received` object — Payment amount received. Present when payment is completed.
        - `amount` string
        - `currency` string
      - `refunded` object — Refund amount and currency. Present when a refund was issued.
        - `amount` string
        - `currency` string
      - `failureReason` object — Reason for payment failure. Present when payment status is 'failed'.
        - `code` string
        - `message` string
  - `nextCursor` string, nullable — Cursor to fetch the next page. Absent when there are no more results.
  - `previousCursor` string, nullable — Cursor to fetch the previous page. Absent on the first page.

## Other responses

- `400` — Invalid query parameters.
- `403` — Forbidden. Ensure your API key has the `orders.read` scope.

---

[API](https://skmtc.net/crossmint/apis/onramp.md) · [All operations](https://skmtc.net/crossmint/apis/onramp/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crossmint/onramp/revisions/e2143d192130/schema)