Shepherd Veterinary Software Product Bundle Item API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Product Bundle Item 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: ProductBundleItem
paths:
  /pav2/open-api-product-bundle-items:
    post:
      tags:
      - ProductBundleItem
      summary: Retrieves {OpenApiProductBundleItemController.ProductBundleItem} resources that…
      description: 'Example Request

        {

        "rpp": 1

        }


        Example Response

        {

        "embed": null,

        "item": [

        {

        "clinicId": "3c1e8a2b-7f0d-4a96-b2d7-5f1c3a9e4d21",

        "description": "Med1 - 1 g/Caplet",

        "discountAmount": null,

        "dose": 0,

        "groupId": "5a9d8c73-2e1f-4b0a-9c8d-7e6f5a4b3c2d",

        "isDiscountPercent": true,

        "maxQuantity": 0,

        "medicationVolume": null,

        "medicationVolumeId": "c2f1a8b7-9d0e-4c3b-8a7f-1e2d3c4b5a6f",

        "minQuantity": 0,

        "name": null,

        "nestedBundle": null,

        "nestedBundleId": null,

        "product": null,

        "productBundle": null,

        "productBundleId": "0f4e2a6b-1c3d-4e5f-9a8b-7c6d5e4f3a2b",

        "productId": "8b7c6d5e-4f3a-2b1c-0e9f-8765d4c3b2a1",

        "dateCreated": "2025-08-04T11:08:09.368869Z",

        "dateUpdated": "2025-08-04T11:08:09.368869Z",

        "id": "e1d2c3b4-a5f6-4d7e-9c0b-1a2b3c4d5e6f"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 1,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 2

        }'
      operationId: OpenApiProductBundleItemGet
      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: A paged collection of product bundle items matching the supplied search criteria.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProductBundleItemController.ProductBundleItem'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProductBundleItemController.ProductBundleItem'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProductBundleItemController.ProductBundleItem'
        '401':
          description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
        '429':
          description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundleItemFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundleItemFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundleItemFilterModel'
        required: true
components:
  schemas:
    OpenApiProductBundleItemController.ProductBundleItemFilterModel:
      description: Product Bundle Item Filter REST model.
      type: object
      properties:
        nestedBundleIds:
          description: Comma-separated list of nested bundle identifiers to filter results.
          type: string
        productBundleIds:
          description: Comma-separated list of product bundle identifiers to filter results.
          type: string
        productIds:
          description: Comma-separated list of product identifiers to filter results.
          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
    OpenApiProductBundleItemController.Product:
      description: Product REST model.
      type: object
      properties:
        administrationPeriodId:
          description: Unique identifier representing the related Administration period entity.
          type: string
        automaticTask:
          description: 'Flag indicating whether an automatic task exists for this clinic product.

            An automatic task is an action that will be triggered after the clinic product is used.'
          type: boolean
        automaticTaskDueDate:
          format: int32
          description: Number of days until this automatic task is due.
          type: integer
        automaticTaskPriorityStatusId:
          description: Unique identifier representing the related Automatic task priority status.
          type: string
        automaticTaskTitle:
          description: Title of the automatic task linked to the clinic product.
          type: string
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        customProductId:
          description: Custom identifier for easier product search.
          type: string
        defaultMedicalRecord:
          description: 'Flag indicating whether product will use a default medical record note, applies only to those products

            that are included in medical record.'
          type: boolean
        defaultMedicalRecordNote:
          description: 'The default medical record note associated with the clinic product, used to document and

            describe the product.'
          type: string
        dischargeInstructions:
          description: Flag indicating whether this product has discharge instructions.
          type: boolean
        dischargeInstructionsText:
          description: 'Discharge instructions text for patient owners

            on how to act and what to do after administration of clinic product.'
          type: string
        dispensingFeeId:
          format: uuid
          description: Unique identifier representing the related Dispensing fee entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        includedInMedicalRecord:
          description: Flag indicating whether product is included in medical record.
          type: boolean
        includedOnInvoice:
          description: Flag indicating whether this product will appear on the printed invoice and estimate. It does not affect invoice and estimate calculations or persistence.
          type: boolean
        isActive:
          description: Flag indicating whether this product is active.
          type: boolean
        isControlled:
          description: Flag indicating whether this product is controlled substance.
          type: boolean
        isDiscountable:
          description: Flag that indicates whether this product is eligible for discounts.
          type: boolean
        isPetAssureDiscountable:
          description: Flag that indicates whether the product bundle is eligible for Pet Assure discounts.
          type: boolean
        isTaxable:
          description: Flag indicating whether this product is taxable.
          type: boolean
        name:
          description: Name of the product.
          type: string
        price:
          format: double
          description: Product price.
          type: number
        productCategoryId:
          description: Unique identifier representing the related Product category entity.
          type: string
        productTypeId:
          description: Unique identifier representing the related Product type entity.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiProductBundleItemController.ProductBundleItem:
      description: Product Bundle Item REST model
      type: object
      properties:
        clinicId:
          format: uuid
          description: Unique identifier representing the related Clinic entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        description:
          description: The Free-text Description property of the Product Bundle Item.
          type: string
        discountAmount:
          format: double
          description: The discount amount for this product bundle item.
          type: number
        dose:
          format: double
          description: The dose for this product bundle item.
          type: number
        groupId:
          format: uuid
          description: The unique identifier for the group.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isDiscountPercent:
          description: Flag indicating whether a discount on this product bundle item is in percentage.
          type: boolean
        maxQuantity:
          format: double
          description: The maximum quantity of this product bundle item.
          type: number
        medicationVolume:
          $ref: '#/components/schemas/OpenApiProductBundleItemController.MedicationVolume'
          description: Object representing the related medication volume entity. If embeded it will return details about Medication Volume.
        medicationVolumeId:
          format: uuid
          description: Unique identifier representing the related medication volume entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        minQuantity:
          format: double
          description: The minimum quantity of this product bundle item.
          type: number
        name:
          description: The display name of the product bundle item.
          type: string
        nestedBundle:
          $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundle'
          description: 'Object representing the nested bundle entity. If embeded and NestedBundleId has a value then it will return details about the

            nested bundle on this product bundle item.'
        nestedBundleId:
          format: uuid
          description: Unique identifier representing The nested bundle entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        product:
          $ref: '#/components/schemas/OpenApiProductBundleItemController.Product'
          description: Object representing the related product entity. If embeded it will return details of the product on this Product bundle item.
        productBundle:
          $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundle'
          description: 'Object representing the related product bundle entity. If embeded it will return details of the Product Bundle to which this porduct bundle

            item is related to.'
        productBundleId:
          format: uuid
          description: Unique identifier representing the related product bundle entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          description: Unique identifier representing the related product entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiProductBundleItemController.ProductBundle:
      description: Product Bundle REST model.
      type: object
      properties:
        clinicId:
          format: uuid
          description: Unique identifier representing the related Clinic entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        createdById:
          format: uuid
          description: Unique identifier representing the user who created this product bundle.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customProductId:
          description: Custom identifer for easier product bundle search. Only applicable to static bundles.
          type: string
        defaultDiscount:
          description: Flag indicating whether deafult discount is applicable to this product bundle.
          type: boolean
        discountNote:
          description: A note or description associated with the discount.
          type: string
        discountRate:
          format: double
          description: The discount rate, expressed as a decimal (e.g., 0.2 = 20%).
          type: number
        isActive:
          description: Flag indicating whether this product bundle is active.
          type: boolean
        isDeleted:
          description: Flag indicating whether this product bundle is deleted.
          type: boolean
        isDiscountPercent:
          description: Flag indicating whether this product bundle is discount percent.
          type: boolean
        isDiscountable:
          description: Flag that indicates whether the product category is eligible for discounts.
          type: boolean
        isPetAssureDiscountable:
          description: Flag indicating whether the product bundle is eligible for Pet Assure discounts.
          type: boolean
        isStaticPriceBundle:
          description: Flag indicating whether the product bundle uses a static price.
          type: boolean
        name:
          description: The Name of this Product Bundle.
          type: string
        productCategoryId:
          format: uuid
          description: Unique identifier representing the related product category entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        staticBundlePrice:
          format: double
          description: The fixed price of the product bundle. Only applicable when isStaticPriceBundle is true.
          type: number
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiProductBundleItemController.ProductBundleItem:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiProductBundleItemController.ProductBundleItem'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiProductBundleItemController.MedicationVolume:
      description: Medication volume REST 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