Create an Insurance Policy

post

https://public-api.easyship.com/2024-09/insurances/policies

Create insurance for a shipment whose label isn't provided by Easyship. For the shipment whose label is provided by Easyship, please ues Shipment Insurance Endpoint to ensure it.

Easyship relies on the tracking number and courier service ID to validate the shipment. Once the tracking record is successfully established, the insurance will be automatically set up and charged.

If the tracking record is initiated using the tracking endpoint POST /:version/trackings, it becomes valid for insurance only after receiving a response from the courier service, and within 24 hours of that time.

Required authorization scope: public.insurance_policy_3p:write

This API requires an updated contract with Easyship. Get in touch with your account manager or Easyship Support Team.

Body Params

tracking_number

string

required

courier_service_id

uuid

unique identifier for a courier service

courier_service_name

string

Name of the courier service. Required if courier_service_id is not provided. For courier services that Easyship doesn't support label generation, please retrieve the name using GET /trackings/external_courier_services

platform_order_number

string | null

≤ 200

Order number that was either copied from an order synced from an ecommerce platform or manually edited in Easyship's order from

origin_address_id

uuid

ID of origin address. Required if the origin_address object is not provided. If provided, the origin address attributes will be ignored.

origin_address

object

destination_address

object

items

array of objects

items

insurance

object

required

Responses

Language

Credentials

Bearer

token

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Insurance policy successfully created

202Insurance policy request accepted. Awaiting tracking result

422insufficient balance