> ## Documentation Index
> Fetch the complete documentation index at: https://staging-docs.arcade.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List orders

> Lists your orders, newest first.



## OpenAPI

````yaml /openapi.json post /orders/list
openapi: 3.1.1
info:
  title: Arcade API
  version: '1'
  description: >-
    Generate patterns and order them as manufactured products. Every request is
    a POST with a JSON body.
servers:
  - url: https://platform.arcade.ai/v1
    description: Production
  - url: https://staging-platform.arcade.ai/v1
    description: Staging
security:
  - apiKey: []
tags:
  - name: Patterns
    description: Patterns you generate.
  - name: Refine
    description: Edit, recolor, crop and extend patterns.
  - name: Jobs
    description: Long-running work.
  - name: References
    description: Images that guide generation.
  - name: Models
    description: The models that generate patterns.
  - name: Categories
    description: Product types and their options.
  - name: Products
    description: Products made from your patterns.
  - name: Checkouts
    description: Checkouts for ordering products.
  - name: Orders
    description: Your orders.
paths:
  /orders/list:
    post:
      tags:
        - Orders
      summary: List orders
      description: Lists your orders, newest first.
      operationId: orders.list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cursor:
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: 'null'
                  description: nextCursor of the previous page; omit for the first page
                limit:
                  type: integer
                  minimum: 1
                  maximum: 50
                  default: 20
                status:
                  enum:
                    - ordered
                    - cadReview
                    - sampleReview
                    - inProduction
                    - inReview
                    - inCorrection
                    - approved
                    - updatedInfo
                    - shipped
                    - delivered
                    - fulfilled
                    - refunded
                  type: string
                  description: Only orders in this status
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        orderId:
                          type: string
                          pattern: ^\d+$
                          description: Order ID
                        orderCode:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: The Arcade order code; null when there is none
                        orderNumber:
                          type: string
                          description: Display name, e.g. "#1042"
                        status:
                          enum:
                            - ordered
                            - cadReview
                            - sampleReview
                            - inProduction
                            - inReview
                            - inCorrection
                            - approved
                            - updatedInfo
                            - shipped
                            - delivered
                            - fulfilled
                            - refunded
                          type: string
                          description: Derived from the makers' fulfillment and any refunds
                        placedAt:
                          type: string
                          format: date-time
                        total:
                          type: object
                          properties:
                            amount:
                              type: string
                              description: Decimal amount, e.g. "48.00"
                            currency:
                              type: string
                              description: ISO 4217 code
                          required:
                            - amount
                            - currency
                        itemCount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        imageUrl:
                          anyOf:
                            - type: string
                              format: uri
                            - type: 'null'
                          description: >-
                            Short-lived; read again to renew. Host not
                            guaranteed.
                        lines:
                          type: array
                          items:
                            type: object
                            properties:
                              productId:
                                anyOf:
                                  - type: string
                                    minLength: 1
                                    description: Opaque product ID
                                  - type: 'null'
                                description: >-
                                  Set when the line is one of the caller's
                                  products
                              title:
                                type: string
                              selectionLabel:
                                type: string
                                description: >-
                                  Human-readable summary of the line's
                                  selection; the store's line title when the
                                  product is not the caller's
                              quantity:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              total:
                                anyOf:
                                  - type: object
                                    properties:
                                      amount:
                                        type: string
                                        description: Decimal amount, e.g. "48.00"
                                      currency:
                                        type: string
                                        description: ISO 4217 code
                                    required:
                                      - amount
                                      - currency
                                  - type: 'null'
                                description: After line discounts
                              imageUrl:
                                anyOf:
                                  - type: string
                                    format: uri
                                  - type: 'null'
                                description: >-
                                  Short-lived; read again to renew. Host not
                                  guaranteed.
                              makerName:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                            required:
                              - productId
                              - title
                              - selectionLabel
                              - quantity
                              - total
                              - imageUrl
                              - makerName
                      required:
                        - orderId
                        - orderCode
                        - orderNumber
                        - status
                        - placedAt
                        - total
                        - itemCount
                        - imageUrl
                        - lines
                    description: Newest first
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      Opaque; pass back unchanged. Null on the last page. With a
                      status, a page can hold fewer than limit orders.
                required:
                  - items
                  - nextCursor
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings → API keys in Arcade Studio.

````