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

# List orders

> Lists orders for a vendor.

### Notes

Orders are sorted by payment date. The most recent orders are shown first. All orders returned have been paid for.



## OpenAPI

````yaml https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders
openapi: 3.1.0
info:
  title: LOMA Vendor API
  version: 1.0.0
  description: >-
    API for managing vendor data on LOMA.

    ### Authentication


    Your API Key should be passed in the `API-Key` header formatted as
    `KEY_ID:KEY_SECRET`.


    Vendors can create API keys in the LOMA console.
  contact:
    email: support@lomaplatform.com
servers:
  - url: https://console.lomaplatform.com
security: []
paths:
  /api/vendor/v1/orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: >-
        Lists orders for a vendor.


        ### Notes


        Orders are sorted by payment date. The most recent orders are shown
        first. All orders returned have been paid for.
      parameters:
        - in: query
          name: page
          schema:
            type: number
            exclusiveMinimum: 0
            default: 1
        - in: query
          name: page_size
          schema:
            type: number
            exclusiveMinimum: 0
            maximum: 1000
            default: 100
        - in: query
          name: status
          schema:
            type: string
            enum:
              - pending_payment
              - pending
              - confirmed
              - in_progress
              - completed
              - cancelled
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    price:
                      type: string
                    status:
                      type: string
                      enum:
                        - pending_payment
                        - pending
                        - confirmed
                        - in_progress
                        - completed
                        - cancelled
                    created_at:
                      type: string
                    updated_at:
                      type: string
                    requirements_due:
                      type: string
                    requirements_submitted:
                      type:
                        - string
                        - 'null'
                    start_date:
                      type: string
                    end_date:
                      type: string
                    parent_order:
                      type: object
                      properties:
                        id:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        invoice_id:
                          type: string
                        payment_date:
                          type: string
                      required:
                        - id
                        - created_at
                        - updated_at
                        - invoice_id
                        - payment_date
                    product:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                        - id
                        - name
                    package:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                        - id
                        - name
                    org:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                        - id
                        - name
                    location:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        address_line_1:
                          type: string
                        address_line_2:
                          type:
                            - string
                            - 'null'
                        address_city:
                          type: string
                        address_state:
                          type: string
                        address_zip:
                          type: string
                        address_country:
                          type: string
                      required:
                        - id
                        - name
                        - address_line_1
                        - address_line_2
                        - address_city
                        - address_state
                        - address_zip
                        - address_country
                  required:
                    - id
                    - price
                    - status
                    - created_at
                    - updated_at
                    - requirements_due
                    - requirements_submitted
                    - start_date
                    - end_date
                    - parent_order
                    - product
                    - package
                    - org
                    - location
                example:
                  - id: i_abc123
                    price: '575.00'
                    status: completed
                    created_at: '2024-08-23 19:10:23.266295+00'
                    updated_at: '2024-08-23 19:24:45.962+00'
                    requirements_due: '2024-09-10'
                    requirements_submitted: '2024-08-23'
                    start_date: '2024-10-01'
                    end_date: '2024-10-01'
                    parent_order:
                      id: ABC123
                      created_at: '2024-08-23 19:10:23.266295+00'
                      updated_at: '2024-08-23 19:24:46.059+00'
                      invoice_id: in_abc123
                      payment_date: '2024-08-23'
                    product:
                      id: prod_abc123
                      name: Phone Outreach for School Fundraisers
                    package:
                      id: pkg_abc123
                      name: 60 Connections
                    org:
                      id: org_abc123
                      name: LOMA
                    location:
                      id: abc123
                      name: LOMA HQ
                      address_line_1: 1234 Main St
                      address_line_2: null
                      address_city: Atlanta
                      address_state: Georgia
                      address_zip: '30303'
                      address_country: US
      security:
        - apiKeyHeader: []
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: API-Key
      description: API Key for the vendor

````