Query Guarantees

get https://protect.sandbox.sensibleweather.io/api/v0_1/guarantee

Get active Guarantees for a product ID. If date filters are not supplied, then only the next week of guarantees will be returned. Timestamps are timezone sensitive.

Responses

Response body

array of objects

object

product_id

uuid

Identifier for the Product used to define behavior for Quotes and Guarantees - provided by SensibleWeather

coverage_start_date

string

The day on which coverage begins

coverage_end_date

string

The day on which coverage ends

currency

string

length between 3 and 3

3 character ISO code representing the currency of the quote - overrides the Product default if provided.

lang_locale

string

The language used to translate response in BCP47 format. If none are sent it will use the product default. If the specific lang_locale is not supported, but a lang_locale with the same root language is supported, the supported lang_locale will be used as a fall back. For example, if fr-CA is sent and only fr-FR is supported, then requests with fr-CA will have responses translated using fr-FR. On quote creation, this field is used to translate document section of the response body. However, on quote acceptance, this field is also used as the initial lang_locale setting for a new User. If the User already exists with Sensible Weather, their lang_locale will not be updated by this field and the Quote Accept response will respond with the lang_locale preference of the User regardless of what was sent in the request body.

coverage_start_hour

string

The hour when coverage begins on each of the covered days - determined by Product

coverage_end_hour

string

The hour when coverage ends on each of the covered days - determined by Product

wholesale_price

float

The price of the Guarantee excluding any markups

suggested_price

float

The price of the Guarantee including suggested markups

tax_amount

float

The amount of tax assessed on the quote price

tax_rate

float

The tax rate assessed on the quote price.

exposure_name

string

length ≥ 1

The human-readable/user-facing name of the location or experience being covered. This field has a character limit of 50, any longer content will be truncated.

exposure_latitude

float

-90 to 90

The latitude in decimal degrees of the exposure location

exposure_longitude

float

-180 to 180

The longitude in decimal degrees of the exposure location

exposure_total_coverage_amount

float

≥ 0.01

The total value of the exposure to be covered

exposure_protections

array of objects

The specific protections and the thresholds at which a given hour will be considered bad weather

exposure_protections

object

name

string

The type of bad weather that is covered

unit

string

The units that the threshold is measured in

upper_threshold

float

The value at which the observed weather at or above this threshold counts as covered weather. Either upper or lower will be present depending on the type of weather

lower_threshold

float

The value at which the observed weather at or below this threshold counts as covered weather. Either upper or lower will be present depending on the type of weather

payout_tiers

array of objects

The schedule matching payout amount to minimum hours of bad weather experienced

payout_tiers

object

number_of_hours

float

The minimum number of hours that will trigger this payout

payout_amount

float

The amount that will be paid out if the number of hours has been met for a single period of coverage

documents

array of objects

documents

object

name

string

Terms and Conditions Privacy Policy

link

url

uuid

Unique guarantee identifier

user_email

string

reservation_id

string

An identifier used to associate a Guarantee to an order/reservation/booking in another system

price_charged

float

The final price including markups charged to a covered user for a Guarantee

created_at

date-time | null

The datetime when this object was created

canceled_at

date-time | null

The datetime when this object was canceled. Will only show up if the object has been canceled

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://protect.sandbox.sensibleweather.io/api/v0_1/guarantee \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An array of Guarantees

400Error: one or more query parameter is invalid

401Error: request is missing valid Auth

404Error: Guarantees not found for given query parameters

500Unexpected internal service error

503Retryable internal service error