FleetConnector Documentation

Step 1: Get Your Onfleet API Key

1. Log in to your Onfleet dashboard at onfleet.com/dashboard
2. Navigate to Settings → API & Webhooks
3. Click "Create New API Key"
4. Give it a descriptive name (e.g., "WooCommerce Integration")
5. Copy the generated API key immediately (you won't be able to see it again)

Step 2: Configure in WooCommerce

1. In WordPress admin, go to WooCommerce → FleetConnector
2. Find the "Onfleet API Settings" section
3. Paste your Onfleet API key in the "Onfleet API Key" field
4. Click "Test Connection" to verify (should show your organization name)
5. Click "Load Teams" to fetch your available Onfleet teams
6. Select a default team from the dropdown (optional but recommended)
7. Click "Save Changes" at the bottom of the page

Enable Auto-Create

Check the "Automatically create Onfleet tasks" checkbox to enable automatic task creation when WooCommerce orders reach specific statuses.

Select Trigger Statuses

Choose which WooCommerce order statuses should trigger Onfleet task creation:

You can also select other statuses like On-Hold, Pending Payment, or any custom statuses you've created.

Auto-Sync Updates

When enabled, any changes to a WooCommerce order automatically update the corresponding Onfleet task.

Delete on Cancel

When enabled, cancelling a WooCommerce order automatically deletes the task in Onfleet.

Supported Delivery Date Plugins

Custom Field Configuration

If you use a custom delivery date field:

1. Select "Custom field" from the Delivery Date Plugin dropdown
2. Enter the meta key in the "Custom Date Field" input (e.g., _my_delivery_date)
3. Save changes

Webhook URL

Copy this URL to configure webhooks in your Onfleet dashboard:

You'll configure this in Chapter 4 (Webhooks).

Order Status Mappings

Configure what happens to WooCommerce orders when Onfleet tasks change status:

Save Driver Information

When enabled, FleetConnector saves driver name and ID to the order when a task is assigned in Onfleet.

From Order Actions Dropdown

1. Go to WooCommerce → Orders
2. Hover over an order in the list
3. Click on "Create Onfleet Task" from the row actions
4. The task will be created immediately and you'll see a success message

From Order Edit Screen

1. Open any WooCommerce order
2. Look for the "Onfleet Task Information" meta box on the right side
3. Click the "Create Onfleet Task" button
4. The task will be created and the meta box will update with task details

How to Use Bulk Actions

1. Go to WooCommerce → Orders
2. Check the boxes next to the orders you want to process
3. Select "Create Onfleet Tasks" from the Bulk Actions dropdown at the top
4. Click "Apply"
5. Wait for the processing to complete - you'll see a success message with the count

Information Displayed

Available Actions

Status Indicators

Step 1: Get Your Webhook URL

1. In WordPress admin, go to WooCommerce → FleetConnector
2. Scroll to the "Webhook Settings" section
3. Copy the webhook URL displayed (it will look like https://yoursite.com/wp-json/fleetconnector/v1/webhook)

Step 2: Configure in Onfleet

1. Log in to your Onfleet dashboard
2. Go to Settings → API & Webhooks
3. Click "Add Webhook"
4. Paste your webhook URL in the URL field
5. Select which events you want to receive (see section 4.2)
6. Click "Create Webhook"
7. Onfleet will test the connection automatically

Step 3: Verify Configuration

Test your webhook by:

• Creating a test order in WooCommerce
• Creating an Onfleet task for that order
• Completing the task in Onfleet (or changing its status)
• Checking that the WooCommerce order status updates automatically
• Verifying the event appears in the FleetConnector Dashboard logs

Log Columns

Filtering and Search

Use the filters at the top of the log to find specific events:

How to Export

1. Apply any filters you want (date range, status, etc.)
2. Click the "Export to CSV" button at the top of the dashboard
3. The filtered results will download as a CSV file
4. Open in Excel, Google Sheets, or any spreadsheet application

How to Retry

1. Filter the log to show only "Error" status events
2. Find the failed task you want to retry
3. Click "View Details" to see the error message
4. If the issue is resolved (e.g., API is back online), click "Retry"
5. The system will attempt to create the task again

Details Include

Automatic Formatting

Default Country Code

FleetConnector assumes Netherlands (+31) as the default country code. If phone numbers don't start with + or 00, it adds +31.

Detection Priority

How Time Windows Work

FleetConnector combines the detected date with your configured time window:

Available Filters

add_filter('fleetconnector_task_data', function($task_data, $order_id) {
    // Add custom metadata
    $task_data['metadata'][] = [
        'name' => 'custom_field',
        'value' => get_post_meta($order_id, '_my_custom_field', true)
    ];
    return $task_data;
}, 10, 2);

add_filter('fleetconnector_delivery_date', function($date, $order_id) {
    // Use custom logic for delivery date
    return '2024-12-25';
}, 10, 2);

add_filter('fleetconnector_phone_number', function($phone, $order_id) {
    // Custom phone formatting logic
    return '+1' . preg_replace('/[^0-9]/', '', $phone);
}, 10, 2);

add_filter('fleetconnector_should_create_task', function($should_create, $order_id) {
    // Don't create tasks for wholesale customers
    $order = wc_get_order($order_id);
    if ($order->get_meta('_customer_type') === 'wholesale') {
        return false;
    }
    return $should_create;
}, 10, 2);

Available Actions

add_action('fleetconnector_task_created', function($task_id, $order_id, $task_data) {
    // Send custom notification, log to external system, etc.
}, 10, 3);

add_action('fleetconnector_webhook_received', function($event_type, $task_data, $order_id) {
    // Custom webhook processing
}, 10, 3);

add_action('fleetconnector_task_failed', function($order_id, $error_message) {
    // Send alert, create support ticket, etc.
}, 10, 2);

Table: wp_fleetconnector_logs

How to Enable

1. Go to WooCommerce → FleetConnector → Settings
2. Scroll to the "Advanced Settings" section
3. Check "Enable Debug Mode"
4. Click "Save Changes"

What Debug Mode Does

Before Contacting Support

How to Contact Us