EAeasyship
Insurance

Create an Insurance Policy

Changed on

Create insurance for a shipment whose label isn't provided by Easyship. For the shipment whose label is provided by Easyship, please use Shipment Insurance Endpoint to insure 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.

post/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

Request body

tracking_numberstring required
courier_service_idstring uuid

unique identifier for a courier service

courier_service_namestring

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_numberPlatformOrderNumber (unresolved $ref)
origin_address_idstring uuid

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

Response

Insurance policy successfully created

Changes

  • b47b54b748a7Revision changes
    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • 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 request property /////////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • 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