Query coverages

get
/coverages

Get multiple coverages

source_id
string

Order source ID

page
number

The page to query. (Default: 1, Max: 1000)

Default:
1
Example:
1
limit
string

Number of coverages each page contain. (Default: 20, Max: 20)

Default:
20
Example:
20

OK

meta
Meta
required

Meta data object.

Example:
{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}
code
number
required
Allowed values:
2000020100404004220050000
Default:
20000
type
string
required
>= 1 characters
message
string
required
>= 1 characters
errors
array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data
object
required
coverages
array[Coverage]
pagination
Pagination

Pagination data

Auth
:
Parameters
:
:
:
Response Example
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "coverages": [ { "id": "string", "source_id": "string", "policy_number": "412-231-231", "status": "inactive", "policy_detail_url": "string", "premium": { "amount": "12.34", "currency": "USD" }, "effective_time": "2022-12-12T12:23:34.333Z", "expiration_time": "2022-12-12T12:23:34.333Z", "updated_at": "2022-12-12T12:23:34.333Z", "created_at": "2022-12-12T12:23:34.333Z", "items": { "source_id": "string", "title": "string", "quantity": 0, "unit_insured_amount": { "amount": "12.34", "currency": "USD" }, "sku": "string", "image_urls": [ "string" ] }, "shipping_address": { "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" }, "sender_address": { "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": [ { "slug": "string", "tracking_number": "string", "ship_date": "2019-08-24" } ], "subtotal": { "amount": "12.34", "currency": "USD" }, "shipping_total": { "amount": "12.34", "currency": "USD" }, "premium_paid_by": "receiver" } ], "pagination": { "page": 1, "limit": 20, "total": 0 } } }