curl --request POST \
--url https://api.withflex.com/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"name": "<string>",
"description": "<string>",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"visit_type": "cbtSleep",
"url": "<string>",
"hsa_fsa_eligibility": "not_eligible",
"metadata": {},
"use_feligibot": true
}
}
'{
"product": {
"product_id": "<string>",
"name": "<string>",
"created_at": "<string>",
"active": true,
"hsa_fsa_eligibility": "not_eligible",
"test_mode": true,
"description": "<string>",
"visit_type": "cbtSleep",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"eligibility_rationale": "<string>",
"metadata": {},
"url": "<string>"
}
}Create Product
Creates a new product.
curl --request POST \
--url https://api.withflex.com/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"name": "<string>",
"description": "<string>",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"visit_type": "cbtSleep",
"url": "<string>",
"hsa_fsa_eligibility": "not_eligible",
"metadata": {},
"use_feligibot": true
}
}
'{
"product": {
"product_id": "<string>",
"name": "<string>",
"created_at": "<string>",
"active": true,
"hsa_fsa_eligibility": "not_eligible",
"test_mode": true,
"description": "<string>",
"visit_type": "cbtSleep",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"eligibility_rationale": "<string>",
"metadata": {},
"url": "<string>"
}
}Authorizations
Use a Bearer token to access this API.
Body
Show child attributes
Show child attributes
The product's name, meant to be displayed to the customer.
The product's description, a short blurb meant to be displayed to the customer.
The product's UPC code. If provided, this will be used to check whether the product is on the eligible product list.
The product's GTIN. If provided, this will be used to check whether the product is on the eligible product list.
If the product is HSA/FSA eligible through private lable, this should be provided.
If the product is eligible via LOMN, the visit type that was provided from the Flex team should be provided.
cbtSleep, notApplicable, metabolomics, tinnitus, gym, exerciseDiet, orthopedic, alcohol, airPurification, vaginalHealth, menstrual, canopy, alopecia, genate, weightBlanket, bedJet, siderAl, sunwinkPowder, wavWatch, bodyComplete, ageRate, nitrousOxide, happyV, groupChat, icalmAnxiety, redBloom, foodom, branchErgonomicFurniture, curalife, eloraInfantWellness, nutriHealth, olipop, goldIntimate, touchStoneEssentials, utiva, sleepGeekz, figBrew, auBabyBlanket, oshWellness, currentBodyRedLight, mito, circularRing, lymaRedLight, goodAirRx, tastermonial, karunaHome, ergoStandingChair, jbaGlucoseControl, bloomNutrition, buoyDrops, luxeWonderWig, saunaMarketplace, amrioreEyewear, pivotOrthoShoe, lumenCynergy, roga, pulsetto, mitoRedLight, gutPersonal, goFlaus, myHixel, calmigo, dotFit, stripesBeauty, mixHers, pmd, positivityWithPurpose, techRing, popVeneers, vertaClean, lumen, coolingBed, posture, supplements, sleep, redLightTherapy, fitness, smartRing, womensVaginalHealth, fertilitySupport, femaleReproduction, pregnancyLiterature, iceBath, orthopedicShoes, sexualHealth, glucose, metabolicTest, skinCare, oralHealth, blueLightGlasses, anxiety, brainHealth, babyMonitor, compressionSocks, waterPurification, medSpa, essentialOils, sleepBuds, latchLight, nutritionist, rairflow, enduranceTraining, hydration, hairGrowth, eD, postureFitness, childDevelopment, adaptiveClothing, sleepConsulting, hairRemoval, menopause, maleFertility, anxietyHealth, bidets, speechHealth A URL of a publicly-accessible image of the product.
The product's HSA/FSA eligibility that you are requesting.
not_eligible, auto_substantiation, private_label, letter_of_medical_necessity, prescription, vision, service Whether to use Feligibot for this product. Defaults to true.
Response
A Product defines what you sell. Flex creates the The product can either be not eligible, elegible via auto-substantiation or elegible via letter of medical necessity.
Show child attributes
Show child attributes
The unique identifier for the product.
The name of the product.
The date the product was created.
Determines if the product is active or not.
The elegibility of the product for HSA/FSA.
not_eligible, auto_substantiation, private_label, letter_of_medical_necessity, prescription, vision, service Whether the product is in test mode or not.
The description of the product.
The visit type of the product if a letter of medical necessity is required.
cbtSleep, notApplicable, metabolomics, tinnitus, gym, exerciseDiet, orthopedic, alcohol, airPurification, vaginalHealth, menstrual, canopy, alopecia, genate, weightBlanket, bedJet, siderAl, sunwinkPowder, wavWatch, bodyComplete, ageRate, nitrousOxide, happyV, groupChat, icalmAnxiety, redBloom, foodom, branchErgonomicFurniture, curalife, eloraInfantWellness, nutriHealth, olipop, goldIntimate, touchStoneEssentials, utiva, sleepGeekz, figBrew, auBabyBlanket, oshWellness, currentBodyRedLight, mito, circularRing, lymaRedLight, goodAirRx, tastermonial, karunaHome, ergoStandingChair, jbaGlucoseControl, bloomNutrition, buoyDrops, luxeWonderWig, saunaMarketplace, amrioreEyewear, pivotOrthoShoe, lumenCynergy, roga, pulsetto, mitoRedLight, gutPersonal, goFlaus, myHixel, calmigo, dotFit, stripesBeauty, mixHers, pmd, positivityWithPurpose, techRing, popVeneers, vertaClean, lumen, coolingBed, posture, supplements, sleep, redLightTherapy, fitness, smartRing, womensVaginalHealth, fertilitySupport, femaleReproduction, pregnancyLiterature, iceBath, orthopedicShoes, sexualHealth, glucose, metabolicTest, skinCare, oralHealth, blueLightGlasses, anxiety, brainHealth, babyMonitor, compressionSocks, waterPurification, medSpa, essentialOils, sleepBuds, latchLight, nutritionist, rairflow, enduranceTraining, hydration, hairGrowth, eD, postureFitness, childDevelopment, adaptiveClothing, sleepConsulting, hairRemoval, menopause, maleFertility, anxietyHealth, bidets, speechHealth The upc code of the product.
The gtin code of the product.
The gtin code of the product.
The rationale for the eligibility determination.
The URL of the product.