diff --git a/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/OK.example.yaml deleted file mode 100644 index ca07aef..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/OK.example.yaml +++ /dev/null @@ -1,13 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id" - method: DELETE - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - body: - type: text - content: "" -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..4fd8767 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order.resources/examples/OK.example.yaml @@ -0,0 +1,44 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id" + method: DELETE + pathVariables: + id: "" +response: + statusCode: 200 + statusText: OK + body: + type: json + content: |- + { + "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" + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..d295672 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/OK.example.yaml @@ -0,0 +1,42 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/capture-photo/:subjectId" + method: POST + headers: + Content-Type: application/json + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" + subjectId: "order_7YqM3KpL2n" + body: + type: json + content: |- + { + "photos": ["iVBORw0KGgoAAAANSUhEUgAA..."], + "remarks": "Verified by Photo", + "data": { + "captured_by": "driver-app" + } + } +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "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" + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/OK.example.yaml index db4e1ae..b4cbc64 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/OK.example.yaml @@ -8,6 +8,17 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/OK.example.yaml index db4e1ae..5334509 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/OK.example.yaml @@ -8,6 +8,17 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..3cb53e7 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/OK.example.yaml @@ -0,0 +1,48 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/complete" + method: POST + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "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" + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Complete Payload.example.yaml similarity index 95% rename from postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Created.example.yaml rename to postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Complete Payload.example.yaml index cb92582..74f9024 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Created.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Complete Payload.example.yaml @@ -3,8 +3,10 @@ request: url: "{{base_url}}/{{namespace}}/orders" method: POST headers: - Content-Type: application/json - Accept: application/json + - key: Content-Type + value: application/json + - key: Accept + value: application/json body: type: json content: |- @@ -20,7 +22,8 @@ response: statusCode: 201 statusText: Created headers: - Content-Type: application/json + - key: Content-Type + value: application/json body: type: json content: |- @@ -123,3 +126,4 @@ response: "created_at": "2026-05-07T08:30:00.000000Z" } order: 1000 +name: Create an Order using Complete Payload diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Payload.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Payload.example.yaml index 9b29d71..50e4c43 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Payload.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Payload.example.yaml @@ -42,6 +42,51 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "id": "order_9LmN2QxZa4", + "internal_id": null, + "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_7Nf8Qw2YxM", "tracking_number": "FB-1003", "status": "created", "status_code": "created", "type": "order" }, + "tracking_statuses": [], + "files": [], + "purchase_rate": null, + "notes": null, + "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" + } order: 4000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entities with Photos.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entities with Photos.example.yaml index 85b29d0..ee76c8a 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entities with Photos.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entities with Photos.example.yaml @@ -50,6 +50,61 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "id": "order_8JqM4LpN3x", + "internal_id": null, + "order_config": "order_config_transport", + "payload": { + "id": "payload_2KpLm9QxZa", + "current_waypoint": "place_pickup123", + "pickup": { "id": "place_pickup123", "name": "Pickup" }, + "dropoff": { "id": "place_dropoff456", "name": "Dropoff" }, + "return": null, + "waypoints": [ + { "id": "waypoint_1", "place": { "id": "place_stop1", "name": "Stop 1" } } + ], + "entities": [ + { + "id": "entity_4Kp9Lm2QxZ", + "name": "Parcel", + "type": "parcel", + "photos": ["https://files.example.com/entity-photo.png"] + } + ], + "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_6Nf8Qw2YxM", "tracking_number": "FB-1002", "status": "created", "status_code": "created", "type": "order" }, + "tracking_statuses": [], + "files": [], + "purchase_rate": null, + "notes": null, + "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" + } order: 6000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entity Destinations.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entity Destinations.example.yaml index 7084253..a7a8c4e 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entity Destinations.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using Waypoints and Entity Destinations.example.yaml @@ -47,6 +47,60 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "id": "order_2Qa9LmN4xZ", + "internal_id": null, + "order_config": "order_config_transport", + "payload": { + "id": "payload_4LmN9QxZa2", + "current_waypoint": "place_pickup123", + "pickup": { "id": "place_pickup123", "name": "Pickup" }, + "dropoff": { "id": "place_dropoff456", "name": "Dropoff" }, + "return": null, + "waypoints": [ + { "id": "waypoint_1", "place": { "id": "place_stop1", "name": "Stop 1" } } + ], + "entities": [ + { + "id": "entity_6Kp9Lm2QxZ", + "name": "Parcel", + "destination": "place_dropoff456" + } + ], + "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_8Nf8Qw2YxM", "tracking_number": "FB-1004", "status": "created", "status_code": "created", "type": "order" }, + "tracking_statuses": [], + "files": [], + "purchase_rate": null, + "notes": null, + "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" + } order: 5000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Pickup Dropoff.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Pickup Dropoff.example.yaml index 295d49d..e1b3ad3 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Pickup Dropoff.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Pickup Dropoff.example.yaml @@ -16,6 +16,51 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "id": "order_7YqM3KpL2n", + "internal_id": null, + "order_config": "order_config_transport", + "payload": { + "id": "payload_x9Z2Lm8QpA", + "pickup": { "id": "place_1A2b3C4d5E", "name": "Singapore 018971" }, + "dropoff": { "id": "place_9Z8y7X6w5V", "name": "321 Orchard Rd, Singapore" }, + "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": null, + "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" + } order: 2000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Waypoints.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Waypoints.example.yaml index 10b4c5f..862a777 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Waypoints.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Create an Order.resources/examples/Create an Order using only Waypoints.example.yaml @@ -22,6 +22,56 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "id": "order_4Za9LmN2Qx", + "internal_id": null, + "order_config": "order_config_transport", + "payload": { + "id": "payload_7LmN9QxZa2", + "current_waypoint": "place_stop1", + "pickup": { "id": "place_stop1", "name": "Stop 1" }, + "dropoff": { "id": "place_stop3", "name": "Stop 3" }, + "return": null, + "waypoints": [ + { "id": "waypoint_1", "place": { "id": "place_stop1", "name": "Stop 1" } }, + { "id": "waypoint_2", "place": { "id": "place_stop2", "name": "Stop 2" } }, + { "id": "waypoint_3", "place": { "id": "place_stop3", "name": "Stop 3" } } + ], + "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_9Nf8Qw2YxM", "tracking_number": "FB-1005", "status": "created", "status_code": "created", "type": "order" }, + "tracking_statuses": [], + "files": [], + "purchase_rate": null, + "notes": null, + "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" + } order: 3000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..92c8d71 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/OK.example.yaml @@ -0,0 +1,23 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id" + method: DELETE + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "order_7YqM3KpL2n", + "object": "order", + "time": "2026-05-07T09:25:00.000000Z", + "deleted": true + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/OK.example.yaml new file mode 100644 index 0000000..6d337b6 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/OK.example.yaml @@ -0,0 +1,29 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/editable-entity-fields" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + [ + { + "key": "weight", + "label": "Weight", + "type": "number" + }, + { + "key": "length", + "label": "Length", + "type": "number" + } + ] +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/OK.example.yaml new file mode 100644 index 0000000..1cc1996 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/OK.example.yaml @@ -0,0 +1,21 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/distance-and-time" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "distance": 4830, + "time": 875 + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a950276 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/OK.example.yaml @@ -0,0 +1,21 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/eta" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "9b14b5c4-4669-4f1b-8d52-ef5d9317ad6b": 720, + "2c44c9f7-4e50-463a-bd0f-f50ab6d2f5e1": 1540 + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/OK.example.yaml index db4e1ae..b522ba7 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/OK.example.yaml @@ -8,6 +8,26 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + [ + { + "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." + } + ] order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/OK.example.yaml new file mode 100644 index 0000000..11e4be5 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/OK.example.yaml @@ -0,0 +1,39 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/tracker" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "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 + } +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/OK.example.yaml new file mode 100644 index 0000000..1f42319 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/OK.example.yaml @@ -0,0 +1,34 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/comments" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + [ + { + "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 + } + ] +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/OK.example.yaml new file mode 100644 index 0000000..b4e423f --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/OK.example.yaml @@ -0,0 +1,33 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders/:id/proofs/:subjectId" + method: GET + headers: + Accept: application/json + pathVariables: + id: "order_7YqM3KpL2n" + subjectId: "order_7YqM3KpL2n" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + [ + { + "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" + } + ] +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/OK.example.yaml new file mode 100644 index 0000000..4793c91 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/OK.example.yaml @@ -0,0 +1,50 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/orders" + method: GET + headers: + Accept: application/json + queryParams: + limit: "10" +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + [ + { + "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" + } + ] +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/OK.example.yaml index 5204f58..209155f 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/OK.example.yaml @@ -15,6 +15,51 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/OK.example.yaml index db4e1ae..ec05603 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/OK.example.yaml @@ -8,6 +8,37 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/OK.example.yaml index db4e1ae..7c8735b 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/OK.example.yaml @@ -8,6 +8,37 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/OK.example.yaml index db4e1ae..c8f8d5c 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/OK.example.yaml @@ -8,6 +8,37 @@ response: statusCode: 200 statusText: OK body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml b/postman/collections/Fleetbase API/Orders/Cancel an Order.request.yaml similarity index 76% rename from postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml rename to postman/collections/Fleetbase API/Orders/Cancel an Order.request.yaml index 5d0fca1..34c71d9 100644 --- a/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Cancel an Order.request.yaml @@ -1,5 +1,4 @@ $kind: http-request -name: Cancel an Order. description: Cancels an order without deleting the order resource. url: "{{base_url}}/{{namespace}}/orders/:id/cancel" method: DELETE @@ -7,5 +6,5 @@ pathVariables: - key: id value: "{{order_id}}" description: (Required) The id of the `Order`. -examples: ./.resources/Cancel an Order-.resources/examples +examples: .resources/Cancel an Order.resources/examples order: 13000