Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withgale.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Product Object

The Product object represents items in your catalog. Gale automatically determines HSA/FSA eligibility via SIGIS database integration.
All monetary amounts are integers in cents (e.g., 4995 = $49.95).

​
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": 4995,
  "currency": "USD",
  "merchant_product_id": "BP-MONITOR-001",
  "upc_code_or_gtin": "14567890123456",
  "status": "active",
  "eligibility": {
    "hsa_fsa_eligible": true,
    "message": "HSA/FSA accepted"
  },
  "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": "2026-02-25T14:30:00Z",
  "updated_at": "2026-02-25T14:30:00Z"
}

​
Attributes

AttributeTypeDescription
idintegerUnique identifier for the product
namestringProduct name (max 255 chars)
taglinestringShort description (max 255 chars)
descriptionstringFull product description (supports markdown)
priceintegerPrice in cents
currencystringISO 4217 currency code
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
messagestringCustomer-facing eligibility explanation
Gale determines eligibility automatically when you sync products. The message field provides a customer-facing explanation you can display on your storefront (e.g., “HSA/FSA accepted”, “Requires Letter of Medical Necessity”).

​
Product Status

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

​
Examples

​
Basic Product (Required Fields Only)

{
  "name": "Digital Thermometer",
  "price": 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": 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"
  }
}