Get Product Details
GET/v1/products/:product_name
Get Product Details
Request
Path Parameters
product_name PolicyTyperequired
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, season-interruption
, team-registration
]
Query Parameters
offer_id uuid
partner objectrequired
Header Parameters
x-api-client-id any
Either x-api-client-id
or Authorization
header must be provided.
Responses
- 200
- 401
- 404
Ok
- application/json
- Schema
- Example (from schema)
Schema
product objectrequired
id uuidnullable
name PolicyType
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, season-interruption
, team-registration
]
friendly_name string
abbreviation string
promotional_header string
promotional_description string
accept_action_text string
decline_action_text string
peril_heading string
perils string[]
descriptors string[]
promotional_icon string
legal_disclaimer string
privacy_policy_url string
terms_conditions_url string
additional_policy_purchase_email_message string
policy_attributes_schema object
offer_id uuid
{
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_icon": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"offer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Either x-api-client-id
or Authorization
header must be provided.
Product not found.
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
message stringrequired
status int32required
{
"error": "string",
"error_code": "string",
"message": "string",
"status": 0
}
Loading...