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

# List sales orders



## OpenAPI

````yaml /technical-reference/openapi.yaml get /api/v1/sales-orders
openapi: 3.1.0
info:
  title: adorabl Public API
  version: 1.0.0
  description: >
    Partner REST API. Authenticate with OAuth 2.0 client credentials issued from

    Data & Admin → API clients. Tokens are bound to one adorabl organization.


    Successful resource responses always wrap the payload in `data` — a single

    object for get-by-id, an array plus `nextCursor` for list. Child collections

    such as `addresses`, `contacts`, `uomConversions`, and `lines` are always
    present

    (`[]` when empty). Optional scalars and singular refs (`terms`,

    `customerGroup`, `supplierGroup`, `paymentMethod`, `category`,

    `preferredSupplier`, `baseUom`, `customer`, `warehouse`, `shipTo`, `billTo`)

    are `null` (or a string for supplier terms), never omitted. Do not send

    empty objects (`{}`) for a missing child.
servers:
  - url: https://sherpa-topaz.vercel.app
security: []
paths:
  /api/v1/sales-orders:
    get:
      summary: List sales orders
      operationId: listSalesOrders
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: cursor
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Sales order page
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SalesOrder'
                  nextCursor:
                    type:
                      - string
                      - 'null'
        '401':
          description: Missing or invalid token
        '403':
          description: Missing sales_orders:read scope
      security:
        - bearerAuth: []
components:
  schemas:
    SalesOrder:
      type: object
      required:
        - id
        - orderNumber
        - orderType
        - channel
        - fulfillmentMethod
        - shippingPolicy
        - status
        - checkoutPaymentStatus
        - orderDate
        - currency
        - notes
        - externalId
        - origin
        - subtotal
        - discountTotal
        - shippingTotal
        - taxTotal
        - total
        - createdAt
        - updatedAt
        - customer
        - warehouse
        - shipTo
        - billTo
        - lines
      properties:
        id:
          type: string
          format: uuid
        orderNumber:
          type: string
        orderType:
          type: string
        channel:
          type:
            - string
            - 'null'
        fulfillmentMethod:
          type:
            - string
            - 'null'
        shippingPolicy:
          type:
            - string
            - 'null'
        status:
          type: string
        checkoutPaymentStatus:
          type:
            - string
            - 'null'
        orderDate:
          type: string
          format: date
        currency:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        externalId:
          type:
            - string
            - 'null'
        origin:
          type: string
        subtotal:
          type: number
        discountTotal:
          type: number
        shippingTotal:
          type: number
        taxTotal:
          type: number
        total:
          type: number
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        customer:
          oneOf:
            - $ref: '#/components/schemas/SalesOrderCustomer'
            - type: 'null'
        warehouse:
          oneOf:
            - $ref: '#/components/schemas/SalesOrderWarehouse'
            - type: 'null'
        shipTo:
          oneOf:
            - $ref: '#/components/schemas/SalesOrderAddress'
            - type: 'null'
        billTo:
          oneOf:
            - $ref: '#/components/schemas/SalesOrderAddress'
            - type: 'null'
        lines:
          type: array
          description: Always present. Empty when the order has no lines.
          items:
            $ref: '#/components/schemas/SalesOrderLine'
    SalesOrderCustomer:
      type: object
      required:
        - id
        - customerNumber
        - name
      properties:
        id:
          type: string
          format: uuid
        customerNumber:
          type: string
        name:
          type: string
    SalesOrderWarehouse:
      type: object
      required:
        - id
        - code
        - name
      properties:
        id:
          type: string
          format: uuid
        code:
          type:
            - string
            - 'null'
        name:
          type: string
    SalesOrderAddress:
      type: object
      required:
        - addressId
        - contactName
        - line1
        - line2
        - city
        - state
        - postalCode
        - country
        - email
        - phone
      properties:
        addressId:
          type:
            - string
            - 'null'
        contactName:
          type:
            - string
            - 'null'
        line1:
          type:
            - string
            - 'null'
        line2:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        postalCode:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
    SalesOrderLine:
      type: object
      required:
        - id
        - lineNumber
        - description
        - qtyOrdered
        - qtyFulfilled
        - unitPrice
        - lineTotal
        - procurementMode
        - item
        - uom
      properties:
        id:
          type: string
          format: uuid
        lineNumber:
          type: integer
        description:
          type:
            - string
            - 'null'
        qtyOrdered:
          type: number
        qtyFulfilled:
          type: number
        unitPrice:
          type: number
        lineTotal:
          type: number
        procurementMode:
          type:
            - string
            - 'null'
        item:
          oneOf:
            - $ref: '#/components/schemas/SalesOrderItem'
            - type: 'null'
        uom:
          oneOf:
            - $ref: '#/components/schemas/ItemUom'
            - type: 'null'
    SalesOrderItem:
      type: object
      required:
        - id
        - sku
        - name
      properties:
        id:
          type: string
          format: uuid
        sku:
          type: string
        name:
          type: string
    ItemUom:
      type: object
      required:
        - id
        - code
        - name
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        name:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.