Insure new shipments

Context

This guide is designed to help:

• a) A Partner Company (third party provider)

insuring new shipments with Anansi.

• b) A Partner Company (retailer)

insuring new shipments with Anansi.

Data requirements

To insure a new shipment, Anansi requires the following information:

• Id of the policyholder the shipment relates to. (This would have been created when signing up a new policyholder).
• Items the shipment contains, including the quantity and the price.
• Shipping costs (exact cost of delivering the items)
• Origin country of the shipment.
• Shipping address including postal code and destination country of the shipment.
• A reference for the Partner’s use. Any text can be added to this field for shipment identification, tracking, or other purposes. This reference should be unique for each shipment of a policyholder. This means that two different policyholders can have the same shipment reference.
• An optional tracking number. Note: The tracking number is the most important piece of information because it’s how Anansi automatically tracks shipments and automates claims processes. If no tracking number is received, Anansi will insure the shipment. However, any claims relating to these shipments will need to be manually submitted by the Policyholder in the Anansi app. Legal information can be found in the Policy Documents.

Eligibility checks

Every shipment sent to Anansi will be considered for insurance, pending verification of the policy exclusions, to:

• The policy limit of £25,000;
• The merchant’s selected insurance limits.
• The origin and destination countries.

A successful API response means the shipment is eligible for insurance and will be covered as soon as Anansi detects it has been shipped.

Note that Anansi will insure all shipments sent via the API, within the policy limit of £25,000 and policy exclusions.

Option 1 - Single shipments

HTTP Example:

POST /api/partner/shipments/ HTTP/1.1
Host: <Host>
authentication: <Authentication token>
Content-Type: application/json

{
  "policyholder_id": "3fa85f6457174562b3fc2c963f66afa6",
  "shipment_reference": "ASJKKASD123",
  "shipping_price": 347.34,
  "tracking_number": "string",
  "creation_date": "2022-12-10",
  "items": [
    {
      "name": "Item 1",
      "quantity": 2,
      "price": 5.47
    }
  ],
  "destination_postcode": "PO1 3AX PO",
  "destination_country_code": "UK",
  "origin_country_code": "UK"
}

Full POST /shipments/ documentation (opens in this window).

This endpoint returns a shipment_id to use when querying information. A successful API response means the shipment is eligible for insurance and will be covered as soon as Anansi detects it has been shipped. A 400 response will be returned if the shipment is not eligible for insurance. In this case, the shipment_reference will be used to indentify the shipment.

Option 2 - Batch shipments

HTTP Example:

POST /api/partner/shipments/batch/ HTTP/1.1
Host: <Host>
authentication: <Authentication token>
Content-Type: application/json
{
  "shipments": [
    {
      "policyholder_id": "3fa85f6457174562b3fc2c963f66afa6",
      "shipment_reference": "ASJKKASD123",
      "shipping_price": 347.34,
      "tracking_number": "string",
      "creation_date": "2022-12-10",
      "items": [
        {
          "name": "Item 1",
          "quantity": 2,
          "price": 5.47
        }
      ],
      "destination_postcode": "PO1 3AX PO",
      "destination_country_code": "UK",
      "origin_country_code": "UK"
    }
  ]
}

Full POST /shipments/batch/ documentation (opens in this window).

This endpoint returns a list of created shipments with respective shipment_id and failed shipments. Created shipment means the shipment is eligible for insurance and will be covered as soon as Anansi detects it has been shipped. A failed shipment will be identified by the shipment_reference sent in the request body.

Next steps

• Check the coverage status
• Common use cases