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

# List your network's orders

> Every order placed by, or credited to, the accounts in your network: the practices and clinics you invited, your Rep Partners and theirs, plus orders you placed yourself and credited to a Rep Partner (`on_behalf_of` on `POST /wholesale/orders`). Your own orders that are not credited to a partner are not included; they are in `GET /wholesale/orders`. Newest first. Each order carries `earnings`: what YOUR organization earns on it, by type. Wholesale cost and platform margin are never returned. Needs `orders:read` (or `orders:write`). With a test key the list is always empty.



## OpenAPI

````yaml /partner-api/openapi.yaml get /network/orders
openapi: 3.1.0
info:
  title: VitaRelay Partner API
  version: 1.0.0
  description: >-
    The Partner API is for rep organizations (a Vita Rep, or a dual Rep + Clinic
    account) that recruit clinics and other reps. Create the invite you would
    otherwise send from the "Refer a Tele Clinic" form, get the signup link
    back, track whether it was accepted, and revoke it.
servers:
  - url: https://vitarelay.com/api/public/partner/v1
security:
  - bearerAuth: []
tags:
  - name: Wholesale
    description: >-
      Order research-use products for your own customers at VitaRelay's
      wholesale price, charged to your card on file. You show your own prices
      and collect from your customer yourself. Rep accounts only.
  - name: Store
    description: >-
      Sell research-use products to your own customers from your own landing
      page, using VitaRelay for fulfillment and payment processing. Customers
      are not patients: no patient, intake or prescription is created. Rep
      accounts only. Needs `store:read` / `store:write`.
  - name: Invites
    description: Clinic and rep invites sent by your organization.
  - name: Network
    description: Read the orders of the accounts in your network. Rep accounts only.
paths:
  /network/orders:
    get:
      tags:
        - Network
      summary: List your network's orders
      description: >-
        Every order placed by, or credited to, the accounts in your network: the
        practices and clinics you invited, your Rep Partners and theirs, plus
        orders you placed yourself and credited to a Rep Partner (`on_behalf_of`
        on `POST /wholesale/orders`). Your own orders that are not credited to a
        partner are not included; they are in `GET /wholesale/orders`. Newest
        first. Each order carries `earnings`: what YOUR organization earns on
        it, by type. Wholesale cost and platform margin are never returned.
        Needs `orders:read` (or `orders:write`). With a test key the list is
        always empty.
      operationId: listNetworkOrders
      parameters:
        - name: rep
          in: query
          required: false
          description: >-
            Only orders credited to this Rep Partner (organization id). `404
            rep_not_found` when it is not in your network.
          schema:
            type: string
            format: uuid
        - name: account_id
          in: query
          required: false
          description: >-
            Only orders placed by this account (an `accepted_org_id`). `404
            account_not_found` when it is not in your network.
          schema:
            type: string
            format: uuid
        - name: payment_status
          in: query
          required: false
          schema:
            type: string
            enum:
              - paid
              - unpaid
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of orders.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NetworkOrder'
                  next_cursor:
                    type: string
                    nullable: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Page size. Default 50, maximum 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The `next_cursor` value returned by the previous page.
      schema:
        type: string
        format: date-time
  schemas:
    NetworkOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        order_number:
          type: string
          nullable: true
        status:
          type: string
        payment_status:
          type: string
        channel:
          type: string
          nullable: true
          description: >-
            Where the order was placed, for example `partner_api` for orders
            posted with `POST /wholesale/orders`.
        external_order_id:
          type: string
          nullable: true
          description: Your `external_order_id`, for orders you posted yourself.
        created_at:
          type: string
          format: date-time
        account:
          type: object
          description: >-
            The account that placed the order. For an order you placed and
            credited to a partner, this is you (`is_you` is true).
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              nullable: true
            is_you:
              type: boolean
        rep:
          type: object
          nullable: true
          description: The rep the sale is credited to.
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              nullable: true
            is_you:
              type: boolean
        invite_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            The invite the ordering account accepted, when it came from one of
            your invites.
        external_invite_id:
          type: string
          nullable: true
        items:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
                format: uuid
                nullable: true
              name:
                type: string
              product_type:
                type: string
                nullable: true
                description: '`rnd`, `503a`, `503b` and so on.'
              quantity:
                type: integer
              unit_price_cents:
                type: integer
        subtotal_cents:
          type: integer
          nullable: true
        shipping_cents:
          type: integer
          nullable: true
        tax_cents:
          type: integer
          nullable: true
        total_cents:
          type: integer
          nullable: true
        currency:
          type: string
        earnings:
          type: array
          description: >-
            What your organization earns on this order, by type. Empty until the
            order is paid.
          items:
            type: object
            properties:
              type:
                type: string
              amount_cents:
                type: integer
              status:
                type: string
        earnings_cents:
          type: integer
          description: The sum of `earnings`.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing, invalid or revoked API key (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        `insufficient_scope` (the key lacks the scope) or `not_available` (your
        organization is not a rep or dual Rep + Clinic account).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationFailed:
      description: >-
        `validation_failed` — a field is missing or invalid; the message says
        which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        VitaRelay API key (`vr_live_...` or `vr_test_...`) with the `invites:*`
        scopes.

````

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