> ## 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 wholesale orders

> Newest first. Page with `limit` and `cursor`. Needs `orders:read` or `orders:write`.



## OpenAPI

````yaml /partner-api/openapi.yaml get /wholesale/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.
paths:
  /wholesale/orders:
    get:
      tags:
        - Wholesale
      summary: List your wholesale orders
      description: >-
        Newest first. Page with `limit` and `cursor`. Needs `orders:read` or
        `orders:write`.
      operationId: listWholesaleOrders
      parameters:
        - $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/WholesaleOrder'
                  next_cursor:
                    type: string
                    nullable: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
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:
    WholesaleOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        order_number:
          type: string
          nullable: true
        status:
          type: string
        payment_status:
          type: string
        external_order_id:
          type: string
          nullable: true
        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
        your_markup_cents:
          type: integer
          description: >-
            What you earn on this order (your prices minus wholesale), before
            VitaRelay's platform fee.
        ship_to:
          type: object
          properties:
            first_name:
              type: string
              nullable: true
            last_name:
              type: string
              nullable: true
            email:
              type: string
              nullable: true
            phone:
              type: string
              nullable: true
            address:
              type: object
              nullable: true
        items:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
                nullable: true
              name:
                type: string
              quantity:
                type: integer
              unit_price_cents:
                type: integer
        tracking:
          type: object
          properties:
            number:
              type: string
              nullable: true
            carrier:
              type: string
              nullable: true
            url:
              type: string
              nullable: true
            status:
              type: string
              nullable: true
            shipped_at:
              type: string
              nullable: true
            delivered_at:
              type: string
              nullable: true
        created_at:
          type: string
          format: date-time
    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'
  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.