Product service
API Base URL
- Server 1:https://uat.api.zinnia.io
Security
Zinnia Product Service
0.1.0OAS 3.0
Product
HealthController_getHealth
get
https://uat.api.zinnia.io/product/products/health
Response
200
Response
200
get/product/products/health
200
CreateProduct
Create Product
post
https://uat.api.zinnia.io/product/v1/products
Body
application/json
Body
application/json
ProductDataModel
productIdstring
Zinnia generated unique ID generated to uniquely identify the product in our product master database
Example:UUID
carrierProductIdstring
Carrier generated unique ID, which may be used to communicate across integrations.
Example:CAR-PROD-123
productMarketingNamestring
Carrier generated marketing name for the product
Allowed values:Everglades Term LifeEverglades Return of Premium TermEverglades Index Universal Life
Example:Everglades Term Life
carrierstring
Unique carrier key used in enterprise APIs
Example:EVGL
productLinestring
Product line category
Allowed values:LIFEANNUITY
Example:LIFE
productTypestring
Product type category
Allowed values:INDEX_UNIVERSAL_LIFEUNIVERSAL_LIFETERM
Example:TERM
planCodestring
Plan code for the product (multiple can exist for a single product)
Example:TL0101
termLengtharray[number]
Term length in years
Allowed values:1510152025303540
Example:[10,20,30]
availableToSellboolean
Indicates if the product is available to sell
Example:true
Response
Response
Bad Request – validation error or duplicate key
post/product/v1/products
Authentication
Body
{}
QueryProduct
Query and retrieve products with optional filtering. Always returns an array of products, even when no products match the criteria (returns empty array) or when only a single product is found.
get
https://uat.api.zinnia.io/product/v1/products
Query Parameters
carrierstringrequired
carrier name
carrierProductIdstring
carrier product id
productIdstring
product id
productTypestring
product type
offsetnumber
offset
limitnumber
limit
Response
application/json
Response
application/json
Array of products matching the search criteria. Returns empty array if no products found, single-item array if one product found, or multiple products if many match.
productIdstring
Zinnia generated unique ID generated to uniquely identify the product in our product master database
Example:UUID
carrierProductIdstring
Carrier generated unique ID, which may be used to communicate across integrations.
Example:CAR-PROD-123
productMarketingNamestring
Carrier generated marketing name for the product
Allowed values:Everglades Term LifeEverglades Return of Premium TermEverglades Index Universal Life
Example:Everglades Term Life
carrierstring
Unique carrier key used in enterprise APIs
Example:EVGL
productLinestring
Product line category
Allowed values:LIFEANNUITY
Example:LIFE
productTypestring
Product type category
Allowed values:INDEX_UNIVERSAL_LIFEUNIVERSAL_LIFETERM
Example:TERM
planCodestring
Plan code for the product (multiple can exist for a single product)
Example:TL0101
termLengtharray[number]
Term length in years
Allowed values:1510152025303540
Example:[10,20,30]
availableToSellboolean
Indicates if the product is available to sell
Example:true
idstring
Database generated unique ID
get/product/v1/products
Authentication
Query Parameters
application/json