API Reference
Update asset resource url
Update the response schema of
list assets The Seel API is built on RESTful principles. It returns JSON encoded-responses, accepts JSON payloads, and has resource-oriented URLs. This data is only available through HTTPS to ensure the security of the transferred data.
The Seel API uses API keys to authenticate requests. You can contact [email protected] to get your API key.
Your API keys carry many privileges, so be sure to keep them secured! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
An authenticated request looks like this:
curl --header 'API-Key: YOUR-API-KEY'\
--url 'https://api-test.seel.com/v1-1/policies'
Attribute | Type | Description |
|---|---|---|
policy_id | string | id of the policy |
order_id | string | id of the corresponding order |
quote_id | string | id of the corresponding quote |
customer_email | string | email of the customer |
premium | float | premium of the policy |
premium_tax | float | sales tax of the policy |
status | string | status of the policy |
effective_ts | string | effective timestamp of the policy |
expired_ts | string | expired timestamp of the policy |
cancelled_ts | string | cancelled timestamp of the policy |
created_ts | string | created timestamp of the policy |
updated_ts | string | updated timestamp of the policy |
assets | json | assets in the policy |
{
"policy_id": "2022082206362294130569",
"order_id": "4c928364-4009-43e1-90bb-9af01c0b82fd",
"quote_id": "b2c6f521-8185-4fa5-b84f-0823827dfe91",
"customer_email": "[email protected]",
"premium": 5.19,
"premium_tax": 0.02,
"status": "active",
"effective_ts": "2022-08-22T10:03:49.415000Z",
"expired_ts": "2022-08-22T10:03:49.415000Z",
"cancelled_ts": "2022-08-22T10:03:49.415000Z",
"created_ts": "2022-08-22T10:03:49.415000Z",
"updated_ts": "2022-08-22T10:03:49.415000Z",
"assets": [
{
"asset_id": "2022659911102665",
"tracking_number": "123213123123",
"carrier": "USPS",
"asset_value": 34.33,
"asset_tax": 6.99,
"created_ts": "2022-05-05T02:52:29.150000Z",
"updated_ts": "2022-05-06T02:52:29.150000Z",
"asset_info": {
"price": 34.33,
"product_url": "url",
"title": "title_2",
"description": "description_2",
}
}
]
}
get
/v1-1/policies
/:policy_id
Get a policy by policy ID
post
/v1-1
/policies/:policy_id/cancel
Cancel a policy
Attribute | Type | Description |
|---|---|---|
asset_id | string | id of the asset |
tracking_number | string | tracking number of the asset |
carrier | string | shipping carrier |
asset_value | float | price of the asset |
asset_tax | float | sales tax of the asset |
created_ts | string | created timestamp of the asset |
updated_ts | string | updated timestamp of the asset |
asset_info | json | extra info of the asset |
{
"asset_id": "2022659911102665",
"tracking_number": "123213123123",
"carrier": "USPS",
"asset_value": 34.33,
"asset_tax": 6.99,
"created_ts": "2022-05-05T02:52:29.150000Z",
"updated_ts": "2022-05-06T02:52:29.150000Z",
"asset_info": {
"price": 34.33,
"product_url": "url",
"title": "title_2",
"description": "description_2"
}
}
get
/v1-1
/policies/:policy_id/assets
List assets of a policy
post
/v1-1/policies/:policy_id/assets
/:asset_id
Update the tracking info
Last modified 9d ago