> ## Documentation Index > Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. **API scope required**: `orders.read` ## OpenAPI ````yaml get /2022-06-09/orders openapi: 3.0.1 info: description: | N/A version: 1.0.0 title: Headless Checkout contact: name: Crossmint Headless Checkout APIs url: https://www.crossmint.com email: support@crossmint.com servers: - url: https://staging.crossmint.com/api description: Staging environment (testnets) - url: https://www.crossmint.com/api description: Production environment (mainnets) security: [] tags: - name: Headless Checkout description: APIs to use the headless checkout paths: /2022-06-09/orders: get: tags: - Headless summary: List Orders description: > 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. **API scope required**: `orders.read` operationId: list-orders parameters: - name: cursor in: query required: false description: >- Opaque cursor from a previous response's `nextCursor` or `previousCursor`. Omit on the first request. schema: type: string - name: limit in: query required: false description: Maximum number of orders to return. Minimum 1, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 30 example: 30 - name: sort in: query required: false description: Sort direction applied to `createdAt`. schema: type: string enum: - asc - desc default: desc responses: '200': description: Orders retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ListOrdersResponse' '400': description: Invalid query parameters. content: application/json: schema: $ref: '#/components/schemas/400Response' '403': description: Forbidden. Ensure your API key has the `orders.read` scope. content: application/json: schema: $ref: '#/components/schemas/403Response' security: - apiKey: [] components: schemas: ListOrdersResponse: type: object required: - data properties: data: type: array description: Page of orders in the requested sort order. items: $ref: '#/components/schemas/OrderObject' nextCursor: type: string nullable: true description: >- Cursor to fetch the next page. Absent when there are no more results. previousCursor: type: string nullable: true description: Cursor to fetch the previous page. Absent on the first page. 400Response: type: object properties: error: type: boolean example: true message: type: string description: Human-readable error message describing what went wrong code: type: string description: Machine-readable error code for programmatic handling enum: - single_purchase_exceeded - daily_transaction_exceeded - token_daily_volume_exceeded parameters: type: object description: Additional parameters providing context for the error properties: amount: type: string description: Transaction amount that caused the error limit: type: string description: The limit that was exceeded hoursUntilReset: type: string description: Hours until the limit resets remainingAmount: type: string description: Remaining amount available before hitting the limit 403Response: type: object properties: error: type: boolean example: true message: type: string example: Malformed API key. / API key provided doesn't have required scopes. OrderObject: type: object properties: orderId: type: string example: b2959ca5-65e4-466a-bd26-1bd05cb4f837 phase: type: string example: payment locale: type: string example: en-US lineItems: type: array items: type: object properties: chain: type: string example: polygon-amoy quantity: type: number example: 1 callData: type: object properties: quantity: type: number example: 1 ADDITIONAL_PROPERTIES: type: string example: Your other mint function arguments metadata: type: object properties: name: type: string example: Headless Checkout Demo description: type: string example: NFT Description imageUrl: type: string example: https://cdn.io/image.png quote: type: object properties: status: type: string example: valid charges: type: object properties: unit: type: object properties: amount: type: string example: '0.0001' currency: type: string example: eth salesTax: type: object description: Sales tax applied to physical product purchases properties: amount: type: string example: '0.34' currency: type: string example: usdc shipping: type: object description: Shipping costs for physical product purchases properties: amount: type: string example: '0' currency: type: string example: usdc totalPrice: type: object properties: amount: type: string example: '0.0001' currency: type: string example: eth delivery: type: object properties: status: type: string enum: - awaiting-payment - in-progress - completed - failed description: >- 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. example: awaiting-payment recipient: type: object properties: locator: type: string example: email:: email: type: string example: testy@crossmint.com walletAddress: type: string example: 0x1234abcd... txId: type: string description: >- The blockchain transaction ID. Only present when status is 'completed'. example: >- 0x2e69f11dae7869b92e3d5eaf4cadd50c48b5c6803d1232815f979d744521ad4c tokens: type: array description: >- Array of tokens delivered. Only present when status is 'completed'. items: type: object properties: locator: type: string description: >- Universal token locator in the format chain:address:tokenId example: polygon:0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA:3 contractAddress: type: string description: The contract address (EVM chains) example: '0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA' tokenId: type: string description: The token ID (EVM chains) example: '3' mintHash: type: string description: The mint hash or address (Solana) example: MintHashAbc123 quantity: type: string description: >- The quantity of tokens delivered in smallest units (optional, only for fungible tokens in exact-in mode) example: '1500000' symbol: type: string description: >- The token symbol (optional, only when quantity is present) example: USDC decimals: type: number description: >- The number of decimals for the token (optional, only when quantity is present) example: 6 quote: type: object properties: status: type: string enum: - valid - expired - all-line-items-unavailable - requires-physical-address description: >- Status of the quote. 'requires-physical-address' indicates that a shipping address is required for physical products. example: valid quotedAt: type: string example: '2024-06-07T16:55:44.653Z' expiresAt: type: string example: '2024-06-07T17:55:44.653Z' totalPrice: type: object properties: amount: type: string example: '0.0001375741' currency: type: string example: eth payment: type: object properties: status: type: string enum: - requires-kyc - failed-kyc - manual-kyc - awaiting-payment - requires-recipient - requires-crypto-payer-address - failed - in-progress - completed description: >- Status of the payment. View the status codes for more information. example: awaiting-payment method: type: string example: base-sepolia currency: type: string example: eth preparation: type: object properties: chain: type: string example: base-sepolia payerAddress: type: string example: 0x1234abcd... serializedTransaction: type: string example: 0x02f90..... securitySchemes: apiKey: type: apiKey name: X-API-KEY in: header ````