> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.bitbybit.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# List Orders

> Retrieve a paginated list of orders for your company.



## OpenAPI

````yaml GET /orders
openapi: 3.1.0
info:
  title: bitbybit Open API
  description: >-
    The bitbybit Open API provides programmatic access to your bitbybit data
    including customers, orders, and products.
  version: 1.0.0
  contact:
    name: bitbybit Support
    url: https://bitbybit.studio
servers:
  - url: https://api.bitbybit.studio/customer/api/open/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: Retrieve a paginated list of orders for your company.
      operationId: listOrders
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: search
          in: query
          schema:
            type: string
          description: Search by order ID or customer name
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - archived
              - cancelled
              - refunded
        - name: fulfillmentStatus
          in: query
          schema:
            type: string
            enum:
              - unfulfilled
              - fulfilled
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Order'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
components:
  schemas:
    Order:
      type: object
      properties:
        id:
          type: string
        orderId:
          type: string
          nullable: true
        orderNumber:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - active
            - archived
            - cancelled
            - refunded
        fulfillmentStatus:
          type: string
          enum:
            - unfulfilled
            - fulfilled
        financialStatus:
          type: string
          enum:
            - pending
            - paid
            - refunded
        total:
          type: number
        currency:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
        customer:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
              nullable: true
            lastName:
              type: string
              nullable: true
            email:
              type: string
              nullable: true
            phoneNumber:
              type: string
              nullable: true
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
        shippingAddress:
          $ref: '#/components/schemas/Address'
        tags:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        hasNextPage:
          type: boolean
    LineItem:
      type: object
      properties:
        id:
          type: string
        quantity:
          type: integer
        price:
          type: number
        title:
          type: string
        productVariant:
          $ref: '#/components/schemas/ProductVariant'
    Address:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        address1:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        province:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        zip:
          type: string
          nullable: true
    ProductVariant:
      type: object
      properties:
        id:
          type: string
        key:
          type: string
        price:
          type: number
        compareAtPrice:
          type: number
          nullable: true
        inventorySku:
          type: string
          nullable: true
        media:
          type: string
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Create one in Settings > Developer.

````