Shepherd Veterinary Software Inventory Tracking API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Inventory Tracking API
  description: 'Production Base URL: https://open-api.shepherd.vet/pav2/


    Production App URL: https://app.shepherd.vet/


    Production Documentation URL: https://app.shepherd.vet/swagger/


    Sandbox Base URL: https://demo-open-api.shepherd.vet/pav2/


    Sandbox App URL: https://demo.shepherd.vet/


    Sandbox Documentation URL: https://demo.shepherd.vet/swagger


    Authorization: The integration is authorized by providing two headers in the API call


    X-Integration-Private-Key - this contains the private key from your credentials

    X-Integration-Public-Key - this contains the public key from your credentials


    Additionally, for all requests other than Clinic, the X-Clinic-Id header must be provided with the value of the clinic entity id for which you are running the API requests. You can get the entity id by calling the Clinic endpoint. If authorization fails, the request returns HTTP status 401 and the response body is one of the messages below. Missing X-Integration-Public-Key header - the public key header is absent from the request. Missing X-Integration-Private-Key header - the private key header is absent from the request. Missing X-Clinic-Id header - the clinic identifier header is absent, and the endpoint is clinic scoped. Incorrect API keys provided - both key headers were supplied, but the public key matches no integration, or the private key is not valid for that integration. Integration not enabled for the provided clinic - the key pair is valid, but the integration is not enabled and active for the clinic supplied in X-Clinic-Id. NEW: Each API call will count against your RPH and RPM limits. Once you exhaust those limits, requests will start returning HTTP status 429. The RPH is set to 12000 and RPM to 800 (subject to change). Where an endpoint supports searchQuery, a query longer than 500 characters may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG, and a query with more than 10 words may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES. NOTE: Since this API is WIP, we would be happy to hear any feedback and to implement additional filtering/sorting options etc. **Endpoints:

    All endpoints are POST requests that accept JSON bodies. The common request properties for all endpoints are:**


    rpp::int - The number of items to return per page. The max is 1000. Defaults to 10. page::int - The page number. Defaults to 1. sort::string - Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". All top-level properties should be sortable, only some nested-fields work and you should probably not use them until this API reaches production and we settle on which nested-field sortings we will support. Default depends on endpoint, usually "id|asc". embed::string - Comma-separated values for nested-fields you want to fetch (eg. "clientPhones,clientPhones.phoneType" on Client endpoint). If a specific embed is not requested, the response will contain either null or an empty array for that value. No default. dateCreatedFrom::date

    dateCreatedTo::date

    dateUpdatedFrom::date

    dateUpdatedTo::date

    - Date range filters for either the creation date or last update date. - You can pass in either one end or both of them. *


    * Only the date filters listed on an endpoint''s request model are supported; sending another one, or a ''From'' later than its ''To'', returns HTTP status 400. The request responses will come back as a JSON object. The common response properties for all endpoints are:


    embed::string - Lists the embed used in the request. This may sometimes be different from what you sent in, if in the future we add that some embeds get set automatically on certain endpoints

    links::object[] - Always empty, a leftover from the internal framework we use on our web API. Will be removed in the future if possible so do not rely on this

    page::int - Which page was fetched.'
servers:
- url: https://open-api.shepherd.vet
tags:
- name: InventoryTracking
paths:
  /pav2/open-api-inventory/trackings:
    post:
      tags:
      - InventoryTracking
      summary: Retrieves {OpenApiInventoryTrackingController.InventoryTracking} resources that…
      description: 'Returns the lots an inventory item is stocked in. Lot status is carried by `isArchived`, which is

        filterable: omit it to receive active and archived lots together, send `false` for active only or

        `true` for archived only. Expiry is returned as lot data rather than a status — auditing it is the

        consumer''s responsibility.


        Embedding `inventoryTrackings` on `POST /pav2/open-api-inventory-product-settings` returns only

        active lots; use this endpoint when archived lots are needed.


        A clinic that does not track lots returns `400 Bad Request` rather than an empty collection —

        the lot rows such a clinic holds are left over from before the setting was turned off and are

        not maintained. Read `isInventoryTrackingEnabled` from `POST /pav2/open-api-clinics` first.


        Example Request

        {

        "embed": "unitOfMeasure",

        "inventoryProductSettingIds": "dcfd5e42-d35b-4f78-bd12-5b2a3e12e4a7",

        "isArchived": false

        }'
      operationId: OpenApiInventoryTrackingGet
      parameters:
      - name: x-integration-public-key
        in: header
        description: Your public API key
        required: true
        schema:
          type: string
      - name: x-integration-private-key
        in: header
        description: Your private API key
        required: true
        schema:
          type: string
      - name: x-clinic-id
        in: header
        description: The clinic uuid identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInventoryTrackingController.InventoryTracking'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInventoryTrackingController.InventoryTracking'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInventoryTrackingController.InventoryTracking'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiInventoryTrackingController.InventoryTrackingFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiInventoryTrackingController.InventoryTrackingFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiInventoryTrackingController.InventoryTrackingFilterModel'
        description: The model.
        required: true
components:
  schemas:
    OpenApiInventoryTrackingController.InventoryTracking:
      description: InventoryTracking response model. Represents a lot an inventory item is stocked in.
      type: object
      properties:
        bottleNumber:
          description: Bottle number assigned to the lot.
          type: string
        cost:
          format: double
          description: Unit cost recorded on the lot.
          type: number
        currentQuantity:
          format: double
          description: Quantity currently remaining on the lot.
          type: number
        hasInitialCount:
          description: Flag indicating whether the lot was created with an initial count.
          type: boolean
        initialCount:
          format: double
          description: Quantity the lot was created with.
          type: number
        inventoryIntegrationId:
          format: uuid
          description: Unique identifier representing the related inventory integration.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        inventoryProductSettingId:
          format: uuid
          description: Unique identifier representing the inventory item the lot belongs to.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isArchived:
          description: Lot status. Archived lots are excluded when embedding lots on the inventory item endpoint.
          type: boolean
        isDefaultLot:
          description: Flag indicating whether this is the item's default lot.
          type: boolean
        isInitialLot:
          description: Flag indicating whether this is the item's initial lot.
          type: boolean
        lotExpirationDate:
          format: date-time
          description: Lot expiration date. Expiry is lot data, not a status value.
          type: string
        lotNumber:
          description: Lot number.
          type: string
        manufacturer:
          description: Manufacturer assigned to the lot.
          type: string
        serialNumber:
          description: Serial number assigned to the lot.
          type: string
        unitOfMeasure:
          $ref: '#/components/schemas/OpenApiInventoryTrackingController.UnitOfMeasure'
          description: Object representing the unit of measure the lot is stocked in.
        unitOfMeasureId:
          format: uuid
          description: Unique identifier representing the unit of measure the lot is stocked in.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        unitType:
          $ref: '#/components/schemas/OpenApiInventoryTrackingController.UnitOfMeasure'
          description: Object representing the unit type of the lot.
        unitTypeId:
          format: uuid
          description: Unique identifier representing the unit type of the lot.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        units:
          format: double
          description: Number of units on the lot.
          type: number
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiInventoryTrackingController.UnitOfMeasure:
      description: UnitOfMeasure response model.
      type: object
      properties:
        abrv:
          description: Short unique identifier for the lookup.
          type: string
        description:
          description: The description of the lookup entry.
          type: string
        name:
          description: The name of the lookup entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiInventoryTrackingController.InventoryTracking:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiInventoryTrackingController.InventoryTracking'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiInventoryTrackingController.InventoryTrackingFilterModel:
      description: InventoryTracking Filter request model.
      type: object
      properties:
        hasInitialCount:
          description: Filters by whether the lot was created with an initial count. Defaults to null (both).
          type: boolean
        inventoryProductSettingIds:
          description: Comma-separated string of InventoryProductSetting identifiers.
          type: string
        isArchived:
          description: 'Filters by lot status. Defaults to null, which returns active and archived lots together;

            send false for active only or true for archived only.'
          type: boolean
        lotExpirationDateFrom:
          format: date-time
          description: Filters lots expiring on or after this date.
          type: string
        lotExpirationDateTo:
          format: date-time
          description: Filters lots expiring on or before this date.
          type: string
        dateCreatedFrom:
          format: date-time
          description: 'Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or

            the request returns 400. Defaults to null.'
          type: string
        dateCreatedTo:
          format: date-time
          description: The end of the date range filter on the entity creation date. Defaults to null.
          type: string
        dateUpdatedFrom:
          format: date-time
          description: 'The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the

            request returns 400. Defaults to null.'
          type: string
        dateUpdatedTo:
          format: date-time
          description: The end of the date range filter on the entity last update date. Defaults to null.
          type: string
        embed:
          description: Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
          type: string
        excludeIds:
          description: Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
          type: string
        ids:
          description: Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
          type: string
        page:
          format: int32
          description: The page number. Defaults to 1.
          type: integer
        rpp:
          format: int32
          description: The number of items to return per page. The max is 1000. Defaults to 10.
          type: integer
        sort:
          description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
          type: string