Biteship provides a shipping insurance service that can be activated through the API to offer protection against loss or damage of goods during shipment. By using this feature, businesses can automatically add insurance to every order without having to activate it manually through the dashboard.
This article explains how to activate shipping insurance using the Biteship API, including the parameters used, example requests, how to check insurance status, and insurance cost information in the API response.
1. Why Activate Insurance Through Biteship API?
- Full Automation – No need to activate insurance manually on the dashboard.
- Maximum Protection – Reduces the risk of loss or damage to goods.
- Increases Customer Trust – Provides assurance of the security of shipped goods.
- Easy to Manage – Can be configured through API requests with simple parameters.
2. How to Activate Insurance in Biteship API
To activate insurance in the Biteship API, add the parameter courier_insurance when creating a shipping order.
Parameters Used in the API
| Parameter | Data Type | Description |
|---|---|---|
courier_insurance | Integer | The value of the goods to be insured in Indonesian Rupiah. |
3. API Request Example to Activate Insurance
Use the order creation endpoint POST /orders with the courier_insurance parameter as follows:
{
"courier_insurance": 15000000
}
📌 Explanation:
courier_insurance: 15000000means the insured value of the goods is IDR 15,000,000.
4. API Response with Active Insurance
If the order is successfully created, the API response will include insurance details in the courier.insurance object.
{
"id": "ORDER12345",
"courier": {
"tracking_id": "6de509ebdefgh4158ij3451c",
"waybill_id": null,
"company": "anteraja",
"driver_name": null,
"driver_phone": null,
"driver_photo_url": null,
"driver_plate_number": null,
"type": "reg",
"link": null,
"insurance": {
"amount": 500000,
"fee": 2500,
"note": ""
}
}
}
📌 Response explanation:
amountindicates the insured value of the goods.feeindicates the insurance cost calculated according to the applicable rate.- The total shipping cost will include the insurance fee.
5. How to Check Insurance Status on an Order
To check whether an order has insurance, use the endpoint GET /orders/{order_id} to retrieve order details.
GET https://api.biteship.com/v1/orders/:order_id
If insurance is active, the response will display insurance information as follows:
{
"id": "ORDER67890",
"courier": {
"tracking_id": "6de509ebdefgh4158ij3451c",
"waybill_id": null,
"company": "anteraja",
"driver_name": null,
"driver_phone": null,
"driver_photo_url": null,
"driver_plate_number": null,
"type": "reg",
"link": null,
"insurance": {
"amount": 500000,
"fee": 2500,
"note": ""
}
}
}
6. What Is the Insurance Cost in Biteship API?
The insurance cost is calculated based on a percentage of the value of the goods, usually around 0.5% depending on the courier’s policy.
| Goods Value (IDR) | Insurance Rate | Total Insurance Cost (IDR) |
|---|---|---|
| 500,000 | 0.5% × 500,000 | 2,500 |
| 1,000,000 | 0.5% × 1,000,000 | 5,000 |
| 5,000,000 | 0.5% × 5,000,000 | 25,000 |
This fee will be automatically calculated by the API based on the value of the goods entered in the request.
7. Frequently Asked Questions about Biteship API Insurance
Can insurance be activated after the order is created?
No, insurance must be activated when the order is first created. If the order has been processed without insurance, insurance cannot be added later.
What if the goods are lost or damaged even though they are insured?
You can file a claim with Biteship by providing supporting documents. Contact support@biteship.com for further claim processing. How to create a ticket here.
Are all goods insurable?
No, items such as fresh food, chemicals, cash, and illegal goods cannot be insured. Make sure your goods meet the requirements before activating insurance. See the list of insurable goods here
Can the insurance value be set differently from the value of the goods?
No, the insurance value must match the value of the goods entered in the order.
8. Conclusion
Activating shipping insurance through the Biteship API helps businesses automatically add protection for goods during the order creation process.
Main steps to activate insurance via API:
- Enter the
courier_insuranceparameter according to the value of the goods to be insured. - Check the API response to ensure the insurance cost has been calculated correctly.
- Use
GET /v1/orders/{order_id}to check the insurance status after the order is created.
Use this feature to ensure safer shipping and better protection for your business.
If you encounter any issues activating insurance via API, please contact support@biteship.com.