v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB

Insurance

List all Insurance Policies

Retrieve a list of insurance policies.

Required authorization scope: public.insurance_policy:read

get/2024-09/insurances/policies

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

easyship_shipment_idstring

Filter records by Easyship shipment ID

state'pending_request' | 'confirmed' | 'failed' | 'pending_void' | 'voided'

Filter records by insurance state

recipient'buyer' | 'merchant'

Filter records by recipient

source'cloud' | 'efulfilment' | 'external'

Filter records by source type. External: shipment label is not generated by Easyship. Cloud: shipment label is generated by Easyship. Efulfilment: Special contract with Easyship.

Response

list of insurances