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

# Get Orders



## OpenAPI

````yaml GET /api/orders/
openapi: 3.0.0
info:
  title: Vitau API
  x-logo:
    url: https://vitau-logos.s3.us-west-1.amazonaws.com/profile-logo.png
    backgroundColor: '#FFFFFF'
  version: v2
servers:
  - url: https://api-v2.vitau.mx/
security:
  - APIKeyAuth: []
  - JWTAuth: []
  - CookieAuth: []
paths:
  /api/orders/:
    parameters: []
    get:
      tags:
        - api
      operationId: api_orders_list
      parameters:
        - name: search
          in: query
          description: A search term.
          required: false
          schema:
            type: string
        - name: ordering
          in: query
          description: Which field to use when ordering the results.
          required: false
          schema:
            type: string
        - name: patient
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: expected_delivery_date
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: max_delivery_date
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: invoicing_status
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: requires_prescription
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: payment_method
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: is_subscription
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: origin
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: subscription
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: has_enlace_vital
          in: query
          description: ''
          required: false
          schema:
            type: string
        - name: order_status__in
          in: query
          description: Múltiples valores separados por comas.
          required: false
          schema:
            type: string
        - name: payment_status__in
          in: query
          description: Múltiples valores separados por comas.
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: A page number within the paginated result set.
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderList'
components:
  schemas:
    OrderList:
      required:
        - total
        - expected_delivery_date
        - max_delivery_date
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        order_status:
          title: Order status
          type: string
          enum:
            - quoted
            - pending_approval
            - approved
            - in_process
            - ready
            - shipped
            - delivered
            - cancelled
            - delayed
            - shortage
        patient_order_status:
          title: Patient order status
          type: string
          readOnly: true
        patient:
          title: Patient
          type: string
          readOnly: true
        payment_status:
          title: Payment status
          type: string
          enum:
            - unpaid
            - credit
            - paid
            - in_process
            - processing
            - rejected
        products_count:
          title: Products count
          type: string
          readOnly: true
        details:
          title: Details
          type: string
          readOnly: true
        shipping:
          title: Shipping
          type: string
          readOnly: true
        payment_method:
          title: Payment method
          type: string
          readOnly: true
        coupon:
          title: Coupon
          type: string
          readOnly: true
        total:
          title: Total
          type: string
          format: decimal
        origin:
          title: Origin
          type: string
          maxLength: 20
        tags:
          title: Tags
          type: string
          readOnly: true
        expected_delivery_date:
          title: Expected delivery date
          type: string
          format: date-time
        max_delivery_date:
          title: Max delivery date
          type: string
          format: date-time
        subscription:
          title: Subscription
          type: integer
          nullable: true
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
    JWTAuth:
      type: apiKey
      in: header
      name: Bearer
    CookieAuth:
      type: apiKey
      in: header
      name: sessionid

````