From 2cebf84749bfc913d8a6c50fc2fd6af749bee5a9 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 14:20:21 +0800 Subject: [PATCH 01/10] Revert "Merge pull request #2 from fleetbase/complete-api-collection-content" This reverts commit 40bb3750aa269d193edf003f6fb3b82bf1e37bfe, reversing changes made to 7600e1c181fc4b116e732ce7292cfd53cfadef12. --- .../Contacts/.resources/object.yaml | 37 ----------- .../Contacts/Delete a Contact.request.yaml | 3 +- .../Contacts/Query Contacts.request.yaml | 2 +- .../Contacts/Update a Contact.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 40 ------------ .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 32 --------- .../Drivers/.resources/object.yaml | 37 ----------- .../Drivers/Create a Driver.request.yaml | 3 +- .../Drivers/Login Driver.params.yaml | 10 --- .../Drivers/Query Drivers.request.yaml | 3 +- .../Drivers/Register Device.params.yaml | 9 --- .../Register Driver Device.params.yaml | 9 --- .../Request Driver Login SMS.params.yaml | 5 -- .../Drivers/Retrieve a Driver.request.yaml | 3 +- .../Drivers/Simulate Driver Route.params.yaml | 22 ------- .../Switch Driver Organization.params.yaml | 5 -- .../Drivers/Toggle Driver Online.params.yaml | 5 -- .../Verify Driver Login Code.params.yaml | 10 --- .../examples/Successful Response.example.yaml | 34 ---------- .../Entities/.resources/object.yaml | 29 --------- .../Entities/Create an Entity.request.yaml | 3 +- .../Entities/Delete a Entity.request.yaml | 3 +- .../Entities/Update a Entity.request.yaml | 3 +- .../Fleets/.resources/object.yaml | 29 --------- .../Fleets/Delete a Fleet.request.yaml | 3 +- .../Fleets/Query Fleets.request.yaml | 2 +- .../Fleets/Update a Fleet.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 39 ----------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 36 ---------- .../Fuel Reports/.resources/object.yaml | 29 --------- .../Create a Fuel Report.request.yaml | 3 +- .../Delete a Fuel Report.request.yaml | 3 +- .../Query Fuel Reports.request.yaml | 3 +- .../Retrieve a Fuel Report.request.yaml | 3 +- .../Update a Fuel Report.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 33 ---------- .../Geofences/.resources/object.yaml | 29 --------- .../Get Driver Geofence History.request.yaml | 3 +- .../Get Geofence Dwell Report.request.yaml | 3 +- .../Get Geofence Inventory.request.yaml | 3 +- .../List Geofence Events.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 38 ----------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 35 ---------- .../Issues/.resources/object.yaml | 29 --------- .../Issues/Create an Issue.request.yaml | 3 +- .../Issues/Delete an Issue.request.yaml | 3 +- .../Issues/Query Issues.request.yaml | 3 +- .../Issues/Retrieve an Issue.request.yaml | 3 +- .../Issues/Update an Issue.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 27 -------- .../Labels/.resources/object.yaml | 29 --------- .../examples/Successful Response.example.yaml | 24 ------- .../Onboard/.resources/object.yaml | 29 --------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 43 ------------ .../examples/Successful Response.example.yaml | 40 ------------ .../examples/Successful Response.example.yaml | 39 ----------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 39 ----------- .../examples/Successful Response.example.yaml | 40 ------------ .../examples/Successful Response.example.yaml | 42 ------------ .../examples/Successful Response.example.yaml | 39 ----------- .../examples/Successful Response.example.yaml | 35 ---------- .../examples/Successful Response.example.yaml | 37 ----------- .../examples/Successful Response.example.yaml | 37 ----------- .../examples/Successful Response.example.yaml | 37 ----------- .../Orders/.resources/object.yaml | 53 --------------- .../Capture Photo for Order.params.yaml | 11 ---- .../Capture QR Code for Order.params.yaml | 12 ---- .../Capture QR Code for Order.request.yaml | 2 +- .../Capture Signature for Order.params.yaml | 8 --- .../Capture Signature for Order.request.yaml | 2 +- .../Orders/Create an Order.request.yaml | 8 ++- .../Orders/Dispatch an Order.request.yaml | 2 +- .../Get Order Next Activity.params.yaml | 8 --- .../Get Order Next Activity.request.yaml | 2 +- .../Orders/Query Orders.request.yaml | 3 +- .../Orders/Schedule an Order.params.yaml | 11 ---- .../Orders/Set Order Destination.params.yaml | 8 --- .../Orders/Set Order Destination.request.yaml | 2 +- .../Orders/Start an Order.params.yaml | 5 -- .../Orders/Start an Order.request.yaml | 2 +- .../Orders/Update Order Activity.request.yaml | 2 +- .../Orders/Update an Order.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 33 ---------- .../Organizations/.resources/object.yaml | 29 --------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 49 -------------- .../Payloads/.resources/object.yaml | 29 --------- .../Payloads/Create a Payload.request.yaml | 3 +- .../Payloads/Delete a Payload.request.yaml | 3 +- .../Payloads/Update a Payload.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 42 ------------ .../examples/Successful Response.example.yaml | 37 ----------- .../examples/Successful Response.example.yaml | 38 ----------- .../examples/Successful Response.example.yaml | 27 -------- .../examples/Successful Response.example.yaml | 29 --------- .../Places/.resources/object.yaml | 40 ------------ .../Places/Create a Place.request.yaml | 4 +- .../Places/List all Places.request.yaml | 2 +- .../Places/Query Places.request.yaml | 2 +- .../Places/Retrieve a Place.request.yaml | 3 +- .../Places/Update a Place.request.yaml | 4 +- .../examples/Successful Response.example.yaml | 34 ---------- .../Purchase Rates/.resources/object.yaml | 29 --------- .../Query Purchase Rates.request.yaml | 3 +- .../Retrieve a Purchase Rate.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 32 --------- .../Service Areas/.resources/object.yaml | 29 --------- .../Create a Service Area.request.yaml | 4 +- .../Query Service Areas.request.yaml | 2 +- .../Retrieve a Service Area.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 24 ------- .../Service Quotes/.resources/object.yaml | 29 --------- .../Query Service Quotes.params.yaml | 8 --- .../Query Service Quotes.request.yaml | 4 +- .../examples/Successful Response.example.yaml | 65 ------------------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 37 ----------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 35 ---------- .../Service Rates/.resources/object.yaml | 29 --------- .../Delete a Service Rate.params.yaml | 8 --- .../Query Service Rates.params.yaml | 8 --- .../Retrieve a Service Rate.params.yaml | 8 --- .../examples/Successful Response.example.yaml | 29 --------- .../Tracking Numbers/.resources/object.yaml | 29 --------- .../Create a Tracking Number.request.yaml | 3 +- .../Decode Tracking Number QR.params.yaml | 6 -- .../Delete a Tracking Number.params.yaml | 11 ---- .../Delete a Tracking Number.request.yaml | 3 +- .../Query Tracking Numbers.request.yaml | 3 +- .../Retrieve a Tracking Number.request.yaml | 4 +- .../Tracking Statuses/.resources/object.yaml | 29 --------- .../Update a Tracking Status.request.yaml | 2 +- .../examples/Successful Response.example.yaml | 34 ---------- .../Vehicles/.resources/object.yaml | 37 ----------- .../Vehicles/Query Vehicles.request.yaml | 3 +- .../Vehicles/Update a Vehicle.request.yaml | 4 +- .../Vendors/.resources/object.yaml | 29 --------- .../Vendors/Create a Vendor.request.yaml | 3 +- .../Vendors/Query Vendors.request.yaml | 3 +- .../Vendors/Retrieve a Vendor.request.yaml | 3 +- .../Zones/.resources/object.yaml | 29 --------- .../Zones/Create a Zone.request.yaml | 2 +- .../Zones/Query Zones.request.yaml | 2 +- .../Zones/Retrieve a zone.request.yaml | 2 +- .../Zones/Update a Zone.request.yaml | 5 +- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 31 --------- .../Chat Channels/.resources/object.yaml | 29 --------- .../Chat Channels/Add Participant.params.yaml | 5 -- .../Add Participant.request.yaml | 3 +- .../Create Chat Channel.request.yaml | 3 +- .../Create Read Receipt.request.yaml | 3 +- .../Delete Chat Channel.request.yaml | 3 +- .../Chat Channels/Delete Message.request.yaml | 3 +- .../List Available Participants.request.yaml | 3 +- .../Query Chat Channels.request.yaml | 3 +- .../Remove Participant.request.yaml | 3 +- .../Retrieve Chat Channel.request.yaml | 3 +- .../Chat Channels/Send Message.params.yaml | 11 ---- .../Chat Channels/Send Message.request.yaml | 3 +- .../Update Chat Channel.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 31 --------- .../Comments/.resources/object.yaml | 29 --------- .../Comments/Create Comment.request.yaml | 3 +- .../Comments/Delete Comment.request.yaml | 3 +- .../Comments/Query Comments.request.yaml | 3 +- .../Comments/Retrieve Comment.request.yaml | 3 +- .../Comments/Update Comment.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 35 ---------- .../Files/.resources/object.yaml | 29 --------- .../Files/Delete a File.request.yaml | 3 +- .../Files/Download File.request.yaml | 3 +- .../Files/Query Files.request.yaml | 3 +- .../Files/Retrieve a File.request.yaml | 3 +- .../Files/Update File.request.yaml | 3 +- .../Files/Upload Base64 File.params.yaml | 17 ----- .../Files/Upload Base64 File.request.yaml | 3 +- .../Files/Upload File.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 22 ------- .../Organizations/.resources/object.yaml | 29 --------- .../examples/Successful Response.example.yaml | 20 ------ .../examples/Successful Response.example.yaml | 28 -------- .../examples/Successful Response.example.yaml | 40 ------------ .../examples/Successful Response.example.yaml | 40 ------------ .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 33 ---------- .../Public Invoices/.resources/object.yaml | 37 ----------- .../Get Public Invoice.request.yaml | 3 +- .../List Public Invoice Gateways.request.yaml | 3 +- .../Pay Public Invoice.params.yaml | 8 --- .../Pay Public Invoice.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 38 ----------- .../examples/Successful Response.example.yaml | 33 ---------- .../Wallet/.resources/object.yaml | 33 ---------- .../Wallet/Get Wallet Balance.request.yaml | 3 +- .../Wallet/Get Wallet.request.yaml | 3 +- .../List Wallet Transactions.request.yaml | 3 +- .../Wallet/Top Up Wallet.params.yaml | 19 ------ .../Wallet/Top Up Wallet.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 35 ---------- .../Webhooks/.resources/object.yaml | 29 --------- .../Handle Gateway Webhook.params.yaml | 19 ------ .../Handle Gateway Webhook.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 37 ----------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 23 ------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 27 -------- .../Cart/.resources/object.yaml | 36 ---------- .../Cart/Add Item to Cart.params.yaml | 17 ----- .../Cart/Add Item to Cart.request.yaml | 2 +- .../Cart/Delete Cart.request.yaml | 3 +- .../Cart/Empty cart.request.yaml | 2 +- .../Cart/Remove item from cart.request.yaml | 2 +- .../Cart/Retrieve a Cart.request.yaml | 2 +- .../Cart/Retrieve or Create Cart.request.yaml | 2 +- .../Cart/Update item in Cart.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 30 --------- .../Category/.resources/object.yaml | 29 --------- .../Category/List categories.request.yaml | 2 +- .../Successful Response.example.yaml" | 31 --------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 30 --------- .../examples/Successful Response.example.yaml | 28 -------- .../examples/Successful Response.example.yaml | 28 -------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 34 ---------- .../Checkout/.resources/object.yaml | 29 --------- .../Before \342\235\227.request.yaml" | 3 +- ...Capture QPay Callback via GET.request.yaml | 3 +- .../Capture QPay Callback.params.yaml | 11 ---- .../Capture QPay Callback.request.yaml | 3 +- .../Capture checkout as order.params.yaml | 6 -- .../Capture checkout as order.request.yaml | 2 +- .../Create Stripe Setup Intent.request.yaml | 3 +- .../Checkout/Get Checkout Status.request.yaml | 3 +- .../Update Stripe Payment Intent.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 30 --------- .../Successful Response.example.yaml" | 26 -------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 27 -------- .../examples/Successful Response.example.yaml | 27 -------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 31 --------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 29 --------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 33 ---------- .../examples/Successful Response.example.yaml | 28 -------- .../examples/Successful Response.example.yaml | 30 --------- .../examples/Successful Response.example.yaml | 26 -------- .../Customer/.resources/object.yaml | 32 --------- ...uthenticate a Customer via SMS.params.yaml | 8 --- ...thenticate a Customer via SMS.request.yaml | 2 +- ...enticate a Customer with Apple.params.yaml | 20 ------ ...nticate a Customer with Apple.request.yaml | 3 +- ...icate a Customer with Facebook.params.yaml | 11 ---- ...cate a Customer with Facebook.request.yaml | 3 +- ...nticate a Customer with Google.params.yaml | 8 --- ...ticate a Customer with Google.request.yaml | 3 +- ...icate a Customer \342\235\227.params.yaml" | 8 --- ...cate a Customer \342\235\227.request.yaml" | 2 +- .../Confirm Account Closure.params.yaml | 6 -- .../Confirm Account Closure.request.yaml | 3 +- .../Customer/Create a Customer.request.yaml | 2 +- .../Get Stripe Ephemeral Key.params.yaml | 2 - .../Get Stripe Ephemeral Key.request.yaml | 3 +- .../Get Stripe Setup Intent.params.yaml | 2 - .../Get Stripe Setup Intent.request.yaml | 3 +- .../List a customer orders.request.yaml | 2 +- .../List a customer saved places.request.yaml | 2 +- .../Customer/Query customers.request.yaml | 2 +- .../Register customer device.params.yaml | 9 --- .../Register customer device.request.yaml | 2 +- .../Request Phone Verification.params.yaml | 5 -- .../Request Phone Verification.request.yaml | 3 +- .../Customer/Retrieve a Customer.request.yaml | 3 +- ...reate a new storefront custome.params.yaml | 8 --- ...eate a new storefront custome.request.yaml | 2 +- .../Start Account Closure.params.yaml | 2 - .../Start Account Closure.request.yaml | 3 +- ...Update Contact Customer Alias.request.yaml | 3 +- .../Customer/Update a Customer.request.yaml | 2 +- .../Customer/Verify Phone Number.params.yaml | 9 --- .../Customer/Verify Phone Number.request.yaml | 3 +- .../Customer/Verify a SMS code.params.yaml | 6 -- .../Customer/Verify a SMS code.request.yaml | 2 +- .../Successful Response.example.yaml" | 26 -------- .../.resources/object.yaml | 29 --------- ...y Service Quote \342\235\227.request.yaml" | 2 +- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../Food Trucks/.resources/object.yaml | 29 --------- .../Query Food Trucks.request.yaml | 3 +- .../Retrieve Food Truck.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 35 ---------- .../examples/Successful Response.example.yaml | 37 ----------- .../Orders/.resources/object.yaml | 53 --------------- .../Orders/Complete Order Pickup.params.yaml | 5 -- .../Orders/Complete Order Pickup.request.yaml | 3 +- .../Orders/Get Order Receipt.params.yaml | 11 ---- .../Orders/Get Order Receipt.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 32 --------- .../examples/Successful Response.example.yaml | 34 ---------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 34 ---------- .../Products/.resources/object.yaml | 37 ----------- .../Products/Create Product.request.yaml | 3 +- .../Products/Query Products.request.yaml | 2 +- .../Products/Retrieve a Product.request.yaml | 2 +- .../Products/Update Product.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 18 ----- .../examples/Successful Response.example.yaml | 29 --------- .../examples/Successful Response.example.yaml | 22 ------- .../Successful Response.example.yaml" | 34 ---------- .../examples/Successful Response.example.yaml | 24 ------- .../Reviews/.resources/object.yaml | 29 --------- ...number of ratings for a store.request.yaml | 3 +- .../Reviews/Create a review.request.yaml | 3 +- .../Reviews/Delete a Review.request.yaml | 3 +- .../Query Reviews \342\235\227.request.yaml" | 3 +- .../Retrieve a Store review.request.yaml | 3 +- .../examples/Successful Response.example.yaml | 30 --------- .../Store Locations/.resources/object.yaml | 29 --------- .../Query Store Locations.request.yaml | 2 +- .../examples/Successful Response.example.yaml | 22 ------- .../examples/Successful Response.example.yaml | 30 --------- .../examples/Successful Response.example.yaml | 35 ---------- .../examples/Successful Response.example.yaml | 30 --------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 25 ------- .../examples/Successful Response.example.yaml | 24 ------- .../examples/Successful Response.example.yaml | 26 -------- .../examples/Successful Response.example.yaml | 24 ------- .../Store/.resources/object.yaml | 29 --------- .../Store/About Store.request.yaml | 3 +- .../Store/List Locations.request.yaml | 3 +- .../Store/List Network Stores.request.yaml | 3 +- .../Store/List Tags.request.yaml | 3 +- .../Store/Lookup Store.request.yaml | 3 +- ...ateways for the current store.request.yaml | 3 +- .../Store/Retrieve Location.request.yaml | 3 +- .../Store/Search Store.request.yaml | 3 +- ... payment gateway given the id.request.yaml | 3 +- 409 files changed, 174 insertions(+), 7063 deletions(-) delete mode 100644 postman/collections/Fleetbase API/Contacts/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Get Driver Current Organization.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/List Driver Organizations.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Login Driver.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Register Device.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Register Driver Device.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Request Driver Login SMS.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Simulate Driver Route.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Switch Driver Organization.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Toggle Driver Online.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Track Driver.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/Verify Driver Login Code.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Register Device.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml delete mode 100644 postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml delete mode 100644 postman/collections/Fleetbase API/Entities/.resources/Query Entities.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Entities/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Fleets/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/Create a Fuel Report.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/Delete a Fuel Report.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/Query Fuel Reports.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/Retrieve a Fuel Report.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/Update a Fuel Report.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Geofences/.resources/Get Driver Geofence History.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Dwell Report.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Inventory.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Geofences/.resources/List Geofence Events.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Geofences/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/Create an Issue.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/Delete an Issue.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/Query Issues.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/Retrieve an Issue.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/Update an Issue.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Issues/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Labels/.resources/Render Label.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Labels/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Onboard/.resources/Get Driver Onboard Settings.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Onboard/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Get Order Next Activity.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Set Order Destination.params.yaml delete mode 100644 postman/collections/Fleetbase API/Orders/Start an Order.params.yaml delete mode 100644 postman/collections/Fleetbase API/Organizations/.resources/List Organizations.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Organizations/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Payloads/.resources/Delete a Payload.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Payloads/.resources/Query Payloads.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Payloads/.resources/Retrieve a Payload.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Payloads/.resources/Update a Payload.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Payloads/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/Create a Place.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/List all Places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/Query Places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/Retrieve a Place.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/Search Places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Places/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Purchase Rates/.resources/Query Purchase Rates.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Service Areas/.resources/Create a Service Area.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Areas/.resources/Query Service Areas.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Areas/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Service Quotes/.resources/Retrieve a Service Quote.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Quotes/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.params.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/Create a Service Rate.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/Delete a Service Rate.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/Query Service Rates.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/Retrieve a Service Rate.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/Update a Service Rate.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/Delete a Service Rate.params.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/Query Service Rates.params.yaml delete mode 100644 postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.params.yaml delete mode 100644 postman/collections/Fleetbase API/Tracking Numbers/.resources/Decode Tracking Number QR.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml delete mode 100644 postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.params.yaml delete mode 100644 postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Vehicles/.resources/Track Vehicle.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase API/Vehicles/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Vendors/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase API/Zones/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Add Participant.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Chat Channel.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Read Receipt.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Chat Channel.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Message.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/List Available Participants.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Query Chat Channels.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Remove Participant.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Retrieve Chat Channel.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Send Message.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/Update Chat Channel.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml delete mode 100644 postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/Create Comment.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/Delete Comment.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/Query Comments.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/Retrieve Comment.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/Update Comment.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Delete a File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Download File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Query Files.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Retrieve a File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Update File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Upload Base64 File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/Upload File.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml delete mode 100644 postman/collections/Fleetbase Core API/Organizations/.resources/Get Current Organization.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Cancel Order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Create Order from Service Quote.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Internal Service Quote.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Service Quote from Integrated Vendor.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Orders.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Integrated Vendor Flow/.resources/Search Places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Get Public Invoice.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/.resources/List Public Invoice Gateways.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Pay Public Invoice.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet Balance.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/List Wallet Transactions.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/Top Up Wallet.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Webhooks/.resources/Handle Gateway Webhook.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Add Item to Cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Delete Cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Empty cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Remove item from cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve a Cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve or Create Cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/Update item in Cart.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Category/.resources/List categories.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml delete mode 100644 "postman/collections/Fleetbase Storefront API/Checkout/.resources/Before \342\235\227.resources/examples/Successful Response.example.yaml" delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback via GET.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture checkout as order.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Create Stripe Setup Intent.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Get Checkout Status.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/Update Stripe Payment Intent.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer via SMS.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Apple.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Facebook.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Google.resources/examples/Successful Response.example.yaml delete mode 100644 "postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer \342\235\227.resources/examples/Successful Response.example.yaml" delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Confirm Account Closure.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Create a Customer.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Ephemeral Key.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Setup Intent.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer orders.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer saved places.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Query customers.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Register customer device.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Request Phone Verification.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Retrieve a Customer.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Setups a verification request to create a new storefront custome.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Start Account Closure.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Update Contact Customer Alias.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Update a Customer.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Verify Phone Number.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/Verify a SMS code.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml delete mode 100644 "postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml delete mode 100644 "postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/Retrieve a Delivery Service Quote \342\235\227.resources/examples/Successful Response.example.yaml" delete mode 100644 postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Query Food Trucks.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Retrieve Food Truck.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Orders/.resources/Complete Order Pickup.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Orders/.resources/Get Order Receipt.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/Create Product.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/Query Products.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/Retrieve a Product.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/Update Product.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/Counts the number of ratings for a store.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/Create a review.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/Delete a Review.resources/examples/Successful Response.example.yaml delete mode 100644 "postman/collections/Fleetbase Storefront API/Reviews/.resources/Query Reviews \342\235\227.resources/examples/Successful Response.example.yaml" delete mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/Retrieve a Store review.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store Locations/.resources/Query Store Locations.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/About Store.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/List Locations.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/List Network Stores.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/List Tags.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/Lookup Store.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/Payment gateways for the current store.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/Retrieve Location.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/Search Store.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/Specific payment gateway given the id.resources/examples/Successful Response.example.yaml delete mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml diff --git a/postman/collections/Fleetbase API/Contacts/.resources/object.yaml b/postman/collections/Fleetbase API/Contacts/.resources/object.yaml deleted file mode 100644 index 82a6080..0000000 --- a/postman/collections/Fleetbase API/Contacts/.resources/object.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: object -name: Contact -description: |- - A contact represents a contact record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "contact_abc123", - "object": "contact", - "name": "John Doe", - "type": "customer", - "email": "john@example.com", - "phone": "+15555550100", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: name - type: string - description: "Display name for the resource." - - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." - - name: email - type: string - description: "Email address for the person or customer." - - name: phone - type: string - description: "Phone number for the person or customer." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml b/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml index 8fb0745..8aa011f 100644 --- a/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a contacts resource. The response confirms the resource that was removed. +description: Delete a Contact. url: "{{base_url}}/{{namespace}}/contacts/:id" method: DELETE headers: diff --git a/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml b/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml index b3b45d3..d36c549 100644 --- a/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns contacts matching the supplied filters. Use pagination and query parameters to control the result set. + Returns a paginated list of contacts for the current organization. Use filters such as `query`, `limit`, `offset`, and `sort` to narrow and order the results. url: "{{base_url}}/{{namespace}}/contacts" method: GET headers: diff --git a/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml b/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml index 7a568cc..b77a73a 100644 --- a/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a contact. Parameters not supplied remain unchanged. +description: Update a Contact url: "{{base_url}}/{{namespace}}/contacts/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Get Driver Current Organization.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Get Driver Current Organization.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 722043f..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Get Driver Current Organization.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/current-organization" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/List Driver Organizations.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/List Driver Organizations.resources/examples/Successful Response.example.yaml deleted file mode 100644 index c2b2aa8..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/List Driver Organizations.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/organizations" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Login Driver.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Login Driver.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 213de7d..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Login Driver.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/login" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "identity": "{{driver_identity}}", - "password": "{{driver_password}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Register Device.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Register Device.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 90a4f00..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Register Device.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/register-device" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "token": "{{device_token}}", - "platform": "ios" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Register Driver Device.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Register Driver Device.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 1372256..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Register Driver Device.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/register-device" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "token": "{{device_token}}", - "platform": "ios" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Request Driver Login SMS.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Request Driver Login SMS.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 122656a..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Request Driver Login SMS.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/login-with-sms" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "phone": "{{driver_phone}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Simulate Driver Route.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Simulate Driver Route.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 70699ec..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Simulate Driver Route.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/simulate" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "start": { - "latitude": 1.3521, - "longitude": 103.8198 - }, - "end": { - "latitude": 1.2903, - "longitude": 103.8519 - } - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Switch Driver Organization.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Switch Driver Organization.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ab57b73..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Switch Driver Organization.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/switch-organization" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "next": "{{organization_id}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Toggle Driver Online.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Toggle Driver Online.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 02986f8..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Toggle Driver Online.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/toggle-online" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "online": true - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Track Driver.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Track Driver.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 51fdd2c..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Track Driver.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/:id/track" - method: PATCH - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: text - content: |- - { - "latitude": -19.288195, - "longitude": 146.795965, - "speed": 100 - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/Verify Driver Login Code.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Drivers/.resources/Verify Driver Login Code.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ffa31a5..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/Verify Driver Login Code.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/drivers/verify-code" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "identity": "{{driver_identity}}", - "code": "{{verification_code}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/object.yaml b/postman/collections/Fleetbase API/Drivers/.resources/object.yaml deleted file mode 100644 index 0b0c221..0000000 --- a/postman/collections/Fleetbase API/Drivers/.resources/object.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: object -name: Driver -description: |- - A driver represents a driver record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "driver_abc123", - "object": "driver", - "name": "Alex Driver", - "status": "active", - "phone": "+15555550101", - "online": false, - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: name - type: string - description: "Display name for the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: phone - type: string - description: "Phone number for the person or customer." - - name: online - type: boolean - description: "Online value for this drivers request." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml b/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml index 9f1db2e..434089f 100644 --- a/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a driver. The response returns the created resource with its generated identifier. +description: Create a driver url: "{{base_url}}/{{namespace}}/drivers" method: POST headers: diff --git a/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml deleted file mode 100644 index 6b255ed..0000000 --- a/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml +++ /dev/null @@ -1,10 +0,0 @@ -$kind: params -fields: - - name: identity - type: string - required: true - description: "Email address or phone number used for authentication." - - name: password - type: string - required: true - description: "Password used for authentication." diff --git a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml index 759296c..e2e9da3 100644 --- a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns drivers matching the supplied filters. Use pagination and query parameters to control the result set. +description: This endpoint allows you to retrieve a driver object to view it's details. url: "{{base_url}}/{{namespace}}/drivers" method: GET headers: diff --git a/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml b/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml deleted file mode 100644 index 575e07f..0000000 --- a/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml +++ /dev/null @@ -1,9 +0,0 @@ -$kind: params -fields: - - name: token - type: string - required: true - description: "Token used to authorize or capture the operation." - - name: platform - type: string - description: "Platform value for this drivers request." diff --git a/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml b/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml deleted file mode 100644 index 575e07f..0000000 --- a/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml +++ /dev/null @@ -1,9 +0,0 @@ -$kind: params -fields: - - name: token - type: string - required: true - description: "Token used to authorize or capture the operation." - - name: platform - type: string - description: "Platform value for this drivers request." diff --git a/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml deleted file mode 100644 index 946203d..0000000 --- a/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: phone - type: string - description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.request.yaml b/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.request.yaml index 958ee30..f4256ae 100644 --- a/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a driver. The response includes the current API representation of the resource. +description: This endpoint allows you to retrieve a driver object to view it's details. url: "{{base_url}}/{{namespace}}/drivers/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml deleted file mode 100644 index 2cabdc9..0000000 --- a/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: params -fields: - - name: start - type: object - description: "Start value for this drivers request." - fields: - - name: latitude - type: number - description: "Decimal latitude coordinate." - - name: longitude - type: number - description: "Decimal longitude coordinate." - - name: end - type: object - description: "End value for this drivers request." - fields: - - name: latitude - type: number - description: "Decimal latitude coordinate." - - name: longitude - type: number - description: "Decimal longitude coordinate." diff --git a/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml deleted file mode 100644 index c66fd62..0000000 --- a/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: next - type: string - description: "Next value for this drivers request." diff --git a/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml b/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml deleted file mode 100644 index 3106928..0000000 --- a/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: online - type: boolean - description: "Online value for this drivers request." diff --git a/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml deleted file mode 100644 index b2e6a11..0000000 --- a/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml +++ /dev/null @@ -1,10 +0,0 @@ -$kind: params -fields: - - name: identity - type: string - required: true - description: "Email address or phone number used for authentication." - - name: code - type: string - required: true - description: "Verification or status code." diff --git a/postman/collections/Fleetbase API/Entities/.resources/Query Entities.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Entities/.resources/Query Entities.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 930b694..0000000 --- a/postman/collections/Fleetbase API/Entities/.resources/Query Entities.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/entities" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - type: "parcel" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "entitie_abc123", - "object": "entitie", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Entities/.resources/object.yaml b/postman/collections/Fleetbase API/Entities/.resources/object.yaml deleted file mode 100644 index a67de50..0000000 --- a/postman/collections/Fleetbase API/Entities/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Entity -description: |- - An entity represents a entity record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "entitie_abc123", - "object": "entitie", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml b/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml index 2393847..773dfc7 100644 --- a/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates an entities resource. The response returns the created resource with its generated identifier. +description: Create an Entity. url: "{{base_url}}/{{namespace}}/entities" method: POST headers: diff --git a/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml b/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml index 6ed783c..eb79034 100644 --- a/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes an entities resource. The response confirms the resource that was removed. +description: Delete an Entity. url: "{{base_url}}/{{namespace}}/entities/:id" method: DELETE headers: diff --git a/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml b/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml index 1525a7c..5fac046 100644 --- a/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates an entities resource. Parameters not supplied remain unchanged. +description: Update an Entity. url: "{{base_url}}/{{namespace}}/entities/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Fleets/.resources/object.yaml b/postman/collections/Fleetbase API/Fleets/.resources/object.yaml deleted file mode 100644 index ef317ce..0000000 --- a/postman/collections/Fleetbase API/Fleets/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Fleet -description: |- - A fleet represents a fleet record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "fleet_abc123", - "object": "fleet", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml b/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml index f0feee1..3f67352 100644 --- a/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a fleets resource. The response confirms the resource that was removed. +description: Deletes a fleet. url: "{{base_url}}/{{namespace}}/fleets/:id" method: DELETE headers: diff --git a/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml b/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml index 7eae45c..56022f0 100644 --- a/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns fleets matching the supplied filters. Use pagination and query parameters to control the result set. + Returns a paginated list of fleets for the current organization. Use pagination and sorting parameters to control the result set. url: "{{base_url}}/{{namespace}}/fleets" method: GET headers: diff --git a/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml b/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml index 9ba452d..0fa052f 100644 --- a/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a fleet. Parameters not supplied remain unchanged. +description: Updates a fleet. url: "{{base_url}}/{{namespace}}/fleets/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/Create a Fuel Report.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/Create a Fuel Report.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 84bed6a..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/Create a Fuel Report.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,39 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/fuel-reports" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "driver": "{{driver_id}}", - "odometer": 12042, - "volume": 42.5, - "metric_unit": "liter", - "location": { - "latitude": 1.3521, - "longitude": 103.8198 - }, - "amount": 120.5, - "currency": "USD", - "status": "submitted" - } - -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/Delete a Fuel Report.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/Delete a Fuel Report.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 1e810c0..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/Delete a Fuel Report.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/fuel-reports/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/Query Fuel Reports.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/Query Fuel Reports.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 636da3c..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/Query Fuel Reports.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/fuel-reports" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/Retrieve a Fuel Report.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/Retrieve a Fuel Report.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a414a21..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/Retrieve a Fuel Report.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/fuel-reports/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/Update a Fuel Report.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/Update a Fuel Report.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f148760..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/Update a Fuel Report.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,36 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/fuel-reports/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "odometer": 12050, - "volume": 43.1, - "metric_unit": "liter", - "amount": 122.75, - "currency": "USD", - "status": "approved" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml deleted file mode 100644 index 48e726a..0000000 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Fuel report -description: |- - A fuel report represents a fuel report record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "fuel-report_abc123", - "object": "fuel-report", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml index 50d6651..70b5679 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a fuel reports resource. The response returns the created resource with its generated identifier. +description: "Create a Fuel Report" url: "{{base_url}}/{{namespace}}/fuel-reports" method: POST body: diff --git a/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml index 9aa0e32..4013917 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a fuel reports resource. The response confirms the resource that was removed. +description: "Delete a Fuel Report" url: "{{base_url}}/{{namespace}}/fuel-reports/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml index 519c3f2..dffc1a8 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns fuel reports matching the supplied filters. Use pagination and query parameters to control the result set. +description: "Query Fuel Reports" url: "{{base_url}}/{{namespace}}/fuel-reports" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml index 6dc6537..4d00050 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a fuel report. The response includes the current API representation of the resource. +description: "Retrieve a Fuel Report" url: "{{base_url}}/{{namespace}}/fuel-reports/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml index 4e8a1f6..073156a 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a fuel reports resource. Parameters not supplied remain unchanged. +description: "Update a Fuel Report" url: "{{base_url}}/{{namespace}}/fuel-reports/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase API/Geofences/.resources/Get Driver Geofence History.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Geofences/.resources/Get Driver Geofence History.resources/examples/Successful Response.example.yaml deleted file mode 100644 index db10fbf..0000000 --- a/postman/collections/Fleetbase API/Geofences/.resources/Get Driver Geofence History.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/geofences/driver/:driverUuid/history" - method: GET - headers: - Accept: application/json - queryParams: - per_page: "50" - pathVariables: - driverUuid: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "geofence_abc123", - "object": "geofence", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Dwell Report.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Dwell Report.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a483570..0000000 --- a/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Dwell Report.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/geofences/dwell-report" - method: GET - headers: - Accept: application/json - queryParams: - from: "{{from_datetime}}" - to: "{{to_datetime}}" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "geofence_abc123", - "object": "geofence", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Inventory.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Inventory.resources/examples/Successful Response.example.yaml deleted file mode 100644 index dcfa767..0000000 --- a/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Inventory.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/geofences/inventory" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "geofence_abc123", - "object": "geofence", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/List Geofence Events.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Geofences/.resources/List Geofence Events.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 18c7e10..0000000 --- a/postman/collections/Fleetbase API/Geofences/.resources/List Geofence Events.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/geofences/events" - method: GET - headers: - Accept: application/json - queryParams: - per_page: "50" - event_type: "entered" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "geofence_abc123", - "object": "geofence", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/object.yaml b/postman/collections/Fleetbase API/Geofences/.resources/object.yaml deleted file mode 100644 index a972daf..0000000 --- a/postman/collections/Fleetbase API/Geofences/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Geofence -description: |- - A geofence represents a geofence record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "geofence_abc123", - "object": "geofence", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml index 3a5a5be..9e663cc 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a geofence. The response includes the current API representation of the resource. +description: "Get Driver Geofence History" url: "{{base_url}}/{{namespace}}/geofences/driver/:driverUuid/history" method: GET diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml index c9074e9..58b3b65 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a geofence. The response includes the current API representation of the resource. +description: "Get Geofence Dwell Report" url: "{{base_url}}/{{namespace}}/geofences/dwell-report" method: GET diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml index 9ca22fa..858d4da 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a geofence. The response includes the current API representation of the resource. +description: "Get Geofence Inventory" url: "{{base_url}}/{{namespace}}/geofences/inventory" method: GET order: 2000 diff --git a/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml b/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml index 9069604..08f3c60 100644 --- a/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns geofences matching the supplied filters. Use pagination and query parameters to control the result set. +description: "List Geofence Events" url: "{{base_url}}/{{namespace}}/geofences/events" method: GET diff --git a/postman/collections/Fleetbase API/Issues/.resources/Create an Issue.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Issues/.resources/Create an Issue.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 400173e..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/Create an Issue.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,38 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/issues" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "driver": "{{driver_id}}", - "location": { - "latitude": 1.3521, - "longitude": 103.8198 - }, - "report": "Vehicle tire pressure warning", - "category": "vehicle", - "type": "maintenance", - "priority": "medium", - "status": "open" - } - -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "issue_abc123", - "object": "issue", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/Delete an Issue.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Issues/.resources/Delete an Issue.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 92f2099..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/Delete an Issue.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/issues/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "issue_abc123", - "object": "issue", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/Query Issues.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Issues/.resources/Query Issues.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ee5a20b..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/Query Issues.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/issues" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "issue_abc123", - "object": "issue", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/Retrieve an Issue.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Issues/.resources/Retrieve an Issue.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a1e28b4..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/Retrieve an Issue.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/issues/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "issue_abc123", - "object": "issue", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/Update an Issue.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Issues/.resources/Update an Issue.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0551104..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/Update an Issue.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/issues/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "report": "Updated issue report", - "category": "vehicle", - "type": "maintenance", - "priority": "high", - "status": "resolved" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "issue_abc123", - "object": "issue", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/object.yaml b/postman/collections/Fleetbase API/Issues/.resources/object.yaml deleted file mode 100644 index b92d7de..0000000 --- a/postman/collections/Fleetbase API/Issues/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Issue -description: |- - An issue represents a issue record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "issue_abc123", - "object": "issue", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml index 46ef60a..af0443a 100644 --- a/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates an issues resource. The response returns the created resource with its generated identifier. +description: "Create an Issue" url: "{{base_url}}/{{namespace}}/issues" method: POST body: diff --git a/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml index a89a779..28124df 100644 --- a/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes an issues resource. The response confirms the resource that was removed. +description: "Delete an Issue" url: "{{base_url}}/{{namespace}}/issues/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml b/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml index 5f68337..5ef773e 100644 --- a/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns issues matching the supplied filters. Use pagination and query parameters to control the result set. +description: "Query Issues" url: "{{base_url}}/{{namespace}}/issues" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml index a10207d..8e0209b 100644 --- a/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a issue. The response includes the current API representation of the resource. +description: "Retrieve an Issue" url: "{{base_url}}/{{namespace}}/issues/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml index edbf1f4..444f164 100644 --- a/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates an issues resource. Parameters not supplied remain unchanged. +description: "Update an Issue" url: "{{base_url}}/{{namespace}}/issues/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase API/Labels/.resources/Render Label.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Labels/.resources/Render Label.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bfaf840..0000000 --- a/postman/collections/Fleetbase API/Labels/.resources/Render Label.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,27 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/labels/:id" - method: GET - headers: - Accept: application/json - queryParams: - format: "stream" - type: "order" - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "label_abc123", - "object": "label", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Labels/.resources/object.yaml b/postman/collections/Fleetbase API/Labels/.resources/object.yaml deleted file mode 100644 index f355ecb..0000000 --- a/postman/collections/Fleetbase API/Labels/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Label -description: |- - A label represents a label record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "label_abc123", - "object": "label", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Onboard/.resources/Get Driver Onboard Settings.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Onboard/.resources/Get Driver Onboard Settings.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 7f0cad1..0000000 --- a/postman/collections/Fleetbase API/Onboard/.resources/Get Driver Onboard Settings.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/onboard/driver-onboard-settings/:companyId" - method: GET - headers: - Accept: application/json - pathVariables: - companyId: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "onboard_abc123", - "object": "onboard", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Onboard/.resources/object.yaml b/postman/collections/Fleetbase API/Onboard/.resources/object.yaml deleted file mode 100644 index b3f7344..0000000 --- a/postman/collections/Fleetbase API/Onboard/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Onboard -description: |- - An onboard represents a onboard record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "onboard_abc123", - "object": "onboard", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 61542cd..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/cancel" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 46611e8..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,43 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/capture-photo/:subjectId" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - subjectId: "" - body: - type: json - content: |- - { - "photos": [ - "{{proof_photo_base64}}" - ], - "remarks": "Verified by Photo", - "data": {} - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 2e4538d..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/capture-qr/:subject-id" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - subject-id: "" - body: - type: json - content: |- - { - "code": "", - "data": [], - "raw_data": [] - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0499aeb..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,39 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/capture-signature/:subject-id" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - subject-id: "" - body: - type: json - content: |- - { - "signature": "", - "data": [] - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 50ec484..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/complete" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 350096d..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index aec6912..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/dispatch" - method: PATCH - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 8df99c6..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/editable-entity-fields" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fbee95f..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/distance-and-time" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6964e8c..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/eta" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bd97f8e..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/next-activity" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 539d4a2..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/tracker" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a65eed5..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,39 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/comments" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 93ae33d..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/proofs/:subjectId" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" - subjectId: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fd5777c..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,42 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" - status: "active" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 86699cf..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,39 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/schedule" - method: PATCH - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "date": "2024-02-11", - "time": "8am", - "timezone": "Asia/Singapore" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/Successful Response.example.yaml deleted file mode 100644 index dc51bfc..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/set-destination/:placeId" - method: PATCH - headers: - Accept: application/json - pathVariables: - id: "" - placeId: "" - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 8711fd9..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/start" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "skip_dispatch": false - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ef299c7..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id/update-activity" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "skip_dispatch": false - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 329151b..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: | - { - "service_quote": "quote_hZ3C21KVkx" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/object.yaml b/postman/collections/Fleetbase API/Orders/.resources/object.yaml deleted file mode 100644 index a9ddfc2..0000000 --- a/postman/collections/Fleetbase API/Orders/.resources/object.yaml +++ /dev/null @@ -1,53 +0,0 @@ -$kind: object -name: Order -description: |- - An order represents a order record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: pickup - type: object - description: "Pickup location, place ID, or embedded pickup details." - fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: name - type: string - description: "Display name for the resource." - - name: dropoff - type: object - description: "Dropoff location, place ID, or embedded dropoff details." - fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: name - type: string - description: "Display name for the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml deleted file mode 100644 index e68d58f..0000000 --- a/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: photos - type: array of strings - description: "Photos value for this orders request." - - name: remarks - type: string - description: "Remarks value for this orders request." - - name: data - type: object - description: "Data value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml deleted file mode 100644 index 2d21771..0000000 --- a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml +++ /dev/null @@ -1,12 +0,0 @@ -$kind: params -fields: - - name: code - type: string - required: true - description: "Verification or status code." - - name: data - type: array of strings - description: "Data value for this orders request." - - name: raw_data - type: array of strings - description: "Raw data value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml index 5eff48b..e194292 100644 --- a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Captures a QR code proof for an order or order subject. The response returns the proof data associated with the order. + Captures a QR code proof for an order or order subject. The response includes the updated proof data associated with the order. url: "{{base_url}}/{{namespace}}/orders/:id/capture-qr/:subject-id" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml deleted file mode 100644 index 0bea175..0000000 --- a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: signature - type: string - description: "Signature value for this orders request." - - name: data - type: array of strings - description: "Data value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml index 25264c8..80cabdc 100644 --- a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Captures a signature proof for an order or order subject. Use it when a workflow requires signed proof of pickup or delivery. + Captures a signature proof for an order or order subject. Use this when a workflow requires signed proof of delivery or pickup. url: "{{base_url}}/{{namespace}}/orders/:id/capture-signature/:subject-id" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml index 043e705..7a93c7e 100644 --- a/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml @@ -1,6 +1,12 @@ $kind: http-request description: |- - Creates an orders resource. The response returns the created resource with its generated identifier. + To create a new `Order` in Fleetbase, the `Order` requires a payload which describres each `Entity` in the order as well as the geolocational waypoints. The payload can be created previously or created by sending a `Payload` object embedded within the Order request. + + Orders can also be subcontracted to a facilitator which can be either a `Contact` or `Vendor`. Like facilitator, the Order can also be assigned a customer which can also be either a `Contact` or `Vendor`. + + To schedule an order upon creation use the `scheduled_at` parameter to send a date and time to schedule the order. + + To assign a driver to the order the send the id of the driver to assign using the `driver` parameter. url: "{{base_url}}/{{namespace}}/orders" method: POST headers: diff --git a/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml index 5292718..0605575 100644 --- a/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Dispatches an order to an assigned or eligible driver. The response returns the order with dispatch state applied. + Dispatches an order to an assigned or eligible driver. The response returns the order after dispatch state has been applied. url: "{{base_url}}/{{namespace}}/orders/:id/dispatch" method: PATCH pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.params.yaml b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml index 91b70f4..cc66b8b 100644 --- a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a order. The response includes the current API representation of the resource. + Returns the next workflow activity for an order. Use it to determine the next operational step available to the assigned driver or dispatcher. url: "{{base_url}}/{{namespace}}/orders/:id/next-activity" method: GET pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml index 017a8b4..840c8c7 100644 --- a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns orders matching the supplied filters. Use pagination and query parameters to control the result set. +description: List all orders. url: "{{base_url}}/{{namespace}}/orders" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml deleted file mode 100644 index 964abd9..0000000 --- a/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: date - type: date - description: "Date value for this orders request." - - name: time - type: string - description: "Time value for this orders request." - - name: timezone - type: string - description: "Timezone value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Set Order Destination.params.yaml b/postman/collections/Fleetbase API/Orders/Set Order Destination.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Orders/Set Order Destination.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml index 8ad331b..f9b6753 100644 --- a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Sets the destination place for an order. The response returns the order after the destination has been updated. + Sets the destination waypoint or place for an order. The response returns the updated order after the destination is changed. url: "{{base_url}}/{{namespace}}/orders/:id/set-destination/:placeId" method: PATCH pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml deleted file mode 100644 index ccfca5c..0000000 --- a/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: skip_dispatch - type: string - description: "Skip dispatch value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml index e17573d..3f94612 100644 --- a/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Starts an order and moves it into active fulfillment. Use this when a driver or dispatcher begins work on the order. + Starts an order and transitions it into active execution. Use this when a driver or dispatcher begins fulfillment. url: "{{base_url}}/{{namespace}}/orders/:id/start" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml b/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml index b230572..c0ce834 100644 --- a/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Updates an orders resource. Parameters not supplied remain unchanged. + Updates the current activity state for an order. The response returns the order with the latest workflow activity applied. url: "{{base_url}}/{{namespace}}/orders/:id/update-activity" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml index 17501a0..429de46 100644 --- a/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates an orders resource. Parameters not supplied remain unchanged. +description: Update an Order. url: "{{base_url}}/{{namespace}}/orders/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase API/Organizations/.resources/List Organizations.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Organizations/.resources/List Organizations.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 835f172..0000000 --- a/postman/collections/Fleetbase API/Organizations/.resources/List Organizations.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/organizations" - method: GET - headers: - Accept: application/json - queryParams: - limit: "10" - with_driver_onboard: "false" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "organization_abc123", - "object": "organization", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Organizations/.resources/object.yaml b/postman/collections/Fleetbase API/Organizations/.resources/object.yaml deleted file mode 100644 index 1542ba4..0000000 --- a/postman/collections/Fleetbase API/Organizations/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Organization -description: |- - An organization represents a organization record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "organization_abc123", - "object": "organization", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Payloads/.resources/Delete a Payload.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Payloads/.resources/Delete a Payload.resources/examples/Successful Response.example.yaml deleted file mode 100644 index d076097..0000000 --- a/postman/collections/Fleetbase API/Payloads/.resources/Delete a Payload.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/payloads/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "payload_abc123", - "object": "payload", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Payloads/.resources/Query Payloads.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Payloads/.resources/Query Payloads.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6e1bdeb..0000000 --- a/postman/collections/Fleetbase API/Payloads/.resources/Query Payloads.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/payloads" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "payload_abc123", - "object": "payload", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Payloads/.resources/Retrieve a Payload.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Payloads/.resources/Retrieve a Payload.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 7157b3f..0000000 --- a/postman/collections/Fleetbase API/Payloads/.resources/Retrieve a Payload.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/payloads/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "payload_abc123", - "object": "payload", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Payloads/.resources/Update a Payload.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Payloads/.resources/Update a Payload.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 221dccc..0000000 --- a/postman/collections/Fleetbase API/Payloads/.resources/Update a Payload.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,49 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/payloads/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "entities": [ - { - "name": "UltraHD 4K Smart TV", - "description": "65-inch high-definition smart TV with vibrant colors and a sleek design.", - "currency": "USD", - "price": 1200.00 - }, - { - "name": "Bluetooth Wireless Headphones", - "description": "Noise-cancelling, over-ear headphones with long-lasting battery life.", - "currency": "USD", - "price": 250.00 - }, - { - "name": "Smart Fitness Watch", - "description": "Water-resistant fitness watch with heart rate monitor and GPS tracking.", - "currency": "USD", - "price": 199.99 - } - ] - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "payload_abc123", - "object": "payload", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Payloads/.resources/object.yaml b/postman/collections/Fleetbase API/Payloads/.resources/object.yaml deleted file mode 100644 index 722e4e0..0000000 --- a/postman/collections/Fleetbase API/Payloads/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Payload -description: |- - A payload represents a payload record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "payload_abc123", - "object": "payload", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml b/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml index d71601a..a4d3d1c 100644 --- a/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a payload. The response returns the created resource with its generated identifier. +description: Create a Payload. url: "{{base_url}}/{{namespace}}/payloads" method: POST body: diff --git a/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml b/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml index d9d9fe2..da58971 100644 --- a/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a payloads resource. The response confirms the resource that was removed. +description: Delete a Payload. url: "{{base_url}}/{{namespace}}/payloads/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml b/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml index f0d7daa..3958b31 100644 --- a/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a payload. Parameters not supplied remain unchanged. +description: Update a Payload. url: "{{base_url}}/{{namespace}}/payloads/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase API/Places/.resources/Create a Place.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Places/.resources/Create a Place.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b563607..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/Create a Place.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,42 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places" - method: POST - headers: - Accept: application/json - body: - type: json - content: | - { - "name": "Central Park", - "street1": "830 5th Ave", - "city": "New York", - "province": "New York", - "postal_code": "10065", - "neighborhood": "Manhattan", - "district": "Midtown", - "building": "Park Area", - "country": "US", - "phone_number": "212-310-6600", - "phone_country_code": "+1", - "type": "Park" - } -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Places/.resources/List all Places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Places/.resources/List all Places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 72a0fae..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/List all Places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Places/.resources/Query Places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Places/.resources/Query Places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a623c7d..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/Query Places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,38 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places" - method: GET - headers: - Accept: application/json - queryParams: - query: "{{place_name}}" - limit: "25" - offset: "" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Places/.resources/Retrieve a Place.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Places/.resources/Retrieve a Place.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0af449d..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/Retrieve a Place.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,27 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Places/.resources/Search Places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Places/.resources/Search Places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bc13b49..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/Search Places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places/search" - method: GET - headers: - Accept: application/json - queryParams: - query: "{{place_query}}" - ll: "{{place_ll}}" - locale: "{{locale}}" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Places/.resources/object.yaml b/postman/collections/Fleetbase API/Places/.resources/object.yaml deleted file mode 100644 index 2836cff..0000000 --- a/postman/collections/Fleetbase API/Places/.resources/object.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: object -name: Place -description: |- - A place represents a place record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "place_abc123", - "object": "place", - "name": "Central Park", - "latitude": 40.7829, - "longitude": -73.9654, - "city": "New York", - "country": "US", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: name - type: string - description: "Display name for the resource." - - name: latitude - type: number - description: "Decimal latitude coordinate." - - name: longitude - type: number - description: "Decimal longitude coordinate." - - name: city - type: string - description: "City value for this places request." - - name: country - type: integer - description: "Country value for this places request." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase API/Places/Create a Place.request.yaml b/postman/collections/Fleetbase API/Places/Create a Place.request.yaml index bdd6b0a..9782a96 100644 --- a/postman/collections/Fleetbase API/Places/Create a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Create a Place.request.yaml @@ -1,6 +1,8 @@ $kind: http-request description: |- - Creates a place. The response returns the created resource with its generated identifier. + When you create a place, you must specify a name and latitude and longitude coordinates. + + Fleetbase will run a reverse geocode automatically on the provided coordinates to automatically complete the address when the optional fields are not provided. url: "{{base_url}}/{{namespace}}/places" method: POST headers: diff --git a/postman/collections/Fleetbase API/Places/List all Places.request.yaml b/postman/collections/Fleetbase API/Places/List all Places.request.yaml index 3e9cb69..77576aa 100644 --- a/postman/collections/Fleetbase API/Places/List all Places.request.yaml +++ b/postman/collections/Fleetbase API/Places/List all Places.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns places matching the supplied filters. Use pagination and query parameters to control the result set. + Returns a paginated list of places for the current organization. Places are sorted by creation date unless another sort order is provided. url: "{{base_url}}/{{namespace}}/places" method: GET headers: diff --git a/postman/collections/Fleetbase API/Places/Query Places.request.yaml b/postman/collections/Fleetbase API/Places/Query Places.request.yaml index 404eec4..bbeb3e3 100644 --- a/postman/collections/Fleetbase API/Places/Query Places.request.yaml +++ b/postman/collections/Fleetbase API/Places/Query Places.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns places matching the supplied filters. Use pagination and query parameters to control the result set. + Searches and filters places for the current organization. Use query and pagination parameters to find matching saved locations. url: "{{base_url}}/{{namespace}}/places" method: GET headers: diff --git a/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml b/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml index 28c5dc6..5302274 100644 --- a/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a place. The response includes the current API representation of the resource. +description: This endpoint allows you to retrieve a place object to view it's details. url: "{{base_url}}/{{namespace}}/places/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Places/Update a Place.request.yaml b/postman/collections/Fleetbase API/Places/Update a Place.request.yaml index b2f8eea..d961772 100644 --- a/postman/collections/Fleetbase API/Places/Update a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Update a Place.request.yaml @@ -1,6 +1,8 @@ $kind: http-request description: |- - Updates a place. Parameters not supplied remain unchanged. + Updates the specified place by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the location parameter, that becomes the place's new location to be used for all spatial queries in the future. + + This request accepts mostly the same arguments as the place creation call. url: "{{base_url}}/{{namespace}}/places/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Purchase Rates/.resources/Query Purchase Rates.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Purchase Rates/.resources/Query Purchase Rates.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6f38251..0000000 --- a/postman/collections/Fleetbase API/Purchase Rates/.resources/Query Purchase Rates.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/purchase-rates" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "purchase-rate_abc123", - "object": "purchase-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml b/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml deleted file mode 100644 index 42a600a..0000000 --- a/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Purchase rate -description: |- - A purchase rate represents a purchase rate record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "purchase-rate_abc123", - "object": "purchase-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml index 7a3b520..3dbb7a2 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns purchase rates matching the supplied filters. Use pagination and query parameters to control the result set. +description: This endpoint allows you to query purchase-rates you have created, it also provides paginated results on all the purchase-rates in your Fleetbase. url: "{{base_url}}/{{namespace}}/purchase-rates" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Purchase Rates/Retrieve a Purchase Rate.request.yaml b/postman/collections/Fleetbase API/Purchase Rates/Retrieve a Purchase Rate.request.yaml index 0702940..3e74d46 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/Retrieve a Purchase Rate.request.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/Retrieve a Purchase Rate.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a purchase rate. The response includes the current API representation of the resource. +description: This endpoint allows you to retrieve a purchase-rate object to view it's details. url: "{{base_url}}/{{namespace}}/purchase-rates/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Service Areas/.resources/Create a Service Area.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Areas/.resources/Create a Service Area.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 4c91aa5..0000000 --- a/postman/collections/Fleetbase API/Service Areas/.resources/Create a Service Area.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-areas" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "name": "Singapore", - "type": "city", - "latitude": "1.3521", - "longitude": "103.8198", - "radius": "30000", - "country": "SG", - "status": "active" - } -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-area_abc123", - "object": "service-area", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Areas/.resources/Query Service Areas.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Areas/.resources/Query Service Areas.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 85d53a8..0000000 --- a/postman/collections/Fleetbase API/Service Areas/.resources/Query Service Areas.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-areas" - method: GET - headers: - Accept: application/json - queryParams: - name: "{{service_area_name}}" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "service-area_abc123", - "object": "service-area", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml b/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml deleted file mode 100644 index e231a3f..0000000 --- a/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Service area -description: |- - A service area represents a service area record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "service-area_abc123", - "object": "service-area", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Service Areas/Create a Service Area.request.yaml b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.request.yaml index a0d75c7..791f326 100644 --- a/postman/collections/Fleetbase API/Service Areas/Create a Service Area.request.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.request.yaml @@ -1,6 +1,8 @@ $kind: http-request description: |- - Creates a service areas resource. The response returns the created resource with its generated identifier. + A service area is created by simply providing a city, province or country in which Fleetbase will reverse geocode into a service area. + + If the service area cannot be reverse geocoded, Fleetbase will return an error. url: "{{base_url}}/{{namespace}}/service-areas" method: POST body: diff --git a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml index 5235740..9521202 100644 --- a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns service areas matching the supplied filters. Use pagination and query parameters to control the result set. + Returns service areas matching the supplied filters. Use this to find configured operating regions by name or other query parameters. url: "{{base_url}}/{{namespace}}/service-areas" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Service Areas/Retrieve a Service Area.request.yaml b/postman/collections/Fleetbase API/Service Areas/Retrieve a Service Area.request.yaml index 74fcd6d..cf1249a 100644 --- a/postman/collections/Fleetbase API/Service Areas/Retrieve a Service Area.request.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Retrieve a Service Area.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a service area. The response includes the current API representation of the resource. +description: This endpoint allows you to retrieve a service area object to view it's details. url: "{{base_url}}/{{namespace}}/service-areas/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Service Quotes/.resources/Retrieve a Service Quote.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Quotes/.resources/Retrieve a Service Quote.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f8bddd2..0000000 --- a/postman/collections/Fleetbase API/Service Quotes/.resources/Retrieve a Service Quote.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-quotes/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-quote_abc123", - "object": "service-quote", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Quotes/.resources/object.yaml b/postman/collections/Fleetbase API/Service Quotes/.resources/object.yaml deleted file mode 100644 index a37f4cd..0000000 --- a/postman/collections/Fleetbase API/Service Quotes/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Service quote -description: |- - A service quote represents a service quote record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "service-quote_abc123", - "object": "service-quote", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.params.yaml b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml index 757860e..68d007c 100644 --- a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml +++ b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml @@ -1,6 +1,8 @@ $kind: http-request description: |- - Returns service quotes matching the supplied filters. Use pagination and query parameters to control the result set. + This endpoint is used to get the ServiceRate quotes based on pickup point location and drop off point location, or payload. + + For some quotes such as parcel based, the payload must be included for calculation of the payload cost. url: "{{base_url}}/{{namespace}}/service-quotes" method: GET headers: diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/Create a Service Rate.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/Create a Service Rate.resources/examples/Successful Response.example.yaml deleted file mode 100644 index af0be32..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/Create a Service Rate.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,65 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-rates" - method: POST - headers: - Accept: application/json - body: - type: json - content: "{\r - - \ \"service_name\": \"Food Delivery\",\r - - \ \"service_type\": \"food_delivery\",\r - - \ \"rate_calculation_method\": \"per_meter\",\r - - \ \"currency\": \"USD\",\r - - \ \"base_fee\": 10.00,\r - - \ \"per_meter_unit\": \"km\",\r - - \ \"per_meter_flat_rate_fee\": 25,\r - - \ \"has_cod_fee\": true,\r - - \ \"cod_calculation_method\": \"percentage\",\r - - \ \"cod_flat_fee\": 1.00,\r - - \ \"cod_percent\": 0,\r - - \ \"has_peak_hours_fee\": true,\r - - \ \"peak_hours_calculation_method\": \"percentage\",\r - - \ \"peak_hours_flat_fee\": 3.00,\r - - \ \"peak_hours_percent\": 0,\r - - \ \"peak_hours_start\": \"17:00\",\r - - \ \"peak_hours_end\": \"18:45\",\r - - \ \"duration_terms\": \"Standard\",\r - - \ \"estimated_days\": 3\r - - }" -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-rate_abc123", - "object": "service-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/Delete a Service Rate.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/Delete a Service Rate.resources/examples/Successful Response.example.yaml deleted file mode 100644 index aec0c60..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/Delete a Service Rate.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-rates/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-rate_abc123", - "object": "service-rate", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/Query Service Rates.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/Query Service Rates.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b637877..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/Query Service Rates.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-rates" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - currency: "USD" - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "service-rate_abc123", - "object": "service-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/Retrieve a Service Rate.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/Retrieve a Service Rate.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 2516dcd..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/Retrieve a Service Rate.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-rates/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: "{\r - - \ \"id\": \"{{service_54k3175}}\"\r - - }\r\n" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-rate_abc123", - "object": "service-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/Update a Service Rate.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/Update a Service Rate.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 7ca7f2f..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/Update a Service Rate.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-rates/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: "{\r - - \ \"currency\": \"SGD\",\r - - \ \"base_fee\": 12.66,\r - - \ \"estimated_days\": 6\r - - }" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "service-rate_abc123", - "object": "service-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml deleted file mode 100644 index 7784ecf..0000000 --- a/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Service rate -description: |- - A service rate represents a service rate record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "service-rate_abc123", - "object": "service-rate", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Service Rates/Delete a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Delete a Service Rate.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Service Rates/Delete a Service Rate.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.params.yaml b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/.resources/Decode Tracking Number QR.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Tracking Numbers/.resources/Decode Tracking Number QR.resources/examples/Successful Response.example.yaml deleted file mode 100644 index a4edd67..0000000 --- a/postman/collections/Fleetbase API/Tracking Numbers/.resources/Decode Tracking Number QR.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/tracking-numbers/from-qr" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "code": "{{qr_code}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "tracking-number_abc123", - "object": "tracking-number", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml b/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml deleted file mode 100644 index 090a5d7..0000000 --- a/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Tracking number -description: |- - A tracking number represents a tracking number record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "tracking-number_abc123", - "object": "tracking-number", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.request.yaml index f6b682e..5b5e7a4 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a tracking numbers resource. The response returns the created resource with its generated identifier. +description: | This endpoint allows you to retrieve a tracking-number object to view it's details. url: "{{base_url}}/{{namespace}}/tracking-numbers" method: POST diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml deleted file mode 100644 index c4e9cce..0000000 --- a/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml +++ /dev/null @@ -1,6 +0,0 @@ -$kind: params -fields: - - name: code - type: string - required: true - description: "Verification or status code." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.params.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.params.yaml deleted file mode 100644 index 91a285a..0000000 --- a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: region - type: string - description: "Region value for this tracking numbers request." - - name: owner - type: string - description: "Owner value for this tracking numbers request." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml index 83b4acd..41289ef 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a tracking numbers resource. The response confirms the resource that was removed. +description: | This endpoint allows you to retrieve a tracking-number object to view it's details. url: "{{base_url}}/{{namespace}}/tracking-numbers/:id" method: DELETE diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml index 2da6415..99306aa 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns tracking numbers matching the supplied filters. Use pagination and query parameters to control the result set. +description: This endpoint allows you to query tracking-numbers you have created, it also provides paginated results on all the tracking-numbers in your Fleetbase. url: "{{base_url}}/{{namespace}}/tracking-numbers" method: GET headers: diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Retrieve a Tracking Number.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Retrieve a Tracking Number.request.yaml index 6460e5c..cbaa89e 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Retrieve a Tracking Number.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Retrieve a Tracking Number.request.yaml @@ -1,6 +1,6 @@ $kind: http-request -description: |- - Retrieves a tracking number. The response includes the current API representation of the resource. +description: | + This endpoint allows you to retrieve a tracking-number object to view it's details. url: "{{base_url}}/{{namespace}}/tracking-numbers/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml b/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml deleted file mode 100644 index 0dbf44c..0000000 --- a/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Tracking status -description: |- - A tracking status represents a tracking status record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "tracking-statuse_abc123", - "object": "tracking-statuse", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml index 58bbb58..9631177 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Updates a tracking statuses resource. Parameters not supplied remain unchanged. + Updates an existing tracking status. The response returns the tracking status with the new values applied. url: "{{base_url}}/{{namespace}}/tracking-statuses/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Vehicles/.resources/Track Vehicle.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase API/Vehicles/.resources/Track Vehicle.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 9ffc477..0000000 --- a/postman/collections/Fleetbase API/Vehicles/.resources/Track Vehicle.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/vehicles/:id/track" - method: PATCH - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: text - content: |- - { - "latitude": -19.288195, - "longitude": 146.795965, - "speed": 100 - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "vehicle_abc123", - "object": "vehicle", - "make": "Toyota", - "model": "Camry", - "plate_number": "ABC123", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml b/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml deleted file mode 100644 index 5473947..0000000 --- a/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: object -name: Vehicle -description: |- - A vehicle represents a vehicle record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "vehicle_abc123", - "object": "vehicle", - "make": "Toyota", - "model": "Camry", - "plate_number": "ABC123", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: make - type: string - description: "Make value for this vehicles request." - - name: model - type: string - description: "Model value for this vehicles request." - - name: plate_number - type: string - description: "Plate number value for this vehicles request." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml index 2920fba..0dfdc28 100644 --- a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns vehicles matching the supplied filters. Use pagination and query parameters to control the result set. +description: This endpoint allows you to query vehicles you have created, it also provides paginated results on all the vehicles in your Fleetbase. url: "{{base_url}}/{{namespace}}/vehicles" method: GET headers: diff --git a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml index 6b7fc5e..beaf351 100644 --- a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml @@ -1,6 +1,8 @@ $kind: http-request description: |- - Updates a vehicle. Parameters not supplied remain unchanged. + You can update the driver assigned, plate number, and status of the `Vehicle`. + + Vehicle's can only be assigned to one driver at a time, if a vehicle is re-assigned to another driver then the last driver will no longer be assigned to the vehicle. url: "{{base_url}}/{{namespace}}/vehicles/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Vendors/.resources/object.yaml b/postman/collections/Fleetbase API/Vendors/.resources/object.yaml deleted file mode 100644 index 38f4ac5..0000000 --- a/postman/collections/Fleetbase API/Vendors/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Vendor -description: |- - A vendor represents a vendor record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "vendor_abc123", - "object": "vendor", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml b/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml index a544839..90f0e89 100644 --- a/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a vendor. The response returns the created resource with its generated identifier. +description: Create a vendor url: "{{base_url}}/{{namespace}}/vendors" method: POST headers: diff --git a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml index d0f08c9..823c1bb 100644 --- a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns vendors matching the supplied filters. Use pagination and query parameters to control the result set. +description: This endpoint allows you to retrieve a vendor object to view it's details. url: "{{base_url}}/{{namespace}}/vendors" method: GET headers: diff --git a/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.request.yaml b/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.request.yaml index 9f92280..2c45acb 100644 --- a/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a vendor. The response includes the current API representation of the resource. +description: This endpoint allows you to retrieve a vendor object to view it's details. url: "{{base_url}}/{{namespace}}/vendors/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Zones/.resources/object.yaml b/postman/collections/Fleetbase API/Zones/.resources/object.yaml deleted file mode 100644 index f5c8f4c..0000000 --- a/postman/collections/Fleetbase API/Zones/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Zone -description: |- - A zone represents a zone record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "zone_abc123", - "object": "zone", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml b/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml index 49bc770..893ab6e 100644 --- a/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Creates a zone. The response returns the created resource with its generated identifier. + Creates a zone inside a service area. Provide either a GeoJSON boundary or a center point with radius, and Fleetbase will store the zone for geofencing and service coverage checks. url: "{{base_url}}/{{namespace}}/zones" method: POST body: diff --git a/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml b/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml index 038a72c..ae634f3 100644 --- a/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns zones matching the supplied filters. Use pagination and query parameters to control the result set. + Returns zones matching the supplied filters. Use this to find configured geofences by name or other query parameters. url: "{{base_url}}/{{namespace}}/zones" method: GET headers: diff --git a/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml b/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml index e1ace8b..473b66a 100644 --- a/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a zone. The response includes the current API representation of the resource. + Retrieves a single zone by ID. The response includes the zone geometry, display styling, and service area relationship. url: "{{base_url}}/{{namespace}}/zones/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml b/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml index ea32d84..4c39e1d 100644 --- a/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: |- - Updates a zone. Parameters not supplied remain unchanged. +description: |+ + You can update all properties of the Zone. + url: "{{base_url}}/{{namespace}}/zones/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Add Participant.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Add Participant.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 97e374e..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Add Participant.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/:id/add-participant" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "user": "{{user_id}}" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Chat Channel.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Chat Channel.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 5f5190f..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Chat Channel.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "name": "Dispatch", - "participants": [ - "{{user_id}}" - ] - } - -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Read Receipt.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Read Receipt.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 79f427d..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Read Receipt.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/read-message/:chatMessageId" - method: POST - headers: - Accept: application/json - pathVariables: - chatMessageId: "" - body: - type: json - content: |- - { - "participant": "{{chat_participant_id}}" - } - -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Chat Channel.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Chat Channel.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 4cb8823..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Chat Channel.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Message.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Message.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b7484f0..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Message.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/delete-message/:chatMessageId" - method: DELETE - headers: - Accept: application/json - pathVariables: - chatMessageId: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/List Available Participants.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/List Available Participants.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3033829..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/List Available Participants.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/available-participants" - method: GET - headers: - Accept: application/json - queryParams: - channel: "{{chat_channel_id}}" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Query Chat Channels.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Query Chat Channels.resources/examples/Successful Response.example.yaml deleted file mode 100644 index c0daec3..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Query Chat Channels.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Remove Participant.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Remove Participant.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 64a3e76..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Remove Participant.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/remove-participant/:participantId" - method: DELETE - headers: - Accept: application/json - pathVariables: - participantId: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Retrieve Chat Channel.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Retrieve Chat Channel.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f7687d3..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Retrieve Chat Channel.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Send Message.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Send Message.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 8fb6443..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Send Message.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/:id/send-message" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "sender": "{{chat_participant_id}}", - "content": "Hello from Fleetbase API", - "files": [] - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Update Chat Channel.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Update Chat Channel.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 544beb0..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/Update Chat Channel.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/chat-channels/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "name": "Dispatch Updates" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml deleted file mode 100644 index 93ea78d..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Chat channel -description: |- - A chat channel represents a chat channel record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "chat-channel_abc123", - "object": "chat-channel", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml deleted file mode 100644 index 5dae897..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: user - type: string - description: "User value for this chat channels request." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml index 3dcfc89..837fa51 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Adds a participant to a chat channel. The response returns the updated channel membership. +description: "Add Participant" url: "{{base_url}}/{{namespace}}/chat-channels/:id/add-participant" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml index 7f47db0..5d75a1f 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a chat channels resource. The response returns the created resource with its generated identifier. +description: "Create Chat Channel" url: "{{base_url}}/{{namespace}}/chat-channels" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml index 7a0ec29..7d96366 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a chat channels resource. The response returns the created resource with its generated identifier. +description: "Create Read Receipt" url: "{{base_url}}/{{namespace}}/chat-channels/read-message/:chatMessageId" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml index d90f8b3..857cdb4 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a chat channels resource. The response confirms the resource that was removed. +description: "Delete Chat Channel" url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml index a33bbb3..5b59a87 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a chat channels resource. The response confirms the resource that was removed. +description: "Delete Message" url: "{{base_url}}/{{namespace}}/chat-channels/delete-message/:chatMessageId" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml index 5e87fa2..3dbfe0c 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns chat channels matching the supplied filters. Use pagination and query parameters to control the result set. +description: "List Available Participants" url: "{{base_url}}/{{namespace}}/chat-channels/available-participants" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml index 12a2bb2..e1bd12b 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns chat channels matching the supplied filters. Use pagination and query parameters to control the result set. +description: "Query Chat Channels" url: "{{base_url}}/{{namespace}}/chat-channels" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml index d26dcba..9abe7ad 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a chat channels resource. The response confirms the resource that was removed. +description: "Remove Participant" url: "{{base_url}}/{{namespace}}/chat-channels/remove-participant/:participantId" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml index 8d9e525..f9c25f0 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a chat channel. The response includes the current API representation of the resource. +description: "Retrieve Chat Channel" url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml deleted file mode 100644 index 0d6c414..0000000 --- a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: sender - type: string - description: "Sender value for this chat channels request." - - name: content - type: string - description: "Content value for this chat channels request." - - name: files - type: array of strings - description: "Files value for this chat channels request." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml index 61cd083..408f880 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Sends a message to a chat channel. The response returns the created chat message. +description: "Send Message" url: "{{base_url}}/{{namespace}}/chat-channels/:id/send-message" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml index 8b521d3..3588970 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a chat channels resource. Parameters not supplied remain unchanged. +description: "Update Chat Channel" url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/Create Comment.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/Create Comment.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ec67232..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/Create Comment.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/comments" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "content": "Example comment", - "subject": { - "id": "{{subject_id}}", - "type": "{{subject_type}}" - } - } - -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "comment_abc123", - "object": "comment", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/Delete Comment.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/Delete Comment.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b3484d6..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/Delete Comment.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/comments/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "comment_abc123", - "object": "comment", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/Query Comments.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/Query Comments.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fe52a7a..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/Query Comments.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/comments" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "comment_abc123", - "object": "comment", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/Retrieve Comment.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/Retrieve Comment.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 309f820..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/Retrieve Comment.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/comments/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "comment_abc123", - "object": "comment", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/Update Comment.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/Update Comment.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0c4ddd5..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/Update Comment.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/comments/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "content": "Updated comment" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "comment_abc123", - "object": "comment", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml deleted file mode 100644 index dffdecb..0000000 --- a/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Comment -description: |- - A comment represents a comment record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "comment_abc123", - "object": "comment", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml index dfdb86f..6275fb4 100644 --- a/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a comment. The response returns the created resource with its generated identifier. +description: "Create Comment" url: "{{base_url}}/{{namespace}}/comments" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml index 27a6ec2..d087506 100644 --- a/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a comments resource. The response confirms the resource that was removed. +description: "Delete Comment" url: "{{base_url}}/{{namespace}}/comments/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml index 6ba297c..ee090f5 100644 --- a/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns comments matching the supplied filters. Use pagination and query parameters to control the result set. +description: "Query Comments" url: "{{base_url}}/{{namespace}}/comments" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml index f21f23c..065b290 100644 --- a/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a comment. The response includes the current API representation of the resource. +description: "Retrieve Comment" url: "{{base_url}}/{{namespace}}/comments/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml index ab70bdd..03fa4bb 100644 --- a/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a comment. Parameters not supplied remain unchanged. +description: "Update Comment" url: "{{base_url}}/{{namespace}}/comments/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Delete a File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Delete a File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 582efba..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Delete a File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files/:id" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Download File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Download File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 25e4102..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Download File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files/:id/download" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Query Files.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Query Files.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ce1046b..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Query Files.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files" - method: GET - headers: - Accept: application/json - queryParams: - limit: "25" - offset: "0" - sort: "created_at" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Retrieve a File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Retrieve a File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index da3359e..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Retrieve a File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files/:id" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Update File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Update File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6a07c3f..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Update File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files/:id" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: |- - { - "caption": "Updated caption", - "meta": {} - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Upload Base64 File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Upload Base64 File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bc9af2d..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Upload Base64 File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files/base64" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "data": "{{base64_file_data}}", - "file_name": "example.png", - "file_type": "image", - "content_type": "image/png", - "path": "uploads" - } - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/Upload File.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Files/.resources/Upload File.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 256879e..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/Upload File.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/files" - method: POST - headers: - Accept: application/json - body: - type: formdata - content: - - type: file - key: file - src: [] - - type: text - key: path - value: "uploads" - - type: text - key: type - value: "attachment" - -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/object.yaml b/postman/collections/Fleetbase Core API/Files/.resources/object.yaml deleted file mode 100644 index 80c3e4a..0000000 --- a/postman/collections/Fleetbase Core API/Files/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: File -description: |- - A file represents a file record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "file_abc123", - "object": "file", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml index 6902fd3..e1e8d5e 100644 --- a/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a files resource. The response confirms the resource that was removed. +description: "Delete a File" url: "{{base_url}}/{{namespace}}/files/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Download File.request.yaml b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml index d8f4939..8620c9d 100644 --- a/postman/collections/Fleetbase Core API/Files/Download File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Downloads a file by ID. The response returns the file payload or download metadata. +description: "Download File" url: "{{base_url}}/{{namespace}}/files/:id/download" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml index e469215..0a89a2e 100644 --- a/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns files matching the supplied filters. Use pagination and query parameters to control the result set. +description: "Query Files" url: "{{base_url}}/{{namespace}}/files" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml index 2b198de..d0d0d39 100644 --- a/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a file. The response includes the current API representation of the resource. +description: "Retrieve a File" url: "{{base_url}}/{{namespace}}/files/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Update File.request.yaml b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml index c27fcc4..8c8456e 100644 --- a/postman/collections/Fleetbase Core API/Files/Update File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a file. Parameters not supplied remain unchanged. +description: "Update File" url: "{{base_url}}/{{namespace}}/files/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml deleted file mode 100644 index a282452..0000000 --- a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml +++ /dev/null @@ -1,17 +0,0 @@ -$kind: params -fields: - - name: data - type: string - description: "Data value for this files request." - - name: file_name - type: string - description: "File name value for this files request." - - name: file_type - type: string - description: "File type value for this files request." - - name: content_type - type: string - description: "Content type value for this files request." - - name: path - type: string - description: "Path value for this files request." diff --git a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml index 5cbf66a..639e645 100644 --- a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Uploads a file from base64-encoded content. The response returns the created file resource. +description: "Upload Base64 File" url: "{{base_url}}/{{namespace}}/files/base64" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml index 5ff4a3a..ab63486 100644 --- a/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Uploads a file using multipart form data. The response returns the created file resource. +description: "Upload File" url: "{{base_url}}/{{namespace}}/files" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Organizations/.resources/Get Current Organization.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Core API/Organizations/.resources/Get Current Organization.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b6a2076..0000000 --- a/postman/collections/Fleetbase Core API/Organizations/.resources/Get Current Organization.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/organizations/current" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "organization_abc123", - "object": "organization", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml b/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml deleted file mode 100644 index 1542ba4..0000000 --- a/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Organization -description: |- - An organization represents a organization record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "organization_abc123", - "object": "organization", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Cancel Order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Cancel Order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 96ae76d..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Cancel Order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,20 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders/order_mdy2Rog/cancel" - method: DELETE - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cancel-order-request-yaml_abc123", - "object": "cancel-order-request-yaml", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Create Order from Service Quote.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Create Order from Service Quote.resources/examples/Successful Response.example.yaml deleted file mode 100644 index c153c5e..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Create Order from Service Quote.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,28 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders" - method: POST - headers: - Accept: application/json - body: - type: formdata - content: - - type: text - key: service_quote - value: quote_wadAVAw -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "create-order-from-service-quote-request-yaml_abc123", - "object": "create-order-from-service-quote-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Internal Service Quote.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Internal Service Quote.resources/examples/Successful Response.example.yaml deleted file mode 100644 index cad47c9..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Internal Service Quote.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-quotes" - method: GET - headers: - Accept: application/json - queryParams: - service_type: "SUV" - facilitator: "integrated_vendor_wa5AwdA" - is_route_optimized: "true" - waypoints[0][name]: "Stop 1" - waypoints[0][phone]: "+886970699044" - waypoints[0][location][type]: "Point" - waypoints[0][location][coordinates]: "121.526333,25.036688" - waypoints[1][name]: "Stop 2" - waypoints[1][phone]: "+886970699044" - waypoints[1][location][type]: "Point" - waypoints[1][location][coordinates]: "121.526333,25.036688" - waypoints[2][name]: "Stop 3" - waypoints[2][phone]: "+886970699044" - waypoints[2][location][type]: "Point" - waypoints[2][location][coordinates]: "121.526333,25.036688" - specialRequests[0]: "CASH_ON_DELIVERY" - specialRequests[1]: "FRAGILE_GOODS" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "get-internal-service-quote-request-yaml_abc123", - "object": "get-internal-service-quote-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Service Quote from Integrated Vendor.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Service Quote from Integrated Vendor.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3eb166d..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Service Quote from Integrated Vendor.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,40 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/service-quotes" - method: GET - headers: - Accept: application/json - queryParams: - service_type: "MOTORCYCLE" - facilitator: "integrated_vendor_wD5EJ7g" - is_route_optimized: "true" - waypoints[0][name]: "Stop 1" - waypoints[0][phone]: "+6596379222" - waypoints[0][location][type]: "Point" - waypoints[0][location][coordinates]: "103.8835179,1.3132044" - waypoints[1][name]: "Stop 2" - waypoints[1][phone]: "+6596379222" - waypoints[1][remarks]: "Testing remarks 1" - waypoints[1][location][type]: "Point" - waypoints[1][location][coordinates]: "103.8384048,1.3081903" - waypoints[2][name]: "Stop 3" - waypoints[2][phone]: "+6596379222" - waypoints[2][remarks]: "Testing remarks 2" - waypoints[2][location][type]: "Point" - waypoints[2][location][coordinates]: "103.8722585,1.3507723" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "get-service-quote-from-integrated-vendor-request-yaml_abc123", - "object": "get-service-quote-from-integrated-vendor-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Orders.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Orders.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f938db0..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Orders.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/orders" - method: GET - headers: - Accept: application/json - queryParams: - limit: "5" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "query-orders-request-yaml_abc123", - "object": "query-orders-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 4380818..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places" - method: GET - headers: - Accept: application/json - queryParams: - limit: "5" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "query-places-request-yaml_abc123", - "object": "query-places-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Search Places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Search Places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index e00f08d..0000000 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Search Places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{namespace}}/places/search" - method: GET - headers: - Accept: application/json - queryParams: - ll: "25.0147912108003,121.46998215767363" - locale: "zh-TW" - query: "臺北市中山區忠孝東歐物" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "search-places-request-yaml_abc123", - "object": "search-places-request-yaml", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Get Public Invoice.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Get Public Invoice.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 205b58f..0000000 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Get Public Invoice.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}" - method: GET - headers: - Accept: application/json - pathVariables: - invoice_public_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "invoice_abc123", - "object": "invoice", - "number": "INV-1001", - "status": "sent", - "currency": "USD", - "balance": 2500, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/List Public Invoice Gateways.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/List Public Invoice Gateways.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ab52a55..0000000 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/List Public Invoice Gateways.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/gateways" - method: GET - headers: - Accept: application/json - pathVariables: - invoice_public_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "invoice_abc123", - "object": "invoice", - "number": "INV-1001", - "status": "sent", - "currency": "USD", - "balance": 2500, - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Pay Public Invoice.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Pay Public Invoice.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 88dcfd6..0000000 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Pay Public Invoice.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/pay" - method: POST - headers: - Accept: application/json - pathVariables: - invoice_public_id: "" - body: - type: json - content: |- - { - "gateway_id": "{{gateway_id}}", - "reference": "{{payment_reference}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "invoice_abc123", - "object": "invoice", - "number": "INV-1001", - "status": "sent", - "currency": "USD", - "balance": 2500, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml deleted file mode 100644 index df0fb09..0000000 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: object -name: Public invoice -description: |- - A public invoice represents a public invoice record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "invoice_abc123", - "object": "invoice", - "number": "INV-1001", - "status": "sent", - "currency": "USD", - "balance": 2500, - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: number - type: string - description: "Number value for this public invoices request." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: currency - type: currency - description: "Three-letter currency code." - - name: balance - type: string - description: "Balance value for this public invoices request." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml index ab367a4..9d61dd4 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a public invoice. The response includes the current API representation of the resource. +description: Get Public Invoice url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml index 7c67a92..de4fd2c 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns public invoices matching the supplied filters. Use pagination and query parameters to control the result set. +description: List Public Invoice Gateways url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/gateways" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml deleted file mode 100644 index 628aec4..0000000 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: gateway_id - type: string - description: "Payment gateway public identifier." - - name: reference - type: string - description: "External reference for the payment or request." diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml index 9df7be8..3e11b74 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Pays a public invoice with the selected payment gateway. The response returns either a hosted checkout URL or the updated invoice payment state. +description: Pay Public Invoice url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/pay" method: POST headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet Balance.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet Balance.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 96e4069..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet Balance.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/balance" - method: GET - headers: - Accept: application/json - queryParams: - currency: "USD" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "wallet_abc123", - "object": "wallet", - "balance": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet.resources/examples/Successful Response.example.yaml deleted file mode 100644 index aa5b30a..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet" - method: GET - headers: - Accept: application/json - queryParams: - currency: "USD" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "wallet_abc123", - "object": "wallet", - "balance": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/List Wallet Transactions.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/List Wallet Transactions.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3ac5b1e..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/List Wallet Transactions.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,38 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/transactions" - method: GET - headers: - Accept: application/json - queryParams: - type: "" - direction: "" - status: "" - date_from: "" - date_to: "" - limit: "25" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "wallet_abc123", - "object": "wallet", - "balance": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Top Up Wallet.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Top Up Wallet.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 2879275..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/Top Up Wallet.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/topup" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "gateway": "{{gateway_id}}", - "amount": 1000, - "payment_method_token": "{{payment_method_token}}", - "customer_id": "{{gateway_customer_id}}", - "description": "Wallet top-up" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "wallet_abc123", - "object": "wallet", - "balance": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml deleted file mode 100644 index 3947748..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: object -name: Wallet -description: |- - A wallet represents a wallet record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "wallet_abc123", - "object": "wallet", - "balance": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: balance - type: string - description: "Balance value for this wallet request." - - name: currency - type: currency - description: "Three-letter currency code." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml index e2f9542..389864e 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a wallet. The response includes the current API representation of the resource. +description: Get Wallet Balance url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/balance" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml index 899c783..22d6ad3 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a wallet. The response includes the current API representation of the resource. +description: Get Wallet url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml index 706e190..44a0dc1 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns wallet matching the supplied filters. Use pagination and query parameters to control the result set. +description: List Wallet Transactions url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/transactions" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml deleted file mode 100644 index ce73ab1..0000000 --- a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml +++ /dev/null @@ -1,19 +0,0 @@ -$kind: params -fields: - - name: gateway - type: string - required: true - description: "Payment gateway ID or code." - - name: amount - type: number - required: true - description: "Monetary amount for the request." - - name: payment_method_token - type: string - description: "Payment method token returned by the gateway." - - name: customer_id - type: string - description: "Customer id value for this wallet request." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml index bde6563..a9c2fc4 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Tops up the authenticated subject wallet through a payment gateway. The response returns the updated wallet and gateway transaction details. +description: Top Up Wallet url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/topup" method: POST headers: diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/Handle Gateway Webhook.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/Handle Gateway Webhook.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0fa4f84..0000000 --- a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/Handle Gateway Webhook.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/webhooks/{{gateway_driver}}" - method: POST - headers: - Accept: application/json - pathVariables: - gateway_driver: "" - body: - type: json - content: |- - { - "company_uuid": "{{company_id}}", - "id": "{{gateway_event_id}}", - "type": "payment_intent.succeeded", - "data": { - "object": {} - } - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "webhook_abc123", - "object": "webhook", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml deleted file mode 100644 index 5ad4d3c..0000000 --- a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Webhook -description: |- - A webhook represents a webhook record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "webhook_abc123", - "object": "webhook", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml deleted file mode 100644 index c8140ed..0000000 --- a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml +++ /dev/null @@ -1,19 +0,0 @@ -$kind: params -fields: - - name: company_uuid - type: string - description: "Company uuid value for this webhooks request." - - name: id - type: string - description: "Unique identifier for the resource." - - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." - - name: data - type: object - description: "Data value for this webhooks request." - fields: - - name: object - type: string - description: "Object type returned by the API." diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml index f26a79e..f6dfc55 100644 --- a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Receives a payment gateway webhook and records the normalized ledger event. The response acknowledges the webhook so the gateway can stop retrying. +description: Handle Gateway Webhook url: "{{base_url}}/{{api_prefix}}/webhooks/{{gateway_driver}}" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Add Item to Cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Add Item to Cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f965220..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Add Item to Cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{product_id}" - method: POST - headers: - Accept: application/json - pathVariables: - id: "" - product_id: "" - body: - type: json - content: |- - { - "addons": [], - "quantity": 1, - "scheduled_at": "scheduled_at_value_here", - "store_location": "store_location_value_here", - "variants": [] - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Delete Cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Delete Cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3d37a5f..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Delete Cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{{cart_id}}" - method: DELETE - headers: - Accept: application/json - pathVariables: - cart_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Empty cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Empty cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b6f0d09..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Empty cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/empty" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Remove item from cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Remove item from cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 20ee764..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Remove item from cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,23 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" - line_item_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "deleted": true - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve a Cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve a Cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 5256e46..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve a Cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve or Create Cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve or Create Cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fc5d708..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve or Create Cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/Update item in Cart.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/Update item in Cart.resources/examples/Successful Response.example.yaml deleted file mode 100644 index d2f4e89..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/Update item in Cart.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,27 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - line_item_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml deleted file mode 100644 index 4d56ab7..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml +++ /dev/null @@ -1,36 +0,0 @@ -$kind: object -name: Cart -description: |- - A cart represents a cart record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "cart_abc123", - "object": "cart", - "currency": "USD", - "items": [], - "subtotal": 0, - "total": 0, - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: currency - type: currency - description: "Three-letter currency code." - - name: items - type: array of strings - description: "Items value for this cart request." - - name: subtotal - type: string - description: "Subtotal value for this cart request." - - name: total - type: string - description: "Total value for this cart request." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml deleted file mode 100644 index 104d424..0000000 --- a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml +++ /dev/null @@ -1,17 +0,0 @@ -$kind: params -fields: - - name: addons - type: array of strings - description: "Addons value for this cart request." - - name: quantity - type: integer - description: "Quantity of the product or line item." - - name: scheduled_at - type: timestamp - description: "Scheduled at value for this cart request." - - name: store_location - type: string - description: "Store location value for this cart request." - - name: variants - type: array of strings - description: "Variants value for this cart request." diff --git a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml index 13e75ca..e46960e 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Adds a product to a cart and creates or updates the matching line item. Include quantity, variants, addons, scheduling, or store location details when needed. + Adds a product to a cart and creates or updates the matching cart line item. Include quantity, variants, addons, scheduling, or store location details when needed. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{product_id}" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml index 8c19aa4..6a031dc 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a cart resource. The response confirms the resource that was removed. +description: Delete Cart url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{{cart_id}}" method: DELETE headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml index 131d57a..dceb2e8 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Removes every line item from the cart. The response returns the cart after its items have been cleared. + Removes all line items from a cart. The response returns the emptied cart resource. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/empty" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml index 6872b06..671fff6 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Deletes a cart resource. The response confirms the resource that was removed. + Removes a line item or product from a cart. The response returns the updated cart after the item is removed. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" method: DELETE headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml index 3c8c03d..998c3ef 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a cart. The response includes the current API representation of the resource. + Retrieves an existing cart by its unique identifier. If the cart is still active, the response includes its current line items and totals. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml index 5efdfae..161214a 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a cart. The response includes the current API representation of the resource. + Retrieves the current cart or creates a new cart when no cart identifier is supplied. Use the returned cart ID for subsequent cart operations. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml index 884a49f..c6fb7b3 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a cart resource. Parameters not supplied remain unchanged. +description: |+ You can update all properties of the Zone. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" diff --git a/postman/collections/Fleetbase Storefront API/Category/.resources/List categories.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Category/.resources/List categories.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 4f08454..0000000 --- a/postman/collections/Fleetbase Storefront API/Category/.resources/List categories.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/categories" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "category_abc123", - "object": "category", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml deleted file mode 100644 index 8163557..0000000 --- a/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Category -description: |- - A category represents a category record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "category_abc123", - "object": "category", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml b/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml index 6ee7636..68be78e 100644 --- a/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns category matching the supplied filters. Use pagination and query parameters to control the result set. + Returns product categories available to the current storefront. Use this list to organize product browsing and filtering. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/categories" method: GET headers: diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Before \342\235\227.resources/examples/Successful Response.example.yaml" "b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Before \342\235\227.resources/examples/Successful Response.example.yaml" deleted file mode 100644 index 9b0c89b..0000000 --- "a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Before \342\235\227.resources/examples/Successful Response.example.yaml" +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/before" - method: GET - headers: - Accept: application/json - queryParams: - gateway: "" - customer: "" - cart: "" - service_quote: "" - cash: "" - pickup: "" - tip: "" - delivery_tip: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback via GET.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback via GET.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6ee213b..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback via GET.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" - method: GET - headers: - Accept: application/json - queryParams: - checkout: "{{checkout_id}}" - respond: "true" - test: "success" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 294b8a9..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "checkout": "{{checkout_id}}", - "respond": true, - "test": "success" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture checkout as order.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture checkout as order.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b891af6..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture checkout as order.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,28 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "token": "{{checkout_token}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Create Stripe Setup Intent.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Create Stripe Setup Intent.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 84e3e62..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Create Stripe Setup Intent.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,28 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-setup-intent" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "customer": "{{customer_id}}" - } -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Get Checkout Status.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Get Checkout Status.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 1cc47fb..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Get Checkout Status.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/status" - method: GET - headers: - Accept: application/json - queryParams: - checkout: "{{checkout_id}}" - token: "{{checkout_token}}" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Update Stripe Payment Intent.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Update Stripe Payment Intent.resources/examples/Successful Response.example.yaml deleted file mode 100644 index e5b9da5..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/Update Stripe Payment Intent.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-update-payment-intent" - method: PUT - headers: - Accept: application/json - body: - type: json - content: |- - { - "customer": "{{customer_id}}", - "cart": "{{cart_id}}", - "service_quote": "{{service_quote_id}}", - "payment_intent_id": "{{payment_intent_id}}", - "pickup": false, - "tip": 0, - "delivery_tip": 0 - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml deleted file mode 100644 index f6dba74..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Checkout -description: |- - A checkout represents a checkout record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "checkout_abc123", - "object": "checkout", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" index 070c9c6..050a86b 100644 --- "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Initializes checkout for a cart, customer, gateway, and service quote. The response returns the checkout token or payment intent details required to complete payment. +description: Before ❗ url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/before" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml index 04cf6a1..0bbf1f5 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Processes a QPay checkout callback over GET. This variant is useful for gateway redirects and sandbox callback testing. +description: Capture QPay Callback via GET url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml deleted file mode 100644 index 3289772..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: checkout - type: string - description: "Checkout value for this checkout request." - - name: respond - type: boolean - description: "Respond value for this checkout request." - - name: test - type: string - description: "Test value for this checkout request." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml index dc78616..14808a1 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Processes a QPay checkout callback and publishes the payment result for the checkout session. The response returns payment status details when a response is requested. +description: Capture QPay Callback url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml deleted file mode 100644 index 0ee40b8..0000000 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml +++ /dev/null @@ -1,6 +0,0 @@ -$kind: params -fields: - - name: token - type: string - required: true - description: "Token used to authorize or capture the operation." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml index a323a43..e1578e5 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Captures a checkout token and creates the corresponding order. If the checkout was already captured, the existing order is returned. + Captures a checkout token and creates the corresponding order. The response returns the completed order or the existing order when the checkout was already captured. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml index ec32097..2bb4853 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a checkout resource. The response returns the created resource with its generated identifier. +description: Create Stripe Setup Intent url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-setup-intent" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml index 6f1f4f5..ab86367 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a checkout. The response includes the current API representation of the resource. +description: Get Checkout Status url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/status" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml index b7ad276..d500fb2 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a checkout resource. Parameters not supplied remain unchanged. +description: Update Stripe Payment Intent url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-update-payment-intent" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer via SMS.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer via SMS.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 5497800..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer via SMS.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-sms" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Apple.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Apple.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3dc2cdb..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Apple.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-apple" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "identityToken": "{{apple_identity_token}}", - "authorizationCode": "{{apple_authorization_code}}", - "email": "{{customer_email}}", - "phone": "{{customer_phone}}", - "name": "{{customer_name}}", - "appleUserId": "{{apple_user_id}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Facebook.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Facebook.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bb93db2..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Facebook.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-facebook" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "email": "{{customer_email}}", - "name": "{{customer_name}}", - "facebookUserId": "{{facebook_user_id}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Google.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Google.resources/examples/Successful Response.example.yaml deleted file mode 100644 index abdd480..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Google.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-google" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "idToken": "{{google_id_token}}", - "clientId": "{{google_client_id}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git "a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer \342\235\227.resources/examples/Successful Response.example.yaml" "b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer \342\235\227.resources/examples/Successful Response.example.yaml" deleted file mode 100644 index c88cb30..0000000 --- "a/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer \342\235\227.resources/examples/Successful Response.example.yaml" +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Confirm Account Closure.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Confirm Account Closure.resources/examples/Successful Response.example.yaml deleted file mode 100644 index d942e33..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Confirm Account Closure.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/confirm-account-closure" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "code": "{{verification_code}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "count": 1 - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Create a Customer.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Create a Customer.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 80e3c74..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Create a Customer.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Ephemeral Key.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Ephemeral Key.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 57cc76b..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Ephemeral Key.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,27 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-ephemeral-key" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - {} -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Setup Intent.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Setup Intent.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 5411aea..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Setup Intent.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,27 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-setup-intent" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - {} -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer orders.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer orders.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 32d9470..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer orders.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/orders" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer saved places.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer saved places.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 17b7c29..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer saved places.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/places" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Query customers.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Query customers.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 041f72f..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Query customers.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,31 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Register customer device.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Register customer device.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 9837e07..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Register customer device.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/register-device" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Request Phone Verification.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Request Phone Verification.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fdf3b7f..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Request Phone Verification.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-phone-verification" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "phone": "{{customer_phone}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Retrieve a Customer.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Retrieve a Customer.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3b97877..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Retrieve a Customer.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{{customer_id}}" - method: GET - headers: - Accept: application/json - pathVariables: - customer_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Setups a verification request to create a new storefront custome.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Setups a verification request to create a new storefront custome.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 86cbb36..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Setups a verification request to create a new storefront custome.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-creation-code" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Start Account Closure.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Start Account Closure.resources/examples/Successful Response.example.yaml deleted file mode 100644 index fb0fa08..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Start Account Closure.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/account-closure" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - {} -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "count": 1 - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Update Contact Customer Alias.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Update Contact Customer Alias.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 3fb0fd6..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Update Contact Customer Alias.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,33 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/contacts/{{customer_id}}" - method: PUT - headers: - Accept: application/json - pathVariables: - customer_id: "" - body: - type: json - content: |- - { - "name": "{{customer_name}}", - "email": "{{customer_email}}", - "phone": "{{customer_phone}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Update a Customer.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Update a Customer.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 18432e6..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Update a Customer.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,28 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{id}" - method: PUT - headers: - Accept: application/json - pathVariables: - id: "" - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify Phone Number.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify Phone Number.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 115d3d0..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify Phone Number.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-phone-number" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "phone": "{{customer_phone}}", - "code": "{{verification_code}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify a SMS code.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify a SMS code.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 76fe236..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify a SMS code.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-code" - method: POST - headers: - Accept: application/json - body: - type: json - content: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml deleted file mode 100644 index 4ec94e0..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: object -name: Customer -description: |- - A customer represents a customer record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "customer_abc123", - "object": "customer", - "name": "Jane Customer", - "email": "jane@example.com", - "phone": "+15555550102", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: name - type: string - description: "Display name for the resource." - - name: email - type: string - description: "Email address for the person or customer." - - name: phone - type: string - description: "Phone number for the person or customer." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml index c4ee910..50b0752 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Starts SMS authentication for an existing storefront customer. The customer receives a code that can be exchanged for an access token. + Starts SMS authentication for an existing storefront customer. The customer receives a verification code that can be exchanged for an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-sms" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml deleted file mode 100644 index 918f1c1..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml +++ /dev/null @@ -1,20 +0,0 @@ -$kind: params -fields: - - name: identityToken - type: string - description: "IdentityToken value for this customer request." - - name: authorizationCode - type: string - description: "AuthorizationCode value for this customer request." - - name: email - type: string - description: "Email address for the person or customer." - - name: phone - type: string - description: "Phone number for the person or customer." - - name: name - type: string - description: "Display name for the resource." - - name: appleUserId - type: string - description: "AppleUserId value for this customer request." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml index bb09c27..d63270e 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Authenticates a storefront customer with Apple Sign In credentials. The response returns the customer profile and access token when authentication succeeds. +description: Authenticate a Customer with Apple url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-apple" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml deleted file mode 100644 index 611a824..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: email - type: string - description: "Email address for the person or customer." - - name: name - type: string - description: "Display name for the resource." - - name: facebookUserId - type: string - description: "FacebookUserId value for this customer request." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml index 298828d..37ac9c2 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Authenticates a storefront customer with Facebook account details. The response returns the customer profile and an access token when authentication succeeds. +description: Authenticate a Customer with Facebook url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-facebook" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml deleted file mode 100644 index 1b0d957..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: idToken - type: string - description: "IdToken value for this customer request." - - name: clientId - type: string - description: "ClientId value for this customer request." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml index 4cfa184..b688eb2 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Authenticates a storefront customer with a Google ID token. The response returns the customer profile and access token when authentication succeeds. +description: Authenticate a Customer with Google url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-google" method: POST headers: diff --git "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" deleted file mode 100644 index fd81b7a..0000000 --- "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" index 7918996..2484f55 100644 --- "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" @@ -1,6 +1,6 @@ $kind: http-request description: |- - Authenticates a storefront customer with an email or phone identity and password. The response returns the customer profile and access token. + Authenticates a storefront customer with an email or phone identity and password. The response includes the customer profile and an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml deleted file mode 100644 index c4e9cce..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml +++ /dev/null @@ -1,6 +0,0 @@ -$kind: params -fields: - - name: code - type: string - required: true - description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml index de9ecd1..f1a762d 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Confirms account closure with the verification code sent to the customer. The response returns the closure result. +description: Confirm Account Closure url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/confirm-account-closure" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml index c891390..1436711 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Creates a customer resource. The response returns the created resource with its generated identifier. + Creates a storefront customer after verifying the supplied creation code. The response includes the customer profile and an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml deleted file mode 100644 index 8454803..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml +++ /dev/null @@ -1,2 +0,0 @@ -$kind: params -fields: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml index 5d36815..9aaa60e 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a customer. The response includes the current API representation of the resource. +description: Get Stripe Ephemeral Key url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-ephemeral-key" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml deleted file mode 100644 index 8454803..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml +++ /dev/null @@ -1,2 +0,0 @@ -$kind: params -fields: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml index 300eaf0..bf289e3 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a customer. The response includes the current API representation of the resource. +description: Get Stripe Setup Intent url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-setup-intent" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml index 1b2006e..d8db385 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. + Returns orders that belong to the authenticated storefront customer. Use pagination and filters to browse the customer order history. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/orders" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml index 9165265..8b56922 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. + Returns saved places for the authenticated storefront customer. Use these places for delivery addresses and checkout defaults. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/places" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml index 2162ae5..16eb9d9 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. + Returns storefront customers for the current company. Use query and pagination parameters to find matching customer records. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml deleted file mode 100644 index e7648db..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml +++ /dev/null @@ -1,9 +0,0 @@ -$kind: params -fields: - - name: token - type: string - required: true - description: "Token used to authorize or capture the operation." - - name: platform - type: string - description: "Platform value for this customer request." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml index 8ce43ad..308dd89 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Registers a push notification device token for the authenticated storefront customer. Use this endpoint to enable customer device notifications. + Registers a device token for the authenticated storefront customer. Use this to enable push notifications for the customer device. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/register-device" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml deleted file mode 100644 index 946203d..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: phone - type: string - description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml index 07692b7..c986afe 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Sends a phone verification code to the authenticated storefront customer. Use the code with the verify phone number endpoint. +description: Request Phone Verification url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-phone-verification" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml index 69b93ce..707a424 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a customer. The response includes the current API representation of the resource. +description: Retrieve a Customer url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{{customer_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml deleted file mode 100644 index fd81b7a..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml +++ /dev/null @@ -1,8 +0,0 @@ -$kind: params -fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml index f921307..d52d2c1 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml @@ -1,7 +1,7 @@ $kind: http-request name: Setups a verification request to create a new storefront customer. ? description: |- - Sends a verification code for creating a storefront customer. Use the code when submitting the customer creation request. + Sends a verification code for storefront customer creation. The code is required when creating the customer account. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-creation-code" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml deleted file mode 100644 index 8454803..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml +++ /dev/null @@ -1,2 +0,0 @@ -$kind: params -fields: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml index 1117956..c28253b 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Starts account closure for the authenticated storefront customer. Fleetbase sends a confirmation code before the account can be closed. +description: Start Account Closure url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/account-closure" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml index 765896a..6157f5f 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a customer resource. Parameters not supplied remain unchanged. +description: Update Contact Customer Alias url: "{{base_url}}/{{api_prefix}}/{{namespace}}/contacts/{{customer_id}}" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml index d37f1de..b24a815 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Updates a customer resource. Parameters not supplied remain unchanged. + Updates a storefront customer profile. The response returns the customer with the new values applied. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{id}" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml deleted file mode 100644 index 8f5e890..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml +++ /dev/null @@ -1,9 +0,0 @@ -$kind: params -fields: - - name: phone - type: string - description: "Phone number for the person or customer." - - name: code - type: string - required: true - description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml index c306468..b0f073a 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Verifies a customer phone number with a previously issued code. The response confirms the phone verification result. +description: Verify Phone Number url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-phone-number" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml deleted file mode 100644 index c4e9cce..0000000 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml +++ /dev/null @@ -1,6 +0,0 @@ -$kind: params -fields: - - name: code - type: string - required: true - description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml index 0e32cfd..ed3496c 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Verifies a storefront SMS or account-creation code. The response returns the customer profile and access token when verification succeeds. + Verifies a storefront SMS or creation code. The response includes the customer profile and auth token when verification succeeds. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-code" method: POST headers: diff --git "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/Retrieve a Delivery Service Quote \342\235\227.resources/examples/Successful Response.example.yaml" "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/Retrieve a Delivery Service Quote \342\235\227.resources/examples/Successful Response.example.yaml" deleted file mode 100644 index 0c27300..0000000 --- "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/Retrieve a Delivery Service Quote \342\235\227.resources/examples/Successful Response.example.yaml" +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/service-quotes/from-cart" - method: GET - headers: - Accept: application/json - queryParams: - origin: "" - destination: "" - cart: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "delivery-service-quote_abc123", - "object": "delivery-service-quote", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml deleted file mode 100644 index 500d50d..0000000 --- a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Delivery service quote -description: |- - A delivery service quote represents a delivery service quote record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "delivery-service-quote_abc123", - "object": "delivery-service-quote", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" index 998fd86..499a6a3 100644 --- "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a delivery service quote. The response includes the current API representation of the resource. + Returns a delivery service quote for the supplied cart, origin, and destination. Use the quote during checkout to include delivery pricing. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/service-quotes/from-cart" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Query Food Trucks.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Query Food Trucks.resources/examples/Successful Response.example.yaml deleted file mode 100644 index cde6160..0000000 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Query Food Trucks.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks" - method: GET - headers: - Accept: application/json - queryParams: - limit: "" - offset: "" - sort: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "food-truck_abc123", - "object": "food-truck", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Retrieve Food Truck.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Retrieve Food Truck.resources/examples/Successful Response.example.yaml deleted file mode 100644 index c4eba9f..0000000 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Retrieve Food Truck.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks/{{food_truck_id}}" - method: GET - headers: - Accept: application/json - pathVariables: - food_truck_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "food-truck_abc123", - "object": "food-truck", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml deleted file mode 100644 index e30f2ee..0000000 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Food truck -description: |- - A food truck represents a food truck record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "food-truck_abc123", - "object": "food-truck", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml index 6e91652..2edce6e 100644 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns food trucks matching the supplied filters. Use pagination and query parameters to control the result set. +description: Query Food Trucks url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml index 9f39719..a31d6f5 100644 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a food truck. The response includes the current API representation of the resource. +description: Retrieve Food Truck url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks/{{food_truck_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/Complete Order Pickup.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/Complete Order Pickup.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b1d80c0..0000000 --- a/postman/collections/Fleetbase Storefront API/Orders/.resources/Complete Order Pickup.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/picked-up" - method: PUT - headers: - Accept: application/json - body: - type: json - content: |- - { - "order": "{{order_id}}" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/Get Order Receipt.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/Get Order Receipt.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ff3a6cc..0000000 --- a/postman/collections/Fleetbase Storefront API/Orders/.resources/Get Order Receipt.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/receipt" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "order": "{{order_id}}", - "ebarimt_receiver_type": "CITIZEN", - "ebarimt_receiver": "" - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml deleted file mode 100644 index a9ddfc2..0000000 --- a/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml +++ /dev/null @@ -1,53 +0,0 @@ -$kind: object -name: Order -description: |- - An order represents a order record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "order_abc123", - "object": "order", - "status": "created", - "pickup": { - "id": "place_pickup", - "name": "Warehouse" - }, - "dropoff": { - "id": "place_dropoff", - "name": "Customer address" - }, - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: pickup - type: object - description: "Pickup location, place ID, or embedded pickup details." - fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: name - type: string - description: "Display name for the resource." - - name: dropoff - type: object - description: "Dropoff location, place ID, or embedded dropoff details." - fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: name - type: string - description: "Display name for the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml deleted file mode 100644 index 614efd7..0000000 --- a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml +++ /dev/null @@ -1,5 +0,0 @@ -$kind: params -fields: - - name: order - type: string - description: "Order value for this orders request." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml index 70fc6d1..07ceca9 100644 --- a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Marks a pickup order as completed by the authenticated customer. The response returns the updated order pickup status. +description: Complete Order Pickup url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/picked-up" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml deleted file mode 100644 index 8aff64e..0000000 --- a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml +++ /dev/null @@ -1,11 +0,0 @@ -$kind: params -fields: - - name: order - type: string - description: "Order value for this orders request." - - name: ebarimt_receiver_type - type: string - description: "Ebarimt receiver type value for this orders request." - - name: ebarimt_receiver - type: string - description: "Ebarimt receiver value for this orders request." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml index 468ab98..da6ad7a 100644 --- a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a order. The response includes the current API representation of the resource. +description: Get Order Receipt url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/receipt" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/Create Product.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/Create Product.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 1a92bd4..0000000 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/Create Product.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,32 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "name": "Example Product", - "description": "Example storefront product", - "price": 1000 - } -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "product_abc123", - "object": "product", - "name": "Example Product", - "price": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/Query Products.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/Query Products.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f3de173..0000000 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/Query Products.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" - method: GET - headers: - Accept: application/json - queryParams: - offset: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "product_abc123", - "object": "product", - "name": "Example Product", - "price": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/Retrieve a Product.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/Retrieve a Product.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 18bf629..0000000 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/Retrieve a Product.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{id}" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "product_abc123", - "object": "product", - "name": "Example Product", - "price": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/Update Product.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/Update Product.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ef8e787..0000000 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/Update Product.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{{product_id}}" - method: PUT - headers: - Accept: application/json - pathVariables: - product_id: "" - body: - type: json - content: |- - { - "name": "Updated Product", - "description": "Updated storefront product", - "price": 1000 - } -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "product_abc123", - "object": "product", - "name": "Example Product", - "price": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml deleted file mode 100644 index 693c8ba..0000000 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml +++ /dev/null @@ -1,37 +0,0 @@ -$kind: object -name: Product -description: |- - A product represents a product record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "product_abc123", - "object": "product", - "name": "Example Product", - "price": 1000, - "currency": "USD", - "status": "active", - "created_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: name - type: string - description: "Display name for the resource." - - name: price - type: number - description: "Price for the item." - - name: currency - type: currency - description: "Three-letter currency code." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." diff --git a/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml index 4c0b66a..cb6620b 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a product. The response returns the created resource with its generated identifier. +description: Create Product url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml index d5f2957..5e29e71 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns products matching the supplied filters. Use pagination and query parameters to control the result set. + Returns products available in the current storefront. Use pagination and filters to browse the catalog. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml index 11fbfaf..763d3b7 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Retrieves a product. The response includes the current API representation of the resource. + Retrieves a single storefront product by ID. The response includes product details, pricing, variants, and related catalog data when available. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{id}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml index 10305c0..27dc468 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Updates a product. Parameters not supplied remain unchanged. +description: Update Product url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{{product_id}}" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Counts the number of ratings for a store.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Counts the number of ratings for a store.resources/examples/Successful Response.example.yaml deleted file mode 100644 index ae0a557..0000000 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Counts the number of ratings for a store.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,18 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/count" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "count": 1 - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Create a review.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Create a review.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 6a2cd0e..0000000 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Create a review.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" - method: POST - headers: - Accept: application/json - body: - type: json - content: |- - { - "content": "", - "rating": 5 - } -response: - statusCode: 201 - statusText: Created - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "review_abc123", - "object": "review", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Delete a Review.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Delete a Review.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 36a46d9..0000000 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Delete a Review.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" - method: DELETE - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "review_abc123", - "object": "review", - "deleted": true - } -order: 1000 diff --git "a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Query Reviews \342\235\227.resources/examples/Successful Response.example.yaml" "b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Query Reviews \342\235\227.resources/examples/Successful Response.example.yaml" deleted file mode 100644 index 1006d47..0000000 --- "a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Query Reviews \342\235\227.resources/examples/Successful Response.example.yaml" +++ /dev/null @@ -1,34 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" - method: GET - headers: - Accept: application/json - queryParams: - limit: "" - offset: "" - sort: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "review_abc123", - "object": "review", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Retrieve a Store review.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Retrieve a Store review.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 0fdce01..0000000 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/Retrieve a Store review.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "review_abc123", - "object": "review", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml deleted file mode 100644 index 295600d..0000000 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Review -description: |- - A review represents a review record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "review_abc123", - "object": "review", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml index 9b5c49b..83fc76b 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns the number of storefront ratings for the current store. Use it to display aggregate review counts without fetching the full review list. +description: Counts the number of ratings for a store url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/count" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml index 9ed9514..8af1d4a 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Creates a review. The response returns the created resource with its generated identifier. +description: Create a review url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml index 563fa95..6012d8f 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Deletes a reviews resource. The response confirms the resource that was removed. +description: Delete a Review url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" method: DELETE headers: diff --git "a/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" index ebd784f..37a20bf 100644 --- "a/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns reviews matching the supplied filters. Use pagination and query parameters to control the result set. +description: Query Reviews ❗ url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml index 30e98e5..ba5494c 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a review. The response includes the current API representation of the resource. +description: Retrieve a Store review url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/Query Store Locations.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/Query Store Locations.resources/examples/Successful Response.example.yaml deleted file mode 100644 index dfe16ae..0000000 --- a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/Query Store Locations.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/store-locations" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "store-location_abc123", - "object": "store-location", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml deleted file mode 100644 index 4e3767b..0000000 --- a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Store location -description: |- - A store location represents a store location record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "store-location_abc123", - "object": "store-location", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml index 6a5b140..5ff1a37 100644 --- a/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: |- - Returns store locations matching the supplied filters. Use pagination and query parameters to control the result set. + Returns store locations available through the current storefront or network. Use these locations for browsing, pickup, and fulfillment selection. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/store-locations" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/About Store.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/About Store.resources/examples/Successful Response.example.yaml deleted file mode 100644 index bdcc98f..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/About Store.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,22 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/about" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/List Locations.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/List Locations.resources/examples/Successful Response.example.yaml deleted file mode 100644 index c604b3b..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/List Locations.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/List Network Stores.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/List Network Stores.resources/examples/Successful Response.example.yaml deleted file mode 100644 index e5e4b22..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/List Network Stores.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,35 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/stores" - method: GET - headers: - Accept: application/json - queryParams: - query: "" - limit: "" - offset: "" - store: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/List Tags.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/List Tags.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 541d8aa..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/List Tags.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,30 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/tags" - method: GET - headers: - Accept: application/json -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "data": [ - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } - ], - "meta": { - "limit": 25, - "offset": 0 - } - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/Lookup Store.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/Lookup Store.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 80dd911..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/Lookup Store.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/lookup/{{store_id}}" - method: GET - headers: - Accept: application/json - pathVariables: - store_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/Payment gateways for the current store.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/Payment gateways for the current store.resources/examples/Successful Response.example.yaml deleted file mode 100644 index b0e9bbb..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/Payment gateways for the current store.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,25 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways" - method: GET - headers: - Accept: application/json - queryParams: - limit: "" - offset: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/Retrieve Location.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/Retrieve Location.resources/examples/Successful Response.example.yaml deleted file mode 100644 index f38c3b4..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/Retrieve Location.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations/{{location_id}}" - method: GET - headers: - Accept: application/json - pathVariables: - location_id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/Search Store.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/Search Store.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 98d3f6d..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/Search Store.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,26 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/search" - method: GET - headers: - Accept: application/json - queryParams: - query: "" - limit: "" - offset: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/Specific payment gateway given the id.resources/examples/Successful Response.example.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/Specific payment gateway given the id.resources/examples/Successful Response.example.yaml deleted file mode 100644 index 26620a7..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/Specific payment gateway given the id.resources/examples/Successful Response.example.yaml +++ /dev/null @@ -1,24 +0,0 @@ -$kind: http-example -request: - url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways/{id}" - method: GET - headers: - Accept: application/json - pathVariables: - id: "" -response: - statusCode: 200 - statusText: OK - headers: - Content-Type: application/json - body: - type: json - content: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml deleted file mode 100644 index 8088551..0000000 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml +++ /dev/null @@ -1,29 +0,0 @@ -$kind: object -name: Store -description: |- - A store represents a store record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API. -example: |- - { - "id": "store_abc123", - "object": "store", - "status": "active", - "created_at": "2026-05-07T12:00:00Z", - "updated_at": "2026-05-07T12:00:00Z" - } -fields: - - name: id - type: string - description: "Unique identifier for the resource." - - name: object - type: string - description: "Object type returned by the API." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status of the resource." - - name: created_at - type: timestamp - description: "Time when the resource was created." - - name: updated_at - type: timestamp - description: "Time when the resource was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml index 576eb3f..bc8c0df 100644 --- a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns public profile and configuration details for the current storefront. Use this endpoint to initialize storefront clients. +description: About Store url: "{{base_url}}/{{api_prefix}}/{{namespace}}/about" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml index ac774d7..e864e53 100644 --- a/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns store matching the supplied filters. Use pagination and query parameters to control the result set. +description: List Locations url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml index 818afc3..f732ec9 100644 --- a/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns store matching the supplied filters. Use pagination and query parameters to control the result set. +description: List Network Stores url: "{{base_url}}/{{api_prefix}}/{{namespace}}/stores" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml index 8293c63..5b0a239 100644 --- a/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Returns store matching the supplied filters. Use pagination and query parameters to control the result set. +description: List Tags url: "{{base_url}}/{{api_prefix}}/{{namespace}}/tags" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml index 7227754..fd93ffa 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Looks up a storefront by identifier. The response returns the matching store profile when it is available to the caller. +description: Lookup Store url: "{{base_url}}/{{api_prefix}}/{{namespace}}/lookup/{{store_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml index 3831c82..267b6a4 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Lists payment gateways available to the current storefront. Use the response to decide which payment methods can be offered at checkout. +description: Payment gateways for the current store url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml index 16b2632..9b051e7 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a store. The response includes the current API representation of the resource. +description: Retrieve Location url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations/{{location_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml index fb180b7..24891d7 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Searches the current storefront catalog and related store data. Use query parameters to narrow the results returned to the shopper. +description: Search Storefront url: "{{base_url}}/{{api_prefix}}/{{namespace}}/search" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml index f9dd6c4..0dab8db 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml @@ -1,6 +1,5 @@ $kind: http-request -description: |- - Retrieves a payment gateway by ID for the current storefront. The response includes the gateway metadata safe for storefront clients. +description: Specific payment gateway given the id url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways/{id}" method: GET headers: From 753e9d93b25b40f7bddbca89428a4a73acd560f4 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 14:31:28 +0800 Subject: [PATCH 02/10] Add source-backed Orders API docs metadata --- .../examples/Created.example.yaml | 316 ++++++------------ .../examples/OK.example.yaml | 49 ++- .../examples/OK.example.yaml | 71 +++- .../examples/OK.example.yaml | 79 +++-- .../Orders/.resources/object.yaml | 145 ++++++++ .../Capture Photo for Order.params.yaml | 16 + .../Capture QR Code for Order.params.yaml | 12 + .../Capture QR Code for Order.request.yaml | 4 +- .../Capture Signature for Order.params.yaml | 19 ++ .../Capture Signature for Order.request.yaml | 4 +- .../Orders/Create an Order.params.yaml | 124 ++++++- .../Orders/Create an Order.request.yaml | 8 +- .../Get Order Next Activity.request.yaml | 2 +- .../Orders/Query Orders.queryParams.yaml | 51 ++- .../Orders/Query Orders.request.yaml | 5 +- .../Orders/Retrieve an Order.request.yaml | 3 +- .../Orders/Schedule an Order.params.yaml | 12 + .../Orders/Schedule an Order.request.yaml | 2 + .../Orders/Set Order Destination.request.yaml | 3 +- .../Orders/Start an Order.params.yaml | 11 + .../Orders/Update Order Activity.params.yaml | 11 +- .../Orders/Update an Order.params.yaml | 78 ++++- .../Orders/Update an Order.request.yaml | 3 +- 23 files changed, 726 insertions(+), 302 deletions(-) create mode 100644 postman/collections/Fleetbase API/Orders/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Orders/Start an Order.params.yaml 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/Created.example.yaml index ef10877..cb92582 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/Created.example.yaml @@ -1,125 +1,20 @@ $kind: http-example request: - url: "{{base_url}}/{{namespace}}/orders?payload=&dispatch=&scheduled_at=&driver=&facilitator=&customer=&meta=¬es=&with=" + url: "{{base_url}}/{{namespace}}/orders" method: POST headers: Content-Type: application/json Accept: application/json - queryParams: - - key: payload - value: - description: (Required) The id of the `Payload` object or a `Payload` object. - - key: dispatch - value: - description: Boolean value that should determine whether or not the order should be dispatched on creation or not. By default dispatch is true. - - key: scheduled_at - value: - description: The date and time the order should optionally be dispatched at, otherwise upon order creation the order will be dispatched unless dispatch is explicitly set to false. - - key: driver - value: - description: The id of the Driver to be assigned to the order, if no driver is set the dispatch will send a "ping" to all drivers within an expanding radius around the pickup point coordinates. - - key: facilitator - value: - description: The id of the Vendor or Contact object assigned to facilitate the completion of the order. This is for orders that will be assigned to third parties. - - key: customer - value: - description: The id of the Vendor or Contact object the payload is for. - - key: meta - value: - description: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - - key: notes - value: - description: Text containing additional information for the order, which can be used to assist the driver or facilitator. - - key: with - value: - description: Set of relationships to embedd in response. body: type: json content: |- { - "id": "", - "customer": "", - "facilitator": "", - "driver": { - "id": "", - "current_job": "", - "vehicle": "", - "email": "", - "phone_number": "", - "phone_country_code": "", - "signup_token_used": "", - "drivers_license_number": "", - "latitude": "", - "longitude": "", - "heading": "", - "altitude": "", - "speed": "", - "country": "", - "currency": "", - "city": "", - "online": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "purchase_rate": { - "id": "", - "customer": "", - "order": "", - "service_quote": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "payload": { - "id": "", - "pickup": { - "id": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "dropoff": { - "id": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "return": { - "id": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "customer": "", - "meta": {}, - "cod_amount": "", - "cod_currency": "", - "cod_payment_method": "", - "type": "", - "updated_at": "", - "created_at": "", - "": "" - }, - "meta": {}, - "notes": "", - "type": "", - "status": "", - "scheduled_at": "", - "updated_at": "", - "created_at": "" + "pickup": "Singapore 018971", + "dropoff": "321 Orchard Rd, Singapore", + "dispatch": false, + "driver": "{{driver_id}}", + "customer": "{{contact_id}}", + "notes": "Deliver through receiving bay." } response: statusCode: 201 @@ -130,126 +25,101 @@ response: type: json content: |- { - "id": "", + "id": "order_7YqM3KpL2n", + "internal_id": "ORD-1001", + "order_config": "order_config_transport", "customer": { - "id": "", - "name": "", - "title": "", - "email": "", - "phone": "", - "type": "", - "slug": "", - "updated_at": "", - "created_at": "" - }, - "facilitator": { - "id": "", - "internal_id": "", - "name": "", - "email": "", - "phone_number": "", - "phone_country_code": "", - "address": "", - "type": "", - "slug": "", - "updated_at": "", - "created_at": "" - }, - "driver": { - "id": "", - "current_job": "", - "vehicle": "", - "email": "", - "phone_number": "", - "phone_country_code": "", - "signup_token_used": "", - "drivers_license_number": "", - "latitude": "", - "longitude": "", - "heading": "", - "altitude": "", - "speed": "", - "country": "", - "currency": "", - "city": "", - "online": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "tracking_number": { - "id": "", - "customer": "", - "facilitator": "", - "driver": "", - "tracking_number": "", - "purchase_rate": "", - "payload": "", - "meta": [], - "notes": "", - "type": "", - "status": "", - "scheduled_at": "", - "updated_at": "", - "created_at": "" - }, - "purchase_rate": { - "id": "", - "customer": "", - "order": "", - "service_quote": "", - "status": "", - "updated_at": "", - "created_at": "" + "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": "", + "id": "payload_x9Z2Lm8QpA", + "current_waypoint": "place_1A2b3C4d5E", "pickup": { - "id": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" + "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": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" - }, - "return": { - "id": "", - "name": "", - "type": "", - "latitude": "", - "longitude": "", - "status": "", - "updated_at": "", - "created_at": "" + "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" }, - "customer": "", + "return": null, + "waypoints": [], + "entities": [], + "cod_amount": null, + "cod_currency": null, + "cod_payment_method": null, + "payment_method": null, "meta": {}, - "cod_amount": "", - "cod_currency": "", - "cod_payment_method": "", - "type": "", - "updated_at": "", - "created_at": "", - "": "" + "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": {}, - "notes": "", - "type": "", - "status": "", - "scheduled_at": "", - "updated_at": "", - "created_at": "" + "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/Dispatch an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/OK.example.yaml index db4e1ae..d4f9fb9 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/OK.example.yaml @@ -2,12 +2,55 @@ $kind: http-example request: url: "{{base_url}}/{{namespace}}/orders/:id/dispatch" method: PATCH + headers: + Accept: application/json pathVariables: - id: "" + id: "order_7YqM3KpL2n" response: statusCode: 200 statusText: OK + headers: + Content-Type: application/json body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Retrieve an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Retrieve an Order.resources/examples/OK.example.yaml index 389c8d4..d96ff54 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Retrieve an Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Retrieve an Order.resources/examples/OK.example.yaml @@ -5,7 +5,7 @@ request: headers: Accept: application/json pathVariables: - id: "" + id: "order_7YqM3KpL2n" response: statusCode: 200 statusText: OK @@ -15,19 +15,60 @@ response: type: json content: |- { - "id": "", - "customer": "", - "facilitator": "", - "driver": "", - "tracking_number": "", - "purchase_rate": "", - "payload": "", - "meta": [], - "notes": "", - "type": "", - "status": "", - "scheduled_at": "", - "updated_at": "", - "created_at": "" + "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" } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/OK.example.yaml index e7bb8c7..a1f2e47 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/OK.example.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/OK.example.yaml @@ -1,35 +1,62 @@ $kind: http-example request: - url: "{{base_url}}/{{namespace}}/orders/:id?payload=&scheduled_at=&driver=&facilitator=&customer=&meta=¬es=" + url: "{{base_url}}/{{namespace}}/orders/:id" method: PUT - queryParams: - - key: payload - value: - description: The id of the Payload object to be sent by the order. - - key: scheduled_at - value: - description: The date and time the order should optionally be dispatched at, otherwise upon order creation the order will be dispatched unless dispatch is explicitly set to false. - - key: driver - value: - description: The id of the Driver to be assigned to the order, if no driver is set the dispatch will send a "ping" to all drivers within an expanding radius around the pickup point coordinates. - - key: facilitator - value: - description: The id of the Vendor or Contact object assigned to facilitate the completion of the order. This is for orders that will be assigned to third parties. - - key: customer - value: - description: The id of the Vendor or Contact object the payload is for. - - key: meta - value: - description: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - - key: notes - value: - description: Text containing additional information for the order, which can be used to assist the driver or facilitator. + headers: + Content-Type: application/json + Accept: application/json pathVariables: - id: "" + id: "order_7YqM3KpL2n" + body: + type: json + content: |- + { + "notes": "Leave with the receiving desk.", + "status": "created" + } response: statusCode: 200 statusText: OK + headers: + Content-Type: application/json body: - type: text - content: "" + type: json + content: |- + { + "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" + } order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/.resources/object.yaml b/postman/collections/Fleetbase API/Orders/.resources/object.yaml new file mode 100644 index 0000000..5106994 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/object.yaml @@ -0,0 +1,145 @@ +$kind: object +name: Order +description: |- + 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. +example: | + { + "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" + } +fields: + - name: id + type: string + description: Public order identifier. + - name: internal_id + type: string + description: Optional internal identifier for the order. + - name: order_config + type: string + description: Public identifier of the order configuration used by the order flow. + - name: customer + type: object + description: Customer contact or vendor resource loaded with the order. + - name: payload + type: object + description: Payload resource containing the pickup, dropoff, return stop, waypoints, and entities for the order. + - name: facilitator + type: object + description: Contact, vendor, or integrated vendor facilitating the order. + - name: driver_assigned + type: object + description: Driver assigned to the order. + - name: vehicle_assigned + type: object + description: Vehicle assigned to the order. + - name: tracking_number + type: object + description: Tracking number resource generated for the order. + - name: tracking_statuses + type: array of objects + description: Tracking statuses loaded with the order. + - name: files + type: array of objects + description: Files attached to the order. + - name: purchase_rate + type: object + description: Purchase rate attached to the order, when present. + - name: notes + type: string + description: Free-form notes attached to the order. + - name: type + type: string + description: Order type resolved from the order configuration. + - name: status + type: string + description: Current order lifecycle status. + - name: pod_method + type: string + description: Proof-of-delivery method required for the order. + - name: pod_required + type: boolean + description: Whether proof of delivery is required. + - name: dispatched + type: boolean + description: Whether the order has been dispatched. + - name: started + type: boolean + description: Whether the order has started. + - name: adhoc + type: boolean + description: Whether the order is ad hoc. + - name: adhoc_distance + type: integer + description: Ad hoc dispatch distance in meters. + - name: distance + type: integer + description: Preliminary route distance in meters. + - name: time + type: integer + description: Preliminary route duration in seconds. + - name: tracker_data + type: object + description: Tracker data returned when requested with `with_tracker_data`. + - name: eta + type: object + description: Estimated arrival data returned when requested with `with_eta`. + - name: meta + type: object + description: Additional order metadata. + - name: dispatched_at + type: timestamp + description: Timestamp when the order was dispatched. + - name: started_at + type: timestamp + description: Timestamp when the order was started. + - name: scheduled_at + type: timestamp + description: Timestamp when the order is scheduled. + - name: updated_at + type: timestamp + description: Timestamp when the order was last updated. + - name: created_at + type: timestamp + description: Timestamp when the order was created. diff --git a/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml new file mode 100644 index 0000000..2934dce --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: photos + type: array of strings + required: true + description: One or more uploaded images or Base64 image strings. Each item must be an image no larger than 10 MB. + - name: remarks + type: string + default: Verified by Photo + description: Remarks stored on each proof record. + - name: data + type: object + description: Structured proof metadata stored with each photo proof. + - name: disk + type: string + description: Filesystem disk used to store proof photos. Defaults to the configured filesystem disk. diff --git a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml new file mode 100644 index 0000000..959bd23 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: code + type: string + required: true + description: QR code value to verify. The code must match the resolved subject UUID. + - name: data + type: object + description: Structured proof metadata stored with the QR proof. + - name: raw_data + type: object + description: Raw QR payload stored on the proof record. diff --git a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml index e194292..396e8f5 100644 --- a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml @@ -6,10 +6,10 @@ method: POST pathVariables: - key: id value: "{{order_id}}" - description: (Required) The id of the order to dispatch. + description: (Required) The id of the order. - key: subject-id value: "" - description: (Optional) Subject for signature, which can be a place, waypoint, or entity + description: (Optional) Subject for the proof, which can be a place, waypoint, or entity. body: type: json content: |- diff --git a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml new file mode 100644 index 0000000..42684dd --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml @@ -0,0 +1,19 @@ +$kind: params +fields: + - name: signature + type: string + required: true + description: Base64 PNG signature data. Fleetbase stores the image and links it to the proof record. + - name: remarks + type: string + default: Verified by Signature + description: Remarks stored on the proof record. + - name: data + type: object + description: Structured proof metadata stored with the signature proof. + - name: disk + type: string + description: Filesystem disk used to store the signature image. Defaults to the configured filesystem disk. + - name: bucket + type: string + description: Storage bucket used for the generated signature file. diff --git a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml index 80cabdc..23f2821 100644 --- a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml @@ -6,10 +6,10 @@ method: POST pathVariables: - key: id value: "{{order_id}}" - description: (Required) The id of the order to dispatch. + description: (Required) The id of the order. - key: subject-id value: "" - description: (Optional) Subject for signature, which can be a place, waypoint, or entity + description: (Optional) Subject for the signature proof, which can be a place, waypoint, or entity. body: type: json content: |- diff --git a/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml index 5159ab3..3a917b9 100644 --- a/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml +++ b/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml @@ -1,16 +1,122 @@ $kind: params fields: - - name: name + - name: payload + type: object + description: Existing payload ID or an inline payload object. If omitted, provide `pickup` and `dropoff`, or provide at least two `waypoints`. + fields: + - name: pickup + type: object + description: Pickup place data or place identifier for the payload. + - name: dropoff + type: object + description: Dropoff place data or place identifier for the payload. + - name: return + type: object + description: Optional return place data or place identifier for the payload. + - name: waypoints + type: array of objects + description: Ordered route stops. Required when the payload does not include both `pickup` and `dropoff`. + - name: entities + type: array of objects + description: Entities, packages, or items attached to the payload. + - name: pickup + type: object + description: Pickup place data or address used to create the order payload when `payload` is not supplied. + - name: dropoff + type: object + description: Dropoff place data or address used to create the order payload when `payload` is not supplied. + - name: return + type: object + description: Optional return place data or address used when creating the order payload. + - name: waypoints + type: array of objects + description: 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. + - name: entities + type: array of objects + description: Entities, packages, or items attached to the generated payload. + - name: type type: string - required: true - description: "Display name for the resource." - - name: description + description: Order configuration key. Fleetbase resolves this with `order_config` and stores the resolved key as the order type. + - name: order_config type: string - description: "Human-readable description of the resource." + description: Order configuration identifier used to resolve the order flow. + - name: service_quote + type: string + description: Service quote ID to purchase and attach to the order. + - name: purchase_rate + type: string + description: Purchase rate ID to attach to the order. + - name: driver + type: string + description: Driver ID to assign to the order. Fleetbase also assigns the driver's vehicle when one is available. + - name: vehicle + type: string + description: Vehicle ID to assign to the order. + - name: facilitator + type: string + description: Contact, vendor, or integrated vendor ID responsible for facilitating the order. + - name: customer + type: object + description: Existing contact/vendor ID, or customer details used to find or create a customer contact. + fields: + - name: internal_id + type: string + description: Optional internal customer identifier. + - name: name + type: string + description: Customer display name. + - name: title + type: string + description: Customer title. + - name: email + type: string + description: Customer email address used when finding or creating the customer contact. + - name: phone + type: string + description: Customer phone number. + - name: meta + type: object + description: Additional customer metadata. + - name: dispatch + type: boolean + description: When `true`, Fleetbase dispatches the order after it is created. Dispatch is skipped for integrated vendor orders. + - name: adhoc + type: boolean + description: Marks the order as ad hoc. + - name: adhoc_distance + type: number + description: Ad hoc search distance for dispatching nearby drivers. + - name: pod_required + type: boolean + description: Whether proof of delivery is required to complete the order. + - name: pod_method + type: string + description: Proof of delivery method. Required when `pod_required` is true. + - name: scheduled_at + type: timestamp + description: Date and time when the order should be scheduled. - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + type: string + description: Initial order status. Defaults to `created` when omitted. + - name: internal_id + type: string + description: Optional internal identifier for the order. - name: meta + type: object + description: Additional order metadata. + - name: notes type: string - description: "Arbitrary metadata stored with the resource." + description: Free-form notes attached to the order. + - name: time_window_start + type: timestamp + description: Earliest time the order should be serviced by the orchestrator. + - name: time_window_end + type: timestamp + description: Latest time the order should be serviced by the orchestrator. + - name: required_skills + type: array of strings + description: Skills required for orchestrator assignment. + - name: orchestrator_priority + type: integer + default: 50 + description: Orchestrator priority for assignment. Fleetbase defaults invalid or omitted values to `50`. diff --git a/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml index 7a93c7e..42deb3e 100644 --- a/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Create an Order.request.yaml @@ -1,12 +1,8 @@ $kind: http-request description: |- - To create a new `Order` in Fleetbase, the `Order` requires a payload which describres each `Entity` in the order as well as the geolocational waypoints. The payload can be created previously or created by sending a `Payload` object embedded within the Order request. + 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. - Orders can also be subcontracted to a facilitator which can be either a `Contact` or `Vendor`. Like facilitator, the Order can also be assigned a customer which can also be either a `Contact` or `Vendor`. - - To schedule an order upon creation use the `scheduled_at` parameter to send a date and time to schedule the order. - - To assign a driver to the order the send the id of the driver to assign using the `driver` parameter. + 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. url: "{{base_url}}/{{namespace}}/orders" method: POST headers: diff --git a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml index cc66b8b..bfa1993 100644 --- a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml @@ -6,7 +6,7 @@ method: GET pathVariables: - key: id value: "{{order_id}}" - description: (Required) The id of the order to dispatch. + description: (Required) The id of the order. body: type: json content: "" diff --git a/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml b/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml index f3a0de0..819b5f0 100644 --- a/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml +++ b/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml @@ -1,15 +1,50 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this orders request." + type: integer + description: Maximum number of orders to return. - name: offset - type: string - description: "Offset value for this orders request." + type: integer + description: Number of orders to skip before returning results. - name: sort type: string - description: "Sort value for this orders request." + description: Sort expression for the order query. - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + type: string + description: Filters orders by lifecycle status. + - name: payload + type: string + description: Filters orders by payload ID. + - name: pickup + type: string + description: Filters orders by pickup place ID. + - name: dropoff + type: string + description: Filters orders by dropoff place ID. + - name: return + type: string + description: Filters orders by return place ID. + - name: facilitator + type: string + description: Filters orders by facilitator public or internal ID. + - name: customer + type: string + description: Filters orders by customer public or internal ID. + - name: entity + type: string + description: Filters orders containing the specified entity public or internal ID. + - name: entity_status + type: string + description: Filters orders by the tracking status code of their payload entities. + - name: on + type: date + description: Filters orders created or scheduled on the specified date. + - name: pod_required + type: boolean + description: When true, returns only orders requiring proof of delivery. + - name: dispatched + type: boolean + description: When true, returns only dispatched orders. + - name: nearby + type: string + description: Filters nearby orders using coordinates, a driver ID, or an address string. diff --git a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml index 840c8c7..8fb21ba 100644 --- a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml @@ -1,10 +1,11 @@ $kind: http-request -description: List all orders. +description: |- + Returns orders for the current company. Use filters such as `status`, `payload`, `customer`, `facilitator`, or `nearby` to narrow the result set. url: "{{base_url}}/{{namespace}}/orders" method: GET queryParams: limit: "25" offset: "0" sort: "created_at" - status: "active" + status: "created" order: 2000 diff --git a/postman/collections/Fleetbase API/Orders/Retrieve an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Retrieve an Order.request.yaml index cb6c5d4..615a2d1 100644 --- a/postman/collections/Fleetbase API/Orders/Retrieve an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Retrieve an Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Retrieve an Order. +description: |- + Retrieves a single order by ID. The response includes the public order fields plus loaded payload, tracking, assignment, customer, and facilitator data when available. url: "{{base_url}}/{{namespace}}/orders/{{order_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml new file mode 100644 index 0000000..b53e628 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: date + type: date + required: true + description: Schedule date in `YYYY-MM-DD` format. + - name: time + type: string + description: Optional time to combine with `date`. + - name: timezone + type: string + description: Timezone used when parsing the schedule date and time. Defaults to the company timezone. diff --git a/postman/collections/Fleetbase API/Orders/Schedule an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Schedule an Order.request.yaml index 6056812..8f82562 100644 --- a/postman/collections/Fleetbase API/Orders/Schedule an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Schedule an Order.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Schedules an order for a specific date and optional time. Fleetbase parses the schedule using the supplied timezone or the company timezone. url: "{{base_url}}/{{namespace}}/orders/:id/schedule" method: PATCH pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml index f9b6753..ad50901 100644 --- a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml @@ -6,9 +6,10 @@ method: PATCH pathVariables: - key: id value: "{{order_id}}" - description: (Required) The id of the order to dispatch. + description: (Required) The id of the order to update. - key: placeId value: "{{place_id}}" + description: (Required) The pickup, dropoff, or waypoint place id to set as the current destination. body: type: json content: "" diff --git a/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml new file mode 100644 index 0000000..c4b634c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: skip_dispatch + type: boolean + description: Starts the order even if it has not been dispatched. + - name: skipDispatch + type: boolean + description: Camel-case alias for `skip_dispatch`. + - name: assign + type: string + description: Driver ID to assign before starting an ad hoc order. diff --git a/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml b/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml index 423ed33..6f9e500 100644 --- a/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml +++ b/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml @@ -1,5 +1,14 @@ $kind: params fields: + - name: activity + type: object + description: Activity payload to apply to the order. Fleetbase resolves it against the order configuration flow. + - name: proof + type: object + description: Optional proof data to attach when the activity updates an entity or waypoint. - name: skip_dispatch type: boolean - description: "Skip dispatch value for this orders request." + description: Uses the first started activity instead of dispatching when the submitted activity is `dispatched`. + - name: skipDispatch + type: boolean + description: Camel-case alias for `skip_dispatch`. diff --git a/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml index 865a32c..2ab4096 100644 --- a/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml +++ b/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml @@ -1,5 +1,81 @@ $kind: params fields: + - name: payload + type: object + description: Existing payload ID or inline payload data used to replace or update the order payload. + - name: pickup + type: object + description: Replacement pickup place data or address for the order payload. + - name: dropoff + type: object + description: Replacement dropoff place data or address for the order payload. + - name: return + type: object + description: Replacement return place data or address for the order payload. + - name: waypoints + type: array of objects + description: Replacement waypoint list. When sent empty with route endpoint fields, existing waypoints are removed. + - name: entities + type: array of objects + description: Replacement entities for the order payload. - name: service_quote type: string - description: "Service quote ID used by the request." + description: Service quote ID to purchase and attach to the order. + - name: driver + type: string + description: Driver ID to assign to the order. + - name: vehicle + type: string + description: Vehicle ID to assign to the order. + - name: facilitator + type: string + description: Contact or vendor ID responsible for facilitating the order. + - name: customer + type: string + description: Contact or vendor ID to assign as the order customer. + - name: dispatch + type: boolean + description: When `true`, dispatches the order after applying the update. + - name: adhoc + type: boolean + description: Marks the order as ad hoc. + - name: adhoc_distance + type: number + description: Ad hoc search distance for dispatching nearby drivers. + - name: pod_required + type: boolean + description: Whether proof of delivery is required to complete the order. + - name: pod_method + type: string + description: Proof of delivery method. Required when `pod_required` is true. + - name: scheduled_at + type: timestamp + description: Date and time when the order should be scheduled. + - name: type + type: string + description: Order type or order configuration key. + - name: status + type: string + description: Order lifecycle status to set. + - name: internal_id + type: string + description: Optional internal identifier for the order. + - name: meta + type: object + description: Additional order metadata. + - name: notes + type: string + description: Free-form notes attached to the order. + - name: time_window_start + type: timestamp + description: Earliest time the order should be serviced by the orchestrator. + - name: time_window_end + type: timestamp + description: Latest time the order should be serviced by the orchestrator. + - name: required_skills + type: array of strings + description: Skills required for orchestrator assignment. + - name: orchestrator_priority + type: integer + default: 50 + description: Orchestrator priority for assignment. Fleetbase defaults explicitly empty values to `50`. diff --git a/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml index 429de46..f0e629e 100644 --- a/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Update an Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update an Order. +description: |- + 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. url: "{{base_url}}/{{namespace}}/orders/:id" method: PUT pathVariables: From d17fbc26aae391270af2154a59e887867ebb2cc6 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:17:56 +0800 Subject: [PATCH 03/10] Add source-backed place payload entity metadata --- .../Entities/.resources/object.yaml | 110 ++++++++++++++++++ .../Entities/Create an Entity.params.yaml | 70 +++++++++-- .../Entities/Create an Entity.request.yaml | 3 +- .../Entities/Query Entities.queryParams.yaml | 20 +++- .../Entities/Query Entities.request.yaml | 4 +- .../Entities/Update a Entity.params.yaml | 60 +++++++++- .../Entities/Update a Entity.request.yaml | 3 +- .../Payloads/.resources/object.yaml | 70 +++++++++++ .../Payloads/Create a Payload.params.yaml | 39 +++++-- .../Payloads/Create a Payload.request.yaml | 18 ++- .../Payloads/Query Payloads.queryParams.yaml | 10 +- .../Payloads/Query Payloads.request.yaml | 3 +- .../Payloads/Update a Payload.params.yaml | 46 +++++--- .../Payloads/Update a Payload.request.yaml | 3 +- .../Places/.resources/object.yaml | 100 ++++++++++++++++ .../Places/Create a Place.params.yaml | 62 +++++++--- .../Places/Create a Place.request.yaml | 7 +- .../Places/List all Places.queryParams.yaml | 10 +- .../Places/Query Places.queryParams.yaml | 15 ++- .../Places/Search Places.queryParams.yaml | 20 +++- .../Places/Update a Place.params.yaml | 56 ++++++--- .../Places/Update a Place.request.yaml | 7 +- 22 files changed, 616 insertions(+), 120 deletions(-) create mode 100644 postman/collections/Fleetbase API/Entities/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Payloads/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Places/.resources/object.yaml diff --git a/postman/collections/Fleetbase API/Entities/.resources/object.yaml b/postman/collections/Fleetbase API/Entities/.resources/object.yaml new file mode 100644 index 0000000..cc25094 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/.resources/object.yaml @@ -0,0 +1,110 @@ +$kind: object +name: Entity +description: |- + An entity represents an item, parcel, package, or other physical unit attached to a payload. It can include dimensions, weight, pricing, destination, customer, tracking, and metadata. +example: | + { + "id": "entity_4Mnp8Qx2Vz", + "internal_id": "ENTITY001", + "name": "Sample Entity", + "type": "parcel", + "payload": "payload_x9Z2Lm8QpA", + "destination": "place_9Z8y7X6w5V", + "customer": null, + "tracking_number": { + "id": "tracking_3Nf8Qw2YxM", + "tracking_number": "FB-ENTITY-1001" + }, + "description": "Sample description", + "photo_url": null, + "length": 10, + "width": 5, + "height": 8, + "dimensions_unit": "mm", + "weight": 2.5, + "weight_unit": "kg", + "declared_value": 1500, + "price": 1200, + "sale_price": 900, + "sku": "SKU123", + "currency": "USD", + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public entity identifier. + - name: internal_id + type: string + description: Optional internal identifier for the entity. + - name: name + type: string + description: Display name for the entity. + - name: type + type: string + description: Entity type. + - name: payload + type: string + description: Public ID of the payload attached to the entity. + - name: destination + type: string + description: Public ID of the destination place. + - name: customer + type: object + description: Customer contact or vendor associated with the entity. + - name: supplier + type: object + description: Supplier associated with the entity, when loaded. + - name: tracking_number + type: object + description: Tracking number resource generated for the entity. + - name: description + type: string + description: Human-readable entity description. + - name: photo_url + type: string + description: Photo URL associated with the entity. + - name: length + type: number + description: Entity length. + - name: width + type: number + description: Entity width. + - name: height + type: number + description: Entity height. + - name: dimensions_unit + type: string + description: Unit for length, width, and height. + - name: weight + type: number + description: Entity weight. + - name: weight_unit + type: string + description: Unit for weight. + - name: declared_value + type: currency + description: Declared value of the entity. + - name: price + type: currency + description: Price of the entity. + - name: sale_price + type: currency + description: Sale price of the entity. + - name: sku + type: string + description: Stock keeping unit for the entity. + - name: currency + type: currency + description: Three-letter currency code for monetary fields. + - name: meta + type: object + description: Additional entity metadata. + - name: updated_at + type: timestamp + description: Timestamp when the entity was last updated. + - name: created_at + type: timestamp + description: Timestamp when the entity was created. diff --git a/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml b/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml index 5159ab3..b1b781e 100644 --- a/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml +++ b/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml @@ -3,14 +3,70 @@ fields: - name: name type: string required: true - description: "Display name for the resource." + description: Display name for the entity. + - name: type + type: string + required: true + description: Entity type, such as `parcel`, `package`, or another application-defined type. + - name: internal_id + type: string + description: Optional internal identifier for the entity. - name: description type: string - description: "Human-readable description of the resource." - - name: status + description: Human-readable entity description. + - name: payload + type: string + description: Payload ID to attach the entity to. Required when `destination` or `waypoint` is supplied. + - name: destination + type: string + description: Place ID within the payload route to use as the entity destination. + - name: waypoint + type: string + description: Alias for `destination`; resolves a place within the payload route. + - name: customer + type: string + description: Contact or vendor ID to assign as the entity customer. + - name: driver + type: string + description: Driver ID to associate with the entity. + - name: email + type: string + description: Contact email associated with the entity. + - name: weight + type: number + description: Entity weight. + - name: weight_unit type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + values: ["g", "oz", "lb", "kg"] + description: Unit for `weight`. Required when `weight` is supplied. + - name: length + type: number + description: Entity length. + - name: width + type: number + description: Entity width. + - name: height + type: number + description: Entity height. + - name: dimensions_unit + type: enum + values: ["cm", "in", "ft", "mm", "m", "yd"] + description: Unit for length, width, and height. Required when dimensions are supplied. + - name: declared_value + type: currency + description: Declared value of the entity. + - name: price + type: currency + description: Price of the entity. + - name: sale_price + type: currency + description: Sale price of the entity. + - name: sku type: string - description: "Arbitrary metadata stored with the resource." + description: Stock keeping unit for the entity. + - name: currency + type: currency + description: Three-letter currency code for monetary fields. + - name: meta + type: object + description: Additional entity metadata. diff --git a/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml b/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml index 773dfc7..9c7b91c 100644 --- a/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Create an Entity.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create an Entity. +description: |- + Creates an entity such as a parcel, package, or item. Attach it to a payload and optionally set a destination or waypoint within that payload route. url: "{{base_url}}/{{namespace}}/entities" method: POST headers: diff --git a/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml b/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml index 209ecb0..2baee06 100644 --- a/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml +++ b/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml @@ -1,12 +1,20 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this entities request." + type: integer + description: Maximum number of entities to return. - name: offset + type: integer + description: Number of entities to skip before returning results. + - name: sort type: string - description: "Offset value for this entities request." + description: Sort expression for the entity query. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + description: Filters entities by entity type. + - name: payload + type: string + description: Filters entities by payload ID. + - name: destination + type: string + description: Filters entities by destination place ID. diff --git a/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml b/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml index eb07b1f..9c86538 100644 --- a/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml @@ -1,9 +1,11 @@ $kind: http-request -description: List all entities. +description: |- + Returns entities for the current company. Use filters such as `type`, `payload`, or `destination` to narrow the result set. url: "{{base_url}}/{{namespace}}/entities" method: GET queryParams: limit: "25" offset: "0" + sort: "created_at" type: "parcel" order: 2000 diff --git a/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml b/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml index 5256277..37a1337 100644 --- a/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml +++ b/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml @@ -1,17 +1,67 @@ $kind: params fields: + - name: name + type: string + description: Display name for the entity. + - name: type + type: string + description: Entity type. - name: internal_id type: string - description: "External or internal identifier supplied by your system." + description: Optional internal identifier for the entity. - name: description type: string - description: "Human-readable description of the resource." + description: Human-readable entity description. + - name: payload + type: string + description: Payload ID to attach the entity to. - name: destination type: string - description: "Destination value for this entities request." + description: Place ID within the payload route to use as the entity destination. + - name: waypoint + type: string + description: Alias for `destination`; resolves a place within the payload route. + - name: customer + type: string + description: Contact or vendor ID to assign as the entity customer. + - name: driver + type: string + description: Driver ID to associate with the entity. + - name: weight + type: number + description: Entity weight. + - name: weight_unit + type: enum + values: ["g", "oz", "lb", "kg"] + description: Unit for `weight`. + - name: length + type: number + description: Entity length. + - name: width + type: number + description: Entity width. + - name: height + type: number + description: Entity height. + - name: dimensions_unit + type: enum + values: ["cm", "in", "ft", "mm", "m", "yd"] + description: Unit for length, width, and height. + - name: declared_value + type: currency + description: Declared value of the entity. + - name: price + type: currency + description: Price of the entity. + - name: sale_price + type: currency + description: Sale price of the entity. - name: sku type: string - description: "Sku value for this entities request." + description: Stock keeping unit for the entity. - name: currency type: currency - description: "Three-letter currency code for monetary values." + description: Three-letter currency code for monetary fields. + - name: meta + type: object + description: Additional entity metadata. diff --git a/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml b/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml index 5fac046..6dee422 100644 --- a/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Update a Entity.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update an Entity. +description: |- + Updates an entity's descriptive fields, payload assignment, destination, dimensions, weight, pricing, or metadata. url: "{{base_url}}/{{namespace}}/entities/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Payloads/.resources/object.yaml b/postman/collections/Fleetbase API/Payloads/.resources/object.yaml new file mode 100644 index 0000000..054d172 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/object.yaml @@ -0,0 +1,70 @@ +$kind: object +name: Payload +description: |- + A payload describes what an order moves and where it moves through. It links pickup, dropoff, return, waypoints, entities, cash-on-delivery settings, and metadata. +example: | + { + "id": "payload_x9Z2Lm8QpA", + "current_waypoint": "place_1A2b3C4d5E", + "pickup": { + "id": "place_1A2b3C4d5E", + "name": "Warehouse 7" + }, + "dropoff": { + "id": "place_9Z8y7X6w5V", + "name": "Customer Dock" + }, + "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" + } +fields: + - name: id + type: string + description: Public payload identifier. + - name: current_waypoint + type: string + description: Public ID of the current waypoint, when one is set. + - name: pickup + type: object + description: Pickup place for the payload. + - name: dropoff + type: object + description: Dropoff place for the payload. + - name: return + type: object + description: Return place for the payload. + - name: waypoints + type: array of objects + description: Ordered waypoint resources for the payload. + - name: entities + type: array of objects + description: Entity resources attached to the payload. + - name: cod_amount + type: currency + description: Cash-on-delivery amount. + - name: cod_currency + type: currency + description: Three-letter currency code for cash-on-delivery. + - name: cod_payment_method + type: string + description: Cash-on-delivery payment method. + - name: payment_method + type: string + description: Payment method associated with the payload. + - name: meta + type: object + description: Additional payload metadata. + - name: updated_at + type: timestamp + description: Timestamp when the payload was last updated. + - name: created_at + type: timestamp + description: Timestamp when the payload was created. diff --git a/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml b/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml index 5159ab3..5b4be57 100644 --- a/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml +++ b/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml @@ -1,16 +1,37 @@ $kind: params fields: - - name: name + - name: pickup + type: object + description: Pickup place data, address string, or place ID for the payload. + - name: dropoff + type: object + description: Dropoff place data, address string, or place ID for the payload. + - name: return + type: object + description: Optional return place data, address string, or place ID for the payload. + - name: waypoints + type: array of objects + description: Ordered route stops for the payload. + - name: entities + type: array of objects + description: Entities, packages, or items attached to the payload. + - name: type type: string required: true - description: "Display name for the resource." - - name: description + description: Payload type. Required when creating a payload. + - name: provider type: string - description: "Human-readable description of the resource." - - name: status + description: Provider identifier associated with the payload. + - name: cod_amount + type: currency + description: Cash-on-delivery amount. + - name: cod_currency + type: currency + description: Three-letter currency code for `cod_amount`. Required when `cod_amount` is supplied. + - name: cod_payment_method type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + values: ["card", "check", "cash", "bank_transfer"] + description: Cash-on-delivery payment method. Required when `cod_amount` is supplied. - name: meta - type: string - description: "Arbitrary metadata stored with the resource." + type: object + description: Additional payload metadata. diff --git a/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml b/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml index a4d3d1c..c26e2e4 100644 --- a/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml @@ -1,18 +1,16 @@ $kind: http-request -description: Create a Payload. +description: |- + Creates a payload containing route endpoints and optional entities. Provide either pickup/dropoff endpoints or a waypoint list, then attach entities as needed. url: "{{base_url}}/{{namespace}}/payloads" method: POST body: type: json - content: "{\r - - \ \"pickup\": \"10 Bayfront Avenue, Singapore 018956\",\r - - \ \"dropoff\": \"80 Mandai Lake Rd, Singapore 729826\",\r - - \ \"type\": \"food_delivery\"\r - - }" + content: |- + { + "pickup": "10 Bayfront Avenue, Singapore 018956", + "dropoff": "80 Mandai Lake Rd, Singapore 729826", + "type": "food_delivery" + } scripts: - type: afterResponse code: | diff --git a/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml b/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml index 84af84d..c5a1014 100644 --- a/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml +++ b/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml @@ -1,11 +1,11 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this payloads request." + type: integer + description: Maximum number of payloads to return. - name: offset - type: string - description: "Offset value for this payloads request." + type: integer + description: Number of payloads to skip before returning results. - name: sort type: string - description: "Sort value for this payloads request." + description: Sort expression for the payload query. diff --git a/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml b/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml index 5e0acb4..7cbcc7d 100644 --- a/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Queries payload resources." +description: |- + Returns payloads for the current company. Use pagination and sort parameters to page through payload records. url: "{{base_url}}/{{namespace}}/payloads" method: GET queryParams: diff --git a/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml b/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml index b5dc316..b65df7f 100644 --- a/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml +++ b/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml @@ -1,18 +1,36 @@ $kind: params fields: + - name: pickup + type: object + description: Replacement pickup place data, address string, or place ID for the payload. + - name: dropoff + type: object + description: Replacement dropoff place data, address string, or place ID for the payload. + - name: return + type: object + description: Replacement return place data, address string, or place ID for the payload. + - name: waypoints + type: array of objects + description: Replacement waypoint list. Sending route endpoint fields without waypoints removes existing waypoints. - name: entities type: array of objects - description: "Entities included in the payload or order." - fields: - - name: name - type: string - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." - - name: currency - type: currency - description: "Three-letter currency code for monetary values." - - name: price - type: integer - description: "Price for the item or entity." + description: Replacement entities, packages, or items attached to the payload. + - name: type + type: string + description: Payload type. + - name: provider + type: string + description: Provider identifier associated with the payload. + - name: cod_amount + type: currency + description: Cash-on-delivery amount. + - name: cod_currency + type: currency + description: Three-letter currency code for `cod_amount`. + - name: cod_payment_method + type: enum + values: ["card", "check", "cash", "bank_transfer"] + description: Cash-on-delivery payment method. + - name: meta + type: object + description: Additional payload metadata. diff --git a/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml b/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml index 3958b31..60b5048 100644 --- a/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Update a Payload.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update a Payload. +description: |- + Updates a payload's route endpoints, waypoints, entities, cash-on-delivery settings, or metadata. The response returns the updated payload with route and entity data. url: "{{base_url}}/{{namespace}}/payloads/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase API/Places/.resources/object.yaml b/postman/collections/Fleetbase API/Places/.resources/object.yaml new file mode 100644 index 0000000..5450e94 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/object.yaml @@ -0,0 +1,100 @@ +$kind: object +name: Place +description: |- + A place represents a physical location used by FleetOps resources such as orders, payloads, vendors, contacts, and waypoints. It stores geocoded coordinates, address fields, ownership, contact details, and metadata. +example: | + { + "id": "place_1A2b3C4d5E", + "name": "Central Park", + "location": { + "latitude": 40.785091, + "longitude": -73.968285 + }, + "address": "830 5th Ave, New York, NY 10065, USA", + "avatar_url": null, + "street1": "830 5th Ave", + "street2": null, + "city": "New York", + "province": "New York", + "postal_code": "10065", + "neighborhood": "Manhattan", + "district": "Midtown", + "building": "Park Area", + "security_access_code": null, + "country": "US", + "phone": "+12123106600", + "type": "park", + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public place identifier. + - name: name + type: string + description: Display name for the place. + - name: location + type: object + description: Geospatial coordinates for the place. + - name: address + type: string + description: Formatted address for the place. + - name: avatar_url + type: string + description: Avatar URL associated with the place. + - name: street1 + type: string + description: Primary street address. + - name: street2 + type: string + description: Secondary street address. + - name: city + type: string + description: City or locality. + - name: province + type: string + description: State, province, or region. + - name: postal_code + type: string + description: Postal or ZIP code. + - name: neighborhood + type: string + description: Neighborhood or local area. + - name: district + type: string + description: District or administrative subdivision. + - name: building + type: string + description: Building name, number, or additional address detail. + - name: security_access_code + type: string + description: Access code or delivery instructions needed to enter the building. + - name: country + type: string + description: Country code. + - name: phone + type: string + description: Phone number associated with the place. + - name: owner + type: object + description: Contact or vendor resource that owns the place, when loaded. + - name: tracking_number + type: object + description: Tracking number associated with the place, when loaded. + - name: type + type: string + description: Place classification. + - name: meta + type: object + description: Additional place metadata. + - name: eta + type: object + description: Estimated arrival data when route ETA is requested. + - name: updated_at + type: timestamp + description: Timestamp when the place was last updated. + - name: created_at + type: timestamp + description: Timestamp when the place was created. diff --git a/postman/collections/Fleetbase API/Places/Create a Place.params.yaml b/postman/collections/Fleetbase API/Places/Create a Place.params.yaml index 89b4dcb..97d08ce 100644 --- a/postman/collections/Fleetbase API/Places/Create a Place.params.yaml +++ b/postman/collections/Fleetbase API/Places/Create a Place.params.yaml @@ -2,39 +2,67 @@ $kind: params fields: - name: name type: string - required: true - description: "Display name for the resource." + description: Display name for the place. Required on create unless address, street, or coordinates are enough for Fleetbase to geocode the place. + - name: address + type: string + description: Address string to geocode into a place when structured address fields are not supplied. - name: street1 type: string - description: "Primary street address." + description: Primary street address. Required on create unless address or coordinates are supplied. + - name: street2 + type: string + description: Secondary street address. - name: city type: string - description: "City or locality for the address." + description: City or locality for the address. - name: province type: string - description: "State, province, or region for the address." + description: State, province, or region for the address. - name: postal_code type: string - description: "Postal or ZIP code for the address." + description: Postal or ZIP code for the address. - name: neighborhood type: string - description: "Neighborhood or local area for the address." + description: Neighborhood or local area for the address. - name: district type: string - description: "District or administrative subdivision for the address." + description: District or administrative subdivision for the address. - name: building type: string - description: "Building name, number, or additional address detail." + description: Building name, number, or additional address detail. + - name: security_access_code + type: string + description: Access code or delivery instructions needed to enter the building. - name: country type: string - description: "ISO country code for the address." - - name: phone_number + description: Country code for the address. + - name: phone + type: string + description: Phone number associated with the place. + - name: location + type: object + description: Resolvable point used as the place location. Fleetbase accepts supported coordinate formats and reverse geocodes missing address fields. + - name: latitude + type: number + description: Decimal latitude. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude. Required with `latitude`. + - name: owner type: string - description: "Local phone number for the place or contact." - - name: phone_country_code + description: Contact or vendor ID that owns the place. + - name: customer type: string - description: "International dialing code for the phone number." + description: Contact or vendor ID to assign as the place owner. + - name: contact + type: string + description: Contact or vendor ID to assign as the place owner. + - name: vendor + type: string + description: Vendor ID to assign as the place owner. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + description: Place classification. + - name: meta + type: object + description: Additional place metadata. diff --git a/postman/collections/Fleetbase API/Places/Create a Place.request.yaml b/postman/collections/Fleetbase API/Places/Create a Place.request.yaml index 9782a96..033ed04 100644 --- a/postman/collections/Fleetbase API/Places/Create a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Create a Place.request.yaml @@ -1,8 +1,6 @@ $kind: http-request description: |- - When you create a place, you must specify a name and latitude and longitude coordinates. - - Fleetbase will run a reverse geocode automatically on the provided coordinates to automatically complete the address when the optional fields are not provided. + Creates a place for the current company. Provide structured address fields, a free-form `address` or `street1` value to geocode, or coordinates for Fleetbase to reverse geocode. url: "{{base_url}}/{{namespace}}/places" method: POST headers: @@ -20,8 +18,7 @@ body: "district": "Midtown", "building": "Park Area", "country": "US", - "phone_number": "212-310-6600", - "phone_country_code": "+1", + "phone": "+12123106600", "type": "Park" } scripts: diff --git a/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml index d7b8283..72c5c79 100644 --- a/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml +++ b/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml @@ -1,11 +1,11 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this places request." + type: integer + description: Maximum number of places to return. - name: offset - type: string - description: "Offset value for this places request." + type: integer + description: Number of places to skip before returning results. - name: sort type: string - description: "Sort value for this places request." + description: Sort expression for the place list. diff --git a/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml index 385a213..f00e78e 100644 --- a/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml +++ b/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml @@ -2,13 +2,16 @@ $kind: params fields: - name: query type: string - description: "Query value for this places request." + description: Search term matched against place fields. - name: limit - type: string - description: "Limit value for this places request." + type: integer + description: Maximum number of places to return. - name: offset - type: string - description: "Offset value for this places request." + type: integer + description: Number of places to skip before returning results. - name: sort type: string - description: "Sort value for this places request." + description: Sort expression for the place query. + - name: vendor + type: string + description: Vendor ID used to filter places owned by a vendor. diff --git a/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml index 995ba06..8532bd4 100644 --- a/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml +++ b/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml @@ -2,10 +2,24 @@ $kind: params fields: - name: query type: string - description: "Query value for this places request." + required: true + description: Free-form search text matched against place name and address fields. - name: ll type: string - description: "Ll value for this places request." + description: Latitude/longitude context used to rank or localize search results. - name: locale type: string - description: "Locale value for this places request." + description: Locale hint used for place search. + - name: limit + type: integer + default: 10 + description: Maximum number of matching places to return. + - name: geo + type: boolean + description: When true, enables geospatial search behavior. + - name: latitude + type: number + description: Latitude context for geospatial search. + - name: longitude + type: number + description: Longitude context for geospatial search. diff --git a/postman/collections/Fleetbase API/Places/Update a Place.params.yaml b/postman/collections/Fleetbase API/Places/Update a Place.params.yaml index 087ca2d..c01c266 100644 --- a/postman/collections/Fleetbase API/Places/Update a Place.params.yaml +++ b/postman/collections/Fleetbase API/Places/Update a Place.params.yaml @@ -2,38 +2,58 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." + description: Display name for the place. - name: street1 type: string - description: "Primary street address." + description: Primary street address. + - name: street2 + type: string + description: Secondary street address. - name: city type: string - description: "City or locality for the address." + description: City or locality for the address. - name: province type: string - description: "State, province, or region for the address." + description: State, province, or region for the address. - name: postal_code type: string - description: "Postal or ZIP code for the address." + description: Postal or ZIP code for the address. - name: neighborhood type: string - description: "Neighborhood or local area for the address." + description: Neighborhood or local area for the address. - name: district type: string - description: "District or administrative subdivision for the address." + description: District or administrative subdivision for the address. - name: building type: string - description: "Building name, number, or additional address detail." - - name: country - type: string - description: "ISO country code for the address." - - name: phone_number + description: Building name, number, or additional address detail. + - name: security_access_code type: string - description: "Local phone number for the place or contact." - - name: phone_country_code + description: Access code or delivery instructions needed to enter the building. + - name: country type: string - description: "International dialing code for the phone number." + description: Country code for the address. + - name: phone + type: string + description: Phone number associated with the place. + - name: location + type: object + description: Resolvable point used as the place location. + - name: latitude + type: number + description: Decimal latitude. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude. Required with `latitude`. + - name: owner + type: string + description: Contact or vendor ID that owns the place. + - name: vendor + type: string + description: Vendor ID to assign as the place owner. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + description: Place classification. + - name: meta + type: object + description: Additional place metadata. diff --git a/postman/collections/Fleetbase API/Places/Update a Place.request.yaml b/postman/collections/Fleetbase API/Places/Update a Place.request.yaml index d961772..5702f73 100644 --- a/postman/collections/Fleetbase API/Places/Update a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Update a Place.request.yaml @@ -1,8 +1,6 @@ $kind: http-request description: |- - Updates the specified place by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the location parameter, that becomes the place's new location to be used for all spatial queries in the future. - - This request accepts mostly the same arguments as the place creation call. + Updates a place by setting the fields included in the request. Send address fields, coordinates, owner assignment, type, phone, or metadata to change only those values. url: "{{base_url}}/{{namespace}}/places/:id" method: PUT headers: @@ -24,8 +22,7 @@ body: "district": "Midtown", "building": "Park Area", "country": "US", - "phone_number": "212-310-6600", - "phone_country_code": "+1", + "phone": "+12123106600", "type": "Park" } examples: ./.resources/Update a Place.resources/examples From b967608e1c76f13b11940a0dca43d51346f754de Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:25:50 +0800 Subject: [PATCH 04/10] Add source-backed fleet resource metadata --- .../Contacts/.resources/object.yaml | 72 +++++++ .../Contacts/Create a Contact.params.yaml | 23 ++- .../Contacts/Create a Contact.request.yaml | 3 +- .../Contacts/Query Contacts.queryParams.yaml | 15 +- .../Contacts/Update a Contact.params.yaml | 25 ++- .../Contacts/Update a Contact.request.yaml | 7 +- .../Drivers/.resources/object.yaml | 120 +++++++++++ .../Drivers/Create a Driver.params.yaml | 50 ++++- .../Drivers/Create a Driver.request.yaml | 3 +- .../Drivers/Login Driver.params.yaml | 10 + .../Drivers/Query Drivers.queryParams.yaml | 20 ++ .../Drivers/Query Drivers.request.yaml | 3 +- .../Drivers/Register Device.params.yaml | 13 ++ .../Register Driver Device.params.yaml | 13 ++ .../Request Driver Login SMS.params.yaml | 6 + .../Drivers/Simulate Driver Route.params.yaml | 15 ++ .../Switch Driver Organization.params.yaml | 6 + .../Drivers/Toggle Driver Online.params.yaml | 5 + .../Drivers/Track Driver.params.yaml | 17 ++ .../Drivers/Update a Driver.params.yaml | 37 +++- .../Drivers/Update a Driver.request.yaml | 7 +- .../Verify Driver Login Code.params.yaml | 14 ++ .../Fleets/.resources/object.yaml | 60 ++++++ .../Fleets/Create a Fleet.params.yaml | 9 +- .../Fleets/Create a Fleet.request.yaml | 5 +- .../Fleets/Query Fleets.queryParams.yaml | 13 +- .../Fleets/Update a Fleet.params.yaml | 9 +- .../Fleets/Update a Fleet.request.yaml | 5 +- .../Vehicles/.resources/object.yaml | 195 ++++++++++++++++++ .../Vehicles/Create a Vehicle.params.yaml | 77 ++++++- .../Vehicles/Create a Vehicle.request.yaml | 6 +- .../Vehicles/Query Vehicles.queryParams.yaml | 15 +- .../Vehicles/Track Vehicle.params.yaml | 17 ++ .../Vehicles/Update a Vehicle.params.yaml | 82 +++++++- .../Vehicles/Update a Vehicle.request.yaml | 11 +- .../Vendors/.resources/object.yaml | 84 ++++++++ .../Vendors/Create a Vendor.params.yaml | 19 +- .../Vendors/Create a Vendor.request.yaml | 4 +- .../Vendors/Query Vendors.queryParams.yaml | 17 ++ .../Vendors/Query Vendors.request.yaml | 3 +- .../Vendors/Update a Vendor.params.yaml | 18 +- .../Vendors/Update a Vendor.request.yaml | 6 +- 42 files changed, 1029 insertions(+), 110 deletions(-) create mode 100644 postman/collections/Fleetbase API/Contacts/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Query Drivers.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Register Device.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Track Driver.params.yaml create mode 100644 postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml create mode 100644 postman/collections/Fleetbase API/Fleets/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Vehicles/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Vehicles/Track Vehicle.params.yaml create mode 100644 postman/collections/Fleetbase API/Vendors/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Vendors/Query Vendors.queryParams.yaml diff --git a/postman/collections/Fleetbase API/Contacts/.resources/object.yaml b/postman/collections/Fleetbase API/Contacts/.resources/object.yaml new file mode 100644 index 0000000..8348083 --- /dev/null +++ b/postman/collections/Fleetbase API/Contacts/.resources/object.yaml @@ -0,0 +1,72 @@ +$kind: object +name: Contact +description: |- + A contact represents a person or customer profile used by FleetOps resources. Contacts can own places, appear as customers, and carry contact details, photos, type, slug, and metadata. +example: | + { + "id": "contact_6zV1KqN9pR", + "customer_id": "customer_6zV1KqN9pR", + "internal_id": "CUST-1001", + "name": "John Doe", + "title": "Mr", + "email": "john@example.com", + "phone": "+15639204264", + "photo_url": null, + "place": null, + "places": [], + "user": null, + "type": "customer", + "meta": {}, + "slug": "john-doe", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public contact identifier. + - name: customer_id + type: string + description: Customer-form identifier returned for public customer contacts. + - name: internal_id + type: string + description: Optional internal identifier. + - name: name + type: string + description: Contact display name. + - name: title + type: string + description: Contact title. + - name: email + type: string + description: Contact email address. + - name: phone + type: string + description: Contact phone number. + - name: photo_url + type: string + description: Contact photo URL. + - name: place + type: object + description: Primary place for the contact, when loaded. + - name: places + type: array of objects + description: Places associated with the contact, when loaded. + - name: user + type: string + description: Public user ID linked to the contact, when present. + - name: type + type: string + description: Contact type. + - name: meta + type: object + description: Additional contact metadata. + - name: slug + type: string + description: URL-friendly contact slug. + - name: updated_at + type: timestamp + description: Timestamp when the contact was last updated. + - name: created_at + type: timestamp + description: Timestamp when the contact was created. diff --git a/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml b/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml index e8cee16..7871ee7 100644 --- a/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml +++ b/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml @@ -3,17 +3,26 @@ fields: - name: name type: string required: true - description: "Display name for the resource." + description: Contact display name. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + required: true + description: Contact type, such as `customer`, `technician`, or another application-defined type. - name: title type: string - description: "Optional title associated with the contact or person." + description: Optional contact title. - name: email type: string - description: "Email address for the person or customer." + description: Contact email address. - name: phone type: string - description: "Phone number for the person or customer." + description: Contact phone number. + - name: photo + type: string + description: File ID, upload reference, or resolvable file input for the contact photo. + - name: place + type: string + description: Place ID to use as the contact's primary place. + - name: meta + type: object + description: Additional contact metadata. diff --git a/postman/collections/Fleetbase API/Contacts/Create a Contact.request.yaml b/postman/collections/Fleetbase API/Contacts/Create a Contact.request.yaml index 0b98293..538b11c 100644 --- a/postman/collections/Fleetbase API/Contacts/Create a Contact.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Create a Contact.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a new Contact. +description: |- + Creates a contact for the current company. Contacts are used as customers, facilitators, personnel, or other addressable people in FleetOps workflows. url: "{{base_url}}/{{namespace}}/contacts" method: POST headers: diff --git a/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml b/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml index 3a1deea..610ad82 100644 --- a/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml +++ b/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml @@ -2,13 +2,16 @@ $kind: params fields: - name: query type: string - description: "Query value for this contacts request." + description: Search term matched against contact fields. - name: limit - type: string - description: "Limit value for this contacts request." + type: integer + description: Maximum number of contacts to return. - name: offset - type: string - description: "Offset value for this contacts request." + type: integer + description: Number of contacts to skip before returning results. - name: sort type: string - description: "Sort value for this contacts request." + description: Sort expression for the contact query. + - name: type + type: string + description: Filters contacts by contact type. diff --git a/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml b/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml index d22d77d..12606ce 100644 --- a/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml +++ b/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml @@ -2,20 +2,25 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." + description: Contact display name. + - name: type + type: string + description: Contact type. - name: title type: string - description: "Optional title associated with the contact or person." + description: Optional contact title. - name: email type: string - description: "Email address for the person or customer." + description: Contact email address. - name: phone type: string - description: "Phone number for the person or customer." - - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." - - name: slug + description: Contact phone number. + - name: photo + type: string + description: File ID, upload reference, or resolvable file input for the contact photo. + - name: place type: string - description: "URL-friendly identifier for the resource." + description: Place ID to use as the contact's primary place. + - name: meta + type: object + description: Additional contact metadata. diff --git a/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml b/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml index b77a73a..a33c7f6 100644 --- a/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Update a Contact.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update a Contact +description: |- + Updates a contact's profile, type, primary place, photo, or metadata. url: "{{base_url}}/{{namespace}}/contacts/:id" method: PUT headers: @@ -17,7 +18,9 @@ body: "email": "john@exampleco.com", "phone": "563-920-4264", "type": "technician", - "slug": "john-doe" + "meta": { + "external_ref": "john-doe" + } } examples: ./.resources/Update a Contact.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/object.yaml b/postman/collections/Fleetbase API/Drivers/.resources/object.yaml new file mode 100644 index 0000000..02c0ab0 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/object.yaml @@ -0,0 +1,120 @@ +$kind: object +name: Driver +description: |- + A driver represents a FleetOps operator who can receive jobs, report location, register devices, and belong to fleets, vendors, vehicles, and organizations. +example: | + { + "id": "driver_A1b2C3d4E5", + "user": "user_1A2b3C4d5E", + "internal_id": "DRV-1001", + "company": "company_6zV1KqN9pR", + "company_name": "Fleetbase", + "name": "Alex Driver", + "email": "alex.driver@example.com", + "phone": "+15555550111", + "drivers_license_number": null, + "photo_url": null, + "avatar_url": null, + "vehicle_avatar": null, + "location": { + "latitude": 1.3521, + "longitude": 103.8198 + }, + "heading": 0, + "altitude": 0, + "speed": 0, + "country": "SG", + "currency": "SGD", + "city": "Singapore", + "online": false, + "status": "active", + "token": null, + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public driver identifier. + - name: user + type: string + description: Public user ID linked to the driver. + - name: internal_id + type: string + description: Optional internal identifier. + - name: company + type: string + description: Public company ID for the driver's current company. + - name: company_name + type: string + description: Name of the driver's current company. + - name: name + type: string + description: Driver display name. + - name: email + type: string + description: Driver email address. + - name: phone + type: string + description: Driver phone number. + - name: drivers_license_number + type: string + description: Driver license number. + - name: photo_url + type: string + description: Driver photo URL. + - name: avatar_url + type: string + description: Driver avatar URL. + - name: vehicle + type: object + description: Assigned vehicle, when loaded. + - name: current_job + type: object + description: Current order, when loaded. + - name: vendor + type: object + description: Assigned vendor, when loaded. + - name: fleets + type: array of objects + description: Fleets the driver belongs to, when loaded. + - name: location + type: object + description: Current driver coordinates. + - name: heading + type: integer + description: Current heading in degrees. + - name: altitude + type: integer + description: Current altitude. + - name: speed + type: integer + description: Current speed. + - name: country + type: string + description: Current country code. + - name: currency + type: currency + description: Currency inferred from the driver's country. + - name: city + type: string + description: Current city. + - name: online + type: boolean + description: Whether the driver is online. + - name: status + type: string + description: Driver lifecycle status. + - name: token + type: string + description: Authentication token returned by driver login endpoints. + - name: meta + type: object + description: Additional driver metadata. + - name: updated_at + type: timestamp + description: Timestamp when the driver was last updated. + - name: created_at + type: timestamp + description: Timestamp when the driver was created. diff --git a/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml index 5159ab3..221e5f3 100644 --- a/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml +++ b/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml @@ -3,14 +3,52 @@ fields: - name: name type: string required: true - description: "Display name for the resource." - - name: description + description: Driver display name. + - name: email type: string - description: "Human-readable description of the resource." + required: true + description: Driver email address. Must be unique when creating a driver. + - name: phone + type: string + required: true + description: Driver phone number. Must be unique when creating a driver. + - name: password + type: string + description: Optional password for the driver user account. + - name: timezone + type: string + description: Timezone for the driver user account. + - name: country + type: string + description: Two-letter country code. + - name: city + type: string + description: Driver city. + - name: vehicle + type: string + description: Vehicle ID to assign to the driver. + - name: vendor + type: string + description: Vendor ID to assign to the driver. + - name: job + type: string + description: Current order ID to assign to the driver. - name: status type: enum values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + description: Driver lifecycle status. + - name: photo type: string - description: "Arbitrary metadata stored with the resource." + description: File ID, upload reference, or resolvable file input for the driver photo. + - name: location + type: object + description: Resolvable point used as the driver's current location. + - name: latitude + type: number + description: Decimal latitude. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude. Required with `latitude`. + - name: meta + type: object + description: Additional driver metadata. diff --git a/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml b/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml index 434089f..d4ce836 100644 --- a/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Create a Driver.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a driver +description: |- + Creates a driver profile and linked user account. Provide a unique email and phone number, then optionally assign a vehicle, vendor, current job, location, or photo. url: "{{base_url}}/{{namespace}}/drivers" method: POST headers: diff --git a/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml new file mode 100644 index 0000000..e16ea20 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Login Driver.params.yaml @@ -0,0 +1,10 @@ +$kind: params +fields: + - name: identity + type: string + required: true + description: Driver email address or phone number. + - name: password + type: string + required: true + description: Driver account password. diff --git a/postman/collections/Fleetbase API/Drivers/Query Drivers.queryParams.yaml b/postman/collections/Fleetbase API/Drivers/Query Drivers.queryParams.yaml new file mode 100644 index 0000000..6f5bb4e --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Query Drivers.queryParams.yaml @@ -0,0 +1,20 @@ +$kind: params +fields: + - name: id + type: string + description: Driver ID filter used by this request example. + - name: query + type: string + description: Search term matched against driver fields. + - name: limit + type: integer + description: Maximum number of drivers to return. + - name: offset + type: integer + description: Number of drivers to skip before returning results. + - name: sort + type: string + description: Sort expression for the driver query. + - name: vendor + type: string + description: Vendor ID used to filter drivers assigned to a vendor. diff --git a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml index e2e9da3..92b9056 100644 --- a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a driver object to view it's details. +description: |- + Returns drivers for the current company. Use filters such as `vendor`, search, pagination, or sort parameters to narrow the result set. url: "{{base_url}}/{{namespace}}/drivers" method: GET headers: diff --git a/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml b/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml new file mode 100644 index 0000000..b3dc2b1 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml @@ -0,0 +1,13 @@ +$kind: params +fields: + - name: token + type: string + required: true + description: Device push token to register. + - name: platform + type: string + required: true + description: Device platform. May also be supplied as `os`. + - name: os + type: string + description: Alias for `platform`. diff --git a/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml b/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml new file mode 100644 index 0000000..74bd7c5 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml @@ -0,0 +1,13 @@ +$kind: params +fields: + - name: token + type: string + required: true + description: Device push token to register for the driver. + - name: platform + type: string + required: true + description: Device platform. May also be supplied as `os`. + - name: os + type: string + description: Alias for `platform`. diff --git a/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml new file mode 100644 index 0000000..a3aa2f1 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: phone + type: string + required: true + description: Driver phone number to send the verification code to. diff --git a/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml new file mode 100644 index 0000000..1ad2099 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml @@ -0,0 +1,15 @@ +$kind: params +fields: + - name: start + type: object + description: Starting point for the simulated drive. Required when `order` is not supplied. + - name: end + type: object + description: Ending point for the simulated drive. Required when `order` is not supplied. + - name: order + type: string + description: Order ID to simulate. Required when the action is `order`. + - name: action + type: string + default: drive + description: Simulation action. Defaults to `drive`. diff --git a/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml new file mode 100644 index 0000000..73895b3 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: next + type: string + required: true + description: Organization ID to switch the driver session to. diff --git a/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml b/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml new file mode 100644 index 0000000..c516803 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: online + type: boolean + description: Online status to set. When omitted, Fleetbase toggles the driver's current online status. diff --git a/postman/collections/Fleetbase API/Drivers/Track Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Track Driver.params.yaml new file mode 100644 index 0000000..24f7913 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Track Driver.params.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: latitude + type: number + description: Driver latitude. When omitted with `longitude`, Fleetbase returns the current driver resource without updating location. + - name: longitude + type: number + description: Driver longitude. When omitted with `latitude`, Fleetbase returns the current driver resource without updating location. + - name: altitude + type: number + description: Current altitude. + - name: heading + type: number + description: Current heading in degrees. + - name: speed + type: number + description: Current speed. diff --git a/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml index 2ef5153..35d8ebf 100644 --- a/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml +++ b/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml @@ -2,10 +2,41 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." + description: Driver display name. - name: email type: string - description: "Email address for the person or customer." + description: Driver email address. - name: phone type: string - description: "Phone number for the person or customer." + description: Driver phone number. + - name: password + type: string + description: Optional password for the driver user account. + - name: vehicle + type: string + description: Vehicle ID to assign to the driver. + - name: vendor + type: string + description: Vendor ID to assign to the driver. + - name: job + type: string + description: Current order ID to assign to the driver. + - name: status + type: enum + values: ["active", "inactive"] + description: Driver lifecycle status. + - name: photo + type: string + description: File ID, upload reference, or resolvable file input for the driver photo. + - name: location + type: object + description: Resolvable point used as the driver's current location. + - name: latitude + type: number + description: Decimal latitude. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude. Required with `latitude`. + - name: meta + type: object + description: Additional driver metadata. diff --git a/postman/collections/Fleetbase API/Drivers/Update a Driver.request.yaml b/postman/collections/Fleetbase API/Drivers/Update a Driver.request.yaml index eb05e3c..8fe6a01 100644 --- a/postman/collections/Fleetbase API/Drivers/Update a Driver.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Update a Driver.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: You can update all properties of the Driver. +description: |- + Updates a driver's account fields, assignment, status, location, photo, or metadata. url: "{{base_url}}/{{namespace}}/drivers/:id" method: PUT headers: @@ -13,8 +14,8 @@ body: content: | { "name": "John Doe", - "email": {{$randomEmail}}, - "phone": {{$randomPhoneNumber}} + "email": "{{$randomEmail}}", + "phone": "{{$randomPhoneNumber}}" } examples: ./.resources/Update a Driver.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml new file mode 100644 index 0000000..f869557 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: identity + type: string + required: true + description: Driver email address or phone number used for verification. + - name: code + type: string + required: true + description: Verification code sent to the driver. + - name: for + type: string + default: driver_login + description: Verification purpose. Defaults to `driver_login`. diff --git a/postman/collections/Fleetbase API/Fleets/.resources/object.yaml b/postman/collections/Fleetbase API/Fleets/.resources/object.yaml new file mode 100644 index 0000000..94e425d --- /dev/null +++ b/postman/collections/Fleetbase API/Fleets/.resources/object.yaml @@ -0,0 +1,60 @@ +$kind: object +name: Fleet +description: |- + A fleet groups drivers and vehicles for operational assignment. Fleets can be linked to service areas, zones, vendors, parent fleets, subfleets, drivers, and vehicles. +example: | + { + "id": "fleet_4Mnp8Qx2Vz", + "name": "Haulers", + "task": null, + "status": "active", + "service_area": null, + "zone": null, + "vendor": null, + "parent_fleet": null, + "subfleets": [], + "drivers": [], + "vehicles": [], + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public fleet identifier. + - name: name + type: string + description: Fleet display name. + - name: task + type: string + description: Task associated with the fleet. + - name: status + type: string + description: Fleet status. + - name: service_area + type: object + description: Service area assigned to the fleet, when loaded. + - name: zone + type: object + description: Zone assigned to the fleet, when loaded. + - name: vendor + type: object + description: Vendor assigned to the fleet, when loaded. + - name: parent_fleet + type: object + description: Parent fleet, when loaded. + - name: subfleets + type: array of objects + description: Child fleets, when loaded. + - name: drivers + type: array of objects + description: Drivers assigned to the fleet, when loaded. + - name: vehicles + type: array of objects + description: Vehicles assigned to the fleet, when loaded. + - name: updated_at + type: timestamp + description: Timestamp when the fleet was last updated. + - name: created_at + type: timestamp + description: Timestamp when the fleet was created. diff --git a/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml b/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml index cb75256..c6ec555 100644 --- a/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml +++ b/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml @@ -3,8 +3,7 @@ fields: - name: name type: string required: true - description: "Display name for the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + description: Fleet display name. + - name: service_area + type: string + description: Service area ID to assign to the fleet. diff --git a/postman/collections/Fleetbase API/Fleets/Create a Fleet.request.yaml b/postman/collections/Fleetbase API/Fleets/Create a Fleet.request.yaml index eeb95be..a681a29 100644 --- a/postman/collections/Fleetbase API/Fleets/Create a Fleet.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Create a Fleet.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a new fleet. +description: |- + Creates a fleet for grouping drivers and vehicles. Assign a service area when the fleet should be constrained to a specific operating area. url: "{{base_url}}/{{namespace}}/fleets" method: POST headers: @@ -9,7 +10,7 @@ body: content: |- { "name": "Haulers", - "status": "active" + "service_area": "{{service_area_id}}" } scripts: - type: afterResponse diff --git a/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml b/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml index 45461ca..4228a3c 100644 --- a/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml +++ b/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml @@ -1,11 +1,14 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this fleets request." + type: integer + description: Maximum number of fleets to return. - name: offset - type: string - description: "Offset value for this fleets request." + type: integer + description: Number of fleets to skip before returning results. - name: sort type: string - description: "Sort value for this fleets request." + description: Sort expression for the fleet query. + - name: with + type: array of strings + description: Relationships to include in fleet responses. diff --git a/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml b/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml index ecc1a5d..048a104 100644 --- a/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml +++ b/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml @@ -2,8 +2,7 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + description: Fleet display name. + - name: service_area + type: string + description: Service area ID to assign to the fleet. diff --git a/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml b/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml index 0fa052f..d0240b3 100644 --- a/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Update a Fleet.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Updates a fleet. +description: |- + Updates a fleet's name or assigned service area. url: "{{base_url}}/{{namespace}}/fleets/:id" method: PUT headers: @@ -11,7 +12,7 @@ body: content: |- { "name": "Haulers", - "status": "active" + "service_area": "{{service_area_id}}" } examples: ./.resources/Update a Fleet.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml b/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml new file mode 100644 index 0000000..f449526 --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml @@ -0,0 +1,195 @@ +$kind: object +name: Vehicle +description: |- + A vehicle represents a trackable asset used for FleetOps assignment, routing, and capacity planning. It stores vehicle identity, status, assignment, current position, capacity, orchestrator constraints, and metadata. +example: | + { + "id": "vehicle_7YqM3KpL2n", + "internal_id": "VEH-1001", + "photo_url": null, + "avatar_url": null, + "name": "ABC123", + "description": null, + "driver": null, + "make": "Toyota", + "model": "Camry", + "year": 2023, + "trim": "SE", + "type": "sedan", + "plate_number": "ABC123", + "vin": "1GCGSBEA0G1111111", + "status": "operational", + "online": false, + "payload_capacity": 500, + "location": { + "latitude": 40.7484, + "longitude": -73.9857 + }, + "heading": 0, + "altitude": 0, + "speed": 0, + "notes": null, + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public vehicle identifier. + - name: internal_id + type: string + description: Optional internal identifier. + - name: photo_url + type: string + description: Vehicle photo URL. + - name: avatar_url + type: string + description: Vehicle avatar URL. + - name: name + type: string + description: Vehicle display name. + - name: description + type: string + description: Vehicle description. + - name: driver + type: object + description: Assigned driver, when loaded. + - name: devices + type: array of objects + description: Vehicle devices, when loaded. + - name: make + type: string + description: Vehicle manufacturer. + - name: model + type: string + description: Vehicle model. + - name: model_type + type: string + description: Vehicle model type. + - name: year + type: integer + description: Model year. + - name: trim + type: string + description: Vehicle trim. + - name: type + type: string + description: Vehicle type. + - name: class + type: string + description: Vehicle class. + - name: color + type: string + description: Vehicle color. + - name: serial_number + type: string + description: Vehicle serial number. + - name: plate_number + type: string + description: License plate number. + - name: call_sign + type: string + description: Vehicle call sign. + - name: vin + type: string + description: Vehicle identification number. + - name: vin_data + type: object + description: Decoded VIN data. + - name: specs + type: object + description: Vehicle specification data. + - name: details + type: object + description: Additional vehicle detail data. + - name: status + type: string + description: Vehicle operational status. + - name: online + type: boolean + description: Whether the vehicle is online. + - name: slug + type: string + description: URL-friendly vehicle slug. + - name: financing_status + type: string + description: Vehicle financing status. + - name: measurement_system + type: string + description: Measurement system used for vehicle metrics. + - name: odometer + type: number + description: Current odometer reading. + - name: odometer_unit + type: string + description: Unit for odometer readings. + - name: fuel_type + type: string + description: Vehicle fuel type. + - name: payload_capacity + type: number + description: Payload capacity. + - name: towing_capacity + type: number + description: Towing capacity. + - name: seating_capacity + type: integer + description: Seating capacity. + - name: weight + type: number + description: Vehicle weight. + - name: length + type: number + description: Vehicle length. + - name: width + type: number + description: Vehicle width. + - name: height + type: number + description: Vehicle height. + - name: currency + type: currency + description: Currency for vehicle financial fields. + - name: acquisition_cost + type: currency + description: Acquisition cost. + - name: current_value + type: currency + description: Current vehicle value. + - name: purchased_at + type: timestamp + description: Purchase timestamp. + - name: lease_expires_at + type: timestamp + description: Lease expiration timestamp. + - name: deleted_at + type: timestamp + description: Deletion timestamp when soft deleted. + - name: updated_at + type: timestamp + description: Timestamp when the vehicle was last updated. + - name: created_at + type: timestamp + description: Timestamp when the vehicle was created. + - name: location + type: object + description: Current vehicle coordinates. + - name: heading + type: integer + description: Current heading in degrees. + - name: altitude + type: integer + description: Current altitude. + - name: speed + type: integer + description: Current speed. + - name: telematics + type: object + description: Telematics payload. + - name: notes + type: string + description: Vehicle notes. + - name: meta + type: object + description: Additional vehicle metadata. diff --git a/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml index c493a5e..7e34866 100644 --- a/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml @@ -2,23 +2,84 @@ $kind: params fields: - name: vin type: string - description: "Vehicle identification number." + description: Vehicle identification number. - name: year type: integer - description: "Model year of the vehicle." + description: Model year of the vehicle. - name: make type: string - description: "Vehicle manufacturer." + description: Vehicle manufacturer. - name: model type: string - description: "Vehicle model." + description: Vehicle model. - name: trim type: string - description: "Vehicle trim or variant." + description: Vehicle trim or variant. + - name: type + type: string + description: Vehicle type. - name: plate_number type: string - description: "Vehicle license plate number." + description: Vehicle license plate number. - name: status type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + values: ["operational", "maintenance", "decommissioned"] + description: Vehicle operational status. + - name: vendor + type: string + description: Vendor ID to assign to the vehicle. + - name: driver + type: string + description: Driver ID to assign this vehicle to after creation. + - name: online + type: boolean + default: false + description: Whether the vehicle is online. + - name: location + type: object + description: Resolvable point used as the vehicle's current location. + - name: latitude + type: number + description: Decimal latitude. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude. Required with `latitude`. + - name: altitude + type: number + description: Current altitude. + - name: heading + type: number + description: Current heading in degrees. + - name: speed + type: number + description: Current speed. + - name: payload_capacity + type: number + description: Payload capacity value used by orchestrator assignment. + - name: payload_capacity_volume + type: number + description: Payload volume capacity. + - name: payload_capacity_pallets + type: integer + description: Pallet capacity. + - name: payload_capacity_parcels + type: integer + description: Parcel capacity. + - name: skills + type: array of strings + description: Skills supported by the vehicle for orchestrator assignment. + - name: max_tasks + type: integer + description: Maximum concurrent tasks for orchestrator assignment. + - name: time_window_start + type: timestamp + description: Earliest time the vehicle is available. + - name: time_window_end + type: timestamp + description: Latest time the vehicle is available. + - name: return_to_depot + type: boolean + description: Whether the vehicle should return to depot after assigned work. + - name: meta + type: object + description: Additional vehicle metadata. diff --git a/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.request.yaml b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.request.yaml index 09b5a0d..b469db4 100644 --- a/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: In order to create a vehicle you must provide the VIN number, Fleetbase will automatically decode the VIN and pull the information on the vehicle. +description: |- + Creates a vehicle for the current company. Send VIN, make/model fields, assignment fields, status, location, capacity, or orchestrator constraints as needed. url: "{{base_url}}/{{namespace}}/vehicles" method: POST headers: @@ -14,7 +15,8 @@ body: "model": "Camry", "trim": "SE", "plate_number": "ABC123", - "status": "maintenance" + "status": "maintenance", + "online": false } scripts: - type: afterResponse diff --git a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml index efc7f31..9d85844 100644 --- a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml @@ -2,13 +2,16 @@ $kind: params fields: - name: query type: string - description: "Query value for this vehicles request." + description: Search term matched against vehicle fields. - name: limit - type: string - description: "Limit value for this vehicles request." + type: integer + description: Maximum number of vehicles to return. - name: offset - type: string - description: "Offset value for this vehicles request." + type: integer + description: Number of vehicles to skip before returning results. - name: sort type: string - description: "Sort value for this vehicles request." + description: Sort expression for the vehicle query. + - name: vendor + type: string + description: Vendor ID used to filter vehicles assigned to a vendor. diff --git a/postman/collections/Fleetbase API/Vehicles/Track Vehicle.params.yaml b/postman/collections/Fleetbase API/Vehicles/Track Vehicle.params.yaml new file mode 100644 index 0000000..402380c --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/Track Vehicle.params.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: latitude + type: number + description: Vehicle latitude. When omitted with `longitude`, Fleetbase returns the current vehicle resource without updating location. + - name: longitude + type: number + description: Vehicle longitude. When omitted with `latitude`, Fleetbase returns the current vehicle resource without updating location. + - name: altitude + type: number + description: Current altitude. + - name: heading + type: number + description: Current heading in degrees. + - name: speed + type: number + description: Current speed. diff --git a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml index b539059..e202788 100644 --- a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml @@ -1,14 +1,82 @@ $kind: params fields: - - name: speed + - name: vin + type: string + description: Vehicle identification number. Updating the VIN refreshes decoded VIN data. + - name: year type: integer - description: "Current speed for the tracked subject." - - name: bearing - type: number - description: "Current heading or bearing in degrees." + description: Model year of the vehicle. + - name: make + type: string + description: Vehicle manufacturer. + - name: model + type: string + description: Vehicle model. + - name: trim + type: string + description: Vehicle trim or variant. + - name: type + type: string + description: Vehicle type. + - name: plate_number + type: string + description: Vehicle license plate number. + - name: status + type: enum + values: ["operational", "maintenance", "decommissioned"] + description: Vehicle operational status. + - name: vendor + type: string + description: Vendor ID to assign to the vehicle. + - name: online + type: boolean + default: false + description: Whether the vehicle is online. + - name: location + type: object + description: Resolvable point used as the vehicle's current location. - name: latitude type: number - description: "Decimal latitude coordinate." + description: Decimal latitude. Required with `longitude`. - name: longitude type: number - description: "Decimal longitude coordinate." + description: Decimal longitude. Required with `latitude`. + - name: altitude + type: number + description: Current altitude. + - name: heading + type: number + description: Current heading in degrees. + - name: speed + type: number + description: Current speed. + - name: payload_capacity + type: number + description: Payload capacity value used by orchestrator assignment. + - name: payload_capacity_volume + type: number + description: Payload volume capacity. + - name: payload_capacity_pallets + type: integer + description: Pallet capacity. + - name: payload_capacity_parcels + type: integer + description: Parcel capacity. + - name: skills + type: array of strings + description: Skills supported by the vehicle for orchestrator assignment. + - name: max_tasks + type: integer + description: Maximum concurrent tasks for orchestrator assignment. + - name: time_window_start + type: timestamp + description: Earliest time the vehicle is available. + - name: time_window_end + type: timestamp + description: Latest time the vehicle is available. + - name: return_to_depot + type: boolean + description: Whether the vehicle should return to depot after assigned work. + - name: meta + type: object + description: Additional vehicle metadata. diff --git a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml index beaf351..750106a 100644 --- a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.request.yaml @@ -1,8 +1,6 @@ $kind: http-request description: |- - You can update the driver assigned, plate number, and status of the `Vehicle`. - - Vehicle's can only be assigned to one driver at a time, if a vehicle is re-assigned to another driver then the last driver will no longer be assigned to the vehicle. + Updates a vehicle's identity, operational status, vendor assignment, location, capacity, or orchestrator constraints. Updating the VIN refreshes decoded VIN data. url: "{{base_url}}/{{namespace}}/vehicles/:id" method: PUT headers: @@ -15,10 +13,11 @@ body: type: json content: | { - "speed": 90, - "bearing": 22.5, + "plate_number": "ABC123", + "status": "operational", "latitude": 40.7484, - "longitude": -73.9857 + "longitude": -73.9857, + "speed": 90 } examples: ./.resources/Update a Vehicle.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Vendors/.resources/object.yaml b/postman/collections/Fleetbase API/Vendors/.resources/object.yaml new file mode 100644 index 0000000..8862113 --- /dev/null +++ b/postman/collections/Fleetbase API/Vendors/.resources/object.yaml @@ -0,0 +1,84 @@ +$kind: object +name: Vendor +description: |- + A vendor represents a third-party company or provider that can be assigned to FleetOps resources and facilitator workflows. +example: | + { + "id": "vendor_8Qw2YxM3Nf", + "internal_id": "VEND-1001", + "business_id": null, + "name": "ABC Corporation", + "email": "abc@example.com", + "phone": "1234567890", + "logo_url": null, + "photo_url": null, + "place": null, + "places": [], + "personnels": [], + "country": null, + "type": "Supplier", + "meta": {}, + "status": "active", + "slug": "abc-corporation", + "website_url": null, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public vendor identifier. + - name: internal_id + type: string + description: Optional internal identifier. + - name: business_id + type: string + description: Business identifier associated with the vendor. + - name: name + type: string + description: Vendor display name. + - name: email + type: string + description: Vendor email address. + - name: phone + type: string + description: Vendor phone number. + - name: logo_url + type: string + description: Vendor logo URL. + - name: photo_url + type: string + description: Vendor photo URL. + - name: place + type: object + description: Primary vendor place, when loaded. + - name: places + type: array of objects + description: Places associated with the vendor, when loaded. + - name: personnels + type: array of objects + description: Personnel contacts associated with the vendor, when loaded. + - name: country + type: string + description: Vendor country code. + - name: type + type: string + description: Vendor type. + - name: meta + type: object + description: Additional vendor metadata. + - name: status + type: string + description: Vendor lifecycle status. + - name: slug + type: string + description: URL-friendly vendor slug. + - name: website_url + type: string + description: Vendor website URL. + - name: updated_at + type: timestamp + description: Timestamp when the vendor was last updated. + - name: created_at + type: timestamp + description: Timestamp when the vendor was created. diff --git a/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml b/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml index 6e66ba6..007d806 100644 --- a/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml +++ b/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml @@ -3,17 +3,20 @@ fields: - name: name type: string required: true - description: "Display name for the resource." + description: Vendor display name. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." - - name: internal_id type: string - description: "External or internal identifier supplied by your system." + required: true + description: Vendor type. - name: email type: string - description: "Email address for the person or customer." + description: Vendor email address. - name: phone type: string - description: "Phone number for the person or customer." + description: Vendor phone number. + - name: address + type: string + description: Place ID to use as the vendor's primary address. + - name: meta + type: object + description: Additional vendor metadata. diff --git a/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml b/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml index 90f0e89..06a4404 100644 --- a/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Create a Vendor.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a vendor +description: |- + Creates a vendor for the current company. Vendors can be assigned to orders, vehicles, drivers, places, and facilitator workflows. url: "{{base_url}}/{{namespace}}/vendors" method: POST headers: @@ -10,7 +11,6 @@ body: { "name": "ABC Corporation", "type": "Supplier", - "internal_id": "ABC123", "email": "abc@example.com", "phone": "1234567890" } diff --git a/postman/collections/Fleetbase API/Vendors/Query Vendors.queryParams.yaml b/postman/collections/Fleetbase API/Vendors/Query Vendors.queryParams.yaml new file mode 100644 index 0000000..3cc6856 --- /dev/null +++ b/postman/collections/Fleetbase API/Vendors/Query Vendors.queryParams.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: id + type: string + description: Vendor ID filter used by this request example. + - name: query + type: string + description: Search term matched against vendor fields. + - name: limit + type: integer + description: Maximum number of vendors to return. + - name: offset + type: integer + description: Number of vendors to skip before returning results. + - name: sort + type: string + description: Sort expression for the vendor query. diff --git a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml index 823c1bb..22ae66f 100644 --- a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a vendor object to view it's details. +description: |- + Returns vendors for the current company. Use search, pagination, and sort parameters to narrow the result set. url: "{{base_url}}/{{namespace}}/vendors" method: GET headers: diff --git a/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml b/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml index b15a3c9..e5f55b7 100644 --- a/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml +++ b/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml @@ -2,17 +2,19 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." + description: Vendor display name. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." - - name: internal_id type: string - description: "External or internal identifier supplied by your system." + description: Vendor type. - name: email type: string - description: "Email address for the person or customer." + description: Vendor email address. - name: phone type: string - description: "Phone number for the person or customer." + description: Vendor phone number. + - name: address + type: string + description: Place ID to use as the vendor's primary address. + - name: meta + type: object + description: Additional vendor metadata. diff --git a/postman/collections/Fleetbase API/Vendors/Update a Vendor.request.yaml b/postman/collections/Fleetbase API/Vendors/Update a Vendor.request.yaml index 03f458c..12a3451 100644 --- a/postman/collections/Fleetbase API/Vendors/Update a Vendor.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Update a Vendor.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: You can update all properties of the Vendor. +description: |- + Updates a vendor's profile, primary address, type, contact fields, or metadata. url: "{{base_url}}/{{namespace}}/vendors/:id" method: PUT headers: @@ -7,14 +8,13 @@ headers: pathVariables: - key: id value: "{{vendor_id}}" - description: (Required) The id of the vendor you want to delete. + description: (Required) The id of the vendor to update. body: type: json content: |- { "name": "ABC Corporation", "type": "Supplier", - "internal_id": "ABC123", "email": "abc@example.com", "phone": "1234567890" } From dc72f4a39d6ab5284c51b0abb4c283a6485a4187 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:35:42 +0800 Subject: [PATCH 05/10] Add source-backed operational resource metadata --- .../Fuel Reports/.resources/object.yaml | 63 +++++++++++++++ .../Create a Fuel Report.params.yaml | 29 ++++--- .../Query Fuel Reports.queryParams.yaml | 16 ++-- .../Update a Fuel Report.params.yaml | 23 +++--- ...t Driver Geofence History.queryParams.yaml | 4 +- ...Get Geofence Dwell Report.queryParams.yaml | 8 +- .../List Geofence Events.queryParams.yaml | 6 +- .../Issues/.resources/object.yaml | 78 ++++++++++++++++++ .../Issues/Create an Issue.params.yaml | 27 ++++--- .../Issues/Query Issues.queryParams.yaml | 19 +++-- .../Issues/Update an Issue.params.yaml | 21 ++--- .../Labels/Render Label.queryParams.yaml | 9 +-- .../List Organizations.queryParams.yaml | 8 +- .../Purchase Rates/.resources/object.yaml | 48 +++++++++++ .../Create a Purchase Rate.params.yaml | 19 +++-- .../Query Purchase Rates.queryParams.yaml | 19 +++-- .../Service Areas/.resources/object.yaml | 44 ++++++++++ .../Create a Service Area.params.yaml | 52 +++++++++--- .../Query Service Areas.queryParams.yaml | 16 +++- .../Update a Service Area.params.yaml | 48 ++++++++++- .../Service Rates/.resources/object.yaml | 71 ++++++++++++++++ .../Create a Service Rate.params.yaml | 81 ++++++++++++++++--- .../Query Service Rates.queryParams.yaml | 21 +++-- .../Retrieve a Service Rate.request.yaml | 10 +-- .../Update a Service Rate.params.yaml | 78 +++++++++++++++--- .../Tracking Numbers/.resources/object.yaml | 56 +++++++++++++ .../Create a Tracking Number.params.yaml | 18 +++-- .../Decode Tracking Number QR.params.yaml | 6 ++ .../Delete a Tracking Number.request.yaml | 12 +-- .../Query Tracking Numbers.queryParams.yaml | 18 +++-- .../Tracking Statuses/.resources/object.yaml | 60 ++++++++++++++ .../Create a Tracking Status.params.yaml | 48 ++++++++--- .../Query Tracking Statuses.queryParams.yaml | 10 ++- .../Update a Tracking Status.params.yaml | 29 ++++++- .../Zones/.resources/object.yaml | 48 +++++++++++ .../Zones/Create a Zone.params.yaml | 47 +++++++++-- .../Zones/Query Zones.queryParams.yaml | 16 +++- .../Zones/Update a Zone.params.yaml | 46 ++++++++++- 38 files changed, 1048 insertions(+), 184 deletions(-) create mode 100644 postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Issues/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Service Areas/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Service Rates/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml create mode 100644 postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Zones/.resources/object.yaml diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml new file mode 100644 index 0000000..3aff4c6 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml @@ -0,0 +1,63 @@ +$kind: object +name: Fuel Report +description: |- + A fuel report records a driver's fuel purchase or fuel usage report with odometer, amount, volume, unit, location, vehicle, and status data. +example: | + { + "id": "fuel_report_4Mnp8Qx2Vz", + "vehicle": null, + "driver": null, + "odometer": 10042, + "amount": 6500, + "currency": "USD", + "volume": 42.5, + "metric_unit": "liters", + "type": null, + "status": "created", + "location": { "latitude": 1.3521, "longitude": 103.8198 }, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public fuel report identifier. + - name: reporter + type: object + description: User who reported the fuel purchase, when loaded. + - name: vehicle + type: object + description: Vehicle associated with the fuel report, when loaded. + - name: driver + type: object + description: Driver associated with the fuel report, when loaded. + - name: odometer + type: number + description: Odometer reading at the time of the report. + - name: amount + type: currency + description: Monetary amount for the fuel purchase. + - name: currency + type: currency + description: Three-letter currency code. + - name: volume + type: number + description: Fuel volume. + - name: metric_unit + type: string + description: Unit for the fuel volume. + - name: type + type: string + description: Fuel report type. + - name: status + type: string + description: Fuel report status. + - name: location + type: object + description: Location where fuel was reported. + - name: updated_at + type: timestamp + description: Timestamp when the fuel report was last updated. + - name: created_at + type: timestamp + description: Timestamp when the fuel report was created. diff --git a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml index 5159ab3..f2e0513 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml @@ -1,16 +1,23 @@ $kind: params fields: - - name: name + - name: driver type: string required: true - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + description: Driver ID reporting the fuel purchase. + - name: odometer + type: number + required: true + description: Vehicle odometer reading at the time of the report. + - name: volume + type: number + required: true + description: Fuel volume purchased or reported. + - name: metric_unit type: string - description: "Arbitrary metadata stored with the resource." + description: Unit used for the fuel volume. + - name: location + type: object + description: Location where the fuel was purchased or reported. + - name: amount + type: currency + description: Monetary amount for the fuel purchase. diff --git a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml index 56abbf5..5dfe74d 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml @@ -1,11 +1,17 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this fuel reports request." + type: integer + description: Maximum number of fuel reports to return. - name: offset - type: string - description: "Offset value for this fuel reports request." + type: integer + description: Number of fuel reports to skip before returning results. - name: sort type: string - description: "Sort value for this fuel reports request." + description: Sort expression for the fuel report query. + - name: driver + type: string + description: Filters fuel reports by driver ID. + - name: vehicle + type: string + description: Filters fuel reports by vehicle ID. diff --git a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml index 3f58da6..889a1cf 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml @@ -1,21 +1,20 @@ $kind: params fields: + - name: driver + type: string + description: Driver ID reporting the fuel purchase. - name: odometer - type: integer - description: "Vehicle odometer reading at the time of the report." + type: number + description: Vehicle odometer reading at the time of the report. - name: volume type: number - description: "Fuel volume purchased or reported." + description: Fuel volume purchased or reported. - name: metric_unit type: string - description: "Unit used for the fuel volume." + description: Unit used for the fuel volume. + - name: location + type: object + description: Location where the fuel was purchased or reported. - name: amount - type: number - description: "Monetary amount for the request." - - name: currency type: currency - description: "Three-letter currency code for monetary values." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + description: Monetary amount for the fuel purchase. diff --git a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml index 63df82a..3ed04bf 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml @@ -1,5 +1,5 @@ $kind: params fields: - name: per_page - type: string - description: "Per page value for this geofences request." + type: integer + description: Number of geofence history records to return per page. diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml index 91e06b7..b67af31 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml @@ -1,8 +1,8 @@ $kind: params fields: - name: from - type: string - description: "From value for this geofences request." + type: timestamp + description: Start of the dwell report time range. - name: to - type: string - description: "To value for this geofences request." + type: timestamp + description: End of the dwell report time range. diff --git a/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml index df271b1..b098b9c 100644 --- a/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml +++ b/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml @@ -1,8 +1,8 @@ $kind: params fields: - name: per_page - type: string - description: "Per page value for this geofences request." + type: integer + description: Number of geofence event records to return per page. - name: event_type type: string - description: "Event type value for this geofences request." + description: Filters geofence events by event type. diff --git a/postman/collections/Fleetbase API/Issues/.resources/object.yaml b/postman/collections/Fleetbase API/Issues/.resources/object.yaml new file mode 100644 index 0000000..a5a461b --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/object.yaml @@ -0,0 +1,78 @@ +$kind: object +name: Issue +description: |- + An issue records a driver- or vehicle-reported operational problem. It includes report text, priority, category, type, status, location, assignee, reporter, and resolution timestamps. +example: | + { + "id": "issue_8Qw2YxM3Nf", + "driver_name": "Alex Driver", + "vehicle_name": "ABC123", + "issue_id": "ISS-1001", + "title": null, + "report": "Flat tire near the pickup location.", + "priority": "high", + "meta": {}, + "type": "vehicle", + "category": "maintenance", + "tags": [], + "status": "open", + "location": { "latitude": 1.3521, "longitude": 103.8198 }, + "resolved_at": null, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public issue identifier. + - name: assignee + type: object + description: User assigned to the issue, when loaded. + - name: reporter + type: object + description: User who reported the issue, when loaded. + - name: vehicle + type: object + description: Vehicle associated with the issue, when loaded. + - name: driver + type: object + description: Driver associated with the issue, when loaded. + - name: issue_id + type: string + description: Human-friendly issue identifier. + - name: title + type: string + description: Issue title. + - name: report + type: string + description: Issue report text. + - name: priority + type: string + description: Issue priority. + - name: meta + type: object + description: Additional issue metadata. + - name: type + type: string + description: Issue type. + - name: category + type: string + description: Issue category. + - name: tags + type: array of strings + description: Tags associated with the issue. + - name: status + type: string + description: Issue status. + - name: location + type: object + description: Location where the issue was reported. + - name: resolved_at + type: timestamp + description: Timestamp when the issue was resolved. + - name: updated_at + type: timestamp + description: Timestamp when the issue was last updated. + - name: created_at + type: timestamp + description: Timestamp when the issue was created. diff --git a/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml b/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml index 5159ab3..bd366e4 100644 --- a/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml +++ b/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml @@ -1,16 +1,23 @@ $kind: params fields: - - name: name + - name: driver type: string required: true - description: "Display name for the resource." - - name: description + description: Driver ID reporting the issue. + - name: location + type: object + required: true + description: Location where the issue was reported. + - name: report + type: string + required: true + description: Issue report text submitted by the caller. + - name: category + type: string + description: Category used to classify the issue. + - name: type type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + description: Issue type. + - name: priority type: string - description: "Arbitrary metadata stored with the resource." + description: Priority level for the issue. diff --git a/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml b/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml index f23b386..4baf8dc 100644 --- a/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml +++ b/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml @@ -1,11 +1,20 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this issues request." + type: integer + description: Maximum number of issues to return. - name: offset - type: string - description: "Offset value for this issues request." + type: integer + description: Number of issues to skip before returning results. - name: sort type: string - description: "Sort value for this issues request." + description: Sort expression for the issue query. + - name: driver + type: string + description: Filters issues by driver ID. + - name: vehicle + type: string + description: Filters issues by vehicle ID. + - name: status + type: string + description: Filters issues by status. diff --git a/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml b/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml index c61839a..465f9ae 100644 --- a/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml +++ b/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml @@ -2,19 +2,14 @@ $kind: params fields: - name: report type: string - description: "Issue report text submitted by the caller." + required: true + description: Issue report text submitted by the caller. - name: category - type: enum - description: "Category used to classify the issue or resource." + type: string + description: Category used to classify the issue. - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + description: Issue type. - name: priority - type: enum - values: ["low", "medium", "high"] - description: "Priority level for the issue." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + type: string + description: Priority level for the issue. diff --git a/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml b/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml index 7bb1673..b09b949 100644 --- a/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml +++ b/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml @@ -1,10 +1,5 @@ $kind: params fields: - name: format - type: enum - values: ["stream", "base64", "url"] - description: "Format value for this labels request." - - name: type - type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + type: string + description: Output format for the rendered label. diff --git a/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml b/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml index 76890d1..f18ab7c 100644 --- a/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml +++ b/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml @@ -1,8 +1,8 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this organizations request." + type: integer + description: Maximum number of organizations to return. - name: with_driver_onboard - type: string - description: "With driver onboard value for this organizations request." + type: boolean + description: Includes organization driver-onboarding data when available. diff --git a/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml b/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml new file mode 100644 index 0000000..d6c4b24 --- /dev/null +++ b/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml @@ -0,0 +1,48 @@ +$kind: object +name: Purchase Rate +description: |- + A purchase rate records a purchased service quote and links it to an order, customer, transaction, amount, currency, and status. +example: | + { + "id": "purchase_rate_7YqM3KpL2n", + "service_quote": "service_quote_6zV1KqN9pR", + "order": "order_7YqM3KpL2n", + "customer": "contact_6zV1KqN9pR", + "transaction": null, + "amount": 2500, + "currency": "USD", + "status": "created", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public purchase rate identifier. + - name: service_quote + type: string + description: Service quote associated with the purchase. + - name: order + type: string + description: Order associated with the purchase. + - name: customer + type: string + description: Customer associated with the purchase. + - name: transaction + type: string + description: Transaction associated with the purchase. + - name: amount + type: currency + description: Purchased amount. + - name: currency + type: currency + description: Three-letter currency code. + - name: status + type: string + description: Purchase rate status. + - name: updated_at + type: timestamp + description: Timestamp when the purchase rate was last updated. + - name: created_at + type: timestamp + description: Timestamp when the purchase rate was created. diff --git a/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml b/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml index 5159ab3..0c42581 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml @@ -1,16 +1,15 @@ $kind: params fields: - - name: name + - name: service_quote type: string required: true - description: "Display name for the resource." - - name: description + description: Service quote ID to purchase. + - name: order type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + description: Existing order ID to attach the purchase rate to. When omitted, Fleetbase may create an order from the service quote. + - name: customer type: string - description: "Arbitrary metadata stored with the resource." + description: Contact or vendor ID to assign as the purchase customer. + - name: meta + type: object + description: Additional purchase rate metadata. diff --git a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml index 6111f08..37d0f6c 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml @@ -1,11 +1,20 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this purchase rates request." + type: integer + description: Maximum number of purchase rates to return. - name: offset - type: string - description: "Offset value for this purchase rates request." + type: integer + description: Number of purchase rates to skip before returning results. - name: sort type: string - description: "Sort value for this purchase rates request." + description: Sort expression for the purchase rate query. + - name: service_quote + type: string + description: Filters purchase rates by service quote ID. + - name: order + type: string + description: Filters purchase rates by order ID. + - name: customer + type: string + description: Filters purchase rates by customer ID. diff --git a/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml b/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml new file mode 100644 index 0000000..79a53ae --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml @@ -0,0 +1,44 @@ +$kind: object +name: Service Area +description: |- + A service area defines an operating region. It stores a center point, border geometry, type, status, and optional loaded zones. +example: | + { + "id": "service_area_4Mnp8Qx2Vz", + "name": "Singapore", + "type": "country", + "center": { "latitude": 1.3521, "longitude": 103.8198 }, + "border": [], + "zones": [], + "status": "active", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public service area identifier. + - name: name + type: string + description: Service area display name. + - name: type + type: string + description: Service area type. + - name: center + type: object + description: Center point for the service area. + - name: border + type: object + description: Service area border geometry. + - name: zones + type: array of objects + description: Zones loaded with the service area. + - name: status + type: string + description: Service area status. + - name: updated_at + type: timestamp + description: Timestamp when the service area was last updated. + - name: created_at + type: timestamp + description: Timestamp when the service area was created. diff --git a/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml index b115787..f97c28c 100644 --- a/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml @@ -3,24 +3,52 @@ fields: - name: name type: string required: true - description: "Display name for the resource." + description: Service area display name. + - name: country + type: string + required: true + description: Country code or country name for the service area. - name: type + type: string + description: Service area type. + - name: status type: enum - values: ["customer", "vendor", "driver"] - description: "Classification used to group or process the resource." + values: ["active", "inactive"] + description: Service area status. + - name: border + type: object + description: Service area polygon border. Required on create unless a point location or latitude/longitude is supplied. + - name: location + type: object + description: Resolvable point used to create a circular service area. - name: latitude type: number - description: "Decimal latitude coordinate." + description: Decimal latitude for a circular service area. Required with `longitude`. - name: longitude type: number - description: "Decimal longitude coordinate." + description: Decimal longitude for a circular service area. Required with `latitude`. - name: radius type: number - description: "Radius in meters when creating a circular zone." - - name: country + default: 500 + description: Radius in meters when creating a circular service area. + - name: parent type: string - description: "ISO country code for the address." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + description: Parent service area ID. + - name: color + type: string + description: Fill color used when rendering the service area. + - name: stroke_color + type: string + description: Stroke color used when rendering the service area. + - name: trigger_on_entry + type: boolean + description: Whether entering this service area should trigger geofence events. + - name: trigger_on_exit + type: boolean + description: Whether exiting this service area should trigger geofence events. + - name: dwell_threshold_minutes + type: integer + description: Minutes inside the service area before dwell behavior is triggered. + - name: speed_limit_kmh + type: integer + description: Speed limit in kilometers per hour for geofence events. diff --git a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml index 8e0ec7d..89515f9 100644 --- a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml @@ -1,5 +1,17 @@ $kind: params fields: - - name: name + - name: query type: string - description: "Display name for the resource." + description: Search term matched against service area fields. + - name: limit + type: integer + description: Maximum number of service areas to return. + - name: offset + type: integer + description: Number of service areas to skip before returning results. + - name: sort + type: string + description: Sort expression for the service area query. + - name: country + type: string + description: Filters service areas by country. diff --git a/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml b/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml index dd778cd..7c5930e 100644 --- a/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml @@ -1,6 +1,52 @@ $kind: params fields: + - name: name + type: string + description: Service area display name. + - name: country + type: string + description: Country code or country name for the service area. + - name: type + type: string + description: Service area type. - name: status type: enum values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." + description: Service area status. + - name: border + type: object + description: Service area polygon border. + - name: location + type: object + description: Resolvable point used to create a circular service area. + - name: latitude + type: number + description: Decimal latitude for a circular service area. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude for a circular service area. Required with `latitude`. + - name: radius + type: number + default: 500 + description: Radius in meters when updating a circular service area. + - name: parent + type: string + description: Parent service area ID. + - name: color + type: string + description: Fill color used when rendering the service area. + - name: stroke_color + type: string + description: Stroke color used when rendering the service area. + - name: trigger_on_entry + type: boolean + description: Whether entering this service area should trigger geofence events. + - name: trigger_on_exit + type: boolean + description: Whether exiting this service area should trigger geofence events. + - name: dwell_threshold_minutes + type: integer + description: Minutes inside the service area before dwell behavior is triggered. + - name: speed_limit_kmh + type: integer + description: Speed limit in kilometers per hour for geofence events. diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml new file mode 100644 index 0000000..bcd7098 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml @@ -0,0 +1,71 @@ +$kind: object +name: Service Rate +description: |- + A service rate defines how Fleetbase prices a service within a service area or zone. It stores the calculation method, fee tiers, algorithm, COD and peak-hour surcharges, currency, and delivery estimates. +example: | + { + "id": "service_rate_8Qw2YxM3Nf", + "order_config": "order_config_transport", + "service_area": null, + "zone": null, + "service_name": "Standard Delivery", + "service_type": "delivery", + "base_fee": 500, + "rate_calculation_method": "fixed_rate", + "rate_fees": [], + "parcel_fees": [], + "currency": "USD", + "duration_terms": "1-2 days", + "estimated_days": 2, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public service rate identifier. + - name: order_config + type: string + description: Order configuration associated with the rate. + - name: service_area + type: object + description: Service area associated with the rate. + - name: zone + type: object + description: Zone associated with the rate. + - name: service_name + type: string + description: Service rate display name. + - name: service_type + type: string + description: Service type this rate applies to. + - name: base_fee + type: currency + description: Base fee applied to the rate. + - name: rate_calculation_method + type: string + description: Method used to calculate the rate. + - name: rate_fees + type: array of objects + description: Distance or tiered fees. + - name: parcel_fees + type: array of objects + description: Parcel-based fees. + - name: algorithm + type: string + description: Computable algorithm for algorithmic rates. + - name: currency + type: currency + description: Three-letter currency code. + - name: duration_terms + type: string + description: Human-readable delivery duration terms. + - name: estimated_days + type: integer + description: Estimated service duration in days. + - name: updated_at + type: timestamp + description: Timestamp when the service rate was last updated. + - name: created_at + type: timestamp + description: Timestamp when the service rate was created. diff --git a/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml index 5159ab3..9e0acc1 100644 --- a/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml +++ b/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml @@ -1,16 +1,79 @@ $kind: params fields: - - name: name + - name: service_name type: string required: true - description: "Display name for the resource." - - name: description + description: Display name for the service rate. + - name: service_type type: string - description: "Human-readable description of the resource." - - name: status + required: true + description: Service type this rate applies to. + - name: service_area + type: string + description: Service area ID this rate applies to. + - name: zone + type: string + description: Zone ID this rate applies to. + - name: rate_calculation_method + type: enum + required: true + values: ["fixed_meter", "fixed_rate", "per_meter", "per_drop", "algo", "parcel"] + description: Method used to calculate the rate. + - name: currency + type: currency + required: true + description: Three-letter currency code. + - name: base_fee + type: currency + description: Base fee applied to the rate. + - name: per_meter_unit type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + values: ["km", "m", "ft", "yd", "mi"] + description: Distance unit for `per_meter` rates. + - name: per_meter_flat_rate_fee + type: currency + description: Flat fee per distance unit for `per_meter` rates. + - name: meter_fees + type: array of objects + description: Distance fee tiers for `fixed_meter` or `fixed_rate` methods. + - name: algorithm + type: string + description: Computable algorithm used when `rate_calculation_method` is `algo`. + - name: has_cod_fee + type: boolean + description: Whether the rate includes a cash-on-delivery fee. + - name: cod_calculation_method + type: enum + values: ["percentage", "flat"] + description: Cash-on-delivery fee calculation method. + - name: cod_flat_fee + type: currency + description: Flat cash-on-delivery fee. + - name: cod_percent + type: integer + description: Percentage cash-on-delivery fee. + - name: has_peak_hours_fee + type: boolean + description: Whether the rate includes a peak-hours fee. + - name: peak_hours_calculation_method + type: enum + values: ["percentage", "flat"] + description: Peak-hours fee calculation method. + - name: peak_hours_flat_fee + type: currency + description: Flat peak-hours fee. + - name: peak_hours_percent + type: integer + description: Percentage peak-hours fee. + - name: peak_hours_start + type: string + description: Peak-hours start time in `HH:mm` format. + - name: peak_hours_end + type: string + description: Peak-hours end time in `HH:mm` format. + - name: duration_terms type: string - description: "Arbitrary metadata stored with the resource." + description: Human-readable duration terms. + - name: estimated_days + type: integer + description: Estimated service duration in days. diff --git a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml index 60fc58d..2d47791 100644 --- a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml +++ b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml @@ -1,11 +1,20 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this service rates request." + type: integer + description: Maximum number of service rates to return. - name: offset + type: integer + description: Number of service rates to skip before returning results. + - name: sort + type: string + description: Sort expression for the service rate query. + - name: service_area + type: string + description: Filters service rates by service area ID. + - name: zone + type: string + description: Filters service rates by zone ID. + - name: service_type type: string - description: "Offset value for this service rates request." - - name: currency - type: currency - description: "Three-letter currency code for monetary values." + description: Filters service rates by service type. diff --git a/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.request.yaml b/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.request.yaml index cd59c1f..7be1168 100644 --- a/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.request.yaml +++ b/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.request.yaml @@ -1,14 +1,8 @@ $kind: http-request -description: Retrieve a Service Rate. +description: |- + Retrieves a service rate by ID. url: "{{base_url}}/{{namespace}}/service-rates/:id" method: GET pathVariables: id: "{{service_rate_id}}" -body: - type: json - content: "{\r - - \ \"id\": \"{{service_54k3175}}\"\r - - }\r\n" order: 3000 diff --git a/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml index ee36024..932c4a7 100644 --- a/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml +++ b/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml @@ -1,15 +1,75 @@ $kind: params fields: - - name: name + - name: service_name type: string - description: "Display name for the resource." - - name: description + description: Display name for the service rate. + - name: service_type type: string - description: "Human-readable description of the resource." - - name: status + description: Service type this rate applies to. + - name: service_area + type: string + description: Service area ID this rate applies to. + - name: zone + type: string + description: Zone ID this rate applies to. + - name: rate_calculation_method + type: enum + values: ["fixed_meter", "fixed_rate", "per_meter", "per_drop", "algo", "parcel"] + description: Method used to calculate the rate. + - name: currency + type: currency + description: Three-letter currency code. + - name: base_fee + type: currency + description: Base fee applied to the rate. + - name: per_meter_unit + type: enum + values: ["km", "m", "ft", "yd", "mi"] + description: Distance unit for `per_meter` rates. + - name: per_meter_flat_rate_fee + type: currency + description: Flat fee per distance unit for `per_meter` rates. + - name: meter_fees + type: array of objects + description: Distance fee tiers for `fixed_meter` or `fixed_rate` methods. + - name: algorithm + type: string + description: Computable algorithm used when `rate_calculation_method` is `algo`. + - name: has_cod_fee + type: boolean + description: Whether the rate includes a cash-on-delivery fee. + - name: cod_calculation_method + type: enum + values: ["percentage", "flat"] + description: Cash-on-delivery fee calculation method. + - name: cod_flat_fee + type: currency + description: Flat cash-on-delivery fee. + - name: cod_percent + type: integer + description: Percentage cash-on-delivery fee. + - name: has_peak_hours_fee + type: boolean + description: Whether the rate includes a peak-hours fee. + - name: peak_hours_calculation_method type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + values: ["percentage", "flat"] + description: Peak-hours fee calculation method. + - name: peak_hours_flat_fee + type: currency + description: Flat peak-hours fee. + - name: peak_hours_percent + type: integer + description: Percentage peak-hours fee. + - name: peak_hours_start + type: string + description: Peak-hours start time in `HH:mm` format. + - name: peak_hours_end + type: string + description: Peak-hours end time in `HH:mm` format. + - name: duration_terms type: string - description: "Arbitrary metadata stored with the resource." + description: Human-readable duration terms. + - name: estimated_days + type: integer + description: Estimated service duration in days. diff --git a/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml b/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml new file mode 100644 index 0000000..9253e04 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml @@ -0,0 +1,56 @@ +$kind: object +name: Tracking Number +description: |- + A tracking number links a generated tracking code to an order or entity. It exposes the current tracking status, QR and barcode assets, console tracking URL, and owner type. +example: | + { + "id": "tracking_3Nf8Qw2YxM", + "tracking_number": "FB-1001", + "subject": "order_7YqM3KpL2n", + "region": "US", + "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" + } +fields: + - name: id + type: string + description: Public tracking number identifier. + - name: tracking_number + type: string + description: Generated tracking code. + - name: subject + type: string + description: Public ID of the owning order or entity. + - name: region + type: string + description: Region used for the tracking number. + - name: status + type: string + description: Latest human-readable status. + - name: status_code + type: string + description: Latest machine-readable status code. + - name: qr_code + type: string + description: QR code asset URL or data. + - name: barcode + type: string + description: Barcode asset URL or data. + - name: url + type: string + description: Tracking URL. + - name: type + type: string + description: Owner resource type. + - name: updated_at + type: timestamp + description: Timestamp when the tracking number was last updated. + - name: created_at + type: timestamp + description: Timestamp when the tracking number was created. diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml index 5159ab3..112aa17 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml @@ -1,16 +1,18 @@ $kind: params fields: - - name: name + - name: region type: string required: true - description: "Display name for the resource." - - name: description + description: Region code used when generating the tracking number. + - name: owner type: string - description: "Human-readable description of the resource." + required: true + description: Order or entity ID that owns the tracking number. + - name: type + type: enum + values: ["city", "province", "country"] + description: Region granularity used when generating the tracking number. - name: status type: enum values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta - type: string - description: "Arbitrary metadata stored with the resource." + description: Initial tracking number status. diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml new file mode 100644 index 0000000..913ea7a --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: code + type: string + required: true + description: QR code UUID to resolve into its matching order, entity, or tracking resource. diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml index 41289ef..296f560 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.request.yaml @@ -1,19 +1,11 @@ $kind: http-request -description: | - This endpoint allows you to retrieve a tracking-number object to view it's details. +description: |- + Deletes a tracking number by ID. url: "{{base_url}}/{{namespace}}/tracking-numbers/:id" method: DELETE headers: Accept: application/json pathVariables: id: "{{tracking_number_id}}" -body: - type: json - content: |- - { - "name": "1", - "region": "US", - "owner": {{contact_id}} - } examples: ./.resources/Delete a Tracking Number.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml index 12a5ce3..a2ac607 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml @@ -2,13 +2,19 @@ $kind: params fields: - name: query type: string - description: "Query value for this tracking numbers request." + description: Search term matched against tracking number fields. - name: limit - type: string - description: "Limit value for this tracking numbers request." + type: integer + description: Maximum number of tracking numbers to return. - name: offset - type: string - description: "Offset value for this tracking numbers request." + type: integer + description: Number of tracking numbers to skip before returning results. - name: sort type: string - description: "Sort value for this tracking numbers request." + description: Sort expression for the tracking number query. + - name: owner + type: string + description: Filters tracking numbers by owner order or entity ID. + - name: status + type: string + description: Filters tracking numbers by latest status. diff --git a/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml b/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml new file mode 100644 index 0000000..5e2b33b --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml @@ -0,0 +1,60 @@ +$kind: object +name: Tracking Status +description: |- + A tracking status is a timeline event for a tracking number. It stores status text, details, a code, location, and address context. +example: | + { + "id": "tracking_status_6zV1KqN9pR", + "status": "Created", + "details": "Order was created.", + "code": "created", + "complete": false, + "tracking_number": "tracking_3Nf8Qw2YxM", + "city": "Singapore", + "province": null, + "postal_code": null, + "country": "SG", + "location": { "latitude": 1.3521, "longitude": 103.8198 }, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public tracking status identifier. + - name: status + type: string + description: Human-readable status. + - name: details + type: string + description: Status details. + - name: code + type: string + description: Machine-readable status code. + - name: complete + type: boolean + description: Whether this status marks the tracked workflow complete. + - name: tracking_number + type: object + description: Tracking number associated with the status. + - name: city + type: string + description: City where the status occurred. + - name: province + type: string + description: Province or region where the status occurred. + - name: postal_code + type: string + description: Postal code where the status occurred. + - name: country + type: string + description: Country code where the status occurred. + - name: location + type: object + description: Location where the status occurred. + - name: updated_at + type: timestamp + description: Timestamp when the tracking status was last updated. + - name: created_at + type: timestamp + description: Timestamp when the tracking status was created. diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml index 5159ab3..99eae37 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml @@ -1,16 +1,44 @@ $kind: params fields: - - name: name + - name: tracking_number type: string - required: true - description: "Display name for the resource." - - name: description + description: Tracking number ID to attach the status to. Required unless `order` is supplied. + - name: order type: string - description: "Human-readable description of the resource." + description: Order ID used to resolve the order's tracking number when `tracking_number` is not supplied. - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta type: string - description: "Arbitrary metadata stored with the resource." + required: true + description: Human-readable tracking status. + - name: code + type: string + required: true + description: Machine-readable tracking status code. + - name: details + type: string + required: true + description: Status details visible to tracking consumers. + - name: location + type: object + description: Resolvable point where the status occurred. Required unless latitude and longitude are supplied. + - name: latitude + type: number + description: Decimal latitude for the status location. + - name: longitude + type: number + description: Decimal longitude for the status location. + - name: city + type: string + description: City where the status occurred. + - name: province + type: string + description: Province or region where the status occurred. + - name: postal_code + type: string + description: Postal code where the status occurred. + - name: country + type: string + description: Two-letter country code where the status occurred. + - name: duplicate + type: boolean + description: When true, allows duplicate status text for the same order or tracking number. diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml index c818d7c..a93e3f4 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml @@ -1,8 +1,14 @@ $kind: params fields: - name: limit + type: integer + description: Maximum number of tracking statuses to return. + - name: offset + type: integer + description: Number of tracking statuses to skip before returning results. + - name: sort type: string - description: "Limit value for this tracking statuses request." + description: Sort expression for the tracking status query. - name: tracking_number type: string - description: "Tracking number ID associated with the status." + description: Filters statuses by tracking number ID. diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml index 7e0f9ba..fbcf3df 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml @@ -1,5 +1,32 @@ $kind: params fields: + - name: status + type: string + description: Human-readable tracking status. + - name: code + type: string + description: Machine-readable tracking status code. + - name: details + type: string + description: Status details visible to tracking consumers. + - name: location + type: object + description: Resolvable point where the status occurred. + - name: latitude + type: number + description: Decimal latitude for the status location. + - name: longitude + type: number + description: Decimal longitude for the status location. + - name: city + type: string + description: City where the status occurred. + - name: province + type: string + description: Province or region where the status occurred. + - name: postal_code + type: string + description: Postal code where the status occurred. - name: country type: string - description: "ISO country code for the address." + description: Two-letter country code where the status occurred. diff --git a/postman/collections/Fleetbase API/Zones/.resources/object.yaml b/postman/collections/Fleetbase API/Zones/.resources/object.yaml new file mode 100644 index 0000000..a3046ff --- /dev/null +++ b/postman/collections/Fleetbase API/Zones/.resources/object.yaml @@ -0,0 +1,48 @@ +$kind: object +name: Zone +description: |- + A zone represents a geofenced area inside a service area. It stores a center point, border geometry, display colors, geofence trigger settings, and lifecycle status. +example: | + { + "id": "zone_7YqM3KpL2n", + "name": "Downtown", + "description": "Downtown delivery zone", + "center": { "latitude": 1.3521, "longitude": 103.8198 }, + "border": [], + "color": "#1f78ff", + "stroke_color": "#0b4fc4", + "status": "active", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public zone identifier. + - name: name + type: string + description: Zone display name. + - name: description + type: string + description: Zone description. + - name: center + type: object + description: Center point for the zone. + - name: border + type: object + description: Zone border geometry. + - name: color + type: string + description: Fill color used when rendering the zone. + - name: stroke_color + type: string + description: Stroke color used when rendering the zone. + - name: status + type: string + description: Zone status. + - name: updated_at + type: timestamp + description: Timestamp when the zone was last updated. + - name: created_at + type: timestamp + description: Timestamp when the zone was created. diff --git a/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml b/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml index 5159ab3..bb8e708 100644 --- a/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml +++ b/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml @@ -3,14 +3,49 @@ fields: - name: name type: string required: true - description: "Display name for the resource." + description: Zone display name. + - name: service_area + type: string + required: true + description: Service area ID the zone belongs to. + - name: border + type: object + description: Zone polygon border. Required on create unless a point location or latitude/longitude is supplied. + - name: location + type: object + description: Resolvable point used to create a circular zone. + - name: latitude + type: number + description: Decimal latitude for a circular zone. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude for a circular zone. Required with `latitude`. + - name: radius + type: number + default: 500 + description: Radius in meters when creating a circular zone. - name: description type: string - description: "Human-readable description of the resource." + description: Zone description. + - name: color + type: string + description: Fill color used when rendering the zone. + - name: stroke_color + type: string + description: Stroke color used when rendering the zone. - name: status type: enum values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta - type: string - description: "Arbitrary metadata stored with the resource." + description: Zone status. + - name: trigger_on_entry + type: boolean + description: Whether entering this zone should trigger geofence events. + - name: trigger_on_exit + type: boolean + description: Whether exiting this zone should trigger geofence events. + - name: dwell_threshold_minutes + type: integer + description: Minutes inside the zone before dwell behavior is triggered. + - name: speed_limit_kmh + type: integer + description: Speed limit in kilometers per hour for geofence events. diff --git a/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml b/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml index 8e0ec7d..db74b72 100644 --- a/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml +++ b/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml @@ -1,5 +1,17 @@ $kind: params fields: - - name: name + - name: query type: string - description: "Display name for the resource." + description: Search term matched against zone fields. + - name: limit + type: integer + description: Maximum number of zones to return. + - name: offset + type: integer + description: Number of zones to skip before returning results. + - name: sort + type: string + description: Sort expression for the zone query. + - name: service_area + type: string + description: Filters zones by service area ID. diff --git a/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml b/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml index 88993ce..4c70423 100644 --- a/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml +++ b/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml @@ -1,5 +1,49 @@ $kind: params fields: + - name: name + type: string + description: Zone display name. + - name: service_area + type: string + description: Service area ID the zone belongs to. + - name: border + type: object + description: Zone polygon border. + - name: location + type: object + description: Resolvable point used to create a circular zone. + - name: latitude + type: number + description: Decimal latitude for a circular zone. Required with `longitude`. + - name: longitude + type: number + description: Decimal longitude for a circular zone. Required with `latitude`. + - name: radius + type: number + default: 500 + description: Radius in meters when updating a circular zone. + - name: description + type: string + description: Zone description. - name: color type: string - description: "Fill color used when rendering the zone." + description: Fill color used when rendering the zone. + - name: stroke_color + type: string + description: Stroke color used when rendering the zone. + - name: status + type: enum + values: ["active", "inactive"] + description: Zone status. + - name: trigger_on_entry + type: boolean + description: Whether entering this zone should trigger geofence events. + - name: trigger_on_exit + type: boolean + description: Whether exiting this zone should trigger geofence events. + - name: dwell_threshold_minutes + type: integer + description: Minutes inside the zone before dwell behavior is triggered. + - name: speed_limit_kmh + type: integer + description: Speed limit in kilometers per hour for geofence events. From 0c6485b82a05f4ee3a848ad708ef62c70c5e8476 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:48:10 +0800 Subject: [PATCH 06/10] Add source-backed core API metadata --- .../Chat Channels/.resources/object.yaml | 59 +++++++++++++++ .../Chat Channels/Add Participant.params.yaml | 6 ++ .../Add Participant.request.yaml | 3 +- .../Create Chat Channel.params.yaml | 15 ++-- .../Create Chat Channel.request.yaml | 3 +- .../Create Read Receipt.params.yaml | 14 +--- .../Create Read Receipt.request.yaml | 3 +- .../Delete Chat Channel.request.yaml | 3 +- .../Chat Channels/Delete Message.request.yaml | 3 +- .../List Available Participants.request.yaml | 3 +- .../Query Chat Channels.request.yaml | 3 +- .../Remove Participant.request.yaml | 3 +- .../Retrieve Chat Channel.request.yaml | 3 +- .../Chat Channels/Send Message.params.yaml | 12 ++++ .../Chat Channels/Send Message.request.yaml | 3 +- .../Update Chat Channel.params.yaml | 3 +- .../Update Chat Channel.request.yaml | 3 +- .../Comments/.resources/object.yaml | 51 +++++++++++++ .../Comments/Create Comment.params.yaml | 31 +++++--- .../Comments/Create Comment.request.yaml | 3 +- .../Comments/Delete Comment.request.yaml | 3 +- .../Comments/Query Comments.request.yaml | 3 +- .../Comments/Retrieve Comment.request.yaml | 3 +- .../Comments/Update Comment.params.yaml | 3 +- .../Comments/Update Comment.request.yaml | 3 +- .../Files/.resources/object.yaml | 52 ++++++++++++++ .../Files/Delete a File.request.yaml | 3 +- .../Files/Download File.request.yaml | 3 +- .../Files/Query Files.request.yaml | 3 +- .../Files/Retrieve a File.request.yaml | 3 +- .../Files/Update File.params.yaml | 5 +- .../Files/Update File.request.yaml | 3 +- .../Files/Upload Base64 File.params.yaml | 46 ++++++++++++ .../Files/Upload Base64 File.request.yaml | 3 +- .../Files/Upload File.params.yaml | 30 ++++++++ .../Files/Upload File.request.yaml | 3 +- .../Organizations/.resources/object.yaml | 72 +++++++++++++++++++ 37 files changed, 409 insertions(+), 59 deletions(-) create mode 100644 postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml create mode 100644 postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml create mode 100644 postman/collections/Fleetbase Core API/Comments/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Core API/Files/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml create mode 100644 postman/collections/Fleetbase Core API/Files/Upload File.params.yaml create mode 100644 postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml new file mode 100644 index 0000000..d2afa96 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml @@ -0,0 +1,59 @@ +$kind: object +name: Chat Channel +description: |- + A chat channel groups participants and messages for organization-scoped conversations. +example: | + { + "id": "chat_channel_5VUl2v4", + "created_by": "user_8xP2L1d", + "name": "Dispatch updates", + "title": "Dispatch updates", + "last_message": null, + "slug": "dispatch-updates", + "feed": [], + "participants": [], + "meta": {}, + "updated_at": "2026-05-07T09:30:00Z", + "created_at": "2026-05-07T09:30:00Z", + "deleted_at": null + } +fields: + - name: id + type: string + description: "Public identifier of the chat channel." + - name: created_by + type: string + description: "Public user ID of the user that created the channel." + - name: name + type: string + description: "Channel name." + - name: title + type: string + description: "Display title for the channel." + - name: last_message + type: object + description: "Most recent chat message for the channel, when available." + - name: unread_count + type: integer + description: "Unread message count for the current session user when session context is available." + - name: slug + type: string + description: "URL-friendly channel slug." + - name: feed + type: array of objects + description: "Messages and feed entries returned for the channel." + - name: participants + type: array of objects + description: "Chat participants in the channel." + - name: meta + type: object + description: "Arbitrary metadata stored with the channel." + - name: updated_at + type: timestamp + description: "Time the channel was last updated." + - name: created_at + type: timestamp + description: "Time the channel was created." + - name: deleted_at + type: timestamp + description: "Time the channel was deleted, when soft deleted." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml new file mode 100644 index 0000000..9f23d61 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: user + type: string + required: true + description: "Public ID of the user to add to the chat channel." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml index 837fa51..b9d62fd 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Add Participant" +description: |- + Adds a user in the current organization to an existing chat channel. The response returns the created chat participant resource. url: "{{base_url}}/{{namespace}}/chat-channels/:id/add-participant" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml index 5159ab3..884ed40 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml @@ -3,14 +3,7 @@ fields: - name: name type: string required: true - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta - type: string - description: "Arbitrary metadata stored with the resource." + description: "Name of the chat channel." + - name: participants + type: array of strings + description: "Public user IDs to add as participants after the channel is created." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml index 5d75a1f..1f238a1 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Create Chat Channel" +description: |- + Creates a chat channel for the current organization. Include participant user IDs to add those users to the channel immediately after it is created. url: "{{base_url}}/{{namespace}}/chat-channels" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml index 5159ab3..cb2751e 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml @@ -1,16 +1,6 @@ $kind: params fields: - - name: name + - name: participant type: string required: true - description: "Display name for the resource." - - name: description - type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta - type: string - description: "Arbitrary metadata stored with the resource." + description: "Public ID of the chat participant that read the message." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml index 7d96366..8a5d35d 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Create Read Receipt" +description: |- + Marks a chat message as read for a participant. If a receipt already exists for the message and participant, Fleetbase returns the existing receipt. url: "{{base_url}}/{{namespace}}/chat-channels/read-message/:chatMessageId" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml index 857cdb4..c343c7c 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Delete Chat Channel" +description: |- + Deletes a chat channel by ID. The response returns a deleted-resource envelope for the removed channel. url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml index 5b59a87..e5f8f80 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Delete Message" +description: |- + Deletes a chat message by ID. Use this when a previously sent message should be removed from the channel feed. url: "{{base_url}}/{{namespace}}/chat-channels/delete-message/:chatMessageId" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml index 3dbfe0c..9296f2b 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "List Available Participants" +description: |- + Lists users in the current organization that can be added to a chat channel. When a channel ID is provided, users already participating in that channel are excluded. url: "{{base_url}}/{{namespace}}/chat-channels/available-participants" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml index e1bd12b..31049f7 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Query Chat Channels" +description: |- + Returns chat channels visible to the current organization. Use query parameters to filter, sort, and paginate the result set. url: "{{base_url}}/{{namespace}}/chat-channels" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml index 9abe7ad..80f7cf4 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Remove Participant" +description: |- + Removes a participant from a chat channel by participant ID. The channel remains active for the remaining participants. url: "{{base_url}}/{{namespace}}/chat-channels/remove-participant/:participantId" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml index f9c25f0..1bd724a 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Retrieve Chat Channel" +description: |- + Retrieves a chat channel by ID, including its participants, feed, and latest message metadata. url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml new file mode 100644 index 0000000..09ff216 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: sender + type: string + required: true + description: "Public ID of the chat participant sending the message." + - name: content + type: string + description: "Message text to publish to the channel." + - name: files + type: array of strings + description: "Public IDs of uploaded files to attach to the message." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml index 408f880..892e803 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Send Message" +description: |- + Sends a message to a chat channel as an existing chat participant. File IDs can be included to attach previously uploaded files to the message. url: "{{base_url}}/{{namespace}}/chat-channels/:id/send-message" method: POST pathVariables: diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml index 8e0ec7d..2d6b5f7 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml @@ -2,4 +2,5 @@ $kind: params fields: - name: name type: string - description: "Display name for the resource." + required: true + description: "Updated channel name." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml index 3588970..a67469a 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Update Chat Channel" +description: |- + Updates a chat channel's name. The response returns the updated chat channel resource. url: "{{base_url}}/{{namespace}}/chat-channels/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml new file mode 100644 index 0000000..dd2cf79 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml @@ -0,0 +1,51 @@ +$kind: object +name: Comment +description: |- + A comment stores authored text against a subject resource or as a reply to another comment. +example: | + { + "id": "comment_8JVZr4q", + "content": "Please confirm the delivery window.", + "tags": [], + "meta": {}, + "author": { + "id": "user_8xP2L1d", + "name": "Alex Rivera" + }, + "replies": [], + "editable": true, + "updated_at": "2026-05-07T09:30:00Z", + "created_at": "2026-05-07T09:30:00Z", + "deleted_at": null + } +fields: + - name: id + type: string + description: "Public identifier of the comment." + - name: content + type: string + description: "Comment body." + - name: tags + type: array of strings + description: "Tags associated with the comment." + - name: meta + type: object + description: "Arbitrary metadata stored with the comment." + - name: author + type: object + description: "User that authored the comment." + - name: replies + type: array of objects + description: "Nested replies to the comment." + - name: editable + type: boolean + description: "Whether the current session user can edit the comment." + - name: updated_at + type: timestamp + description: "Time the comment was last updated." + - name: created_at + type: timestamp + description: "Time the comment was created." + - name: deleted_at + type: timestamp + description: "Time the comment was deleted, when soft deleted." diff --git a/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml b/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml index 5159ab3..21d751d 100644 --- a/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml @@ -1,16 +1,27 @@ $kind: params fields: - - name: name + - name: content type: string required: true - description: "Display name for the resource." - - name: description + description: "Comment body." + - name: subject + type: object + description: "Subject resource receiving the comment. Provide this object when creating a top-level comment." + fields: + - name: id + type: string + required: true + description: "Public ID of the subject resource." + - name: type + type: string + required: true + description: "Mutation type or resource type used to resolve the subject model." + - name: subject_id type: string - description: "Human-readable description of the resource." - - name: status - type: enum - values: ["active", "inactive"] - description: "Lifecycle status to apply to the resource." - - name: meta + description: "Public ID of the subject resource. Use with `subject_type` as an alternative to `subject`." + - name: subject_type type: string - description: "Arbitrary metadata stored with the resource." + description: "Mutation type or resource type used to resolve the subject model. Use with `subject_id`." + - name: parent + type: string + description: "Public ID of the parent comment when creating a reply." diff --git a/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml index 6275fb4..124ccc0 100644 --- a/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Create Comment" +description: |- + Creates a comment on a subject resource or as a reply to an existing comment. Provide either a subject reference or a parent comment ID with the comment content. url: "{{base_url}}/{{namespace}}/comments" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml index d087506..e5aa3b6 100644 --- a/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Delete Comment" +description: |- + Deletes a comment by ID. The response returns a deleted-resource envelope for the removed comment. url: "{{base_url}}/{{namespace}}/comments/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml index ee090f5..f7a19d5 100644 --- a/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Query Comments" +description: |- + Returns comments for the current organization. Use query parameters to filter, sort, and paginate the result set. url: "{{base_url}}/{{namespace}}/comments" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml index 065b290..5b18054 100644 --- a/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Retrieve Comment" +description: |- + Retrieves a comment by ID, including its author and any nested replies returned by the API resource. url: "{{base_url}}/{{namespace}}/comments/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml b/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml index 1775f21..8876df7 100644 --- a/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml @@ -2,4 +2,5 @@ $kind: params fields: - name: content type: string - description: "Text content for the comment or message." + required: true + description: "Updated comment body." diff --git a/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml index 03fa4bb..69791ec 100644 --- a/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml +++ b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Update Comment" +description: |- + Updates the content of an existing comment. The subject and parent linkage are not changed by this endpoint. url: "{{base_url}}/{{namespace}}/comments/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/.resources/object.yaml b/postman/collections/Fleetbase Core API/Files/.resources/object.yaml new file mode 100644 index 0000000..5d33bd8 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/object.yaml @@ -0,0 +1,52 @@ +$kind: object +name: File +description: |- + A file represents an uploaded binary object and the metadata Fleetbase stores for it. +example: | + { + "id": "file_4WdX9o2", + "url": "https://files.example.com/uploads/example.png", + "original_filename": "example.png", + "folder": "uploads", + "content_type": "image/png", + "file_size": 24576, + "caption": "Proof of delivery", + "type": "attachment", + "meta": {}, + "updated_at": "2026-05-07T09:30:00Z", + "created_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the file." + - name: url + type: string + description: "Public URL for the stored file." + - name: original_filename + type: string + description: "Original filename stored on the file record." + - name: folder + type: string + description: "Storage folder containing the file." + - name: content_type + type: string + description: "MIME content type of the file." + - name: file_size + type: integer + description: "File size in bytes." + - name: caption + type: string + description: "Caption displayed with the file." + - name: type + type: string + description: "Logical file type stored on the file record." + - name: meta + type: object + description: "Arbitrary metadata stored with the file." + - name: updated_at + type: timestamp + description: "Time the file record was last updated." + - name: created_at + type: timestamp + description: "Time the file record was created." diff --git a/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml index e1e8d5e..4859479 100644 --- a/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Delete a File" +description: |- + Deletes a file record by ID. The response returns a deleted-resource envelope for the removed file. url: "{{base_url}}/{{namespace}}/files/:id" method: DELETE pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Download File.request.yaml b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml index 8620c9d..9457b60 100644 --- a/postman/collections/Fleetbase Core API/Files/Download File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Download File" +description: |- + Downloads the binary contents of a file by ID. The API streams the stored file using its original filename. url: "{{base_url}}/{{namespace}}/files/:id/download" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml index 0a89a2e..ed95578 100644 --- a/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Query Files" +description: |- + Returns uploaded files for the current organization. Use query parameters to filter, sort, and paginate the result set. url: "{{base_url}}/{{namespace}}/files" method: GET queryParams: diff --git a/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml index d0d0d39..5ef15be 100644 --- a/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Retrieve a File" +description: |- + Retrieves a file record by ID, including its URL, original filename, content type, size, caption, and metadata. url: "{{base_url}}/{{namespace}}/files/:id" method: GET pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Update File.params.yaml b/postman/collections/Fleetbase Core API/Files/Update File.params.yaml index 297a857..c7e439a 100644 --- a/postman/collections/Fleetbase Core API/Files/Update File.params.yaml +++ b/postman/collections/Fleetbase Core API/Files/Update File.params.yaml @@ -3,6 +3,9 @@ fields: - name: caption type: string description: "Caption displayed with the file." + - name: filename + type: string + description: "New original filename to store on the file record." - name: meta type: object - description: "Arbitrary metadata stored with the resource." + description: "Arbitrary metadata stored with the file record." diff --git a/postman/collections/Fleetbase Core API/Files/Update File.request.yaml b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml index 8c8456e..761cef0 100644 --- a/postman/collections/Fleetbase Core API/Files/Update File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Update File" +description: |- + Updates a file record's caption, metadata, or original filename. The uploaded binary object is not replaced. url: "{{base_url}}/{{namespace}}/files/:id" method: PUT pathVariables: diff --git a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml new file mode 100644 index 0000000..5db521c --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml @@ -0,0 +1,46 @@ +$kind: params +fields: + - name: data + type: string + required: true + description: "Base64-encoded file contents." + - name: file_name + type: string + required: true + description: "Filename to use when storing the decoded file." + - name: file_type + type: string + description: "Logical file type stored on the file record. Defaults to `image`." + - name: content_type + type: string + description: "MIME content type stored on the file record. Defaults to `image/png`." + - name: subject_uuid + type: string + description: "UUID of a subject resource to associate with the file." + - name: subject_type + type: string + description: "Model class or subject type for the associated resource." + - name: resize + type: enum + values: ["thumb", "sm", "md", "lg", "xl", "2xl"] + description: "Optional image resize preset." + - name: resize_width + type: integer + description: "Target resize width in pixels. Must be between 1 and 10000." + - name: resize_height + type: integer + description: "Target resize height in pixels. Must be between 1 and 10000." + - name: resize_mode + type: enum + values: ["fit", "crop", "stretch", "contain"] + description: "Resize mode used when transforming the image." + - name: resize_quality + type: integer + description: "Resize output quality from 1 to 100." + - name: resize_format + type: enum + values: ["jpg", "jpeg", "png", "webp", "gif", "bmp", "avif"] + description: "Output image format for the resized file." + - name: resize_upscale + type: boolean + description: "Whether smaller images may be upscaled during resizing." diff --git a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml index 639e645..407c22e 100644 --- a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Upload Base64 File" +description: |- + Creates a file from base64-encoded data. Fleetbase stores the decoded file, creates a file record, and optionally associates it with a subject resource. url: "{{base_url}}/{{namespace}}/files/base64" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Files/Upload File.params.yaml b/postman/collections/Fleetbase Core API/Files/Upload File.params.yaml new file mode 100644 index 0000000..76146eb --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Upload File.params.yaml @@ -0,0 +1,30 @@ +$kind: params +fields: + - name: file + type: string + required: true + description: "Multipart file upload. The uploaded file may be up to 100 MB and must use one of the supported MIME types." + - name: resize + type: enum + values: ["thumb", "sm", "md", "lg", "xl", "2xl"] + description: "Optional image resize preset." + - name: resize_width + type: integer + description: "Target resize width in pixels. Must be between 1 and 10000." + - name: resize_height + type: integer + description: "Target resize height in pixels. Must be between 1 and 10000." + - name: resize_mode + type: enum + values: ["fit", "crop", "stretch", "contain"] + description: "Resize mode used when transforming the image." + - name: resize_quality + type: integer + description: "Resize output quality from 1 to 100." + - name: resize_format + type: enum + values: ["jpg", "jpeg", "png", "webp", "gif", "bmp", "avif"] + description: "Output image format for the resized file." + - name: resize_upscale + type: boolean + description: "Whether smaller images may be upscaled during resizing." diff --git a/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml index ab63486..57339b9 100644 --- a/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml +++ b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Upload File" +description: |- + Uploads a multipart file and creates a file record. The response includes the stored file URL and metadata captured from the upload. url: "{{base_url}}/{{namespace}}/files" method: POST body: diff --git a/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml b/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml new file mode 100644 index 0000000..20b18e7 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml @@ -0,0 +1,72 @@ +$kind: object +name: Organization +description: |- + An organization is the company context associated with the current API credential. +example: | + { + "id": "org_9W2KxA1", + "name": "Acme Logistics", + "description": "Regional logistics operations", + "phone": "+15555550100", + "timezone": "America/New_York", + "country": "US", + "currency": "USD", + "logo_url": "https://files.example.com/logos/acme.png", + "backdrop_url": null, + "branding": {}, + "options": {}, + "owner": null, + "slug": "acme-logistics", + "status": "active", + "updated_at": "2026-05-07T09:30:00Z", + "created_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the organization." + - name: name + type: string + description: "Organization name." + - name: description + type: string + description: "Organization description." + - name: phone + type: string + description: "Organization phone number." + - name: timezone + type: string + description: "Default timezone for the organization." + - name: country + type: string + description: "Organization country code." + - name: currency + type: currency + description: "Default currency code for the organization." + - name: logo_url + type: string + description: "URL of the organization logo." + - name: backdrop_url + type: string + description: "URL of the organization backdrop image." + - name: branding + type: object + description: "Branding settings returned with the organization." + - name: options + type: object + description: "Organization option values." + - name: owner + type: object + description: "Owner user for the organization, when included." + - name: slug + type: string + description: "URL-friendly organization slug." + - name: status + type: string + description: "Organization status." + - name: updated_at + type: timestamp + description: "Time the organization was last updated." + - name: created_at + type: timestamp + description: "Time the organization was created." From 79782e09461d415e662369e203cca80ff0a7c22e Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:48:39 +0800 Subject: [PATCH 07/10] Add source-backed ledger API metadata --- .../Public Invoices/.resources/object.yaml | 108 ++++++++++++++++++ .../Get Public Invoice.request.yaml | 3 +- .../List Public Invoice Gateways.request.yaml | 3 +- .../Pay Public Invoice.params.yaml | 9 ++ .../Pay Public Invoice.request.yaml | 3 +- .../Wallet/.resources/object.yaml | 68 +++++++++++ .../Wallet/Get Wallet Balance.request.yaml | 3 +- .../Wallet/Get Wallet.request.yaml | 3 +- .../List Wallet Transactions.request.yaml | 3 +- .../Wallet/Top Up Wallet.params.yaml | 19 +++ .../Wallet/Top Up Wallet.request.yaml | 3 +- .../Webhooks/.resources/object.yaml | 12 ++ .../Handle Gateway Webhook.params.yaml | 14 +++ .../Handle Gateway Webhook.request.yaml | 3 +- 14 files changed, 246 insertions(+), 8 deletions(-) create mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml create mode 100644 postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml create mode 100644 postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml new file mode 100644 index 0000000..55a41b8 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml @@ -0,0 +1,108 @@ +$kind: object +name: Public Invoice +description: |- + A public invoice is the customer-facing representation of a Ledger invoice. It includes invoice totals, dates, line items, customer data when available, and payment state. +example: | + { + "id": "invoice_7fJ3kQ9", + "public_id": "invoice_7fJ3kQ9", + "customer": null, + "order": null, + "transaction": null, + "template": null, + "number": "INV-1007", + "status": "sent", + "date": "2026-05-07", + "due_date": "2026-05-21", + "currency": "USD", + "subtotal": 12500, + "tax": 0, + "total_amount": 12500, + "amount_paid": 0, + "balance": 12500, + "notes": "Thank you for your business.", + "terms": "Due on receipt.", + "items": [], + "meta": {}, + "sent_at": "2026-05-07T09:30:00Z", + "viewed_at": null, + "paid_at": null, + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the invoice." + - name: public_id + type: string + description: "Public identifier of the invoice." + - name: customer + type: object + description: "Customer associated with the invoice, when loaded." + - name: order + type: object + description: "Related order, when loaded." + - name: transaction + type: object + description: "Related transaction, when loaded." + - name: template + type: object + description: "Invoice template, when loaded." + - name: number + type: string + description: "Invoice number." + - name: status + type: string + description: "Invoice status." + - name: date + type: date + description: "Invoice issue date." + - name: due_date + type: date + description: "Invoice due date." + - name: currency + type: currency + description: "Invoice currency code." + - name: subtotal + type: integer + description: "Subtotal in the smallest currency unit." + - name: tax + type: integer + description: "Tax amount in the smallest currency unit." + - name: total_amount + type: integer + description: "Total invoice amount in the smallest currency unit." + - name: amount_paid + type: integer + description: "Amount paid in the smallest currency unit." + - name: balance + type: integer + description: "Remaining balance in the smallest currency unit." + - name: notes + type: string + description: "Invoice notes." + - name: terms + type: string + description: "Invoice payment terms." + - name: items + type: array of objects + description: "Invoice line items." + - name: meta + type: object + description: "Arbitrary metadata stored with the invoice." + - name: sent_at + type: timestamp + description: "Time the invoice was sent." + - name: viewed_at + type: timestamp + description: "Time the invoice was first viewed publicly." + - name: paid_at + type: timestamp + description: "Time the invoice was paid." + - name: created_at + type: timestamp + description: "Time the invoice was created." + - name: updated_at + type: timestamp + description: "Time the invoice was last updated." diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml index 9d61dd4..55518f5 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Public Invoice +description: |- + Retrieves the public view of an invoice by public ID or UUID. Draft invoices are not available through the public invoice URL. url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml index de4fd2c..e1f5ccf 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: List Public Invoice Gateways +description: |- + Lists active payment gateways available for a public invoice. Gateway credentials and sensitive configuration are never returned. url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/gateways" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml new file mode 100644 index 0000000..3801fc7 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml @@ -0,0 +1,9 @@ +$kind: params +fields: + - name: gateway_id + type: string + required: true + description: "Public ID of the payment gateway to use for the invoice payment." + - name: reference + type: string + description: "Customer-provided payment reference or note." diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml index 3e11b74..49f42c9 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Pay Public Invoice +description: |- + Initiates or records payment for a public invoice. Stripe gateways return a checkout URL, while non-redirect gateways record the invoice payment immediately. url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/pay" method: POST headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml new file mode 100644 index 0000000..2e15fc9 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml @@ -0,0 +1,68 @@ +$kind: object +name: Wallet +description: |- + A wallet tracks the balance for the authenticated subject. Ledger stores monetary values in the smallest currency unit. +example: | + { + "id": "wallet_2Tn8Qk1", + "subject_uuid": "9c6292e4-9d7b-4ab4-94a1-3f4a11c1cf25", + "subject_type": "Fleetbase\\Models\\User", + "subject": null, + "name": "Default wallet", + "description": null, + "type": "default", + "balance": 5000, + "formatted_balance": "50.00", + "currency": "USD", + "status": "active", + "is_frozen": false, + "meta": {}, + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the wallet." + - name: subject_uuid + type: string + description: "UUID of the model that owns the wallet." + - name: subject_type + type: string + description: "Model class that owns the wallet." + - name: subject + type: object + description: "Loaded wallet owner, when included." + - name: name + type: string + description: "Wallet name." + - name: description + type: string + description: "Wallet description." + - name: type + type: string + description: "Wallet type." + - name: balance + type: integer + description: "Wallet balance in the smallest currency unit." + - name: formatted_balance + type: string + description: "Human-readable wallet balance." + - name: currency + type: currency + description: "Wallet currency code." + - name: status + type: string + description: "Wallet status." + - name: is_frozen + type: boolean + description: "Whether wallet activity is frozen." + - name: meta + type: object + description: "Arbitrary metadata stored with the wallet." + - name: created_at + type: timestamp + description: "Time the wallet was created." + - name: updated_at + type: timestamp + description: "Time the wallet was last updated." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml index 389864e..2a88a00 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Wallet Balance +description: |- + Returns the authenticated subject's wallet balance. Fleetbase provisions a wallet automatically when one does not already exist. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/balance" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml index 22d6ad3..08080d4 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Wallet +description: |- + Retrieves the authenticated subject's wallet. Pass a currency to choose the wallet currency when Fleetbase needs to provision one. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml index 44a0dc1..f241c25 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: List Wallet Transactions +description: |- + Lists transactions for the authenticated subject's wallet. Results can be filtered by transaction type, direction, status, and creation date range. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/transactions" method: GET headers: diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml new file mode 100644 index 0000000..6500dc1 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.params.yaml @@ -0,0 +1,19 @@ +$kind: params +fields: + - name: gateway + type: string + required: true + description: "Public ID or UUID of the payment gateway to charge." + - name: amount + type: integer + required: true + description: "Top-up amount in the smallest currency unit. Must be at least 100." + - name: payment_method_token + type: string + description: "Gateway payment method token, such as a Stripe `pm_` token." + - name: customer_id + type: string + description: "Customer ID from the payment gateway." + - name: description + type: string + description: "Description stored with the top-up payment. Maximum length is 500 characters." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml index a9c2fc4..b13eabe 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Top Up Wallet +description: |- + Tops up the authenticated subject's wallet through a configured payment gateway. Amounts are submitted in the smallest currency unit. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/topup" method: POST headers: diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml new file mode 100644 index 0000000..9a8604a --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml @@ -0,0 +1,12 @@ +$kind: object +name: Gateway Webhook +description: |- + A gateway webhook is an inbound provider event handled by a Ledger payment gateway driver. +example: | + { + "message": "Webhook received." + } +fields: + - name: message + type: string + description: "Processing result returned to the gateway provider." diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml new file mode 100644 index 0000000..2c86d3e --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: company_uuid + type: string + description: "Organization UUID used to resolve the active gateway when the gateway driver supports multi-company callbacks." + - name: id + type: string + description: "Gateway event or transaction identifier from the provider payload." + - name: type + type: string + description: "Gateway event type, such as a payment succeeded or payment failed event." + - name: data + type: object + description: "Provider-specific webhook data passed to the gateway driver for parsing." diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml index f6dfc55..19aac17 100644 --- a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml +++ b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Handle Gateway Webhook +description: |- + Receives an inbound webhook from a payment gateway driver. Fleetbase verifies the gateway event, records it idempotently, and dispatches normalized payment events. url: "{{base_url}}/{{api_prefix}}/webhooks/{{gateway_driver}}" method: POST headers: From 20fba849e1ad81f67d1e9d71bfdcf20a6ce958c5 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:55:47 +0800 Subject: [PATCH 08/10] Add source-backed storefront API metadata --- .../Cart/.resources/object.yaml | 56 ++++++++++++ .../Cart/Add Item to Cart.params.yaml | 17 ++++ .../Category/.resources/object.yaml | 62 +++++++++++++ .../Checkout/.resources/object.yaml | 34 +++++++ .../Before \342\235\227.request.yaml" | 3 +- ...Capture QPay Callback via GET.request.yaml | 3 +- .../Capture QPay Callback.params.yaml | 13 +++ .../Capture QPay Callback.request.yaml | 3 +- .../Capture checkout as order.params.yaml | 12 +++ .../Create Stripe Setup Intent.request.yaml | 3 +- .../Checkout/Get Checkout Status.request.yaml | 3 +- .../Update Stripe Payment Intent.request.yaml | 3 +- .../Customer/.resources/object.yaml | 72 +++++++++++++++ ...uthenticate a Customer via SMS.params.yaml | 6 ++ ...enticate a Customer with Apple.params.yaml | 22 +++++ ...nticate a Customer with Apple.request.yaml | 3 +- ...icate a Customer with Facebook.params.yaml | 12 +++ ...cate a Customer with Facebook.request.yaml | 3 +- ...nticate a Customer with Google.params.yaml | 10 ++ ...ticate a Customer with Google.request.yaml | 3 +- ...icate a Customer \342\235\227.params.yaml" | 19 ++++ .../Confirm Account Closure.params.yaml | 6 ++ .../Confirm Account Closure.request.yaml | 3 +- .../Get Stripe Ephemeral Key.params.yaml | 2 + .../Get Stripe Ephemeral Key.request.yaml | 3 +- .../Get Stripe Setup Intent.params.yaml | 2 + .../Get Stripe Setup Intent.request.yaml | 3 +- .../Register customer device.params.yaml | 12 +++ .../Request Phone Verification.params.yaml | 6 ++ .../Request Phone Verification.request.yaml | 3 +- .../Customer/Retrieve a Customer.request.yaml | 3 +- ...reate a new storefront custome.params.yaml | 11 +++ .../Start Account Closure.params.yaml | 2 + .../Start Account Closure.request.yaml | 3 +- ...Update Contact Customer Alias.request.yaml | 3 +- .../Customer/Verify Phone Number.params.yaml | 6 ++ .../Customer/Verify Phone Number.request.yaml | 3 +- .../Customer/Verify a SMS code.params.yaml | 23 +++++ .../.resources/object.yaml | 27 ++++++ .../Food Trucks/.resources/object.yaml | 48 ++++++++++ .../Orders/.resources/object.yaml | 53 +++++++++++ .../Orders/Complete Order Pickup.params.yaml | 6 ++ .../Orders/Complete Order Pickup.request.yaml | 3 +- .../Orders/Get Order Receipt.params.yaml | 13 +++ .../Orders/Get Order Receipt.request.yaml | 3 +- .../Products/.resources/object.yaml | 91 +++++++++++++++++++ .../Reviews/.resources/object.yaml | 44 +++++++++ .../Store Locations/.resources/object.yaml | 39 ++++++++ .../Store/.resources/object.yaml | 85 +++++++++++++++++ 49 files changed, 849 insertions(+), 19 deletions(-) create mode 100644 postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml create mode 100644 "postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml create mode 100644 postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml new file mode 100644 index 0000000..f21ffdb --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml @@ -0,0 +1,56 @@ +$kind: object +name: Cart +description: |- + A cart stores storefront products selected for checkout, including quantities, variants, addons, scheduling, and pricing totals. +example: | + { + "id": "cart_8Xk2mQ1", + "customer_id": "customer_4sW9kP2", + "currency": "USD", + "subtotal": 4200, + "total_items": 3, + "total_unique_items": 2, + "items": [], + "events": [], + "discount_code": null, + "expires_at": "2026-05-08T09:30:00Z", + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the cart." + - name: customer_id + type: string + description: "Customer identifier associated with the cart." + - name: currency + type: currency + description: "Cart currency code." + - name: subtotal + type: integer + description: "Cart subtotal." + - name: total_items + type: integer + description: "Total quantity of items in the cart." + - name: total_unique_items + type: integer + description: "Number of unique cart line items." + - name: items + type: array of objects + description: "Cart line items." + - name: events + type: array of objects + description: "Cart event history." + - name: discount_code + type: string + description: "Discount code applied to the cart." + - name: expires_at + type: timestamp + description: "Time the cart expires." + - name: created_at + type: timestamp + description: "Time the cart was created." + - name: updated_at + type: timestamp + description: "Time the cart was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml new file mode 100644 index 0000000..beaeb0d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: quantity + type: integer + description: "Quantity of the product to add. Defaults to 1." + - name: variants + type: array of objects + description: "Selected product variant data to store on the cart line item." + - name: addons + type: array of objects + description: "Selected product addon data to store on the cart line item." + - name: scheduled_at + type: timestamp + description: "Scheduled fulfillment time for the line item." + - name: store_location + type: string + description: "Public ID of the store location to associate with the line item." diff --git a/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml new file mode 100644 index 0000000..bed2bef --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml @@ -0,0 +1,62 @@ +$kind: object +name: Category +description: |- + A category groups storefront products and can include nested subcategories. +example: | + { + "id": "category_2xK9mP1", + "name": "Beverages", + "description": "Drinks and bottled beverages.", + "icon_url": "https://files.example.com/beverages.png", + "parent": null, + "tags": [], + "translations": [], + "meta": {}, + "order": 1, + "slug": "beverages", + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the category." + - name: name + type: string + description: "Category name." + - name: description + type: string + description: "Category description." + - name: icon_url + type: string + description: "Category icon URL." + - name: parent + type: string + description: "Parent category public ID when loaded." + - name: tags + type: array of strings + description: "Category tags." + - name: translations + type: object + description: "Translated category values." + - name: products + type: array of objects + description: "Products in the category when requested." + - name: subcategories + type: array of objects + description: "Nested subcategories when requested." + - name: meta + type: object + description: "Arbitrary metadata stored with the category." + - name: order + type: integer + description: "Sort order." + - name: slug + type: string + description: "URL-friendly category slug." + - name: created_at + type: timestamp + description: "Time the category was created." + - name: updated_at + type: timestamp + description: "Time the category was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml new file mode 100644 index 0000000..19dc178 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml @@ -0,0 +1,34 @@ +$kind: object +name: Checkout +description: |- + A checkout token represents a prepared storefront checkout session for a cart, customer, gateway, and delivery or pickup option. +example: | + { + "token": "checkout-token", + "paymentIntent": "pi_123", + "clientSecret": "pi_123_secret_456", + "ephemeralKey": "ek_test_123", + "customerId": "cus_123" + } +fields: + - name: token + type: string + description: "Checkout token used to capture the order." + - name: paymentIntent + type: string + description: "Stripe PaymentIntent ID when using Stripe checkout." + - name: clientSecret + type: string + description: "Stripe client secret when using Stripe checkout." + - name: ephemeralKey + type: string + description: "Stripe ephemeral key when returned for mobile checkout." + - name: customerId + type: string + description: "Gateway customer ID." + - name: invoice + type: object + description: "QPay invoice payload when using QPay checkout." + - name: checkout + type: string + description: "Public checkout ID returned by QPay checkout initialization." diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" index 050a86b..bee5a7e 100644 --- "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" @@ -1,5 +1,6 @@ $kind: http-request -description: Before ❗ +description: |- + Initializes a checkout preview for a cart, customer, gateway, and delivery or pickup option. The response prepares gateway-specific client data or a checkout token before the order is captured. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/before" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml index 0bbf1f5..e48c268 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Capture QPay Callback via GET +description: |- + Processes a QPay checkout callback from query parameters. Sandbox requests can pass `test` to simulate success or failure. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml new file mode 100644 index 0000000..0de0f8f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml @@ -0,0 +1,13 @@ +$kind: params +fields: + - name: checkout + type: string + required: true + description: "Public checkout ID being confirmed by QPay." + - name: respond + type: boolean + description: "Whether Fleetbase should return the payment check payload in the HTTP response." + - name: test + type: enum + values: ["success", "error"] + description: "Sandbox-only test scenario to simulate." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml index 14808a1..312166a 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Capture QPay Callback +description: |- + Processes a QPay checkout callback. Fleetbase verifies the checkout and gateway, checks the QPay invoice payment state, and creates the order when payment is confirmed. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml new file mode 100644 index 0000000..386c32e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: token + type: string + required: true + description: "Checkout token returned by checkout initialization." + - name: transactionDetails + type: object + description: "Optional gateway transaction details to store with the resulting transaction and order metadata." + - name: notes + type: string + description: "Optional notes stored on the created order." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml index 2bb4853..84aeed2 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create Stripe Setup Intent +description: |- + Creates a Stripe SetupIntent for a storefront customer. The response includes Stripe client data for saving a payment method. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-setup-intent" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml index ab86367..c9d0ab5 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Checkout Status +description: |- + Returns the status of a checkout by checkout ID or token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/status" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml index d500fb2..59c0046 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update Stripe Payment Intent +description: |- + Recalculates and updates an existing Stripe PaymentIntent for the current cart and checkout options. The response includes refreshed Stripe client data and a new checkout token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-update-payment-intent" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml new file mode 100644 index 0000000..69407d4 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml @@ -0,0 +1,72 @@ +$kind: object +name: Customer +description: |- + A storefront customer is a FleetOps contact exposed through the Storefront API with customer-specific identifiers, saved addresses, and an optional auth token. +example: | + { + "id": "customer_5M8xQp2", + "address_id": "place_9eL2wA1", + "internal_id": null, + "name": "Alex Rivera", + "title": null, + "photo_url": null, + "email": "alex@example.com", + "phone": "+15555550100", + "address": "123 Market Street", + "addresses": [], + "token": "plain-text-token", + "orders": 4, + "meta": {}, + "slug": "alex-rivera", + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public customer identifier." + - name: address_id + type: string + description: "Public ID of the customer's default place." + - name: internal_id + type: string + description: "Internal customer reference." + - name: name + type: string + description: "Customer name." + - name: title + type: string + description: "Customer title." + - name: photo_url + type: string + description: "Customer photo URL." + - name: email + type: string + description: "Customer email address." + - name: phone + type: string + description: "Customer phone number." + - name: address + type: string + description: "Default address text." + - name: addresses + type: array of objects + description: "Saved customer places." + - name: token + type: string + description: "Auth token returned by authentication and customer creation endpoints." + - name: orders + type: integer + description: "Count of customer orders for the current storefront or network context." + - name: meta + type: object + description: "Arbitrary metadata stored with the customer." + - name: slug + type: string + description: "URL-friendly customer slug." + - name: created_at + type: timestamp + description: "Time the customer was created." + - name: updated_at + type: timestamp + description: "Time the customer was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml new file mode 100644 index 0000000..7de5a12 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: phone + type: string + required: true + description: "Customer phone number to receive the storefront login verification code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml new file mode 100644 index 0000000..4abd926 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml @@ -0,0 +1,22 @@ +$kind: params +fields: + - name: identityToken + type: string + required: true + description: "Apple identity token to verify." + - name: authorizationCode + type: string + required: true + description: "Apple authorization code issued during sign-in." + - name: email + type: string + description: "Customer email address provided by Apple." + - name: phone + type: string + description: "Customer phone number." + - name: name + type: string + description: "Customer display name." + - name: appleUserId + type: string + description: "Stable Apple user identifier." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml index d63270e..bad71f0 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Authenticate a Customer with Apple +description: |- + Authenticates a storefront customer with Apple Sign-In. Fleetbase verifies the Apple identity token, creates or updates the user, and returns the storefront customer with an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-apple" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml new file mode 100644 index 0000000..d1eec17 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: email + type: string + description: "Customer email address from Facebook." + - name: name + type: string + description: "Customer display name from Facebook." + - name: facebookUserId + type: string + required: true + description: "Stable Facebook user identifier." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml index 37ac9c2..cfaf22b 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Authenticate a Customer with Facebook +description: |- + Authenticates a storefront customer with Facebook account data. Fleetbase creates or updates the matching user and returns the storefront customer with an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-facebook" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml new file mode 100644 index 0000000..ddb9d5c --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml @@ -0,0 +1,10 @@ +$kind: params +fields: + - name: idToken + type: string + required: true + description: "Google ID token to verify." + - name: clientId + type: string + required: true + description: "Google OAuth client ID expected for the ID token." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml index b688eb2..c8addf3 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Authenticate a Customer with Google +description: |- + Authenticates a storefront customer with Google Sign-In. Fleetbase verifies the Google ID token, creates or updates the user, and returns the storefront customer with an auth token. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-google" method: POST headers: diff --git "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" new file mode 100644 index 0000000..e46b1ce --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" @@ -0,0 +1,19 @@ +$kind: params +fields: + - name: identity + type: string + required: true + description: "Customer email address or phone number." + - name: password + type: string + required: true + description: "Customer password." + - name: name + type: string + description: "Customer name used when a contact record must be created for the storefront." + - name: phone + type: string + description: "Customer phone used when a contact record must be created for the storefront." + - name: email + type: string + description: "Customer email used when a contact record must be created for the storefront." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml new file mode 100644 index 0000000..d1b9595 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: code + type: string + required: true + description: "Account closure verification code sent to the customer." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml index f1a762d..1509eae 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Confirm Account Closure +description: |- + Confirms storefront account closure using the verification code sent to the customer. Fleetbase deletes the customer contact and, for customer users, the linked user account. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/confirm-account-closure" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml new file mode 100644 index 0000000..5162c44 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.params.yaml @@ -0,0 +1,2 @@ +$kind: params +fields: [] diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml index 9aaa60e..c4b9a82 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Stripe Ephemeral Key +description: |- + Creates a Stripe ephemeral key for the authenticated storefront customer. Fleetbase creates the Stripe customer first when the customer does not already have one. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-ephemeral-key" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml new file mode 100644 index 0000000..5162c44 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.params.yaml @@ -0,0 +1,2 @@ +$kind: params +fields: [] diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml index bf289e3..32e7324 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get 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. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-setup-intent" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml new file mode 100644 index 0000000..79b92a1 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: token + type: string + required: true + description: "Push notification device token." + - name: platform + type: string + description: "Device platform. `os` is also accepted as an alias." + - name: os + type: string + description: "Device platform alias used when `platform` is not provided." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml new file mode 100644 index 0000000..0b7d5db --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: phone + type: string + required: true + description: "Phone number to verify for the authenticated customer." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml index c986afe..be79a9a 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Request Phone Verification +description: |- + Sends a verification code to a new phone number for the authenticated storefront customer. Fleetbase rejects numbers already assigned to another user. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-phone-verification" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml index 707a424..f95e275 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Retrieve a Customer +description: |- + Retrieves a storefront customer by ID. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{{customer_id}}" method: GET headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml new file mode 100644 index 0000000..8f14c0f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: mode + type: enum + values: ["email", "sms"] + required: true + description: "Verification delivery mode." + - name: identity + type: string + required: true + description: "Email address or phone number receiving the customer creation code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml new file mode 100644 index 0000000..5162c44 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.params.yaml @@ -0,0 +1,2 @@ +$kind: params +fields: [] diff --git a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml index c28253b..0f27637 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Start Account Closure +description: |- + Starts storefront account closure for the authenticated customer. Fleetbase sends a verification code to the linked phone number or email address. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/account-closure" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml index 6157f5f..2280da1 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update Contact Customer Alias +description: |- + Updates a storefront customer through the legacy contact alias route. The request is handled by the same customer update controller as `/customers/{id}`. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/contacts/{{customer_id}}" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml new file mode 100644 index 0000000..b95d49d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: code + type: string + required: true + description: "Verification code sent to the pending phone number." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml index b0f073a..49e988d 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Verify Phone Number +description: |- + Verifies the customer's pending phone number with the code sent by the phone verification request. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-phone-number" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml new file mode 100644 index 0000000..ded3c35 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: identity + type: string + required: true + description: "Customer email address or phone number being verified." + - name: code + type: string + required: true + description: "Verification code submitted by the customer." + - name: for + type: string + default: storefront_login + description: "Verification purpose. Use `storefront_create_customer` to continue customer creation." + - name: name + type: string + description: "Customer name used when a contact record must be created." + - name: phone + type: string + description: "Customer phone used when a contact record must be created." + - name: email + type: string + description: "Customer email used when a contact record must be created." diff --git a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml new file mode 100644 index 0000000..98b2550 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml @@ -0,0 +1,27 @@ +$kind: object +name: Delivery Service Quote +description: |- + A delivery service quote prices delivery for a storefront cart and is consumed during checkout capture. +example: | + { + "id": "service_quote_4fK2mQ8", + "amount": 950, + "currency": "USD", + "meta": { + "origin": "place_123", + "destination": "place_456" + } + } +fields: + - name: id + type: string + description: "Public identifier of the service quote." + - name: amount + type: integer + description: "Quoted delivery amount." + - name: currency + type: currency + description: "Quote currency code." + - name: meta + type: object + description: "Quote metadata, including origin and destination used by checkout." diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml new file mode 100644 index 0000000..2afcff9 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml @@ -0,0 +1,48 @@ +$kind: object +name: Food Truck +description: |- + A food truck connects a storefront to a FleetOps vehicle, service area, zone, and catalogs for mobile ordering. +example: | + { + "id": "food_truck_8Fq2mL1", + "vehicle": null, + "service_area": null, + "zone": null, + "catalogs": [], + "location": null, + "online": false, + "status": "active", + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the food truck." + - name: vehicle + type: object + description: "FleetOps vehicle assigned to the food truck." + - name: service_area + type: object + description: "Service area assigned to the food truck." + - name: zone + type: object + description: "Zone assigned to the food truck." + - name: catalogs + type: array of objects + description: "Catalogs available for the food truck." + - name: location + type: object + description: "Current vehicle location." + - name: online + type: boolean + description: "Whether the assigned vehicle is online." + - name: status + type: string + description: "Food truck status." + - name: created_at + type: timestamp + description: "Time the food truck was created." + - name: updated_at + type: timestamp + description: "Time the food truck was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml new file mode 100644 index 0000000..b799cd8 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml @@ -0,0 +1,53 @@ +$kind: object +name: Storefront Order +description: |- + A storefront order is a FleetOps order created from a captured storefront checkout. +example: | + { + "id": "order_9Kx2mQ1", + "public_id": "order_9Kx2mQ1", + "status": "created", + "type": "storefront", + "payload": null, + "customer": null, + "meta": { + "checkout_id": "checkout_123", + "storefront": "Acme Market", + "total": 5150, + "currency": "USD" + }, + "notes": null, + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the order." + - name: public_id + type: string + description: "Public identifier of the order." + - name: status + type: string + description: "Order lifecycle status." + - name: type + type: string + description: "Order type, usually `storefront` for orders created by this API." + - name: payload + type: object + description: "FleetOps payload created from the storefront cart." + - name: customer + type: object + description: "Customer associated with the order." + - name: meta + type: object + description: "Storefront checkout, payment, totals, and fulfillment metadata." + - name: notes + type: string + description: "Order notes supplied during checkout capture." + - name: created_at + type: timestamp + description: "Time the order was created." + - name: updated_at + type: timestamp + description: "Time the order was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml new file mode 100644 index 0000000..b8db90a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: order + type: string + required: true + description: "Public ID of the pickup order to mark completed." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml index 07ceca9..d76fb3a 100644 --- a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Complete Order Pickup +description: |- + Marks an authenticated customer's pickup order as completed. Fleetbase verifies that the order belongs to the customer before updating the order status. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/picked-up" method: PUT headers: diff --git a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml new file mode 100644 index 0000000..0c9fb91 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml @@ -0,0 +1,13 @@ +$kind: params +fields: + - name: order + type: string + required: true + description: "Public ID of the order to retrieve a receipt for." + - name: ebarimt_receiver_type + type: enum + values: ["CITIZEN", "COMPANY"] + description: "Ebarimt receiver type for QPay receipts." + - name: ebarimt_receiver + type: string + description: "Company registration number. Required when `ebarimt_receiver_type` is `COMPANY`." diff --git a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml index da6ad7a..4c61763 100644 --- a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Get Order Receipt +description: |- + Returns a receipt for an authenticated customer's order when the payment method supports receipts. QPay orders can generate an Ebarimt receipt. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/receipt" method: POST headers: diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml new file mode 100644 index 0000000..8f97d54 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml @@ -0,0 +1,91 @@ +$kind: object +name: Product +description: |- + A product is an item or service sold through a storefront, including pricing, availability, media, variants, addons, and tags. +example: | + { + "id": "product_9Lb2mQ1", + "name": "Cold Brew", + "description": "Bottled cold brew coffee.", + "sku": "CB-12", + "primary_image_url": "https://files.example.com/cold-brew.png", + "price": 450, + "sale_price": null, + "currency": "USD", + "is_on_sale": false, + "is_recommended": true, + "is_service": false, + "is_bookable": false, + "is_available": true, + "tags": ["coffee"], + "status": "active", + "meta": {}, + "slug": "cold-brew", + "translations": [], + "addon_categories": [], + "variants": [], + "images": [], + "videos": [], + "hours": [], + "youtube_urls": [], + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the product." + - name: name + type: string + description: "Product name." + - name: description + type: string + description: "Product description." + - name: sku + type: string + description: "Stock keeping unit." + - name: primary_image_url + type: string + description: "Primary product image URL." + - name: price + type: integer + description: "Product price." + - name: sale_price + type: integer + description: "Sale price when the product is on sale." + - name: currency + type: currency + description: "Product currency code." + - name: is_available + type: boolean + description: "Whether the product is available for purchase." + - name: tags + type: array of strings + description: "Product tags." + - name: status + type: string + description: "Product status." + - name: meta + type: object + description: "Arbitrary metadata stored with the product." + - name: addon_categories + type: array of objects + description: "Addon categories available for the product." + - name: variants + type: array of objects + description: "Product variants and options." + - name: images + type: array of strings + description: "Product image URLs." + - name: videos + type: array of strings + description: "Product video URLs." + - name: hours + type: array of objects + description: "Product availability hours." + - name: created_at + type: timestamp + description: "Time the product was created." + - name: updated_at + type: timestamp + description: "Time the product was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml new file mode 100644 index 0000000..f2864d0 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml @@ -0,0 +1,44 @@ +$kind: object +name: Review +description: |- + A review stores a customer rating, written content, photos, and the reviewed subject. +example: | + { + "id": "review_2xK9mQ1", + "subject_id": "store_3Xb9kL2", + "rating": 5, + "content": "Great pickup experience.", + "customer": null, + "slug": "great-pickup-experience", + "photos": [], + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the review." + - name: subject_id + type: string + description: "Identifier of the reviewed subject." + - name: rating + type: integer + description: "Numeric review rating." + - name: content + type: string + description: "Review text." + - name: customer + type: object + description: "Customer that created the review." + - name: slug + type: string + description: "URL-friendly review slug." + - name: photos + type: array of objects + description: "Photos attached to the review." + - name: created_at + type: timestamp + description: "Time the review was created." + - name: updated_at + type: timestamp + description: "Time the review was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml new file mode 100644 index 0000000..6360867 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml @@ -0,0 +1,39 @@ +$kind: object +name: Store Location +description: |- + A store location links a storefront to a FleetOps place and operating hours. +example: | + { + "id": "store_location_7Lk2mQ1", + "store": "store_3Xb9kL2", + "name": "Downtown", + "place": null, + "hours": [], + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the store location." + - name: store + type: string + description: "Public ID of the store." + - name: store_data + type: object + description: "Store resource when requested." + - name: name + type: string + description: "Location name." + - name: place + type: object + description: "FleetOps place for the store location." + - name: hours + type: array of objects + description: "Operating hours for the location." + - name: created_at + type: timestamp + description: "Time the store location was created." + - name: updated_at + type: timestamp + description: "Time the store location was last updated." diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml new file mode 100644 index 0000000..f589a42 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml @@ -0,0 +1,85 @@ +$kind: object +name: Store +description: |- + A store describes a storefront business, including branding, contact information, operating options, locations, media, and network membership. +example: | + { + "id": "store_3Xb9kL2", + "name": "Acme Market", + "description": "Local grocery and delivery.", + "website": "https://example.com", + "email": "orders@example.com", + "phone": "+15555550100", + "tags": ["grocery"], + "currency": "USD", + "country": "US", + "options": {}, + "logo_url": "https://files.example.com/logo.png", + "backdrop_url": null, + "rating": 4.8, + "online": true, + "alertable": true, + "is_network": false, + "is_store": true, + "slug": "acme-market", + "created_at": "2026-05-07T09:30:00Z", + "updated_at": "2026-05-07T09:30:00Z" + } +fields: + - name: id + type: string + description: "Public identifier of the store." + - name: name + type: string + description: "Store name." + - name: description + type: string + description: "Store description." + - name: website + type: string + description: "Store website URL." + - name: email + type: string + description: "Store email address." + - name: phone + type: string + description: "Store phone number." + - name: tags + type: array of strings + description: "Store tags." + - name: currency + type: currency + description: "Store currency code." + - name: country + type: string + description: "Country code derived from the store currency." + - name: options + type: object + description: "Public store option values." + - name: logo_url + type: string + description: "Store logo URL." + - name: backdrop_url + type: string + description: "Store backdrop image URL." + - name: rating + type: number + description: "Store rating." + - name: online + type: boolean + description: "Whether the store is online." + - name: alertable + type: boolean + description: "Whether the store can receive order alerts." + - name: is_network + type: boolean + description: "Whether the resource is a storefront network." + - name: is_store + type: boolean + description: "Whether the resource is a store." + - name: created_at + type: timestamp + description: "Time the store was created." + - name: updated_at + type: timestamp + description: "Time the store was last updated." From 24df2ab29b1e11ae6cbb76bdcc16ba83a3b3896c Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 15:58:35 +0800 Subject: [PATCH 09/10] Polish integrated vendor workflow metadata --- .../Cancel Order.request.yaml | 4 ++- ...reate Order from Service Quote.params.yaml | 2 +- ...eate Order from Service Quote.request.yaml | 4 ++- ...et Internal Service Quote.queryParams.yaml | 34 +++++++++---------- .../Get Internal Service Quote.request.yaml | 2 ++ ...te from Integrated Vendor.queryParams.yaml | 34 +++++++++---------- ... Quote from Integrated Vendor.request.yaml | 2 ++ .../Query Orders.queryParams.yaml | 4 +-- .../Query Orders.request.yaml | 2 ++ .../Query Places.queryParams.yaml | 4 +-- .../Query Places.request.yaml | 2 ++ .../Search Places.queryParams.yaml | 6 ++-- .../Search Places.request.yaml | 2 ++ 13 files changed, 58 insertions(+), 44 deletions(-) diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Cancel Order.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Cancel Order.request.yaml index 75fb9ff..550dc21 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Cancel Order.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Cancel Order.request.yaml @@ -1,4 +1,6 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/orders/order_mdy2Rog/cancel" +description: |- + Cancels the order created from the integrated vendor service quote workflow. +url: "{{base_url}}/{{namespace}}/orders/{{order_id}}/cancel" method: DELETE order: 7000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml index 533e820..c0dcaa2 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml @@ -3,4 +3,4 @@ fields: - name: service_quote type: string required: true - description: "Service quote ID used by the request." + description: "Public ID of the service quote to convert into an order." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.request.yaml index 104662d..3676c96 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Creates an order from a purchased service quote. Use this after selecting the integrated vendor quote returned by the service quote step. url: "{{base_url}}/{{namespace}}/orders" method: POST body: @@ -6,5 +8,5 @@ body: content: - type: text key: service_quote - value: quote_wadAVAw + value: "{{service_quote_id}}" order: 6000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml index 0a18471..ad8c7b5 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml @@ -2,52 +2,52 @@ $kind: params fields: - name: service_type type: string - description: "Service type code used for rating and dispatch logic." + description: "Integrated vendor service type code used for rating." - name: facilitator type: string - description: "Vendor or contact ID that facilitates the order." + description: "Public ID of the integrated vendor facilitator." - name: is_route_optimized type: boolean - description: "Is route optimized value for this get internal service quote.request.yaml request." + description: "Whether the integrated vendor should optimize waypoint order." - name: waypoints[0][name] type: string - description: "Waypoints[0][name] value for this get internal service quote.request.yaml request." + description: "Display name for the first waypoint." - name: waypoints[0][phone] type: string - description: "Waypoints[0][phone] value for this get internal service quote.request.yaml request." + description: "Contact phone number for the first waypoint." - name: waypoints[0][location][type] type: string - description: "Waypoints[0][location][type] value for this get internal service quote.request.yaml request." + description: "GeoJSON location type for the first waypoint." - name: waypoints[0][location][coordinates] type: string - description: "Waypoints[0][location][coordinates] value for this get internal service quote.request.yaml request." + description: "Longitude and latitude coordinates for the first waypoint." - name: waypoints[1][name] type: string - description: "Waypoints[1][name] value for this get internal service quote.request.yaml request." + description: "Display name for the second waypoint." - name: waypoints[1][phone] type: string - description: "Waypoints[1][phone] value for this get internal service quote.request.yaml request." + description: "Contact phone number for the second waypoint." - name: waypoints[1][location][type] type: string - description: "Waypoints[1][location][type] value for this get internal service quote.request.yaml request." + description: "GeoJSON location type for the second waypoint." - name: waypoints[1][location][coordinates] type: string - description: "Waypoints[1][location][coordinates] value for this get internal service quote.request.yaml request." + description: "Longitude and latitude coordinates for the second waypoint." - name: waypoints[2][name] type: string - description: "Waypoints[2][name] value for this get internal service quote.request.yaml request." + description: "Display name for the third waypoint." - name: waypoints[2][phone] type: string - description: "Waypoints[2][phone] value for this get internal service quote.request.yaml request." + description: "Contact phone number for the third waypoint." - name: waypoints[2][location][type] type: string - description: "Waypoints[2][location][type] value for this get internal service quote.request.yaml request." + description: "GeoJSON location type for the third waypoint." - name: waypoints[2][location][coordinates] type: string - description: "Waypoints[2][location][coordinates] value for this get internal service quote.request.yaml request." + description: "Longitude and latitude coordinates for the third waypoint." - name: specialRequests[0] type: string - description: "SpecialRequests[0] value for this get internal service quote.request.yaml request." + description: "First integrated vendor special request code." - name: specialRequests[1] type: string - description: "SpecialRequests[1] value for this get internal service quote.request.yaml request." + description: "Second integrated vendor special request code." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml index 7b44e0c..22b1283 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Requests a service quote using an internal integrated vendor facilitator and waypoint payload. url: "{{base_url}}/{{namespace}}/service-quotes" method: GET queryParams: diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml index be56511..7fa73cf 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml @@ -2,52 +2,52 @@ $kind: params fields: - name: service_type type: string - description: "Service type code used for rating and dispatch logic." + description: "Integrated vendor service type code used for rating." - name: facilitator type: string - description: "Vendor or contact ID that facilitates the order." + description: "Public ID of the integrated vendor facilitator." - name: is_route_optimized type: boolean - description: "Is route optimized value for this get service quote from integrated vendor.request.yaml request." + description: "Whether the integrated vendor should optimize waypoint order." - name: waypoints[0][name] type: string - description: "Waypoints[0][name] value for this get service quote from integrated vendor.request.yaml request." + description: "Display name for the first waypoint." - name: waypoints[0][phone] type: string - description: "Waypoints[0][phone] value for this get service quote from integrated vendor.request.yaml request." + description: "Contact phone number for the first waypoint." - name: waypoints[0][location][type] type: string - description: "Waypoints[0][location][type] value for this get service quote from integrated vendor.request.yaml request." + description: "GeoJSON location type for the first waypoint." - name: waypoints[0][location][coordinates] type: string - description: "Waypoints[0][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." + description: "Longitude and latitude coordinates for the first waypoint." - name: waypoints[1][name] type: string - description: "Waypoints[1][name] value for this get service quote from integrated vendor.request.yaml request." + description: "Display name for the second waypoint." - name: waypoints[1][phone] type: string - description: "Waypoints[1][phone] value for this get service quote from integrated vendor.request.yaml request." + description: "Contact phone number for the second waypoint." - name: waypoints[1][remarks] type: string - description: "Waypoints[1][remarks] value for this get service quote from integrated vendor.request.yaml request." + description: "Driver or vendor remarks for the second waypoint." - name: waypoints[1][location][type] type: string - description: "Waypoints[1][location][type] value for this get service quote from integrated vendor.request.yaml request." + description: "GeoJSON location type for the second waypoint." - name: waypoints[1][location][coordinates] type: string - description: "Waypoints[1][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." + description: "Longitude and latitude coordinates for the second waypoint." - name: waypoints[2][name] type: string - description: "Waypoints[2][name] value for this get service quote from integrated vendor.request.yaml request." + description: "Display name for the third waypoint." - name: waypoints[2][phone] type: string - description: "Waypoints[2][phone] value for this get service quote from integrated vendor.request.yaml request." + description: "Contact phone number for the third waypoint." - name: waypoints[2][remarks] type: string - description: "Waypoints[2][remarks] value for this get service quote from integrated vendor.request.yaml request." + description: "Driver or vendor remarks for the third waypoint." - name: waypoints[2][location][type] type: string - description: "Waypoints[2][location][type] value for this get service quote from integrated vendor.request.yaml request." + description: "GeoJSON location type for the third waypoint." - name: waypoints[2][location][coordinates] type: string - description: "Waypoints[2][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." + description: "Longitude and latitude coordinates for the third waypoint." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml index cb8e6c7..29cdf32 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Requests a route-optimized service quote from an integrated vendor using waypoint coordinates and optional stop remarks. url: "{{base_url}}/{{namespace}}/service-quotes" method: GET queryParams: diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml index 0928eae..cb6a44a 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml @@ -1,5 +1,5 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this query orders.request.yaml request." + type: integer + description: "Maximum number of orders to return." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml index 3d4d14b..cb20b0a 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Lists recent orders so you can verify the order created by the integrated vendor workflow. url: "{{base_url}}/{{namespace}}/orders" method: GET headers: diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml index 4a21c34..ba55eec 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml @@ -1,5 +1,5 @@ $kind: params fields: - name: limit - type: string - description: "Limit value for this query places.request.yaml request." + type: integer + description: "Maximum number of places to return." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml index 94874b3..44c9631 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Lists recent places that can be reused as waypoint or order locations during the workflow. url: "{{base_url}}/{{namespace}}/places" method: GET queryParams: diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml index 2144e8c..f07cc01 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml @@ -2,10 +2,10 @@ $kind: params fields: - name: ll type: string - description: "Ll value for this search places.request.yaml request." + description: "Latitude and longitude used as the search origin." - name: locale type: string - description: "Locale value for this search places.request.yaml request." + description: "Locale used to format place search results." - name: query type: string - description: "Query value for this search places.request.yaml request." + description: "Search text for the place lookup." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml index 747b2cc..896aff3 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml @@ -1,4 +1,6 @@ $kind: http-request +description: |- + Searches places near a latitude/longitude pair for use as workflow waypoint data. url: "{{base_url}}/{{namespace}}/places/search" method: GET headers: From 0cd92f04e4a05e58f5fd2b22130d29927b172a15 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Thu, 7 May 2026 16:04:22 +0800 Subject: [PATCH 10/10] Add resource header descriptions --- .../Fleetbase API/Contacts/.resources/definition.yaml | 2 ++ .../Fleetbase API/Drivers/.resources/definition.yaml | 2 ++ .../Fleetbase API/Entities/.resources/definition.yaml | 2 ++ .../Fleetbase API/Fleets/.resources/definition.yaml | 2 ++ .../Fleetbase API/Fuel Reports/.resources/definition.yaml | 2 ++ .../Fleetbase API/Geofences/.resources/definition.yaml | 2 ++ .../Fleetbase API/Issues/.resources/definition.yaml | 2 ++ .../Fleetbase API/Labels/.resources/definition.yaml | 2 ++ .../Fleetbase API/Onboard/.resources/definition.yaml | 2 ++ .../Fleetbase API/Orders/.resources/definition.yaml | 2 ++ .../Fleetbase API/Organizations/.resources/definition.yaml | 2 ++ .../Fleetbase API/Payloads/.resources/definition.yaml | 2 ++ .../Fleetbase API/Places/.resources/definition.yaml | 3 ++- .../Fleetbase API/Purchase Rates/.resources/definition.yaml | 2 ++ .../Fleetbase API/Service Areas/.resources/definition.yaml | 2 ++ .../Fleetbase API/Service Quotes/.resources/definition.yaml | 2 ++ .../Fleetbase API/Service Rates/.resources/definition.yaml | 2 ++ .../Fleetbase API/Tracking Numbers/.resources/definition.yaml | 2 ++ .../Tracking Statuses/.resources/definition.yaml | 2 ++ .../Fleetbase API/Vehicles/.resources/definition.yaml | 2 ++ .../Fleetbase API/Vendors/.resources/definition.yaml | 2 ++ .../Fleetbase API/Zones/.resources/definition.yaml | 4 +--- .../Chat Channels/.resources/definition.yaml | 2 ++ .../Fleetbase Core API/Comments/.resources/definition.yaml | 2 ++ .../Fleetbase Core API/Files/.resources/definition.yaml | 2 ++ .../Organizations/.resources/definition.yaml | 2 ++ .../.resources/definition.yaml | 2 ++ .../Public Invoices/.resources/definition.yaml | 2 ++ .../Fleetbase Ledger API/Wallet/.resources/definition.yaml | 2 ++ .../Fleetbase Ledger API/Webhooks/.resources/definition.yaml | 2 ++ .../Fleetbase Storefront API/Cart/.resources/definition.yaml | 2 ++ .../Category/.resources/definition.yaml | 2 ++ .../Checkout/.resources/definition.yaml | 2 ++ .../Customer/.resources/definition.yaml | 2 ++ .../Delivery Service Quote/.resources/definition.yaml | 2 ++ .../Food Trucks/.resources/definition.yaml | 2 ++ .../Orders/.resources/definition.yaml | 2 ++ .../Products/.resources/definition.yaml | 2 ++ .../Reviews/.resources/definition.yaml | 2 ++ .../Store Locations/.resources/definition.yaml | 2 ++ .../Fleetbase Storefront API/Store/.resources/definition.yaml | 2 ++ 41 files changed, 81 insertions(+), 4 deletions(-) diff --git a/postman/collections/Fleetbase API/Contacts/.resources/definition.yaml b/postman/collections/Fleetbase API/Contacts/.resources/definition.yaml index dcd7396..cec7abf 100644 --- a/postman/collections/Fleetbase API/Contacts/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Contacts/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Contacts represent customers, recipients, senders, and other people or organizations connected to logistics activity. Use contacts to attach identity, communication details, and default places to orders and payloads. order: 4000 diff --git a/postman/collections/Fleetbase API/Drivers/.resources/definition.yaml b/postman/collections/Fleetbase API/Drivers/.resources/definition.yaml index fa91a43..d4c8a7e 100644 --- a/postman/collections/Fleetbase API/Drivers/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Drivers/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Drivers are mobile workers who can be assigned to vehicles and orders. Use driver endpoints to manage driver profiles, authentication, devices, availability, tracking, and organization context. order: 7000 diff --git a/postman/collections/Fleetbase API/Entities/.resources/definition.yaml b/postman/collections/Fleetbase API/Entities/.resources/definition.yaml index 35c57ea..6ca1ec5 100644 --- a/postman/collections/Fleetbase API/Entities/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Entities/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Entities describe the individual goods, parcels, or items carried inside a payload. Use entities to capture dimensions, weight, declared value, tracking metadata, and customer ownership for shipment contents. order: 11000 diff --git a/postman/collections/Fleetbase API/Fleets/.resources/definition.yaml b/postman/collections/Fleetbase API/Fleets/.resources/definition.yaml index 88c421d..d88e496 100644 --- a/postman/collections/Fleetbase API/Fleets/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Fleets/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Fleets group vehicles and drivers under an operating unit. Use fleets to organize capacity by team, region, or service area before assigning resources to orders. order: 9000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml index 7f9cc0c..ba08bf1 100644 --- a/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Fuel reports record vehicle refueling events and fuel costs. Use them to track fuel purchases, odometer context, and operational expenses for fleet vehicles. order: 7700 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml b/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml index 8392130..f008ff9 100644 --- a/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Geofences detect when tracked resources enter or leave defined geographic areas. Use geofence endpoints to monitor location-based events around depots, service areas, customer sites, and operational zones. order: 8050 diff --git a/postman/collections/Fleetbase API/Issues/.resources/definition.yaml b/postman/collections/Fleetbase API/Issues/.resources/definition.yaml index a9d80d8..95ed844 100644 --- a/postman/collections/Fleetbase API/Issues/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Issues/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Issues capture operational problems reported against orders, drivers, vehicles, or other resources. Use issues to track incidents, exceptions, and resolution status during fulfillment. order: 7600 diff --git a/postman/collections/Fleetbase API/Labels/.resources/definition.yaml b/postman/collections/Fleetbase API/Labels/.resources/definition.yaml index 015248f..9c4aa1c 100644 --- a/postman/collections/Fleetbase API/Labels/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Labels/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Labels generate printable shipment labels for Fleetbase resources. Use label endpoints to render carrier, order, payload, or entity data into label output for fulfillment workflows. order: 13000 diff --git a/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml b/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml index 9668770..54b6741 100644 --- a/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Onboarding endpoints support initial API setup flows. Use them when a workflow needs to bootstrap or verify account context before consuming operational resources. order: 13100 diff --git a/postman/collections/Fleetbase API/Orders/.resources/definition.yaml b/postman/collections/Fleetbase API/Orders/.resources/definition.yaml index 7a11f3d..be97f22 100644 --- a/postman/collections/Fleetbase API/Orders/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Orders/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + 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. order: 8000 diff --git a/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml b/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml index 4b9abd9..c47298f 100644 --- a/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Organizations define the company context for API activity. Use organization endpoints to inspect the account associated with the current credential. order: 500 diff --git a/postman/collections/Fleetbase API/Payloads/.resources/definition.yaml b/postman/collections/Fleetbase API/Payloads/.resources/definition.yaml index a51c152..57d08f9 100644 --- a/postman/collections/Fleetbase API/Payloads/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Payloads/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Payloads describe what an order is carrying and where it moves from pickup to dropoff. Use payload endpoints to manage shipment contents, payment details, and the entities attached to an order. order: 10000 diff --git a/postman/collections/Fleetbase API/Places/.resources/definition.yaml b/postman/collections/Fleetbase API/Places/.resources/definition.yaml index ddd8639..3227924 100644 --- a/postman/collections/Fleetbase API/Places/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Places/.resources/definition.yaml @@ -1,3 +1,4 @@ $kind: collection -description: Place represents a location, places are typically addresses, but can also be objects or landmarks as long as the `Place` has coordinates. +description: |- + Places represent physical locations used across routing, dispatch, contacts, stores, and orders. A place can be a street address, landmark, facility, or any coordinate-backed location Fleetbase can route to. order: 1000 diff --git a/postman/collections/Fleetbase API/Purchase Rates/.resources/definition.yaml b/postman/collections/Fleetbase API/Purchase Rates/.resources/definition.yaml index 5ee6550..5d2ceec 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Purchase rates record the cost paid to acquire capacity or services from carriers, vendors, and integrated providers. Use them to compare buy-side costs against customer-facing service rates. order: 14000 diff --git a/postman/collections/Fleetbase API/Service Areas/.resources/definition.yaml b/postman/collections/Fleetbase API/Service Areas/.resources/definition.yaml index 6522e17..67cbcd8 100644 --- a/postman/collections/Fleetbase API/Service Areas/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Service Areas/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Service areas define the geographic regions where a fleet, vendor, or storefront operates. Use service areas to constrain availability, pricing, routing, and dispatch behavior by region. order: 2000 diff --git a/postman/collections/Fleetbase API/Service Quotes/.resources/definition.yaml b/postman/collections/Fleetbase API/Service Quotes/.resources/definition.yaml index 015248f..433d742 100644 --- a/postman/collections/Fleetbase API/Service Quotes/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Service Quotes/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Service quotes price a requested movement before an order is created. Use quotes to estimate delivery cost, select a service type or facilitator, and convert accepted pricing into an order. order: 13000 diff --git a/postman/collections/Fleetbase API/Service Rates/.resources/definition.yaml b/postman/collections/Fleetbase API/Service Rates/.resources/definition.yaml index ac1749f..60273b4 100644 --- a/postman/collections/Fleetbase API/Service Rates/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Service Rates/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Service rates define sell-side pricing rules for delivery and logistics services. Use service rates to configure how quotes are calculated from distance, time, zones, service areas, and service types. order: 12000 diff --git a/postman/collections/Fleetbase API/Tracking Numbers/.resources/definition.yaml b/postman/collections/Fleetbase API/Tracking Numbers/.resources/definition.yaml index 65883a4..9e508fb 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Tracking numbers identify shipments, payloads, and scannable workflow artifacts. Use tracking number endpoints to create identifiers, decode QR data, and attach trackable references to operations. order: 15000 diff --git a/postman/collections/Fleetbase API/Tracking Statuses/.resources/definition.yaml b/postman/collections/Fleetbase API/Tracking Statuses/.resources/definition.yaml index 45a4c01..bb8d7b8 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Tracking statuses define the customer-facing milestones shown during shipment tracking. Use them to create and manage the status labels, codes, and descriptions surfaced in tracking flows. order: 16000 diff --git a/postman/collections/Fleetbase API/Vehicles/.resources/definition.yaml b/postman/collections/Fleetbase API/Vehicles/.resources/definition.yaml index b6d8d5b..03b466e 100644 --- a/postman/collections/Fleetbase API/Vehicles/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Vehicles/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Vehicles represent fleet assets that can be tracked, assigned, and used to fulfill orders. Use vehicle endpoints to manage registration details, assignment state, live location, and operational status. order: 6000 diff --git a/postman/collections/Fleetbase API/Vendors/.resources/definition.yaml b/postman/collections/Fleetbase API/Vendors/.resources/definition.yaml index afdeb9a..ed70877 100644 --- a/postman/collections/Fleetbase API/Vendors/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Vendors/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Vendors represent external service providers, carriers, or partners that can support fulfillment. Use vendors to model third-party capacity, contact details, and service relationships. order: 5000 diff --git a/postman/collections/Fleetbase API/Zones/.resources/definition.yaml b/postman/collections/Fleetbase API/Zones/.resources/definition.yaml index 7484675..c0fb6e5 100644 --- a/postman/collections/Fleetbase API/Zones/.resources/definition.yaml +++ b/postman/collections/Fleetbase API/Zones/.resources/definition.yaml @@ -1,6 +1,4 @@ $kind: collection description: |- - Zone represents a boundry within a Service Area to limit your fleet operataations to a specific area. - - The Zone boundy can also be visually styled and represented to stand out in your service area views. + Zones define boundaries inside a service area for pricing, dispatch, and operational control. Use zones to model neighborhoods, delivery regions, restricted areas, or styled map overlays. order: 3000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml index 40bbb1c..1fb0e89 100644 --- a/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Chat channels organize conversations between users and participants in an organization. Use chat channel endpoints to create rooms, send messages, manage participants, and record read receipts. order: 3000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml index dcd7396..acc98b9 100644 --- a/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml +++ b/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Comments attach discussion to Fleetbase resources or reply to existing comments. Use comment endpoints to create threaded context around orders, files, operational records, and other subject models. order: 4000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml index 6522e17..9ac96f5 100644 --- a/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml +++ b/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Files store uploaded documents, images, and other binary assets used across Fleetbase. Use file endpoints to upload, retrieve, download, update, and attach file metadata to other resources. order: 2000 diff --git a/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml index 53d990d..2752e7e 100644 --- a/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml +++ b/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Organizations expose the company context tied to the current API credential. Use this resource to confirm which organization a request is scoped to. order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/definition.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/definition.yaml index 732b6a6..988dfee 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/.resources/definition.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/definition.yaml @@ -1,4 +1,6 @@ $kind: collection +description: |- + This workflow shows how to quote, create, inspect, and cancel an order that uses an integrated vendor. Follow the steps in order to move from place lookup through service quote selection and order creation. variables: base_url: "" namespace: v1 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml index 6522e17..6f99070 100644 --- a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Public invoices let customers view and pay invoices without signing in to Fleetbase. Use these endpoints to retrieve invoice details, list available gateways, and start or record payment. order: 2000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml index 53d990d..d5d95b1 100644 --- a/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Wallet endpoints expose the authenticated subject's balance and transaction history. Use wallets to retrieve current funds, inspect ledger activity, and initiate top-ups through a configured gateway. order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml index 40bbb1c..07da0e9 100644 --- a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml +++ b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Webhooks receive payment gateway events and normalize them for Ledger processing. Use this resource to understand the callback shape Fleetbase expects from configured gateway drivers. order: 3000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/definition.yaml index 53d990d..c7aea0f 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Carts hold the products a storefront customer intends to purchase. Use cart endpoints to create or retrieve a cart, add or update line items, empty the cart, and prepare it for checkout. order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Category/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Category/.resources/definition.yaml index 40bbb1c..d199fc2 100644 --- a/postman/collections/Fleetbase Storefront API/Category/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Category/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Categories organize storefront products for browsing and discovery. Use category endpoints to list product groupings exposed by a store or network. order: 3000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Checkout/.resources/definition.yaml index 7a11f3d..34c2141 100644 --- a/postman/collections/Fleetbase Storefront API/Checkout/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Checkout endpoints turn a cart into a payable order flow. Use them to initialize gateway-specific payment data, check checkout status, capture payment callbacks, and create orders from completed checkouts. order: 8000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Customer/.resources/definition.yaml index dcd7396..914ccb8 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Customers represent storefront shoppers and their authentication context. Use customer endpoints to create accounts, authenticate with SMS or social providers, manage devices, addresses, orders, and account closure. order: 4000 diff --git a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/definition.yaml index fa91a43..a84c2a7 100644 --- a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Delivery service quotes estimate the fulfillment cost for a storefront cart. Use this endpoint before checkout when an order requires delivery instead of pickup. order: 7000 diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml index 5e46d3b..332aa75 100644 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Food trucks expose mobile storefront availability backed by FleetOps vehicles, zones, and service areas. Use food truck endpoints to discover mobile vendors and their current operating state. order: 5500 diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml index fa91a43..1cc872c 100644 --- a/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Storefront order endpoints expose customer-facing actions after checkout. Use them to mark pickup orders complete and retrieve receipts for supported payment methods. order: 7000 diff --git a/postman/collections/Fleetbase Storefront API/Products/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Products/.resources/definition.yaml index 6522e17..de42c49 100644 --- a/postman/collections/Fleetbase Storefront API/Products/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Products are the items and services customers can browse and add to carts. Use product endpoints to list, retrieve, create, or update catalog items with pricing, media, variants, addons, and availability. order: 2000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Reviews/.resources/definition.yaml index 88c421d..eaae823 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Reviews capture customer ratings and feedback for storefront resources. Use review endpoints to create, retrieve, count, query, and remove customer feedback. order: 9000 diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/definition.yaml index b6d8d5b..b5df4e7 100644 --- a/postman/collections/Fleetbase Storefront API/Store Locations/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Store locations connect a storefront to physical places and operating hours. Use location endpoints to list or inspect where a store can fulfill pickup, delivery, or local service. order: 6000 diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/definition.yaml index afdeb9a..178b988 100644 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/definition.yaml @@ -1,2 +1,4 @@ $kind: collection +description: |- + Store endpoints describe the active storefront or network being browsed. Use them to retrieve store profile data, locations, payment gateways, tags, search results, and network store listings. order: 5000