Orders

Orders represent work to be planned, dispatched, tracked, and completed. Use order endpoints to create delivery or service jobs, assign resources, manage status, capture proof of delivery, and record activity.

The Order object

An order represents a FleetOps delivery or service workflow. It links a payload, optional customer and facilitator, assigned driver and vehicle resources, tracking data, proof-of-delivery settings, and lifecycle timestamps.

Attributes

idstringoptional

Public order identifier.

internal_idstringoptional

Optional internal identifier for the order.

order_configstringoptional

Public identifier of the order configuration used by the order flow.

customerobjectoptional

Customer contact or vendor resource loaded with the order.

payloadobjectoptional

Payload resource containing the pickup, dropoff, return stop, waypoints, and entities for the order.

facilitatorobjectoptional

Contact, vendor, or integrated vendor facilitating the order.

driver_assignedobjectoptional

Driver assigned to the order.

vehicle_assignedobjectoptional

Vehicle assigned to the order.

tracking_numberobjectoptional

Tracking number resource generated for the order.

tracking_statusesarray of objectsoptional

Tracking statuses loaded with the order.

filesarray of objectsoptional

Files attached to the order.

purchase_rateobjectoptional

Purchase rate attached to the order, when present.

notesstringoptional

Free-form notes attached to the order.

typestringoptional

Order type resolved from the order configuration.

statusstringoptional

Current order lifecycle status.

pod_methodstringoptional

Proof-of-delivery method required for the order.

pod_requiredbooleanoptional

Whether proof of delivery is required.

dispatchedbooleanoptional

Whether the order has been dispatched.

startedbooleanoptional

Whether the order has started.

adhocbooleanoptional

Whether the order is ad hoc.

adhoc_distanceintegeroptional

Ad hoc dispatch distance in meters.

distanceintegeroptional

Preliminary route distance in meters.

timeintegeroptional

Preliminary route duration in seconds.

tracker_dataobjectoptional

Tracker data returned when requested with with_tracker_data.

etaobjectoptional

Estimated arrival data returned when requested with with_eta.

metaobjectoptional

Additional order metadata.

dispatched_attimestampoptional

Timestamp when the order was dispatched.

started_attimestampoptional

Timestamp when the order was started.

scheduled_attimestampoptional

Timestamp when the order is scheduled.

updated_attimestampoptional

Timestamp when the order was last updated.

created_attimestampoptional

Timestamp when the order was created.

The Order object

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "customer": {
    "id": "contact_6zV1KqN9pR",
    "name": "Acme Receiving"
  },
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "pickup": {
      "id": "place_1A2b3C4d5E",
      "name": "Warehouse 7"
    },
    "dropoff": {
      "id": "place_9Z8y7X6w5V",
      "name": "Customer Dock"
    },
    "waypoints": [],
    "entities": []
  },
  "facilitator": null,
  "driver_assigned": null,
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001"
  },
  "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"
}

POST/v1/orders

Create an Order

Creates a new order for the current company. Provide an existing payload ID, an inline payload, a pickup/dropoff pair, or at least two waypoints; Fleetbase creates or attaches the payload before creating the order.

You can assign a driver, vehicle, facilitator, customer, service quote, or schedule at creation time. When dispatch is true, Fleetbase dispatches the order after it is created unless the order belongs to an integrated vendor flow.

Body parameters

payloadobjectoptional

Existing payload ID or an inline payload object. If omitted, provide pickup and dropoff, or provide at least two waypoints.

pickupobjectoptional

Pickup place data or place identifier for the payload.

dropoffobjectoptional

Dropoff place data or place identifier for the payload.

returnobjectoptional

Optional return place data or place identifier for the payload.

waypointsarray of objectsoptional

Ordered route stops. Required when the payload does not include both pickup and dropoff.

entitiesarray of objectsoptional

Entities, packages, or items attached to the payload.

pickupobjectoptional

Pickup place data or address used to create the order payload when payload is not supplied.

dropoffobjectoptional

Dropoff place data or address used to create the order payload when payload is not supplied.

returnobjectoptional

Optional return place data or address used when creating the order payload.

waypointsarray of objectsoptional

Ordered route stops used when creating the order payload without a pickup/dropoff pair. At least two waypoints are required when no pickup/dropoff pair is provided.

entitiesarray of objectsoptional

Entities, packages, or items attached to the generated payload.

typestringoptional

Order configuration key. Fleetbase resolves this with order_config and stores the resolved key as the order type.

order_configstringoptional

Order configuration identifier used to resolve the order flow.

service_quotestringoptional

Service quote ID to purchase and attach to the order.

purchase_ratestringoptional

Purchase rate ID to attach to the order.

driverstringoptional

Driver ID to assign to the order. Fleetbase also assigns the driver's vehicle when one is available.

vehiclestringoptional

Vehicle ID to assign to the order.

facilitatorstringoptional

Contact, vendor, or integrated vendor ID responsible for facilitating the order.

customerobjectoptional

Existing contact/vendor ID, or customer details used to find or create a customer contact.

internal_idstringoptional

Optional internal customer identifier.

namestringoptional

Customer display name.

titlestringoptional

Customer title.

emailstringoptional

Customer email address used when finding or creating the customer contact.

phonestringoptional

Customer phone number.

metaobjectoptional

Additional customer metadata.

dispatchbooleanoptional

When true, Fleetbase dispatches the order after it is created. Dispatch is skipped for integrated vendor orders.

adhocbooleanoptional

Marks the order as ad hoc.

adhoc_distancenumberoptional

Ad hoc search distance for dispatching nearby drivers.

pod_requiredbooleanoptional

Whether proof of delivery is required to complete the order.

pod_methodstringoptional

Proof of delivery method. Required when pod_required is true.

scheduled_attimestampoptional

Date and time when the order should be scheduled.

statusstringoptional

Initial order status. Defaults to created when omitted.

internal_idstringoptional

Optional internal identifier for the order.

metaobjectoptional

Additional order metadata.

notesstringoptional

Free-form notes attached to the order.

time_window_starttimestampoptional

Earliest time the order should be serviced by the orchestrator.

time_window_endtimestampoptional

Latest time the order should be serviced by the orchestrator.

required_skillsarray of stringsoptional

Skills required for orchestrator assignment.

orchestrator_priorityintegeroptionalDefault: 50

Orchestrator priority for assignment. Fleetbase defaults invalid or omitted values to 50.

POST/v1/orders

curl -X POST https://api.fleetbase.io/v1/orders \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "pickup": "Singapore 018971",
  "dropoff": "321 Orchard Rd, Singapore",
  "waypoints": [
      "10 Bayfront Avenue, Singapore 018956",
      "18 Marina Gardens Drive, Singapore 018953",
      "80 Mandai Lake Rd, Singapore 729826",
      "1 Beach Road, Singapore 189673"
  ],
  "dispatch": false,
  "driver": "{{driver_id}}",
  "facilitator": "{{vendor_id}}",
  "customer": "{{contact_id}}",
  "meta": {
      "Warehouse": "WAREHOUSE-123"
  },
  "notes": "Order notes"
}'

Other ways to call this

201 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "customer": {
    "id": "contact_6zV1KqN9pR",
    "name": "Acme Receiving",
    "email": "receiving@example.com",
    "phone": "+15555550100",
    "type": "customer-contact",
    "customer_type": "customer-contact",
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  },
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "current_waypoint": "place_1A2b3C4d5E",
    "pickup": {
      "id": "place_1A2b3C4d5E",
      "name": "Marina Bay Sands",
      "location": {
        "latitude": 1.2834,
        "longitude": 103.8607
      },
      "address": "10 Bayfront Avenue, Singapore 018956",
      "type": "place",
      "meta": {},
      "updated_at": "2026-05-07T08:30:00.000000Z",
      "created_at": "2026-05-07T08:30:00.000000Z"
    },
    "dropoff": {
      "id": "place_9Z8y7X6w5V",
      "name": "321 Orchard Rd",
      "location": {
        "latitude": 1.3048,
        "longitude": 103.8318
      },
      "address": "321 Orchard Rd, Singapore",
      "type": "place",
      "meta": {},
      "updated_at": "2026-05-07T08:30:00.000000Z",
      "created_at": "2026-05-07T08:30:00.000000Z"
    },
    "return": null,
    "waypoints": [],
    "entities": [],
    "cod_amount": null,
    "cod_currency": null,
    "cod_payment_method": null,
    "payment_method": null,
    "meta": {},
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  },
  "facilitator": null,
  "driver_assigned": {
    "id": "driver_A1b2C3d4E5",
    "name": "Alex Driver",
    "email": "alex.driver@example.com",
    "phone": "+15555550111",
    "status": "active",
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  },
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001",
    "status": "created",
    "status_code": "created",
    "qr_code": "https://api.fleetbase.io/qr/FB-1001",
    "barcode": "https://api.fleetbase.io/barcode/FB-1001",
    "url": "https://console.fleetbase.io/track-order/FB-1001",
    "type": "order",
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  },
  "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"
}

GET/v1/orders

Query Orders

Returns orders for the current company. Use filters such as status, payload, customer, facilitator, or nearby to narrow the result set.

Query parameters

limitintegeroptional

Maximum number of orders to return.

offsetintegeroptional

Number of orders to skip before returning results.

sortstringoptional

Sort expression for the order query.

statusstringoptional

Filters orders by lifecycle status.

payloadstringoptional

Filters orders by payload ID.

pickupstringoptional

Filters orders by pickup place ID.

dropoffstringoptional

Filters orders by dropoff place ID.

returnstringoptional

Filters orders by return place ID.

facilitatorstringoptional

Filters orders by facilitator public or internal ID.

customerstringoptional

Filters orders by customer public or internal ID.

entitystringoptional

Filters orders containing the specified entity public or internal ID.

entity_statusstringoptional

Filters orders by the tracking status code of their payload entities.

ondateoptional

Filters orders created or scheduled on the specified date.

pod_requiredbooleanoptional

When true, returns only orders requiring proof of delivery.

dispatchedbooleanoptional

When true, returns only dispatched orders.

nearbystringoptional

Filters nearby orders using coordinates, a driver ID, or an address string.

GET/v1/orders

curl https://api.fleetbase.io/v1/orders?limit=25&offset=0&sort=created_at&status=created \
  -H "Authorization: Bearer flb_live_…"

200 OK

[
  {
    "id": "order_7YqM3KpL2n",
    "internal_id": "ORD-1001",
    "order_config": "order_config_transport",
    "payload": {
      "id": "payload_x9Z2Lm8QpA",
      "waypoints": [],
      "entities": [],
      "meta": {}
    },
    "customer": null,
    "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"
  }
]

PATCH/v1/orders/:id/schedule

Schedule an Order

Schedules an order for a specific date and optional time. Fleetbase parses the schedule using the supplied timezone or the company timezone.

Body parameters

datedaterequired

Schedule date in YYYY-MM-DD format.

timestringoptional

Optional time to combine with date.

timezonestringoptional

Timezone used when parsing the schedule date and time. Defaults to the company timezone.

PATCH/v1/orders/:id/schedule

curl -X PATCH https://api.fleetbase.io/v1/orders/:id/schedule \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-02-11",
    "time": "8am",
    "timezone": "Asia/Singapore"
}'

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "pickup": {
      "id": "place_1A2b3C4d5E",
      "name": "Marina Bay Sands"
    },
    "dropoff": {
      "id": "place_9Z8y7X6w5V",
      "name": "321 Orchard Rd"
    },
    "return": null,
    "waypoints": [],
    "entities": [],
    "cod_amount": null,
    "cod_currency": null,
    "cod_payment_method": null,
    "payment_method": null,
    "meta": {},
    "updated_at": "2026-05-07T08:30:00.000000Z",
    "created_at": "2026-05-07T08:30:00.000000Z"
  },
  "customer": null,
  "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": "2026-05-08T14:30:00.000000Z",
  "updated_at": "2026-05-07T08:35:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

PATCH/v1/orders/:id/dispatch

Dispatch an Order

Dispatches an order to an assigned or eligible driver. The response returns the order after dispatch state has been applied.

PATCH/v1/orders/:id/dispatch

curl -X PATCH https://api.fleetbase.io/v1/orders/:id/dispatch \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "id": "order_7YqM3KpL2n",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "waypoints": [],
    "entities": [],
    "meta": {}
  },
  "driver_assigned": {
    "id": "driver_A1b2C3d4E5",
    "name": "Alex Driver"
  },
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001",
    "status": "dispatched",
    "status_code": "dispatched",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "type": "transport",
  "status": "dispatched",
  "pod_required": false,
  "dispatched": true,
  "started": false,
  "adhoc": false,
  "adhoc_distance": 0,
  "distance": 0,
  "time": 0,
  "meta": {},
  "dispatched_at": "2026-05-07T08:50:00.000000Z",
  "started_at": null,
  "scheduled_at": null,
  "updated_at": "2026-05-07T08:50:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/orders/:id/start

Start an Order

Starts an order and transitions it into active execution. Use this when a driver or dispatcher begins fulfillment.

Body parameters

skip_dispatchbooleanoptional

Starts the order even if it has not been dispatched.

skipDispatchbooleanoptional

Camel-case alias for skip_dispatch.

assignstringoptional

Driver ID to assign before starting an ad hoc order.

POST/v1/orders/:id/start

curl -X POST https://api.fleetbase.io/v1/orders/:id/start \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "skip_dispatch": false
}'

200 OK

{
  "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"
}

POST/v1/orders/:id/update-activity

Update Order Activity

Updates the current activity state for an order. The response returns the order with the latest workflow activity applied.

Body parameters

activityobjectoptional

Activity payload to apply to the order. Fleetbase resolves it against the order configuration flow.

proofobjectoptional

Optional proof data to attach when the activity updates an entity or waypoint.

skip_dispatchbooleanoptional

Uses the first started activity instead of dispatching when the submitted activity is dispatched.

skipDispatchbooleanoptional

Camel-case alias for skip_dispatch.

POST/v1/orders/:id/update-activity

curl -X POST https://api.fleetbase.io/v1/orders/:id/update-activity \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "skip_dispatch": false
}'

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "current_waypoint": "place_9Z8y7X6w5V",
    "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": "in_progress",
    "status_code": "in_progress",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "in_progress",
  "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:55:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

GET/v1/orders/:id/next-activity

Get Order Next Activity

Returns the next workflow activity for an order. Use it to determine the next operational step available to the assigned driver or dispatcher.

GET/v1/orders/:id/next-activity

curl https://api.fleetbase.io/v1/orders/:id/next-activity \
  -H "Authorization: Bearer flb_live_…"

200 OK

[
  {
    "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."
  }
]

PATCH/v1/orders/:id/set-destination/:placeId

Set Order Destination

Sets the destination waypoint or place for an order. The response returns the updated order after the destination is changed.

PATCH/v1/orders/:id/set-destination/:placeId

curl -X PATCH https://api.fleetbase.io/v1/orders/:id/set-destination/:placeId \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "current_waypoint": "place_9Z8y7X6w5V",
    "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": "in_progress",
    "status_code": "in_progress",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "in_progress",
  "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:58:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/orders/:id/capture-signature/:subject-id

Capture Signature for Order

Captures a signature proof for an order or order subject. Use this when a workflow requires signed proof of delivery or pickup.

Body parameters

signaturestringrequired

Base64 PNG signature data. Fleetbase stores the image and links it to the proof record.

remarksstringoptionalDefault: Verified by Signature

Remarks stored on the proof record.

dataobjectoptional

Structured proof metadata stored with the signature proof.

diskstringoptional

Filesystem disk used to store the signature image. Defaults to the configured filesystem disk.

bucketstringoptional

Storage bucket used for the generated signature file.

POST/v1/orders/:id/capture-signature/:subject-id

curl -X POST https://api.fleetbase.io/v1/orders/:id/capture-signature/:subject-id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "signature": "",
    "data": []
}'

200 OK

{
  "id": "proof_8pQ3mN7xYa",
  "subject_id": "order_7YqM3KpL2n",
  "order_id": "order_7YqM3KpL2n",
  "url": "https://files.example.com/uploads/company_123/signatures/proof_8pQ3mN7xYa.png",
  "remarks": "Verified by Signature",
  "raw": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "data": {
    "recipient_name": "Alex Receiver"
  },
  "updated_at": "2026-05-07T09:10:00.000000Z",
  "created_at": "2026-05-07T09:10:00.000000Z"
}

POST/v1/orders/:id/capture-qr/:subject-id

Capture QR Code for Order

Captures a QR code proof for an order or order subject. The response includes the updated proof data associated with the order.

Body parameters

codestringrequired

QR code value to verify. The code must match the resolved subject UUID.

dataobjectoptional

Structured proof metadata stored with the QR proof.

raw_dataobjectoptional

Raw QR payload stored on the proof record.

POST/v1/orders/:id/capture-qr/:subject-id

curl -X POST https://api.fleetbase.io/v1/orders/:id/capture-qr/:subject-id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "",
    "data": [],
    "raw_data": []
}'

200 OK

{
  "id": "proof_x9L2mN4pQr",
  "subject_id": "entity_4Kp9Lm2QxZ",
  "order_id": "order_7YqM3KpL2n",
  "url": null,
  "remarks": "Verified by QR Code Scan",
  "raw": "entity-qr-scan-payload",
  "data": {
    "scanner": "driver-app"
  },
  "updated_at": "2026-05-07T09:05:00.000000Z",
  "created_at": "2026-05-07T09:05:00.000000Z"
}

GET/v1/orders

Retrieve an Order

Retrieves a single order by ID. The response includes the public order fields plus loaded payload, tracking, assignment, customer, and facilitator data when available.

GET/v1/orders

curl https://api.fleetbase.io/v1/orders \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "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"
}

PUT/v1/orders/:id

Update an Order

Updates an order and returns the updated order resource. You can update order metadata, notes, status, assignment fields, scheduling fields, proof-of-delivery settings, and payload details.

Body parameters

payloadobjectoptional

Existing payload ID or inline payload data used to replace or update the order payload.

pickupobjectoptional

Replacement pickup place data or address for the order payload.

dropoffobjectoptional

Replacement dropoff place data or address for the order payload.

returnobjectoptional

Replacement return place data or address for the order payload.

waypointsarray of objectsoptional

Replacement waypoint list. When sent empty with route endpoint fields, existing waypoints are removed.

entitiesarray of objectsoptional

Replacement entities for the order payload.

service_quotestringoptional

Service quote ID to purchase and attach to the order.

driverstringoptional

Driver ID to assign to the order.

vehiclestringoptional

Vehicle ID to assign to the order.

facilitatorstringoptional

Contact or vendor ID responsible for facilitating the order.

customerstringoptional

Contact or vendor ID to assign as the order customer.

dispatchbooleanoptional

When true, dispatches the order after applying the update.

adhocbooleanoptional

Marks the order as ad hoc.

adhoc_distancenumberoptional

Ad hoc search distance for dispatching nearby drivers.

pod_requiredbooleanoptional

Whether proof of delivery is required to complete the order.

pod_methodstringoptional

Proof of delivery method. Required when pod_required is true.

scheduled_attimestampoptional

Date and time when the order should be scheduled.

typestringoptional

Order type or order configuration key.

statusstringoptional

Order lifecycle status to set.

internal_idstringoptional

Optional internal identifier for the order.

metaobjectoptional

Additional order metadata.

notesstringoptional

Free-form notes attached to the order.

time_window_starttimestampoptional

Earliest time the order should be serviced by the orchestrator.

time_window_endtimestampoptional

Latest time the order should be serviced by the orchestrator.

required_skillsarray of stringsoptional

Skills required for orchestrator assignment.

orchestrator_priorityintegeroptionalDefault: 50

Orchestrator priority for assignment. Fleetbase defaults explicitly empty values to 50.

PUT/v1/orders/:id

curl -X PUT https://api.fleetbase.io/v1/orders/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "service_quote": "quote_hZ3C21KVkx"
}'

Other ways to call this

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "waypoints": [],
    "entities": [],
    "meta": {}
  },
  "customer": null,
  "facilitator": null,
  "driver_assigned": null,
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Leave with the receiving desk.",
  "type": "transport",
  "status": "created",
  "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:45:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

DELETE/v1/orders/:id/cancel

Cancel an Order

Cancels an order without deleting the order resource.

DELETE/v1/orders/:id/cancel

curl -X DELETE https://api.fleetbase.io/v1/orders/:id/cancel \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "waypoints": [],
    "entities": [],
    "meta": {}
  },
  "customer": null,
  "facilitator": null,
  "driver_assigned": null,
  "vehicle_assigned": null,
  "tracking_number": {
    "id": "tracking_3Nf8Qw2YxM",
    "tracking_number": "FB-1001",
    "status": "canceled",
    "status_code": "canceled",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "canceled",
  "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:40:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

DELETE/v1/orders/:id

Delete an Order

Deletes an order resource.

DELETE/v1/orders/:id

curl -X DELETE https://api.fleetbase.io/v1/orders/:id \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "id": "order_7YqM3KpL2n",
  "object": "order",
  "time": "2026-05-07T09:25:00.000000Z",
  "deleted": true
}

GET/v1/orders/:id/distance-and-time

Get Order Distance and Time

Returns and updates the order distance/time matrix.

GET/v1/orders/:id/distance-and-time

curl https://api.fleetbase.io/v1/orders/:id/distance-and-time \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "distance": 4830,
  "time": 875
}

POST/v1/orders/:id/complete

Complete an Order

Completes an order after all waypoints are complete.

POST/v1/orders/:id/complete

curl -X POST https://api.fleetbase.io/v1/orders/:id/complete \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "id": "order_7YqM3KpL2n",
  "internal_id": "ORD-1001",
  "order_config": "order_config_transport",
  "payload": {
    "id": "payload_x9Z2Lm8QpA",
    "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": "completed",
    "status_code": "completed",
    "type": "order"
  },
  "tracking_statuses": [],
  "files": [],
  "purchase_rate": null,
  "notes": "Deliver through receiving bay.",
  "type": "transport",
  "status": "completed",
  "pod_method": "signature",
  "pod_required": true,
  "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-07T09:20:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

GET/v1/orders/:id/tracker

Get Order Tracker

Returns public tracking data for an order.

GET/v1/orders/:id/tracker

curl https://api.fleetbase.io/v1/orders/:id/tracker \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "driver_current_location": {
    "latitude": 1.2921,
    "longitude": 103.8502
  },
  "progress_percentage": 42.5,
  "total_distance": 4830,
  "completed_distance": 2053,
  "current_destination_eta": 720,
  "completion_eta": 1540,
  "estimated_completion_time": "2026-05-07T09:35:00.000000Z",
  "estimated_completion_time_formatted": "May 7th, 2026 09:35",
  "start_time": "2026-05-07T08:52:00.000000Z",
  "completion_time": null,
  "current_destination": {
    "id": "place_9Z8y7X6w5V",
    "name": "321 Orchard Rd"
  },
  "next_destination": null,
  "first_waypoint_completed": true,
  "last_waypoint_completed": false
}

GET/v1/orders/:id/eta

Get Order ETA

Returns ETA data for an order.

GET/v1/orders/:id/eta

curl https://api.fleetbase.io/v1/orders/:id/eta \
  -H "Authorization: Bearer flb_live_…"

200 OK

{
  "9b14b5c4-4669-4f1b-8d52-ef5d9317ad6b": 720,
  "2c44c9f7-4e50-463a-bd0f-f50ab6d2f5e1": 1540
}

GET/v1/orders/:id/comments

List Order Comments

Lists comments attached to an order.

GET/v1/orders/:id/comments

curl https://api.fleetbase.io/v1/orders/:id/comments \
  -H "Authorization: Bearer flb_live_…"

200 OK

[
  {
    "id": "comment_6gK2mN8pQa",
    "content": "Driver should use the receiving bay entrance.",
    "tags": [],
    "meta": {},
    "author": {
      "id": "user_4xK2mQ8pAa",
      "name": "Alex Dispatcher"
    },
    "replies": [],
    "editable": false,
    "updated_at": "2026-05-07T08:45:00.000000Z",
    "created_at": "2026-05-07T08:45:00.000000Z",
    "deleted_at": null
  }
]

POST/v1/orders/:id/capture-photo/:subjectId

Capture Photo for Order

Captures proof photos for an order or order subject.

Body parameters

photosarray of stringsrequired

One or more uploaded images or Base64 image strings. Each item must be an image no larger than 10 MB.

remarksstringoptionalDefault: Verified by Photo

Remarks stored on each proof record.

dataobjectoptional

Structured proof metadata stored with each photo proof.

diskstringoptional

Filesystem disk used to store proof photos. Defaults to the configured filesystem disk.

POST/v1/orders/:id/capture-photo/:subjectId

curl -X POST https://api.fleetbase.io/v1/orders/:id/capture-photo/:subjectId \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "photos": [
    "{{proof_photo_base64}}"
  ],
  "remarks": "Verified by Photo",
  "data": {}
}'

Other ways to call this

200 OK

{
  "id": "proof_3Vq8mN2xLa",
  "subject_id": "order_7YqM3KpL2n",
  "order_id": "order_7YqM3KpL2n",
  "url": "https://files.example.com/uploads/company_123/photos/proof_3Vq8mN2xLa.png",
  "remarks": "Verified by Photo",
  "raw": "iVBORw0KGgoAAAANSUhEUgAA...",
  "data": {
    "captured_by": "driver-app"
  },
  "updated_at": "2026-05-07T09:15:00.000000Z",
  "created_at": "2026-05-07T09:15:00.000000Z"
}

GET/v1/orders/:id/proofs/:subjectId

List Order Proofs

Lists proof of delivery resources for an order or subject.

GET/v1/orders/:id/proofs/:subjectId

curl https://api.fleetbase.io/v1/orders/:id/proofs/:subjectId \
  -H "Authorization: Bearer flb_live_…"

200 OK

[
  {
    "id": "proof_8pQ3mN7xYa",
    "subject_id": "order_7YqM3KpL2n",
    "order_id": "order_7YqM3KpL2n",
    "url": "https://files.example.com/uploads/company_123/signatures/proof_8pQ3mN7xYa.png",
    "remarks": "Verified by Signature",
    "raw": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "data": {
      "recipient_name": "Alex Receiver"
    },
    "updated_at": "2026-05-07T09:10:00.000000Z",
    "created_at": "2026-05-07T09:10:00.000000Z"
  }
]

GET/v1/orders/:id/editable-entity-fields

Get Editable Entity Fields

Returns configured editable entity fields for an order.

GET/v1/orders/:id/editable-entity-fields

curl https://api.fleetbase.io/v1/orders/:id/editable-entity-fields \
  -H "Authorization: Bearer flb_live_…"

200 OK

[
  {
    "key": "weight",
    "label": "Weight",
    "type": "number"
  },
  {
    "key": "length",
    "label": "Length",
    "type": "number"
  }
]