LogoWPCocktail Docs

Features Documentation

Core Features

Overview

Shipping Insurance for WooCommerce Pro offers a comprehensive set of features designed to provide flexible, customizable shipping insurance options for your WooCommerce store. This document details all available features and their use cases.

Core Features

1. Flexible Insurance Calculation

Fixed Amount Insurance

Purpose: Charge a consistent insurance fee regardless of order value

Benefits:

  • Predictable costs for customers
  • Simple pricing structure
  • Easy to understand and explain

Use Cases:

  • Standard product lines with similar risk profiles
  • Stores with low-value items
  • Consistent shipping insurance providers

Configuration:

Rate Type: Fixed Amount
Rate Value: 2.99
Result: $2.99 insurance fee for all orders

Percentage-Based Insurance

Purpose: Calculate insurance fee as percentage of order value

Benefits:

  • Scales with order value
  • More accurate risk coverage
  • Higher revenue on larger orders

Use Cases:

  • High-value items
  • Variable product pricing
  • Risk-proportional coverage

Configuration:

Rate Type: Percentage of Order Value
Rate Value: 2.5
Min Amount: 1.00
Max Amount: 25.00

Examples:
$50 order = $1.25 insurance (2.5%)
$20 order = $1.00 insurance (minimum applied)
$1000 order = $25.00 insurance (maximum applied)

2. Smart Country Management

Country Exclusions

Purpose: Hide insurance options for specific countries

Features:

  • Comma-separated country code input
  • Real-time validation
  • AJAX-based country detection

Benefits:

  • Comply with local regulations
  • Exclude countries with included insurance
  • Reduce support for unavailable regions

Configuration:

Excluded Countries: US,CA,AU,GB
Result: No insurance option for customers from these countries

Dynamic Country Detection

Technical Implementation:

  • Monitors billing/shipping country changes
  • Updates insurance display in real-time
  • No page reload required

3. Weight-Based Conditions

Weight Threshold System

Purpose: Control insurance availability based on package weight

Available Conditions:

  • Greater Than
  • Less Than
  • Equal To
  • Greater Than or Equal To
  • Less Than or Equal To

Use Cases:

Light items only: Less Than 500g
Heavy items only: Greater Than 2kg
Specific weight range: Between 1-5kg (using multiple conditions)

Real-Time Weight Calculation

Features:

  • Automatic cart weight calculation
  • Updates when quantities change
  • Considers all cart items

4. Advanced Display Options

Flexible Positioning

Available Positions:

  • After Order Notes (default)
  • Before Order Notes
  • After Customer Details
  • After Terms & Conditions

Benefits:

  • Integrate with theme design
  • Optimize conversion placement
  • Match checkout flow

Customizable Text and Labels

Customizable Elements:

  • Section title
  • Checkbox label
  • Terms link text
  • Price display text

Example Customization:

Title: "Package Protection"
Label: "Protect my order during shipping"
Terms: "View Protection Policy"
Price Text: "Protection Fee: "

5. Multi-Currency Support

Automatic Plugin Detection

Supported Plugins:

  • WPML Multi-Currency
  • WOOCS (WooCommerce Currency Switcher)
  • WooCommerce Currency Switcher
  • Currency Switcher for WooCommerce
  • Aelia Currency Switcher

Smart Currency Conversion

Features:

  • Automatic rate detection
  • Real-time price updates
  • Currency-specific formatting

Technical Details:

// Automatic detection and conversion
$current_currency = $core->get_current_currency();
$converted_price = $core->convert_price_to_current_currency($base_price);
$formatted_price = $core->format_price_in_current_currency($converted_price);

Currency Switching Events

Automatic Updates:

  • Listens for currency change events
  • Updates insurance pricing immediately
  • Maintains checkout state

Administrative Features

6. Insurance Records Management

Comprehensive Order Tracking

Features:

  • Complete insurance order history
  • Filterable by date range
  • Sortable by multiple criteria

Data Tracked:

  • Order ID and date
  • Insurance fee amount
  • Order status
  • Customer information

Advanced Filtering

Filter Options:

  • Date range selection
  • Order status
  • Insurance amount ranges
  • Customer country

7. Statistics and Analytics

Performance Metrics

Available Statistics:

  • Total insurance orders
  • Total revenue from insurance
  • Average insurance fee
  • Conversion rates

Date Range Analysis:

  • Today
  • This week
  • This month
  • This year
  • Custom date ranges

Revenue Insights

Metrics Provided:

Total Orders: 1,247
Total Revenue: $3,891.53
Average Fee: $3.12
Min Fee: $1.00
Max Fee: $15.00

8. Data Export and Reporting

CSV Export Functionality

Export Options:

  • All insurance records
  • Filtered results
  • Date range exports
  • Custom field selection

Export Format:

Order ID,Date,Amount,Status,Customer
12345,2024-01-15,$2.99,Completed,john@example.com
12346,2024-01-16,$4.50,Processing,jane@example.com

Automated Reporting

Features:

  • Scheduled exports
  • Email delivery options
  • Custom report formats

Customization Features

9. Theme Integration

Visual Customization

Customizable Elements:

  • Link colors
  • Text formatting
  • Section styling
  • Position control

CSS Classes Available:

#shipping_insurance_container
.insurance-checkbox
.insurance-terms-link
.insurance-price-display

Responsive Design

Features:

  • Mobile-optimized display
  • Touch-friendly checkboxes
  • Responsive text sizing

10. Terms and Conditions Integration

Link Types:

  • Internal WordPress pages
  • External URLs
  • JavaScript popups
  • Modal dialogs

Link Behavior:

  • Open in same window
  • Open in new tab/window
  • Custom JavaScript handling

Policy Management

Features:

  • Hide/show terms link
  • Custom link text
  • Styling options

Technical Features

11. AJAX Integration

Real-Time Updates

AJAX Events:

  • Country change detection
  • Currency switching
  • Cart updates
  • Weight recalculation

Performance Benefits:

  • No page reloads
  • Instant feedback
  • Smooth user experience

Error Handling

Robust Error Management:

  • Graceful fallbacks
  • User-friendly messages
  • Debug logging

12. Security Features

Data Protection

Security Measures:

  • Nonce verification
  • Input sanitization
  • SQL injection prevention
  • XSS protection

Permission Checks:

  • Admin capability verification
  • AJAX request validation
  • Secure data transmission

13. Performance Optimization

Caching System

Optimization Features:

  • Option caching
  • Query optimization
  • Minimal database calls

Loading Optimization:

  • Conditional script loading
  • Minified assets
  • Optimized database queries

Developer Features

14. Extensibility

Action Hooks

Available Hooks:

// Before insurance display
do_action('shipping_insurance_before_display');
 
// After insurance calculation
do_action('shipping_insurance_after_calculation', $fee);
 
// On insurance selection
do_action('shipping_insurance_selected', $order_id);

Filter Hooks

Customization Filters:

// Modify insurance fee
$fee = apply_filters('shipping_insurance_fee', $fee, $order);
 
// Customize display conditions
$show = apply_filters('shipping_insurance_show_condition', $show, $cart);
 
// Modify supported countries
$countries = apply_filters('shipping_insurance_countries', $countries);

15. API Integration

REST API Endpoints

Available Endpoints:

GET  /wp-json/shipping-insurance/v1/records
POST /wp-json/shipping-insurance/v1/calculate
GET  /wp-json/shipping-insurance/v1/statistics

Webhook Support

Event Triggers:

  • Insurance added to order
  • Insurance removed from order
  • Configuration changes

Feature Compatibility

16. Plugin Integrations

WooCommerce Extensions

Compatible With:

  • WooCommerce Subscriptions
  • WooCommerce Bookings
  • WooCommerce Product Bundles
  • WooCommerce Composite Products

Third-Party Integrations

Supported Plugins:

  • Checkout Field Editor
  • Custom checkout plugins
  • Payment gateway plugins
  • Shipping calculator plugins

17. Theme Compatibility

Tested With:

  • Storefront
  • Astra
  • OceanWP
  • GeneratePress
  • Divi

Custom Theme Support

Features:

  • Flexible CSS classes
  • Template override support
  • Hook-based integration

Feature Usage Examples

E-commerce Store Scenarios

Scenario 1: Electronics Store

Configuration:
- Rate Type: Percentage
- Rate Value: 3%
- Min Amount: $5.00
- Max Amount: $100.00
- Weight Condition: Greater than 1kg

Use Case: Higher value electronics with weight-based qualification

Scenario 2: International Jewelry

Configuration:
- Rate Type: Percentage
- Rate Value: 2%
- Excluded Countries: US,CA (local insurance available)
- Multi-Currency: Enabled
- Default State: Yes

Use Case: High-value items with regional restrictions

Scenario 3: Local Delivery Service

Configuration:
- Rate Type: Fixed Amount
- Rate Value: $1.99
- Weight Condition: Any
- Display Position: After Terms
- Terms Link: /delivery-guarantee/

Use Case: Simple, consistent insurance for local deliveries

Feature Roadmap

Upcoming Features

  • Advanced analytics dashboard
  • Automated claim processing
  • Integration with shipping carriers
  • Mobile app support

Feature Requests

Submit feature requests through:

  • GitHub Issues
  • Support tickets
  • Community forums

Explore More: Check out the Configuration Guide to set up these features for your store.

Table of Contents