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

# List Orders

> 
### Overview

This API lists the **medicine orders** of your workspace, newest first. Orders and **return orders** are listed together: use `kind` to tell them apart (or to filter), and `parentOrderId` to find the returns placed against an order.

All filters are optional. Results are paged with `limit` (default `50`) and `skip` (default `0`).



## OpenAPI

````yaml get /ipd/v1/service/orders
openapi: 3.0.0
info:
  title: Ekacare API & Webhook Documentation
  contact: {}
  version: '1.0'
servers:
  - description: Production
    url: https://api.eka.care
  - description: Stage/Sandbox
    url: https://api.dev.eka.care
security: []
paths:
  /ipd/v1/service/orders:
    get:
      tags:
        - IPD API
      summary: List Orders
      description: >-

        ### Overview


        This API lists the **medicine orders** of your workspace, newest first.
        Orders and **return orders** are listed together: use `kind` to tell
        them apart (or to filter), and `parentOrderId` to find the returns
        placed against an order.


        All filters are optional. Results are paged with `limit` (default `50`)
        and `skip` (default `0`).
      operationId: ListIpdOrders
      parameters:
        - name: auth
          in: header
          required: true
          schema:
            type: string
          example: >-
            eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM
        - name: admissionId
          in: query
          description: Only orders of this IPD admission.
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Only orders in this status.
          required: false
          schema:
            type: string
            enum:
              - CREATED
              - DISPATCHED
              - CANCELLED
              - RETURNED
              - PARTIALLY_RETURNED
        - name: provider
          in: query
          description: Only orders sent to this provider.
          required: false
          schema:
            type: string
            enum:
              - evital
              - dawakhana
        - name: kind
          in: query
          description: Only orders (`order`) or only return orders (`return`).
          required: false
          schema:
            type: string
            enum:
              - order
              - return
        - name: parentOrderId
          in: query
          description: Only return orders placed against this order.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Maximum number of orders to return. Defaults to `50`.
          required: false
          schema:
            type: number
            default: 50
        - name: skip
          in: query
          description: Number of orders to skip (for paging). Defaults to `0`.
          required: false
          schema:
            type: number
            default: 0
      responses:
        '200':
          description: OK — the matching orders.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IpdOrder'
              example:
                success: true
                data:
                  - id: 66f1cd07e4b0a1b2c3d4ef0a
                    admissionId: a1b2c3d4-5678-90ab-cdef-1234567890ab
                    kind: order
                    orderNumber: DW-7Q2K9F3M
                    ipdId: IPD-2026-0042
                    status: DISPATCHED
                    createdBy: '161467756044203'
                    createdByName: Vivek Sharma
                    isCollected: false
                    provider: dawakhana
                    patientName: Ravi Kumar
                    billedTotal: 45
                    fulfilmentType: FULL
                    dispatchedBy: '161467756044204'
                    dispatchedByName: Meena Iyer
                    dispatchedAt: '2026-10-07T12:40:00.000Z'
                    createdAt: '2026-10-07T12:10:00.000Z'
                    updatedAt: '2026-10-07T12:40:00.000Z'
        '400':
          description: >-
            Bad Request. Returns `{ message }` when a query parameter is invalid
            (for example an unknown `status` or a non-numeric `limit`; the
            `message` is currently empty), or `{ success: false, error }` when
            the orders could not be loaded.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/IpdServiceFailure'
                  - $ref: '#/components/schemas/IpdServiceError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpdServiceError'
      deprecated: false
components:
  schemas:
    IpdOrder:
      title: IpdOrder
      type: object
      properties:
        id:
          type: string
          description: Order id.
        admissionId:
          type: string
          description: Id of the IPD admission the order is for.
        kind:
          type: string
          enum:
            - order
            - return
          description: '`order`, or `return` for a return order placed against an order.'
        parentOrderId:
          type: string
          description: For a return order, the id of the order it was placed against.
        externalReturnId:
          type: string
          description: For an eVital return order, eVital's return id.
        orderNumber:
          type: string
          description: >-
            Display order number (Dawakhana's own number, or eVital's order
            number).
        ipdId:
          type: string
          description: Patient IPD case number.
        status:
          type: string
          enum:
            - CREATED
            - DISPATCHED
            - CANCELLED
            - RETURNED
            - PARTIALLY_RETURNED
          description: Order status.
        createdBy:
          type: string
          description: Id of the user who placed the order.
        createdByName:
          type: string
          description: Name of the user who placed the order.
        rxId:
          type: string
          description: Id of the prescription the order is based on.
        isCollected:
          type: boolean
          description: '`true` when the patient has collected the medicines.'
        collectedBy:
          type: string
          description: Id of the user who marked the order collected.
        collectedByName:
          type: string
          description: Name of the user who marked the order collected.
        collectedAt:
          type: string
          description: Date-time the order was marked collected, as an ISO-8601 string.
        provider:
          type: string
          enum:
            - evital
            - dawakhana
          description: Pharmacy provider fulfilling the order.
        pharmacyId:
          type: string
          description: Id of the fulfilling pharmacy.
        patientName:
          type: string
          description: Name of the patient.
        mobile:
          type: string
          description: Mobile number of the patient.
        patientId:
          type: string
          description: Id of the patient.
        doctorName:
          type: string
          description: Name of the prescribing doctor.
        deliveryType:
          type: string
          enum:
            - pickup
            - delivery
          description: How the medicines reach the patient.
        rxPdfUrl:
          type: string
          description: URL of the prescription PDF.
        notes:
          type: string
          description: Order-level remarks.
        billedTotal:
          type: number
          description: Amount billed for the order, set when it is dispatched.
        fulfilmentType:
          type: string
          enum:
            - FULL
            - PARTIAL
          description: Whether the dispatched order was fulfilled fully or partially.
        dispatchNote:
          type: string
          description: Note added when the order was dispatched.
        dispatchedBy:
          type: string
          description: Id of the user who dispatched the order.
        dispatchedByName:
          type: string
          description: Name of the user who dispatched the order.
        dispatchedAt:
          type: string
          description: Date-time the order was dispatched, as an ISO-8601 string.
        cancelledBy:
          type: string
          description: Id of the user who cancelled the order.
        cancelledByName:
          type: string
          description: Name of the user who cancelled the order.
        cancelledAt:
          type: string
          description: Date-time the order was cancelled, as an ISO-8601 string.
        cancelReason:
          type: string
          description: Reason the order was cancelled.
        returnedBy:
          type: string
          description: Id of the user who returned the order.
        returnedByName:
          type: string
          description: Name of the user who returned the order.
        returnedAt:
          type: string
          description: Date-time the order was returned, as an ISO-8601 string.
        returnReason:
          type: string
          description: Reason the order was returned.
        returnedTotal:
          type: number
          description: Total amount returned against the order.
        createdAt:
          type: string
          description: Created date-time as an ISO-8601 string.
        updatedAt:
          type: string
          description: Last-updated date-time as an ISO-8601 string.
    IpdServiceFailure:
      title: IpdServiceFailure
      type: object
      properties:
        success:
          type: boolean
          description: Always `false`.
        error:
          type: string
          description: Human-readable error message.
    IpdServiceError:
      title: IpdServiceError
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.

````

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