Coverage

id
string
required

coverage id

>= 1 characters
source_id
string
required
policy_number
string
required

policy id from insurance supplier

>= 1 characters
Example:
412-231-231
status
string
required

policy status

>= 1 characters
Allowed values:
inactiveactivatedclaimedexpiredvoid
Example:
inactive
policy_detail_url
string
required

URL of the policy detail

>= 1 characters
premium
Amount
required
amount
string
required
Example:
12.34
Match pattern:
^[0-9.]+$
currency
string
required

Only support USD for now

>= 3 characters<= 3 characters
Example:
USD
Match pattern:
^[A-Z]{3}$
effective_time
string
required

Effective time of coverage, times in ISO8601 format.Show all...

>= 1 characters
Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
expiration_time
string
required

expiration time of coverage, render times in ISO8601 format e.g.: "2012-01-01T12:00:00Z"

>= 1 characters
Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
updated_at
string
required

Updated time in ISO8601 format.Show all...

>= 1 characters
Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
created_at
string
required

Created time in ISO8601 format.Show all...

>= 1 characters
Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
items
Order Item
required
source_id
string
required

A globally-unique identifier for the item.

title
string
required

Name of the product

>= 1 characters
quantity
integer
required

Quantity of the item in order

unit_insured_amount
Amount
required
sku
string

SKU of the product item

>= 1 characters
image_urls
array[string]

item image urls

shipping_address
Address
required
Example:
{"street_1":"1104, South University Avenue","street_2":"","postal_code":"53916","city":"Beaver Dam","state":{"name":"Wisconsin"},"country_region":{"code":"USA"},"phone":"+14155552671","email":"[email protected]","first_name":"Joe","last_name":"Smith"}
street_1
string
required

Street address 1, a complete line

>= 1 characters
Example:
Jones Avenue
street_2
string

Street address 2, a complete line

>= 1 characters
Example:
Jones Avenue
street_3
string

Street address 3, a complete line

>= 1 characters
Example:
Jones Avenue
postal_code
string
required

Postal code / zip code

>= 1 characters
Example:
27101
city
string
required

City name, e.g. San Jose

>= 1 characters
Example:
NC
state
object
required

State object

country_region
object
required

Country region object

phone
string
Example:
+14155552671
email
string
first_name
string
required
Example:
Joe
last_name
string
required
Example:
Smith
sender_address
Address
required
Example:
{"street_1":"1104, South University Avenue","street_2":"","postal_code":"53916","city":"Beaver Dam","state":{"name":"Wisconsin"},"country_region":{"code":"USA"},"phone":"+14155552671","email":"[email protected]","first_name":"Joe","last_name":"Smith"}
trackings
array[Tracking]
slug
string
required
tracking_number
string
required
ship_date
string<date>
required

ship_date should be in UTC timezone.

subtotal
Amount
required
shipping_total
Amount
premium_paid_by
string

Indicates who paid for the premium

Allowed values:
receiversender
Default:
receiver
Example
preparing...