carrierstringrequired
carrier name
carrierProductIdstring
carrier product id
productIdstring
product id
productTypestring
product type
offsetnumber
offset
limitnumber
limit
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
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
Get product by ID
Retrieves a single product by its UUID
get
https://uat.api.zinnia.io/product/v2/products/{productId}
Path Parameters
productIdstringrequired
Unique product identifier (UUID)
Response
application/json
Response
application/json
Product found
ProductV2Model
idstringrequired
System-generated unique identifier (UUID)
Example:7b9f2b65-1b4a-4f4c-9d9d-6a7f5b6d9b1a
carrierCodestringrequired
Unique carrier code
Example:EVGL
carrierNamestringrequired
Carrier name
Example:Everglades
cusipstring | null
CUSIP identifier (9 characters)
Example:1234567AB
productNamestringrequired
Primary product name
Example:Term Life 20
marketingNamestringrequired
Marketing name for the product
Example:Everglades Term 20
legalNamestringrequired
Full legal name of the product
Example:Everglades Term Life Insurance – 20 Year Level Premium
versionstringrequired
Version identifier
Example:1.0
versionStartDatestringrequired
Version start date
Example:2025-01-01
versionEndDatestringrequired
Version end date
Example:2099-01-01
linestringrequired
Product line classification
Allowed values:LIFEANNUITY
Example:LIFE
typestringrequired
Product type
Allowed values:TERMUNIVERSAL_LIFE
Example:TERM
planCodestringrequired
Plan code
Example:TL0101
availableToSellbooleanrequired
Whether the product is available to sell at product level
Example:true
distributorsarray | null[object]
List of distributors authorized to sell this product
Show Child Parameters
stateAvailabilityarray[object]required
State-level availability records
Show Child Parameters
get/product/v2/products/{productId}
Authentication
Path Parameters
application/json
Search for products by criteria
When searching for products, each separate field combines in a logical AND grouping
post
https://uat.api.zinnia.io/product/v2/products/search
Query Parameters
orderBystring
Field to order by
Example:productName
orderByDirectionstring
Order direction
Allowed values:ASCDESC
Example:DESC
limitnumber
Number of results to return (max 1000)
>= 10
Example:10
offsetnumber
Index to start page search at
>= 0
Example:0
Body
application/json
Body
application/json
ProductSearchRequestDto
distributorCodesarray[string]
Distributor codes to include (logical OR)
Example:["EVGL"]
distributorNamesarray[string]
Distributor names to match (logical OR, case-insensitive)
distributorEffectiveOnstring
Date on which distributor must be effective
Example:2025-01-15
carrierCodesarray[string]
Carrier codes to include (logical OR)
Example:["EVGL","SBGC"]
carrierNamesarray[string]
Carrier names to match (logical OR, case-insensitive)
cusipsarray[string]
CUSIPs to match exactly (logical OR)
planCodesarray[string]
Plan codes to include (logical OR)
Example:["TL0101"]
productNamesarray[string]
Product names to match (logical OR)
marketingNamesarray[string]
Marketing names to match (logical OR)
legalNamesarray[string]
Legal names to match (logical OR)
typesarray[string]
Product types to include (logical OR)
Allowed values:TERMUNIVERSAL_LIFE
Example:["TERM"]
linestring
Product line to filter by
Allowed values:LIFEANNUITY
versionEffectiveOnstring
Returns products whose version is effective on this date
Example:2025-01-15
statesarray[string]
Two-letter state abbreviations to filter by (logical OR)
Example:["NY","FL"]
stateEffectiveOnstring
Date on which state availability must be effective
Example:2025-01-15
stateAvailableToSellboolean
State-level availability filter
availableToSellboolean
Product-level availability filter
Response
application/json
Response
application/json
Paginated search results
PaginatedProductsResponse
countnumberrequired
Total number of records matching the search
Example:121
nextstring | nullrequired
URL to the next page, if any
Example:/product/v2/products/search?offset=10&limit=10
previousstring | nullrequired
URL to the previous page, if any
Example:[ "" ]
resultsarray[object]required
Array of products matching the search criteria
Show Child Parameters
post/product/v2/products/search
Authentication
Query Parameters
Body
{}
application/json
ProductDataModel
objectproductIdstring
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
Example
ProductModelDB
objectproductIdstring
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
Example