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

# Check item availability

> **Permission:** `inventory.availability:read`

Availability for up to 100 items, by id or by identifier.

For a workspace TEST key this reads the workspace's seeded synthetic sandbox — same shape either way.



## OpenAPI

````yaml /openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/availability
openapi: 3.1.0
info:
  title: ClinikEHR API
  version: 1.0.0
  description: >-
    Server-to-server REST API for a clinic's own data, reached with a key the
    clinic (or a developer workspace) creates in the developer portal.


    Authenticate every request with `Authorization: Bearer <key>`. Test keys
    reach only your workspace's own synthetic sandbox; live keys reach the
    clinic that created them. Lists wrap their rows as `{ data, has_more,
    next_cursor }`; single resources are returned directly. Errors are
    `application/problem+json` (RFC 9457) with a stable `code`.


    Write requests accept an `Idempotency-Key` header so a retry never repeats a
    change. See the guides for authentication, permissions, pagination, rate
    limits and retries.
servers:
  - url: https://api.clinikehr.com
security:
  - ApiKey: []
paths:
  /v1/clinics/{clinic_id}/inventory/availability:
    post:
      tags:
        - Inventory
      summary: Check item availability
      description: >-
        **Permission:** `inventory.availability:read`


        Availability for up to 100 items, by id or by identifier.


        For a workspace TEST key this reads the workspace's seeded synthetic
        sandbox — same shape either way.
      operationId: postInventoryAvailability
      parameters:
        - name: clinic_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityRequest'
            example:
              entries:
                - item_id: 9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02
                - system: gtin
                  value: '6001234567890'
      responses:
        '200':
          description: OK. One entry per requested item, in request order.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryAvailability'
              example:
                data:
                  - item_id: 9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02
                    matched: true
                    band: in_stock
                    as_of: '2026-09-20T10:00:00.000Z'
                  - item_id: null
                    matched: false
                    band: null
                    as_of: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - ApiKey: []
components:
  schemas:
    AvailabilityRequest:
      type: object
      additionalProperties: false
      required:
        - entries
      properties:
        entries:
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/AvailabilityRequestEntry'
    InventoryAvailability:
      type: object
      required:
        - matched
      properties:
        item_id:
          type:
            - string
            - 'null'
          format: uuid
        matched:
          type: boolean
        band:
          type:
            - string
            - 'null'
          enum:
            - out
            - low
            - in_stock
            - null
        as_of:
          type:
            - string
            - 'null'
          format: date-time
    AvailabilityRequestEntry:
      description: Exactly one of an item_id, or a {system, value} identifier — never both.
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - item_id
          properties:
            item_id:
              type: string
              format: uuid
        - type: object
          additionalProperties: false
          required:
            - system
            - value
          properties:
            system:
              type: string
              enum:
                - gtin
                - nafdac
                - ndc
                - rxcui
                - partner
            value:
              type: string
    Problem:
      type: object
      description: RFC 9457 application/problem+json.
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - pointer
              - message
            properties:
              pointer:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: >-
        The request failed validation (unknown query parameter, limit out of
        range, malformed body).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or expired key, or the wrong
        secret.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The key or connection lacks the required scope, the plan does not
        include this resource, the request came from an address this key's IP
        allow-list does not permit, a TEST-environment workspace key asked for a
        clinic_id other than its own workspace's sandbox (`sandbox_only`), or a
        LIVE workspace key asked for a real clinic while its workspace's
        verification has lapsed (`not_verified`) — the response never names
        which addresses ARE allowed, nor which clinic actually is the sandbox.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: The record is absent, or out of the key's scope — one message for both.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: Rate limited. See the Retry-After header.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: ehr_live_<keyId>_<secret> or ehr_test_<keyId>_<secret>

````

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