Skip to main content

Product Object

The Product object represents items in your catalog. Gale automatically determines HSA/FSA eligibility via SIGIS database integration.

The Product Object

{
  "id": 12345,
  "name": "Digital Blood Pressure Monitor",
  "tagline": "FDA-approved automatic BP monitor",
  "description": "Clinically validated blood pressure monitor with Bluetooth connectivity. Features automatic inflation, irregular heartbeat detection, and memory for 200 readings. Includes carrying case and 4 AAA batteries.",
  "price": {
    "cents": 4995,
    "dollars": 49.95,
    "currency": "USD",
    "formatted": "$49.95"
  },
  "merchant_product_id": "BP-MONITOR-001",
  "upc_code_or_gtin": "14567890123456",
  "status": "active",
  "eligibility": {
    "hsa_fsa_eligible": true,
    "eligibility_type": "auto_substantiation",
    "reason": "SIGIS verified - Medical device",
    "checked_at": "2025-10-18T14:30:00Z"
  },
  "images": [
    {
      "id": 567,
      "url": "https://cdn.example.com/bp-monitor-front.jpg",
      "is_primary": true
    },
    {
      "id": 568,
      "url": "https://cdn.example.com/bp-monitor-side.jpg",
      "is_primary": false
    }
  ],
  "metadata": {
    "category": "medical_devices",
    "brand": "HealthTech Pro",
    "weight": "0.5 lbs"
  },
  "created_at": "2025-10-18T14:30:00Z",
  "updated_at": "2025-10-18T14:30:00Z"
}

Attributes

AttributeTypeDescription
idintegerUnique identifier for the product
namestringProduct name (max 255 chars)
taglinestringShort description (max 255 chars)
descriptionstringFull product description (supports markdown)
priceobjectPrice information
merchant_product_idstringYour reference ID for this product
upc_code_or_gtinstringUPC or GTIN barcode
statusenumProduct status: active, inactive, archived
eligibilityobjectHSA/FSA eligibility information
imagesarrayProduct images (max 10)
metadataobjectCustom key-value pairs
created_attimestampWhen product was created
updated_attimestampWhen product was last updated

Eligibility Object

FieldTypeDescription
hsa_fsa_eligiblebooleanWhether product is HSA/FSA eligible
eligibility_typeenumType of eligibility (see below)
reasonstringExplanation of eligibility status
checked_attimestampWhen eligibility was last verified

Eligibility Types

TypeDescriptionExample
auto_substantiationAutomatically eligible via SIGISThermometers, bandages, blood pressure monitors
dual_purposeEligible with LMN (Letter of Medical Necessity)Vitamins, supplements (requires doctor’s note)
visionVision care productsPrescription glasses, contact lenses
rxPrescription requiredPrescription medications and devices

Price Object

FieldTypeDescription
centsintegerPrice in cents (e.g., 4995 = $49.95)
dollarsfloatPrice in dollars (for display)
currencystringISO 4217 currency code
formattedstringFormatted price string

Product Status

StatusDescription
activeAvailable for sale
inactiveTemporarily unavailable
archivedRemoved from catalog (soft deleted)

Examples

Basic Product (Required Fields Only)

{
  "name": "Digital Thermometer",
  "price_cents": 2995,
  "currency": "USD"
}

Complete Product

{
  "name": "Premium Blood Pressure Monitor",
  "tagline": "Professional-grade BP monitoring",
  "description": "Clinically validated automatic blood pressure monitor with advanced features including irregular heartbeat detection, WHO classification indicator, and Bluetooth connectivity for health app integration.",
  "price_cents": 4995,
  "currency": "USD",
  "merchant_product_id": "BP-MONITOR-PRO",
  "upc_code_or_gtin": "14567890123456",
  "images": [
    "https://cdn.example.com/bp-monitor-1.jpg",
    "https://cdn.example.com/bp-monitor-2.jpg"
  ],
  "metadata": {
    "category": "medical_devices",
    "brand": "HealthTech",
    "features": "bluetooth,memory,irregular_detection"
  }
}