Fleetbase

https://fleetbase.io/docs
Admin
Fleetbase is a modular logistics and supply chain operating system designed to streamline...
Tokens:744,152
Snippets:5,972
Trust Score:7.2
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Run Docker install script

Source: https://fleetbase.io/docs/platform/quickstart/running-locally

Clone the repository and run the setup wizard script that handles configuration, starts the stack, and runs the deploy script automatically.

```bash
git clone https://github.com/fleetbase/fleetbase.git
cd fleetbase
./scripts/docker-install.sh
```

--------------------------------

### Install and start the console

Source: https://fleetbase.io/docs/ui/getting-started/installation

Installs dependencies and starts the console to verify the install. Run after adding ember-ui.

```bash
cd /path/to/fleetbase/console
pnpm install
pnpm start
```

--------------------------------

### Install Fleetbase CLI and run install-fleetbase

Source: https://fleetbase.io/docs/platform/quickstart/running-locally

Install the Fleetbase CLI globally and run the interactive installer. The CLI prompts for host (use localhost), environment (choose development), and install directory (defaults to fleetbase/). Setup takes 3-5 minutes and prints console and API URLs.

```bash
npm install -g @fleetbase/cli
flb install-fleetbase
```

--------------------------------

### Get registry service in extension setup

Source: https://fleetbase.io/docs/extension-development/universe/registry-service

Shows how to obtain the registry service inside an extension's setupExtension hook. Use this as the starting point for registering components or creating registries.

```javascript
// addon/extension.js
import { ExtensionComponent } from '@fleetbase/ember-core/contracts';

export default {
    setupExtension(app, universe) {
        const registryService = universe.getService('registry');
        // …
    },
};
```

--------------------------------

### Complete addon/extension.js example using sub-services

Source: https://fleetbase.io/docs/extension-development/universe/overview

A representative example combining several sub-services: menu, registry, widget, and hook. It registers a header menu item, a settings menu item, a renderable component, a dashboard widget, and a hook. Use this as a template for extension setup.

```javascript
// addon/extension.js
import { MenuItem, Widget, ExtensionComponent, Hook } from '@fleetbase/ember-core/contracts';

export default {
    setupExtension(app, universe) {
        const menuService     = universe.getService('menu');
        const registryService = universe.getService('registry');
        const widgetService   = universe.getService('widget');
        const hookService     = universe.getService('hook');

        // 1. Top-level header item
        menuService.registerHeaderMenuItem('My Extension', 'console.my-extension', {
            icon: 'puzzle-piece',
            description: 'My custom logistics feature.',
        });

        // 2. Settings item
        menuService.registerSettingsMenuItem(
            new MenuItem({
                title: 'My Extension',
                slug: 'my-extension',
                icon: 'gear',
                component: new ExtensionComponent('@my-org/my-extension-engine', 'settings'),
            })
        );

        // 3. Inject a component into another extension's slot
        registryService.registerRenderableComponent(
            'fleet-ops:component:order:details',
            new ExtensionComponent('@my-org/my-extension-engine', 'my-order-tab')
        );

        // 4. Register a dashboard widget
        widgetService.registerWidgets('dashboard', [
            new Widget({
                id: 'my-extension-stats',
                name: 'My Stats',
                icon: 'chart-line',
                component: new ExtensionComponent('@my-org/my-extension-engine', 'widget/my-stats'),
                grid_options: { w: 6, h: 6, minW: 4, minH: 4 },
            }),
        ]);

        // 5. Hook into the console boot
        hookService.registerHook(
            new Hook('console:after-model', (session, router) => {
                // do something after the user is authenticated
            })
        );
    },
};
```

--------------------------------

### POST /v1/customers/stripe-setup-intent

Source: https://fleetbase.io/docs/api/storefront/customer

Get a Stripe setup intent for the customer.

```APIDOC
## POST /v1/customers/stripe-setup-intent

### Description
Get a Stripe setup intent for the customer.

### Method
POST

### Endpoint
/v1/customers/stripe-setup-intent

### Parameters
#### Request Body
- **customer_id** (string) - Required - Customer ID

### Response
#### Success Response (200)
- **setup_intent** (object) - Stripe setup intent object

```

--------------------------------

### Get menu service in extension setup

Source: https://fleetbase.io/docs/extension-development/universe/menu-service

Use this as the entry point for registering navigation entries in the console. It imports the contracts and obtains the menu service via universe.getService('menu') inside setupExtension, where you can then call the service's registrars.

```javascript
// addon/extension.js
import { MenuItem, ExtensionComponent } from '@fleetbase/ember-core/contracts';

export default {
    setupExtension(app, universe) {
        const menuService = universe.getService('menu');
        // … registrations
    },
};
```

--------------------------------

### Docker Dev Server Setup (Dockerfile.server-build)

Source: https://fleetbase.io/docs/platform/quickstart/development-setup

Override the console service in docker-compose.override.yml to use Dockerfile.server-build and mount local source, then rebuild and start the console container. The console will be available at http://localhost:4200 with live reload.

```yaml
services:
  console:
    build:
      context: ./console
      dockerfile: Dockerfile.server-build
    volumes:
      - ./console:/console
      - /console/node_modules
    ports:
      - "4200:4200"
```

```bash
docker compose up -d --build console
```

--------------------------------

### POST /v1/checkouts/stripe-setup-intent

Source: https://fleetbase.io/docs/api/storefront/checkout

Creates a Stripe Setup Intent. Initializes a Stripe Setup Intent for payment method setup.

```APIDOC
## POST /v1/checkouts/stripe-setup-intent

### Description
Creates a Stripe Setup Intent. Initializes a Stripe Setup Intent for payment method setup.

### Method
POST

### Endpoint
/v1/checkouts/stripe-setup-intent

### Parameters
No parameters documented.

### Response
No response schema documented.
```

--------------------------------

### Enable Fleet-Ops with --install

Source: https://fleetbase.io/docs/platform/quickstart/development-setup

Enables Fleet-Ops and immediately runs the install commands (pnpm install and composer update) without a separate install step.

```bash
flb-package-linker enable fleetops --shared ember-core ember-ui fleetops-data --install
```

--------------------------------

### Install Nginx and create configuration file

Source: https://fleetbase.io/docs/platform/quickstart/deploy-in-cloud

Install Nginx and open the configuration file for editing. Replace yourdomain.com with your actual domain.

```bash
sudo apt-get update && sudo apt-get install -y nginx
sudo nano /etc/nginx/sites-available/fleetbase
```

--------------------------------

### Start Order 200 OK Response

Source: https://fleetbase.io/docs/api/fleetbase/orders

Example 200 OK response for the start order request. Shows the order object with started status and tracking number details.

```json
{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "current_waypoint": "place_1A2b3C4d5E",
    "waypoints": [],
    "entities": [],
    "meta": {}
  },
  "customer": null,
  "facilitator": null,
  "driver_assigned": {
    "id": "driver_A1b2C3d4E5",
    "name": "Alex Driver"
  },
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001",
    "status": "started",
    "status_code": "started",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "started",
  "pod_method": null,
  "pod_required": false,
  "dispatched": true,
  "started": true,
  "adhoc": false,
  "adhoc_distance": 0,
  "distance": 4830,
  "time": 875,
  "meta": {},
  "dispatched_at": "2026-05-07T08:50:00.000000Z",
  "started_at": "2026-05-07T08:52:00.000000Z",
  "scheduled_at": null,
  "updated_at": "2026-05-07T08:52:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
```

--------------------------------

### Run Fleetbase Docker install script on AWS

Source: https://fleetbase.io/docs/platform/getting-started/architecture

Run this script on an EC2 instance (t3.medium or larger) after installing Docker and cloning the Fleetbase repository. It starts an interactive installation that prompts for RDS and ElastiCache endpoints.

```bash
bash scripts/docker-install.sh
```

--------------------------------

### Create a bundle from extension root

Source: https://fleetbase.io/docs/cli/extension-development/bundle

Navigate to the extension directory and run `flb bundle`. The output shows the created bundle file name.

```bash
cd /path/to/your-extension
flb bundle
```

```text
Creating bundle vehicle-inspections-v1.2.0-bundle.tar.gz...
Bundle created at /path/to/your-extension/vehicle-inspections-v1.2.0-bundle.tar.gz
```

--------------------------------

### Start stack and run migrations

Source: https://fleetbase.io/docs/platform/quickstart/deploy-in-cloud

Starts the Fleetbase stack in detached mode and runs the deploy script inside the application container to execute migrations and setup. Continue to the Nginx and SSL sections after the stack is running.

```bash
docker compose up -d
docker compose exec application bash -c "./deploy.sh"
```

--------------------------------

### Bundle and upload in one step

Source: https://fleetbase.io/docs/cli/extension-development/bundle

Creates the bundle and uploads it to the registry. The CLI looks up your auth token from `~/.npmrc`; pass `--auth-token` to override.

```bash
flb bundle --upload
```

--------------------------------

### 200 OK Response for GET /v1/orders

Source: https://fleetbase.io/docs/api/fleetbase/orders

Example 200 OK response for the GET /v1/orders endpoint. Shows the public order fields plus loaded payload, tracking, assignment, customer, and facilitator data when available.

```json
{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "customer": {
    "id": "contact_6zV1KqN9pR",
    "name": "Acme Receiving",
    "type": "customer-contact"
  },
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "pickup": {
      "id": "place_1A2b3C4d5E",
      "name": "Marina Bay Sands",
      "address": "10 Bayfront Avenue, Singapore 018956"
    },
    "dropoff": {
      "id": "place_9Z8y7X6w5V",
      "name": "321 Orchard Rd",
      "address": "321 Orchard Rd, Singapore"
    },
    "return": null,
    "waypoints": [],
    "entities": [],
    "meta": {}
  },
  "facilitator": null,
  "driver_assigned": null,
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001",
    "status": "created",
    "status_code": "created",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "created",
  "pod_method": null,
  "pod_required": false,
  "dispatched": false,
  "started": false,
  "adhoc": false,
  "adhoc_distance": 0,
  "distance": 0,
  "time": 0,
  "meta": {},
  "dispatched_at": null,
  "started_at": null,
  "scheduled_at": null,
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
```

--------------------------------

### Install from anywhere with --path

Source: https://fleetbase.io/docs/cli/extensions/install

Install an extension from anywhere by specifying the path to the Fleetbase instance with --path.

```bash
flb install fleetbase/storefront --path /path/to/fleetbase
```

--------------------------------

### Get Order Next Activity Response

Source: https://fleetbase.io/docs/api/fleetbase/orders

Example 200 OK response for the Get Order Next Activity endpoint. Shows the next activities with their codes, statuses, details, and sequence numbers. The completed activity includes proof-of-delivery requirements.

```json
[
  {
    "code": "started",
    "status": "Order started",
    "details": "The assigned driver has started the order.",
    "sequence": 2,
    "_resolved_status": "Order started",
    "_resolved_details": "The assigned driver has started the order."
  },
  {
    "code": "completed",
    "status": "Order completed",
    "details": "The order has been completed.",
    "sequence": 3,
    "require_pod": true,
    "pod_method": "signature",
    "_resolved_status": "Order completed",
    "_resolved_details": "The order has been completed."
  }
]
```

--------------------------------

### Extension boot sequence: console and Laravel startup

Source: https://fleetbase.io/docs/extension-development/getting-started/extension-anatomy

Shows how the extension pieces are wired together at boot. The console application loads the addon's extension.js, which triggers setupExtension and registers menus, widgets, and registries. Then on first navigation, the engine.js loads and routes.js wires the route map. Meanwhile, Laravel boots the ServiceProvider, running parent::boot(), registerObservers(), registerExpansionsFrom(), and loading routes and migrations.

```plaintext
Console application boots
  ├── ExtensionManager loads each extension's addon/extension.js
  │     └── setupExtension(app, universe) runs
  │           ├── menu service registers your header item, settings panels, etc.
  │           ├── widget service registers your dashboard widgets
  │           └── registry service creates registries / injects components
  │
  └── On first navigation into your extension:
        └── Ember loads addon/engine.js
              ├── routes.js wires your route map
              └── onEngineLoaded(engineInstance, universe, app) fires (if exported)

Laravel boots
  └── <Name>ServiceProvider.boot() runs
        ├── parent::boot() — middleware groups, abilities schemas
        ├── registerObservers() — attach your model observers
        ├── registerExpansionsFrom() — auto-load class expansions
        ├── loadRoutesFrom('server/src/routes.php')
        └── loadMigrationsFrom('server/migrations')
```

--------------------------------

### string-starts-with: Check prefix

Source: https://fleetbase.io/docs/ui/helpers/data

Checks if a string starts with a given prefix. Example: {{#if (string-starts-with @id "store_")}} ... {{/if}}.

```handlebars
{{#if (string-starts-with @id "store_")}}
  {{!-- it's a store key --}}
{{/if}}
```

--------------------------------

### Lifecycle hooks: setupExtension and onEngineLoaded

Source: https://fleetbase.io/docs/extension-development/universe/extension-manager

Shows the two lifecycle hooks that addon/extension.js can export. setupExtension runs during boot before any engine is loaded, and onEngineLoaded runs the first time your own engine loads.

```javascript
export default {
    setupExtension(app, universe) {
        // synchronous setup — registries, menus, widgets
    },

    onEngineLoaded(engine, universe, app) {
        // engine.lookup('service:my-service'), etc.
    },
};
```

--------------------------------

### List categories curl request

Source: https://fleetbase.io/docs/api/storefront/category

Example curl command to list categories using the GET /v1/categories endpoint. Requires an Authorization header with a bearer token.

```bash
curl https://api.fleetbase.io/v1/categories?store=&parent=&parents_only=&with_products=&with_stores= \
  -H "Authorization: Bearer flb_live_…"
```

--------------------------------

### POST /v1/checkouts/stripe-setup-intent

Source: https://fleetbase.io/docs/api/storefront/checkout

Creates a Stripe SetupIntent for a storefront customer. The response includes Stripe client data for saving a payment method.

```APIDOC
## [POST] /v1/checkouts/stripe-setup-intent

### Description
Creates a Stripe SetupIntent for a storefront customer. The response includes Stripe client data for saving a payment method.

### Method
POST

### Endpoint
/v1/checkouts/stripe-setup-intent

### Parameters
#### Request Body
- **name** (string) - Required - Display name for the resource.
- **description** (string) - Optional - Human-readable description of the resource.
- **status** (enum) - Optional - Lifecycle status to apply to the resource. One of `active`, `inactive`.
- **meta** (string) - Optional - Arbitrary metadata stored with the resource.

### Request Example
```
curl -X POST https://api.fleetbase.io/v1/checkouts/stripe-setup-intent \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "customer": "{{customer_id}}"
}'
```

### Response
No response schema provided in the source.
```

--------------------------------

### Create Product with curl

Source: https://fleetbase.io/docs/api/storefront/products

Create a product with name, description, and price. Requires a store or network API key.

```bash
curl -X POST https://api.fleetbase.io/v1/products \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Product",
  "description": "Example storefront product",
  "price": 1000
}'
```

--------------------------------

### Get Driver Geofence History with curl

Source: https://fleetbase.io/docs/api/fleetbase/geofences

Retrieves geofence history for a specific driver. The per_page query parameter is optional; the example requests 50 records.

```curl
curl https://api.fleetbase.io/v1/geofences/driver/:driverId/history?per_page=50 \
  -H "Authorization: Bearer flb_live_…"
```

--------------------------------

### Get Internal Service Quote with GET /v1/service-quotes

Source: https://fleetbase.io/docs/api/workflows/integrated-vendor

Requests a service quote using an internal integrated vendor facilitator and waypoint payload. The example sets `service_type=SUV`, `facilitator=integrated_vendor_wa5AwdA`, `is_route_optimized=true`, three waypoints, and two special requests (`CASH_ON_DELIVERY`, `FRAGILE_GOODS`). Requires an API key in the Authorization header.

```curl
curl https://api.fleetbase.io/v1/service-quotes?service_type=SUV&facilitator=integrated_vendor_wa5AwdA&is_route_optimized=true&waypoints%5B0%5D%5Bname%5D=Stop%201&waypoints%5B0%5D%5Bphone%5D=%2B886970699044&waypoints%5B0%5D%5Blocation%5D%5Btype%5D=Point&waypoints%5B0%5D%5Blocation%5D%5Bcoordinates%5D=121.526333%2C25.036688&waypoints%5B1%5D%5Bname%5D=Stop%202&waypoints%5B1%5D%5Bphone%5D=%2B886970699044&waypoints%5B1%5D%5Blocation%5D%5Btype%5D=Point&waypoints%5B1%5D%5Blocation%5D%5Bcoordinates%5D=121.526333%2C25.036688&waypoints%5B2%5D%5Bname%5D=Stop%203&waypoints%5B2%5D%5Bphone%5D=%2B886970699044&waypoints%5B2%5D%5Blocation%5D%5Btype%5D=Point&waypoints%5B2%5D%5Blocation%5D%5Bcoordinates%5D=121.526333%2C25.036688&specialRequests%5B0%5D=CASH_ON_DELIVERY&specialRequests%5B1%5D=FRAGILE_GOODS \
  -H "Authorization: Bearer flb_live_…"
```

--------------------------------

### Enable Nginx site and test configuration

Source: https://fleetbase.io/docs/platform/quickstart/deploy-in-cloud

Create a symlink to enable the site, test the Nginx configuration, and reload Nginx to apply changes.

```bash
sudo ln -s /etc/nginx/sites-available/fleetbase /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx
```

--------------------------------

### Run the dev server

Source: https://fleetbase.io/docs/contributing/documentation

Starts the local development server with hot reload.

```bash
pnpm dev
```

--------------------------------

### Query Fleets Response (200 OK)

Source: https://fleetbase.io/docs/api/fleetbase/fleets

Example response for the GET /v1/fleets request. Shows a fleet object with fields like id, name, status, and timestamps.

```json
[
  {
    "id": "fleet_4Mnp8Qx2Vz",
    "name": "Haulers",
    "color": "#2563EB",
    "task": "Long haul distribution",
    "status": "active",
    "photo_url": "https://s3.ap-northeast-2.amazonaws.com/fleetbase/public/default-fleet.png",
    "service_area_id": "service_area_9Kp2Vx4Qm1",
    "zone_id": null,
    "vendor_id": null,
    "parent_fleet_id": null,
    "photo_id": null,
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  }
]
```

--------------------------------

### POST /v1/customers/stripe-setup-intent

Source: https://fleetbase.io/docs/api/storefront/customer

Creates a Stripe SetupIntent for the authenticated storefront customer. Use the returned client secret to collect or update a saved payment method.

```APIDOC
## POST /v1/customers/stripe-setup-intent

### Description
Creates a Stripe SetupIntent for the authenticated storefront customer. Use the returned client secret to collect or update a saved payment method.

### Method
POST

### Endpoint
/v1/customers/stripe-setup-intent

### Request Example
```
curl -X POST https://api.fleetbase.io/v1/customers/stripe-setup-intent \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Customer-Token: {{customer_token}}" \
  -d '{}'
```

### Response
#### Success Response
- **client secret** - The client secret from the created SetupIntent.
```

--------------------------------

### Query Store Locations with curl

Source: https://fleetbase.io/docs/api/storefront/store-locations

Example curl request to the GET /v1/store-locations endpoint, including query parameters for filtering and ordering, and an Authorization header with a bearer token.

```curl
curl https://api.fleetbase.io/v1/store-locations?query=&tagged=&ids=&exclude=&with_store=true&location%5Blatitude%5D=&location%5Blongitude%5D=&limit=&offset= \
  -H "Authorization: Bearer flb_live_…"
```

--------------------------------

### Create a bundle with flb bundle

Source: https://fleetbase.io/docs/cli/extension-development/bundle

Run from inside your extension's root directory. The output is named `<package-name>-v<version>-bundle.tar.gz` and excludes `node_modules/`, `server_vendor/`, and any previously generated bundle files.

```bash
flb bundle               # Just create the bundle
flb bundle --upload      # Create and upload to the registry
```

--------------------------------

### Get Geofence Dwell Report with curl

Source: https://fleetbase.io/docs/api/fleetbase/geofences

Generates a dwell report for a time range. The from and to query parameters are optional timestamps; the example uses placeholders {{from_datetime}} and {{to_datetime}}.

```curl
curl https://api.fleetbase.io/v1/geofences/dwell-report?from={{from_datetime}}&to={{to_datetime}} \
  -H "Authorization: Bearer flb_live_…"
```

--------------------------------

### OrderConfig object example (JSON)

Source: https://fleetbase.io/docs/api/fleetbase/order-configs

Example JSON of an OrderConfig object with a flow containing activities like created, dispatched, started, enroute, and completed. This shows the structure with key, name, namespace, status, version, and flow activities. It reflects the default transport config with empty events, actions, options, and entities arrays.

```json
{
  "id": "order_config_A1b2C3d4E5",
  "key": "transport",
  "name": "Transport",
  "namespace": "system:order-config:transport",
  "description": "Default order configuration for transport",
  "tags": [
    "transport",
    "delivery"
  ],
  "status": "private",
  "version": "0.0.1",
  "flow": {
    "created": {
      "key": "created",
      "code": "created",
      "color": "#1f2937",
      "logic": [],
      "events": [],
      "status": "Order Created",
      "actions": [],
      "details": "New order was created.",
      "options": [],
      "complete": false,
      "entities": [],
      "sequence": 0,
      "activities": [
        "dispatched"
      ],
      "internalId": "aac819a0-4d3f-4543-b7fa-e50804df83f1",
      "pod_method": "scan",
      "require_pod": false
    },
    "enroute": {
      "key": "enroute",
      "code": "enroute",
      "color": "#1f2937",
      "logic": [],
      "events": [],
      "status": "Driver Enroute",
      "actions": [],
      "details": "Driver is en-route.",
      "options": [],
      "complete": false,
      "entities": [],
      "sequence": 0,
      "activities": [
        "completed"
      ],
      "internalId": "5422a0c3-8683-4cc2-a4b5-4d064067cd4d",
      "pod_method": "scan",
      "require_pod": false
    },
    "started": {
      "key": "started",
      "code": "started",
      "color": "#1f2937",
      "logic": [],
      "events": [],
      "status": "Order Started",
      "actions": [],
      "details": "Order has been started",
      "options": [],
      "complete": false,
      "entities": [],
      "sequence": 0,
      "activities": [
        "enroute"
      ],
      "internalId": "b68fad7c-b09d-4161-a01c-a9a95e7f09a8",
      "pod_method": "scan",
      "require_pod": false
    },
    "completed": {
      "key": "completed",
      "code": "completed",
      "color": "#1f2937",
      "logic": [],
      "events": [],
      "status": "Order Completed",
      "actions": [],
      "details": "Order has been completed.",
      "options": [],
      "complete": true,
      "entities": [],
      "sequence": 0,
      "activities": [],
      "internalId": "8406520c-3f61-447b-8a48-d225d0f062d6",
      "pod_method": "scan",
      "require_pod": false
    },
    "dispatched": {
      "key": "dispatched",
      "code": "dispatched",
      "color": "#1f2937",
      "logic": [],
      "events": [],
      "status": "Order Dispatched",
      "actions": [],
      "details": "Order has been dispatched.",
      "options": [],
      "complete": false,
      "entities": [],
      "sequence": 0,
      "activities": [
        "started"
      ],
      "internalId": "152fa650-34d0-45d8-8b4f-e5820bde4277",
      "pod_method": "scan",
      "require_pod": false
    }
  },
  "created_at": "2026-04-01T10:00:00.000000Z",
  "updated_at": "2026-04-01T10:00:00.000000Z"
}
```

--------------------------------

### Install Fleetbase CLI and scaffold extension

Source: https://fleetbase.io/docs/platform/quickstart/development-setup

Installs the Fleetbase CLI globally and scaffolds a new extension interactively. The CLI prompts for extension name, description, author, PHP namespace, and repository URL, then generates a package with addon/, server/, package.json, and composer.json.

```bash
npm install -g @fleetbase/cli
flb scaffold
```

--------------------------------

### first-char: Get first character

Source: https://fleetbase.io/docs/ui/helpers/data

Returns the first character — useful for avatars / monogram fallbacks. Example: <div class="avatar">{{first-char @user.name}}</div>.

```handlebars
<div class="avatar">{{first-char @user.name}}</div>
```

--------------------------------

### GET /storefront/v1/customers/me with Customer-Token header

Source: https://fleetbase.io/docs/storefront/customers/authentication

Example request to the authenticated customer endpoint. The storefront key is sent in Authorization: Bearer, and the Sanctum personal access token is sent in the Customer-Token header.

```http
GET /storefront/v1/customers/me
Authorization: Bearer store_your_store_key
Customer-Token: 1|VlKK7lZ...
```

--------------------------------

### Retrieve Driver - 200 OK Response

Source: https://fleetbase.io/docs/api/fleetbase/drivers

Example 200 OK response for the GET /v1/drivers/:id endpoint. Shows the full driver object including vehicle, location, and status fields.

```json
{
  "id": "driver_A1b2C3d4E5",
  "user": "user_1A2b3C4d5E",
  "internal_id": "DRV-1002",
  "company": "company_6zV1KqN9pR",
  "company_name": "Fleetbase",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+15555550111",
  "timezone": "Asia/Singapore",
  "drivers_license_number": "S1234567A",
  "license_expiry": "2030-06-30",
  "photo_url": null,
  "avatar_url": "https://flb-assets.s3-ap-southeast-1.amazonaws.com/static/driver-icons/moto-driver.png",
  "vehicle_id": "vehicle_7YqM3KpL2n",
  "vendor_id": null,
  "job_id": null,
  "vehicle": {
    "id": "vehicle_7YqM3KpL2n",
    "plate_number": "ABC123",
    "make": "Toyota",
    "model": "Camry"
  },
  "vendor": null,
  "current_job": null,
  "location": {
    "type": "Point",
    "coordinates": [
      103.8198,
      1.3521
    ]
  },
  "heading": 0,
  "bearing": null,
  "altitude": 0,
  "speed": 0,
  "country": "SG",
  "currency": "SGD",
  "city": "Johor Bahru",
  "online": false,
  "current_status": "off_duty",
  "status": "available",
  "token": null,
  "skills": [
    "hazmat"
  ],
  "max_travel_time": 28800,
  "max_distance": 250000,
  "time_window_start": "08:00:00",
  "time_window_end": "18:00:00",
  "meta": {
    "badge": "B34"
  },
  "updated_at": "2026-05-07T09:12:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
```
Tokens:
Raw