Query claims

get
/claims

Get multiple claims

coverage_id
string

Coverage ID

limit
number

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

page
number

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

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
claims
array[Claim]
pagination
Pagination

Pagination data

Auth
:
Parameters
:
:
:
Response Example
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "claims": [ { "id": "string", "number": "412-231-231", "coverage_id": "string", "status": "unsubmitted", "resolve_status": "precheck", "resolved_resolution_method": "refund_to_original_payment_method", "resolved_resolution_detail": "string", "customer_resolution_method": "refund_to_original_payment_method", "customer_resolution_detail": "string", "created_at": "2023-03-13T08:16:40.207Z", "updated_at": "2023-08-15T03:40:12.628Z", "issue_type": "lost_in_transit", "issue_desc": "string", "issue_commodity": "string", "claim_items": [ { "source_id": "string", "title": "string", "quantity": 0, "unit_insured_amount": { "amount": "12.34", "currency": "USD" }, "sku": "string", "image_urls": [ "string" ] } ], "claim_items_amount": { "amount": "12.34", "currency": "USD" }, "shipping_amount": { "amount": "12.34", "currency": "USD" }, "claim_submit_amount": { "amount": "12.34", "currency": "USD" }, "uploaded_documents": [ { "file_name": "string", "created_at": "string", "url": "string", "url_expired_at": "string" } ], "required_document_types": [ "string" ], "claim_payment_amount": { "amount": "12.34", "currency": "USD" }, "paid_at": "string" } ], "pagination": { "page": 1, "limit": 20, "total": 0 } } }