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

# Search Items

> Word-prefix item search. Defaults to returning every match (capped at 500).



## OpenAPI

````yaml get /inventory/items/search
openapi: 3.1.0
info:
  title: Decoda API
  description: External API documentation for the Decoda Health platform.
  version: '1.0'
servers: []
security: []
paths:
  /inventory/items/search:
    get:
      tags:
        - Items
      summary: Search Items
      description: >-
        Word-prefix item search. Defaults to returning every match (capped at
        500).
      operationId: search_items_inventory_items_search_get
      parameters:
        - name: TENANT
          in: header
          required: true
          schema:
            type: string
            title: Tenant
          description: The tenant you are making this request on behalf of
        - name: API-KEY
          in: header
          required: true
          schema:
            type: string
            title: Api-Key
          description: Your api key
        - name: name
          in: query
          required: true
          schema:
            type: string
            minLength: 2
            title: Name
        - name: item_type
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  $ref: '#/components/schemas/ItemType'
              - type: 'null'
            title: Item Type
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 500
            title: Limit
        - name: location_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Location Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ItemSearchResult'
                title: Response Search Items Inventory Items Search Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ItemType:
      type: string
      enum:
        - ITEM
        - SERVICE
        - PRODUCT
        - PACKAGE
        - MEMBERSHIP
        - MEDICATION
        - SERVICE_FEE
        - GIFT_CARD
      title: ItemType
    ItemSearchResult:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the item
        name:
          type: string
          title: Name
          description: Name of the item
        price:
          type: integer
          title: Price
          description: Price of the item in cents
        type:
          $ref: '#/components/schemas/ItemType'
          description: Type of item
        taxable:
          type: boolean
          title: Taxable
          description: Whether the item is taxable
          default: true
        discountTemplates:
          anyOf:
            - items:
                $ref: '#/components/schemas/DiscountTemplateWithItem'
              type: array
            - type: 'null'
          title: Discounttemplates
          description: 'For packages: the package''s contents'
      type: object
      required:
        - id
        - name
        - price
        - type
      title: ItemSearchResult
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DiscountTemplateWithItem:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the discount template
        createdByItemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Createdbyitemid
          description: ID of the item (membership or package) that creates this discount
        discountChoiceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Discountchoiceid
          description: ID of the discount choice group
        itemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Itemid
          description: ID of the specific item for this discount
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Category name for items in this discount (references category.name)
        itemType:
          anyOf:
            - $ref: '#/components/schemas/ItemType'
            - type: 'null'
          description: Type of item this discount applies to (PRODUCT, SERVICE, etc.)
        type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
          description: Type of discount template
        percentage:
          anyOf:
            - type: number
            - type: 'null'
          title: Percentage
          description: Discount percentage (0-100)
        amount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Amount
          description: Discount amount in cents
        quantity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantity
          description: Quantity for this discount (null = unlimited)
        expiryTimeDays:
          anyOf:
            - type: integer
            - type: 'null'
          title: Expirytimedays
          description: Days until discounts expire after issuance (null = never expires)
        renewalCycleInterval:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Renewalcycleinterval
          description: >-
            Number of billing cycles between re-issuances. null = every billing
            cycle.
        isStackable:
          type: boolean
          title: Isstackable
          description: Whether this discount can be combined with other discounts
          default: true
        isPrepayment:
          type: boolean
          title: Isprepayment
          description: Whether this is a prepayment (commissions on full price)
          default: false
        group:
          anyOf:
            - type: string
            - type: 'null'
          title: Group
          description: Group name for discount choices (resolved to discount_choice_id)
        isArchived:
          type: boolean
          title: Isarchived
          description: Whether the discount is archived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
          description: When the template was created
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
          description: When the template was last updated
        item:
          anyOf:
            - $ref: '#/components/schemas/DiscountItemTiny'
            - type: 'null'
          description: The item this template applies to (the content)
      type: object
      title: DiscountTemplateWithItem
      description: >-
        A discount template with its target item resolved.


        Used to describe the *contents* of a package (or membership) — which
        item each

        template applies to — so the cart/checkout UI can list what's inside
        without a

        second lookup. Uses the minimal :class:`DiscountItemTiny` to avoid an
        import

        cycle with the item schema.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    DiscountType:
      type: string
      enum:
        - GLOBAL
        - CUSTOM
        - MEMBERSHIP
        - PACKAGE
        - SAVED_ITEM
        - PROMOTION
      title: DiscountType
    DiscountItemTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the item
        name:
          type: string
          title: Name
          description: Name of the item
        brandName:
          anyOf:
            - type: string
            - type: 'null'
          title: Brandname
          description: Optional brand name of the item
        price:
          anyOf:
            - type: integer
            - type: 'null'
          title: Price
          description: Price of the item in cents
        cashPrice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cashprice
          description: Cash price of the item in cents (for dual pricing)
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Category name (references category.name)
        unit:
          anyOf:
            - $ref: '#/components/schemas/Unit'
            - type: 'null'
          description: Unit of measurement for the item
        type:
          anyOf:
            - $ref: '#/components/schemas/ItemType'
            - type: 'null'
          description: Type of item (PRODUCT, SERVICE, etc.)
        isPhysical:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isphysical
          description: Whether the item is physical
        isArchived:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isarchived
          description: Whether the item is archived
        allowCustomPricing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Allowcustompricing
          description: Whether custom pricing is allowed for this item
        showInCheckOut:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Showincheckout
          description: Whether this item appears in checkout
      type: object
      required:
        - id
        - name
      title: DiscountItemTiny
      description: |-
        Minimal item info for discount display.

        Carries enough scalar item detail for the console to append an archived
        benefit target to its active-only catalog list without a second items
        query. Scalar columns only — no relationships — so any loader that
        selectinloads the item row alone can serialize this schema.
    Unit:
      type: string
      enum:
        - AMPOULES
        - APPLICATORS
        - BOTTLES
        - BOXES
        - CAPSULES
        - CUPS
        - DOSES
        - G_PER_ML
        - GRAMS
        - IU
        - IU_PER_ML
        - OUNCES
        - FLUID_OUNCES
        - KG
        - KITS
        - LITERS
        - MCG
        - MG
        - MG_PER_ML
        - ML
        - MMOL
        - MICROGRAM_PER_ML
        - PACKS
        - PAIRS
        - PATCHES
        - PERCENTAGE
        - PIECES
        - POUCHES
        - ROLLS
        - SACHETS
        - SHEETS
        - SPRAYS
        - STRIPS
        - SYRINGES
        - TABLETS
        - TABLETS_PER_DAY
        - TESTS
        - TROCHES
        - TUBES
        - UNITS
        - VIALS
        - TREATMENTS
        - SESSIONS
        - PULSES
        - JOULES
        - CENTIMETERS
        - THREAD_COUNT
        - INJECTIONS
        - WRINKLE_UNITS
        - POUNDS
        - FEET
        - INCHES
      title: Unit

````