> ## 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.

# Get an order

> Retrieves a single order for a vendor.

### Notes

All orders returned have been paid for.



## OpenAPI

````yaml https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{id}
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/{id}:
    get:
      tags:
        - Orders
      summary: Get an order
      description: |-
        Retrieves a single order for a vendor.

        ### Notes

        All orders returned have been paid for.
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                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
                  requirement_schema:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: select
                            description:
                              type: string
                            is_required:
                              type: boolean
                            multiple:
                              type: boolean
                            options:
                              type: array
                              items:
                                type: object
                                properties:
                                  label:
                                    type: string
                                    minLength: 1
                                  value:
                                    type: string
                                    minLength: 1
                                required:
                                  - label
                                  - value
                              minItems: 1
                          required:
                            - id
                            - name
                            - type
                            - is_required
                            - options
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: target
                            description:
                              type: string
                            is_required:
                              type: boolean
                            target_type:
                              type: string
                              enum:
                                - any
                                - postcode
                          required:
                            - id
                            - name
                            - type
                            - is_required
                            - target_type
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: file
                            description:
                              type: string
                            is_required:
                              type: boolean
                            accept:
                              type: string
                            template_url:
                              type: string
                            example_url:
                              type: string
                          required:
                            - id
                            - name
                            - type
                            - is_required
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: text
                            description:
                              type: string
                            is_required:
                              type: boolean
                            min_length:
                              type: integer
                              exclusiveMinimum: 0
                            max_length:
                              type: integer
                              exclusiveMinimum: 0
                            sub_type:
                              type: string
                              enum:
                                - email
                                - tel
                                - url
                          required:
                            - id
                            - name
                            - type
                            - is_required
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: text_area
                            description:
                              type: string
                            is_required:
                              type: boolean
                            min_length:
                              type: integer
                              exclusiveMinimum: 0
                            max_length:
                              type: integer
                              exclusiveMinimum: 0
                            default_value:
                              type: string
                          required:
                            - id
                            - name
                            - type
                            - is_required
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            name:
                              type: string
                              minLength: 1
                            type:
                              type: string
                              const: rich_text
                            description:
                              type: string
                            is_required:
                              type: boolean
                            default_value:
                              type: string
                          required:
                            - id
                            - name
                            - type
                            - is_required
                    description: The requirements schema for the order.
                  requirement_meta:
                    type: object
                    additionalProperties: {}
                    description: >-
                      The requirements submitted by the customer. Each key
                      should map to a requirement ID.
                  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
                  kpis:
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        value:
                          type:
                            - number
                            - 'null'
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                        - id
                        - name
                        - value
                        - created_at
                        - updated_at
                  results:
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                        - id
                        - title
                        - created_at
                        - updated_at
                required:
                  - id
                  - price
                  - status
                  - created_at
                  - updated_at
                  - requirements_due
                  - requirements_submitted
                  - start_date
                  - end_date
                  - requirement_schema
                  - requirement_meta
                  - parent_order
                  - product
                  - package
                  - org
                  - location
                  - kpis
                  - results
                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'
                  requirement_schema:
                    - id: link
                      name: Email Link
                      type: text
                      description: >-
                        URL you want embedded into the email for a call to
                        action.
                      is_required: true
                  requirement_meta:
                    link: http://www.example.com
                  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
                  kpis:
                    - id: evJcYq2GgBtdoVxa
                      name: Schools Engaged
                      value: 2
                      created_at: '2024-08-23T19:10:23.266295+00:00'
                      updated_at: '2024-08-23T19:10:23.266295+00:00'
                    - id: mxhTwZdeIxA2wBUx
                      name: Emails Collected
                      value: null
                      created_at: '2024-08-23T19:10:23.266295+00:00'
                      updated_at: '2024-08-23T19:10:23.266295+00:00'
                  results:
                    - id: res_abc123
                      title: connections.csv
                      created_at: '2024-08-23T19:26:44.583043+00:00'
                      updated_at: '2024-08-23T19:26:44.583043+00:00'
                    - id: res_abc123
                      title: headshot.png
                      created_at: '2024-08-23T19:25:41.605688+00:00'
                      updated_at: '2024-08-23T19:25:41.605688+00:00'
        '404':
          description: Order not found
      security:
        - apiKeyHeader: []
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: API-Key
      description: API Key for the vendor

````