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

# Get Inventory Status

> 
### Overview

This API returns the **stock and price** of the given medicines at each pharmacy that tracks inventory (eVital pharmacies). Each result is one pharmacy with the matching medicines' availability, price and packaging.

The in-house pharmacy does not track stock, so it is not included. If one provider cannot be reached, its results are left out.



## OpenAPI

````yaml post /ipd/v1/service/pharmacies/inventory-status
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/pharmacies/inventory-status:
    post:
      tags:
        - IPD API
      summary: Get Inventory Status
      description: >-

        ### Overview


        This API returns the **stock and price** of the given medicines at each
        pharmacy that tracks inventory (eVital pharmacies). Each result is one
        pharmacy with the matching medicines' availability, price and packaging.


        The in-house pharmacy does not track stock, so it is not included. If
        one provider cannot be reached, its results are left out.
      operationId: GetIpdInventoryStatus
      parameters:
        - name: auth
          in: header
          required: true
          schema:
            type: string
          example: >-
            eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJiX2lkIjoiMTIzNDU2IiwiY2xpZW50X2lkIjoiNzg5MCIsImV4dHJhX2ZpZWxkIjoiZXh0cmFfZmllbGRfZGF0YSJ9.q9KzBI6f4l3OyM_EkB5Quq0l9EEMFh5JS-fx3F_PHUM
      requestBody:
        description: The medicines to check.
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - medicineIds
              properties:
                medicineIds:
                  type: array
                  items:
                    type: string
                  description: Ids of the medicines to check.
            example:
              medicineIds:
                - med-paracetamol-500
                - med-amoxicillin-250
      responses:
        '200':
          description: OK — stock per pharmacy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IpdInventoryResult'
              example:
                success: true
                data:
                  - provider: evital
                    pharmacyId: Q2hlbWlzdC0xMjM0
                    pharmacyName: City Medicals
                    inventory:
                      - medicineId: med-paracetamol-500
                        name: Paracetamol 500mg Tablet
                        availableQty: 120
                        mrp: 30
                        price: 27
                        sellInLoose: true
                        packing: Strip
                        packSize: 15 Tablet
                        packingSize: 1 Strip of 15 Tablet
                        size: 15
        '400':
          description: >-
            Bad Request. Returns `{ message }` when the request body failed
            schema validation (for example `medicineIds` is missing; the
            `message` is currently empty), or `{ success: false, error }` when
            the stock 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:
    IpdInventoryResult:
      title: IpdInventoryResult
      type: object
      properties:
        provider:
          type: string
          enum:
            - evital
            - dawakhana
          description: Provider of the pharmacy.
        pharmacyId:
          type: string
          description: Id of the pharmacy.
        pharmacyName:
          type: string
          description: Name of the pharmacy.
        inventory:
          type: array
          description: Stock of the requested medicines at this pharmacy.
          items:
            $ref: '#/components/schemas/IpdInventoryItem'
    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.
    IpdInventoryItem:
      title: IpdInventoryItem
      type: object
      properties:
        medicineId:
          type: string
          description: Id of the medicine.
        name:
          type: string
          description: Name of the medicine.
        availableQty:
          type: number
          description: Stock available.
        mrp:
          type: number
          description: Maximum retail price.
        price:
          type: number
          description: Selling price.
        sellInLoose:
          type: boolean
          description: >-
            `true` when the medicine can be sold per unit, not only as a full
            pack.
        packing:
          type: string
          description: Pack type, for example `Strip`.
        packSize:
          type: string
          description: Units per pack as text, for example `15 Tablet`.
        packingSize:
          type: string
          description: Full packaging label, for example `1 Strip of 15 Tablet`.
        size:
          type: number
          description: Units per pack, for converting between loose and strip quantities.

````

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