EAeasyship
Insurance

List all Insurance Policies

Changed on

Retrieve a list of insurance policies.

Required authorization scope: public.insurance_policy:read

get/2024-09/insurances/policies

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/insurances/policies
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

policy_type'easyship_label' | 'external_label'

Filter records by policy type. By default, both easyship_label and external_label policies are returned. If easyship_shipment_id or source is set and policy_type is not, only easyship_label policies are returned, since those two filters have no equivalent on external_label policies.

easyship_shipment_idstring

Filter records by Easyship shipment ID. Only matches easyship_label policies; if set without policy_type, external_label policies are excluded entirely rather than returned unfiltered.

state'pending_request' | 'confirmed' | 'failed' | 'pending_void' | 'voided' | 'awaiting' | 'active' | 'canceled' | 'expired'

Filter records by insurance state. Applies to both policy types, each using its own state machine's values (see the state field on the response schema) -- easyship_label and external_label policies do not share a vocabulary, so this does not translate state values between them.

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. Only matches easyship_label policies; if set without policy_type, external_label policies are excluded entirely rather than returned unfiltered.

Response

list of insurances

Changes

  • b47b54b748a7Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      added the new accepted enum value to the // response property for the response status

    • warning

      added the new active enum value to the // response property for the response status

    • warning

      added the new awaiting enum value to the // response property for the response status

    • warning

      added the new canceled enum value to the // response property for the response status

    • warning

      added the new closed enum value to the // response property for the response status

    • warning

      added the new expired enum value to the // response property for the response status

    • warning

      added the new filed enum value to the // response property for the response status

    • warning

      added the new in_progress enum value to the // response property for the response status

    • warning

      added the new not_started enum value to the // response property for the response status

    • warning

      added the new refund_completed enum value to the // response property for the response status

    • warning

      added the new refund_failed enum value to the // response property for the response status

    • warning

      added the new refund_initiated enum value to the // response property for the response status

    • warning

      added the new rejected enum value to the // response property for the response status

    • info

      added the new optional query request parameter policy_type

    • info

      added the new enum value active to the query request parameter state

    • info

      added the new enum value awaiting to the query request parameter state

    • info

      added the new enum value canceled to the query request parameter state

    • info

      added the new enum value expired to the query request parameter state

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status