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..82a6080 --- /dev/null +++ b/postman/collections/Fleetbase API/Contacts/.resources/object.yaml @@ -0,0 +1,37 @@ +$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 8aa011f..8fb0745 100644 --- a/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Delete a Contact.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Delete a Contact. +description: |- + Deletes a contacts resource. The response confirms the resource that was removed. 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 d36c549..b3b45d3 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 a paginated list of contacts for the current organization. Use filters such as `query`, `limit`, `offset`, and `sort` to narrow and order the results. + Returns contacts matching the supplied filters. Use pagination and query parameters to control the result set. 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 b77a73a..7a568cc 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. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..722043f --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Get Driver Current Organization.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..c2b2aa8 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/List Driver Organizations.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..213de7d --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Login Driver.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..90a4f00 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Register Device.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..1372256 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Register Driver Device.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..122656a --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Request Driver Login SMS.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..70699ec --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Simulate Driver Route.resources/examples/Successful Response.example.yaml @@ -0,0 +1,40 @@ +$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 new file mode 100644 index 0000000..ab57b73 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Switch Driver Organization.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..02986f8 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Toggle Driver Online.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..51fdd2c --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Track Driver.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..ffa31a5 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/Verify Driver Login Code.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..0b0c221 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/.resources/object.yaml @@ -0,0 +1,37 @@ +$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 434089f..9f1db2e 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. The response returns the created resource with its generated identifier. 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..6b255ed --- /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: "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 e2e9da3..759296c 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 matching the supplied filters. Use pagination and query parameters to control 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..575e07f --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Device.params.yaml @@ -0,0 +1,9 @@ +$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 new file mode 100644 index 0000000..575e07f --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Driver Device.params.yaml @@ -0,0 +1,9 @@ +$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 new file mode 100644 index 0000000..946203d --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.params.yaml @@ -0,0 +1,5 @@ +$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 f4256ae..958ee30 100644 --- a/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Retrieve a Driver.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: |- + Retrieves a driver. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..2cabdc9 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.params.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..c66fd62 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.params.yaml @@ -0,0 +1,5 @@ +$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 new file mode 100644 index 0000000..3106928 --- /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 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 new file mode 100644 index 0000000..b2e6a11 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.params.yaml @@ -0,0 +1,10 @@ +$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 new file mode 100644 index 0000000..930b694 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/.resources/Query Entities.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..a67de50 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 773dfc7..2393847 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 entities resource. The response returns the created resource with its generated identifier. 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 eb79034..6ed783c 100644 --- a/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Delete a Entity.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Delete an Entity. +description: |- + Deletes an entities resource. The response confirms the resource that was removed. 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 5fac046..1525a7c 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 entities resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..ef317ce --- /dev/null +++ b/postman/collections/Fleetbase API/Fleets/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 3f67352..f0feee1 100644 --- a/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Delete a Fleet.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Deletes a fleet. +description: |- + Deletes a fleets resource. The response confirms the resource that was removed. 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 56022f0..7eae45c 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 a paginated list of fleets for the current organization. Use pagination and sorting parameters to control the result set. + Returns fleets matching the supplied filters. Use pagination and query 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 0fa052f..9ba452d 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. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..84bed6a --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/Create a Fuel Report.resources/examples/Successful Response.example.yaml @@ -0,0 +1,39 @@ +$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 new file mode 100644 index 0000000..1e810c0 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/Delete a Fuel Report.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..636da3c --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/Query Fuel Reports.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..a414a21 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/Retrieve a Fuel Report.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..f148760 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/Update a Fuel Report.resources/examples/Successful Response.example.yaml @@ -0,0 +1,36 @@ +$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 new file mode 100644 index 0000000..48e726a --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 70b5679..50d6651 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,5 +1,6 @@ $kind: http-request -description: "Create a Fuel Report" +description: |- + Creates a fuel reports resource. The response returns the created resource with its generated identifier. 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 4013917..9aa0e32 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,5 +1,6 @@ $kind: http-request -description: "Delete a Fuel Report" +description: |- + Deletes a fuel reports resource. The response confirms the resource that was removed. 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 dffc1a8..519c3f2 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,5 +1,6 @@ $kind: http-request -description: "Query Fuel Reports" +description: |- + Returns fuel reports matching the supplied filters. Use pagination and query parameters to control the result set. 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 4d00050..6dc6537 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,5 +1,6 @@ $kind: http-request -description: "Retrieve a Fuel Report" +description: |- + Retrieves a fuel report. The response includes the current API representation of the resource. 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 073156a..4e8a1f6 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,5 +1,6 @@ $kind: http-request -description: "Update a Fuel Report" +description: |- + Updates a fuel reports resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..db10fbf --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/Get Driver Geofence History.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..a483570 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Dwell Report.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..dcfa767 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/Get Geofence Inventory.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..18c7e10 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/List Geofence Events.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..a972daf --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 9e663cc..3a5a5be 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,5 +1,6 @@ $kind: http-request -description: "Get Driver Geofence History" +description: |- + Retrieves a geofence. The response includes the current API representation of the resource. 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 58b3b65..c9074e9 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,5 +1,6 @@ $kind: http-request -description: "Get Geofence Dwell Report" +description: |- + Retrieves a geofence. The response includes the current API representation of the resource. 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 858d4da..9ca22fa 100644 --- a/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Get Geofence Inventory" +description: |- + Retrieves a geofence. The response includes the current API representation of the resource. 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 08f3c60..9069604 100644 --- a/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml +++ b/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "List Geofence Events" +description: |- + Returns geofences matching the supplied filters. Use pagination and query parameters to control the result set. 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 new file mode 100644 index 0000000..400173e --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/Create an Issue.resources/examples/Successful Response.example.yaml @@ -0,0 +1,38 @@ +$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 new file mode 100644 index 0000000..92f2099 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/Delete an Issue.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..ee5a20b --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/Query Issues.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..a1e28b4 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/Retrieve an Issue.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..0551104 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/Update an Issue.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..b92d7de --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 af0443a..46ef60a 100644 --- a/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Create an Issue" +description: |- + Creates an issues resource. The response returns the created resource with its generated identifier. 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 28124df..a89a779 100644 --- a/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Delete an Issue" +description: |- + Deletes an issues resource. The response confirms the resource that was removed. 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 5ef773e..5f68337 100644 --- a/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Query Issues" +description: |- + Returns issues matching the supplied filters. Use pagination and query parameters to control the result set. 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 8e0209b..a10207d 100644 --- a/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Retrieve an Issue" +description: |- + Retrieves a issue. The response includes the current API representation of the resource. 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 444f164..edbf1f4 100644 --- a/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml +++ b/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: "Update an Issue" +description: |- + Updates an issues resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..bfaf840 --- /dev/null +++ b/postman/collections/Fleetbase API/Labels/.resources/Render Label.resources/examples/Successful Response.example.yaml @@ -0,0 +1,27 @@ +$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 new file mode 100644 index 0000000..f355ecb --- /dev/null +++ b/postman/collections/Fleetbase API/Labels/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..7f0cad1 --- /dev/null +++ b/postman/collections/Fleetbase API/Onboard/.resources/Get Driver Onboard Settings.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..b3f7344 --- /dev/null +++ b/postman/collections/Fleetbase API/Onboard/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..61542cd --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Cancel an Order-.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..46611e8 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture Photo for Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,43 @@ +$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 new file mode 100644 index 0000000..2e4538d --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture QR Code for Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,40 @@ +$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 new file mode 100644 index 0000000..0499aeb --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Capture Signature for Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,39 @@ +$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 new file mode 100644 index 0000000..50ec484 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Complete an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..350096d --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Delete an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..aec6912 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Dispatch an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..8df99c6 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Editable Entity Fields.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..fbee95f --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Distance and Time.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..6964e8c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order ETA.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..bd97f8e --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Next Activity.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..539d4a2 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Get Order Tracker.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..a65eed5 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/List Order Comments.resources/examples/Successful Response.example.yaml @@ -0,0 +1,39 @@ +$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 new file mode 100644 index 0000000..93ae33d --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/List Order Proofs.resources/examples/Successful Response.example.yaml @@ -0,0 +1,40 @@ +$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 new file mode 100644 index 0000000..fd5777c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Query Orders.resources/examples/Successful Response.example.yaml @@ -0,0 +1,42 @@ +$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 new file mode 100644 index 0000000..86699cf --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Schedule an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,39 @@ +$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 new file mode 100644 index 0000000..dc51bfc --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Set Order Destination.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..8711fd9 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Start an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..ef299c7 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Update Order Activity.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..329151b --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/Update an Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..a9ddfc2 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/.resources/object.yaml @@ -0,0 +1,53 @@ +$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 new file mode 100644 index 0000000..e68d58f --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.params.yaml @@ -0,0 +1,11 @@ +$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 new file mode 100644 index 0000000..2d21771 --- /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: "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 e194292..5eff48b 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 includes the updated proof data associated with the order. + Captures a QR code proof for an order or order subject. The response returns the 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 new file mode 100644 index 0000000..0bea175 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.params.yaml @@ -0,0 +1,8 @@ +$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 80cabdc..25264c8 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 this when a workflow requires signed proof of delivery or pickup. + Captures a signature proof for an order or order subject. Use it when a workflow requires signed proof of pickup or delivery. 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 7a93c7e..043e705 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,6 @@ $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. - - 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. + Creates an orders resource. The response returns the created resource with its generated identifier. 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 0605575..5292718 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 after dispatch state has been applied. + Dispatches an order to an assigned or eligible driver. The response returns the order with dispatch state 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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.params.yaml @@ -0,0 +1,8 @@ +$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 cc66b8b..91b70f4 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: |- - Returns the next workflow activity for an order. Use it to determine the next operational step available to the assigned driver or dispatcher. + Retrieves a order. The response includes the current API representation of the resource. 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 840c8c7..017a8b4 100644 --- a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: List all orders. +description: |- + Returns orders matching the supplied filters. Use pagination and query parameters to control the result set. 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 new file mode 100644 index 0000000..964abd9 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Schedule an Order.params.yaml @@ -0,0 +1,11 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Set Order Destination.params.yaml @@ -0,0 +1,8 @@ +$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 f9b6753..8ad331b 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 waypoint or place for an order. The response returns the updated order after the destination is changed. + Sets the destination place for an order. The response returns the order after the destination has been updated. 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 new file mode 100644 index 0000000..ccfca5c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Start an Order.params.yaml @@ -0,0 +1,5 @@ +$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 3f94612..e17573d 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 transitions it into active execution. Use this when a driver or dispatcher begins fulfillment. + Starts an order and moves it into active fulfillment. Use this when a driver or dispatcher begins work on the order. 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 c0ce834..b230572 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 the current activity state for an order. The response returns the order with the latest workflow activity applied. + Updates an orders resource. Parameters not supplied remain unchanged. 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 429de46..17501a0 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 orders resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..835f172 --- /dev/null +++ b/postman/collections/Fleetbase API/Organizations/.resources/List Organizations.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..1542ba4 --- /dev/null +++ b/postman/collections/Fleetbase API/Organizations/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..d076097 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/Delete a Payload.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..6e1bdeb --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/Query Payloads.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..7157b3f --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/Retrieve a Payload.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..221dccc --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/Update a Payload.resources/examples/Successful Response.example.yaml @@ -0,0 +1,49 @@ +$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 new file mode 100644 index 0000000..722e4e0 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 a4d3d1c..d71601a 100644 --- a/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Create a Payload.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a Payload. +description: |- + Creates a payload. The response returns the created resource with its generated identifier. 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 da58971..d9d9fe2 100644 --- a/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml +++ b/postman/collections/Fleetbase API/Payloads/Delete a Payload.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Delete a Payload. +description: |- + Deletes a payloads resource. The response confirms the resource that was removed. 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 3958b31..f0d7daa 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. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..b563607 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/Create a Place.resources/examples/Successful Response.example.yaml @@ -0,0 +1,42 @@ +$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 new file mode 100644 index 0000000..72a0fae --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/List all Places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..a623c7d --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/Query Places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,38 @@ +$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 new file mode 100644 index 0000000..0af449d --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/Retrieve a Place.resources/examples/Successful Response.example.yaml @@ -0,0 +1,27 @@ +$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 new file mode 100644 index 0000000..bc13b49 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/Search Places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..2836cff --- /dev/null +++ b/postman/collections/Fleetbase API/Places/.resources/object.yaml @@ -0,0 +1,40 @@ +$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 9782a96..bdd6b0a 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. The response returns the created resource with its generated identifier. 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 77576aa..3e9cb69 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 a paginated list of places for the current organization. Places are sorted by creation date unless another sort order is provided. + Returns places matching the supplied filters. Use pagination and query parameters to control the result set. 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 bbeb3e3..404eec4 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: |- - Searches and filters places for the current organization. Use query and pagination parameters to find matching saved locations. + Returns places matching the supplied filters. Use pagination and query parameters to control the result set. 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 5302274..28c5dc6 100644 --- a/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml +++ b/postman/collections/Fleetbase API/Places/Retrieve a Place.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a place object to view it's details. +description: |- + Retrieves a place. The response includes the current API representation of the resource. 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 d961772..b2f8eea 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. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..6f38251 --- /dev/null +++ b/postman/collections/Fleetbase API/Purchase Rates/.resources/Query Purchase Rates.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..42a600a --- /dev/null +++ b/postman/collections/Fleetbase API/Purchase Rates/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 3dbb7a2..7a3b520 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,5 +1,6 @@ $kind: http-request -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. +description: |- + Returns purchase rates matching the supplied filters. Use pagination and query parameters to control the result set. 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 3e74d46..0702940 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,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a purchase-rate object to view it's details. +description: |- + Retrieves a purchase rate. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..4c91aa5 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/.resources/Create a Service Area.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..85d53a8 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/.resources/Query Service Areas.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..e231a3f --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 791f326..a0d75c7 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,8 +1,6 @@ $kind: http-request description: |- - 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. + Creates a service areas resource. The response returns the created resource with its generated identifier. 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 9521202..5235740 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 this to find configured operating regions by name or other query parameters. + Returns service areas matching the supplied filters. Use pagination and query parameters to control the result set. 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 cf1249a..74fcd6d 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,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a service area object to view it's details. +description: |- + Retrieves a service area. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..f8bddd2 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Quotes/.resources/Retrieve a Service Quote.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..a37f4cd --- /dev/null +++ b/postman/collections/Fleetbase API/Service Quotes/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.params.yaml @@ -0,0 +1,8 @@ +$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 68d007c..757860e 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,8 +1,6 @@ $kind: http-request description: |- - 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. + Returns service quotes matching the supplied filters. Use pagination and query parameters to control the result set. 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 new file mode 100644 index 0000000..af0be32 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/Create a Service Rate.resources/examples/Successful Response.example.yaml @@ -0,0 +1,65 @@ +$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 new file mode 100644 index 0000000..aec0c60 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/Delete a Service Rate.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..b637877 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/Query Service Rates.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..2516dcd --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/Retrieve a Service Rate.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..7ca7f2f --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/Update a Service Rate.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..7784ecf --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Delete a Service Rate.params.yaml @@ -0,0 +1,8 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.params.yaml @@ -0,0 +1,8 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Retrieve a Service Rate.params.yaml @@ -0,0 +1,8 @@ +$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 new file mode 100644 index 0000000..a4edd67 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/.resources/Decode Tracking Number QR.resources/examples/Successful Response.example.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..090a5d7 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 5b5e7a4..f6b682e 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,5 +1,6 @@ $kind: http-request -description: | +description: |- + Creates a tracking numbers resource. The response returns the created resource with its generated identifier. 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 new file mode 100644 index 0000000..c4e9cce --- /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: "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 new file mode 100644 index 0000000..91a285a --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/Delete a Tracking Number.params.yaml @@ -0,0 +1,11 @@ +$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 41289ef..83b4acd 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,5 +1,6 @@ $kind: http-request -description: | +description: |- + Deletes a tracking numbers resource. The response confirms the resource that was removed. 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 99306aa..2da6415 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,5 +1,6 @@ $kind: http-request -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. +description: |- + Returns tracking numbers matching the supplied filters. Use pagination and query parameters to control the result set. 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 cbaa89e..6460e5c 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: | - This endpoint allows you to retrieve a tracking-number object to view it's details. +description: |- + Retrieves a tracking number. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..0dbf44c --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Statuses/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 9631177..58bbb58 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 an existing tracking status. The response returns the tracking status with the new values applied. + Updates a tracking statuses resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..9ffc477 --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/.resources/Track Vehicle.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..5473947 --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/.resources/object.yaml @@ -0,0 +1,37 @@ +$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 0dfdc28..2920fba 100644 --- a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to query vehicles you have created, it also provides paginated results on all the vehicles in your Fleetbase. +description: |- + Returns vehicles matching the supplied filters. Use pagination and query parameters to control the result set. 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 beaf351..6b7fc5e 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. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..38f4ac5 --- /dev/null +++ b/postman/collections/Fleetbase API/Vendors/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 90f0e89..a544839 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. The response returns the created resource with its generated identifier. 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 823c1bb..d0f08c9 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 matching the supplied filters. Use pagination and query parameters to control the result set. 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 2c45acb..9f92280 100644 --- a/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Retrieve a Vendor.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: |- + Retrieves a vendor. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..f5c8f4c --- /dev/null +++ b/postman/collections/Fleetbase API/Zones/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 893ab6e..49bc770 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 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. + Creates a zone. The response returns the created resource with its generated identifier. 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 ae634f3..038a72c 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 this to find configured geofences by name or other query parameters. + Returns zones matching the supplied filters. Use pagination and query parameters to control the result set. 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 473b66a..e1ace8b 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 single zone by ID. The response includes the zone geometry, display styling, and service area relationship. + Retrieves a zone. The response includes the current API representation of the resource. 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 4c39e1d..ea32d84 100644 --- a/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Update a Zone.request.yaml @@ -1,7 +1,6 @@ $kind: http-request -description: |+ - You can update all properties of the Zone. - +description: |- + Updates a zone. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..97e374e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Add Participant.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..5f5190f --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Chat Channel.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..79f427d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Create Read Receipt.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..4cb8823 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Chat Channel.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..b7484f0 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Delete Message.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..3033829 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/List Available Participants.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..c0daec3 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Query Chat Channels.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..64a3e76 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Remove Participant.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..f7687d3 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Retrieve Chat Channel.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..8fb6443 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Send Message.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..544beb0 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/Update Chat Channel.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..93ea78d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..5dae897 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.params.yaml @@ -0,0 +1,5 @@ +$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 837fa51..3dcfc89 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 participant to a chat channel. The response returns the updated channel membership. 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 5d75a1f..7f47db0 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 channels resource. The response returns the created resource with its generated identifier. 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 7d96366..7a0ec29 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: |- + Creates a chat channels resource. The response returns the created resource with its generated identifier. 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..d90f8b3 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 channels resource. The response confirms the resource that was removed. 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..a33bbb3 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 channels resource. The response confirms the resource that was removed. 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..5e87fa2 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: |- + Returns chat channels matching the supplied filters. Use pagination and query parameters to control the result set. 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..12a2bb2 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 matching the supplied filters. Use pagination and query parameters to control 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..d26dcba 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: |- + Deletes a chat channels resource. The response confirms the resource that was removed. 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..8d9e525 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. The response includes the current API representation of the resource. 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..0d6c414 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.params.yaml @@ -0,0 +1,11 @@ +$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 408f880..61cd083 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. The response returns the created chat 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 3588970..8b521d3 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 channels resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..ec67232 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/Create Comment.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..b3484d6 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/Delete Comment.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..fe52a7a --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/Query Comments.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..309f820 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/Retrieve Comment.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..0c4ddd5 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/Update Comment.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..dffdecb --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 6275fb4..dfdb86f 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. The response returns the created resource with its generated identifier. 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..27a6ec2 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 comments resource. The response confirms the resource that was removed. 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..6ba297c 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 matching the supplied filters. Use pagination and query parameters to control 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..f21f23c 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. The response includes the current API representation of the resource. 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 03fa4bb..ab70bdd 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 a comment. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..582efba --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Delete a File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..25e4102 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Download File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..ce1046b --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Query Files.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..da3359e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Retrieve a File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..6a07c3f --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Update File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..bc9af2d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Upload Base64 File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..256879e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/Upload File.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..80c3e4a --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 e1e8d5e..6902fd3 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 files resource. The response confirms the resource that was removed. 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..d8f4939 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 a file by ID. The response returns the file payload or download metadata. 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..e469215 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 files matching the supplied filters. Use pagination and query parameters to control 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..2b198de 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. The response includes the current API representation of the resource. 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 8c8456e..c27fcc4 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. Parameters not supplied remain unchanged. 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..a282452 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.params.yaml @@ -0,0 +1,17 @@ +$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 639e645..5cbf66a 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: |- + Uploads a file from base64-encoded content. The response returns the created file resource. 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 ab63486..5ff4a3a 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 file using multipart form data. The response returns the created file resource. 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 new file mode 100644 index 0000000..b6a2076 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Organizations/.resources/Get Current Organization.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..1542ba4 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Organizations/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..96ae76d --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Cancel Order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,20 @@ +$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 new file mode 100644 index 0000000..c153c5e --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Create Order from Service Quote.resources/examples/Successful Response.example.yaml @@ -0,0 +1,28 @@ +$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 new file mode 100644 index 0000000..cad47c9 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Internal Service Quote.resources/examples/Successful Response.example.yaml @@ -0,0 +1,40 @@ +$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 new file mode 100644 index 0000000..3eb166d --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Get Service Quote from Integrated Vendor.resources/examples/Successful Response.example.yaml @@ -0,0 +1,40 @@ +$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 new file mode 100644 index 0000000..f938db0 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Orders.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..4380818 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Query Places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..e00f08d --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/.resources/Search Places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..205b58f --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Get Public Invoice.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..ab52a55 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/List Public Invoice Gateways.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..88dcfd6 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/Pay Public Invoice.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..df0fb09 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/object.yaml @@ -0,0 +1,37 @@ +$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 9d61dd4..ab367a4 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 a public invoice. The response includes the current API representation of the resource. 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..7c67a92 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: |- + Returns public invoices matching the supplied filters. Use pagination and query parameters to control the result set. 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..628aec4 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.params.yaml @@ -0,0 +1,8 @@ +$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 3e11b74..9df7be8 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: |- + Pays a public invoice with the selected payment gateway. The response returns either a hosted checkout URL or the updated invoice payment state. 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 new file mode 100644 index 0000000..96e4069 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet Balance.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..aa5b30a --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Get Wallet.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..3ac5b1e --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/List Wallet Transactions.resources/examples/Successful Response.example.yaml @@ -0,0 +1,38 @@ +$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 new file mode 100644 index 0000000..2879275 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/Top Up Wallet.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..3947748 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/object.yaml @@ -0,0 +1,33 @@ +$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 389864e..e2f9542 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: |- + Retrieves a wallet. The response includes the current API representation of the resource. 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..899c783 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 a wallet. The response includes the current API representation of the resource. 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..706e190 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: |- + Returns wallet matching the supplied filters. Use pagination and query parameters to control the result set. 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..ce73ab1 --- /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: "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 a9c2fc4..bde6563 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 wallet through a payment gateway. The response returns the updated wallet and gateway transaction details. 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 new file mode 100644 index 0000000..0fa4f84 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/Handle Gateway Webhook.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..5ad4d3c --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..c8140ed --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.params.yaml @@ -0,0 +1,19 @@ +$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 f6dfc55..f26a79e 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 a payment gateway webhook and records the normalized ledger event. The response acknowledges the webhook so the gateway can stop retrying. 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 new file mode 100644 index 0000000..f965220 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Add Item to Cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..3d37a5f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Delete Cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..b6f0d09 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Empty cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..20ee764 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Remove item from cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,23 @@ +$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 new file mode 100644 index 0000000..5256e46 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve a Cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..fc5d708 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Retrieve or Create Cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..d2f4e89 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/Update item in Cart.resources/examples/Successful Response.example.yaml @@ -0,0 +1,27 @@ +$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 new file mode 100644 index 0000000..4d56ab7 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml @@ -0,0 +1,36 @@ +$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 new file mode 100644 index 0000000..104d424 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.params.yaml @@ -0,0 +1,17 @@ +$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 e46960e..13e75ca 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 cart 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 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 6a031dc..8c19aa4 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Delete Cart +description: |- + Deletes a cart resource. The response confirms the resource that was removed. 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 dceb2e8..131d57a 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 all line items from a cart. The response returns the emptied cart resource. + Removes every line item from the cart. The response returns the cart after its items have been cleared. 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 671fff6..6872b06 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: |- - Removes a line item or product from a cart. The response returns the updated cart after the item is removed. + Deletes a cart resource. The response confirms the resource that was 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 998c3ef..3c8c03d 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 an existing cart by its unique identifier. If the cart is still active, the response includes its current line items and totals. + Retrieves a cart. The response includes the current API representation of the resource. 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 161214a..5efdfae 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 the current cart or creates a new cart when no cart identifier is supplied. Use the returned cart ID for subsequent cart operations. + Retrieves a cart. The response includes the current API representation of the resource. 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 c6fb7b3..884a49f 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,5 +1,6 @@ $kind: http-request -description: |+ +description: |- + Updates a cart resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..4f08454 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Category/.resources/List categories.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..8163557 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Category/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 68be78e..6ee7636 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 product categories available to the current storefront. Use this list to organize product browsing and filtering. + Returns category matching the supplied filters. Use pagination and query parameters to control the result set. 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" new file mode 100644 index 0000000..9b0c89b --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Before \342\235\227.resources/examples/Successful Response.example.yaml" @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..6ee213b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback via GET.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..294b8a9 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture QPay Callback.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..b891af6 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Capture checkout as order.resources/examples/Successful Response.example.yaml @@ -0,0 +1,28 @@ +$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 new file mode 100644 index 0000000..84e3e62 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Create Stripe Setup Intent.resources/examples/Successful Response.example.yaml @@ -0,0 +1,28 @@ +$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 new file mode 100644 index 0000000..1cc47fb --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Get Checkout Status.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..e5b9da5 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/Update Stripe Payment Intent.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..f6dba74 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 050a86b..070c9c6 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 checkout for a cart, customer, gateway, and service quote. The response returns the checkout token or payment intent details required to complete payment. 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..04cf6a1 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 over GET. This variant is useful for gateway redirects and sandbox callback testing. 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..3289772 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.params.yaml @@ -0,0 +1,11 @@ +$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 14808a1..dc78616 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 and publishes the payment result for the checkout session. The response returns payment status details when a response is requested. 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..0ee40b8 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.params.yaml @@ -0,0 +1,6 @@ +$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 e1578e5..a323a43 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. The response returns the completed order or the existing order when the checkout was already captured. + Captures a checkout token and creates the corresponding order. If the checkout was already captured, the existing order is returned. 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 2bb4853..ec32097 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 checkout resource. The response returns the created resource with its generated identifier. 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..6f1f4f5 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: |- + Retrieves a checkout. The response includes the current API representation of the resource. 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..b7ad276 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: |- + Updates a checkout resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..5497800 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer via SMS.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..3dc2cdb --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Apple.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..bb93db2 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Facebook.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..abdd480 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer with Google.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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" new file mode 100644 index 0000000..c88cb30 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Customer/.resources/Authenticate a Customer \342\235\227.resources/examples/Successful Response.example.yaml" @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..d942e33 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Confirm Account Closure.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..80e3c74 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Create a Customer.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..57cc76b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Ephemeral Key.resources/examples/Successful Response.example.yaml @@ -0,0 +1,27 @@ +$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 new file mode 100644 index 0000000..5411aea --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Get Stripe Setup Intent.resources/examples/Successful Response.example.yaml @@ -0,0 +1,27 @@ +$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 new file mode 100644 index 0000000..32d9470 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer orders.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..17b7c29 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/List a customer saved places.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..041f72f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Query customers.resources/examples/Successful Response.example.yaml @@ -0,0 +1,31 @@ +$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 new file mode 100644 index 0000000..9837e07 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Register customer device.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..fdf3b7f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Request Phone Verification.resources/examples/Successful Response.example.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..3b97877 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Retrieve a Customer.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..86cbb36 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Setups a verification request to create a new storefront custome.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..fb0fa08 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Start Account Closure.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..3fb0fd6 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Update Contact Customer Alias.resources/examples/Successful Response.example.yaml @@ -0,0 +1,33 @@ +$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 new file mode 100644 index 0000000..18432e6 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Update a Customer.resources/examples/Successful Response.example.yaml @@ -0,0 +1,28 @@ +$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 new file mode 100644 index 0000000..115d3d0 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify Phone Number.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..76fe236 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/Verify a SMS code.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..4ec94e0 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/.resources/object.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.params.yaml @@ -0,0 +1,8 @@ +$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 50b0752..c4ee910 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 verification code that can be exchanged for an auth token. + Starts SMS authentication for an existing storefront customer. The customer receives a code that can be exchanged for an access 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 new file mode 100644 index 0000000..918f1c1 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.params.yaml @@ -0,0 +1,20 @@ +$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 d63270e..bb09c27 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 credentials. The response returns the customer profile and access token when authentication succeeds. 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..611a824 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.params.yaml @@ -0,0 +1,11 @@ +$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 37ac9c2..298828d 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 details. The response returns the customer profile and an access token when authentication succeeds. 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..1b0d957 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.params.yaml @@ -0,0 +1,8 @@ +$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 b688eb2..4cfa184 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 a Google ID token. The response returns the customer profile and access token when authentication succeeds. 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..fd81b7a --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.params.yaml" @@ -0,0 +1,8 @@ +$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 2484f55..7918996 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 includes the customer profile and an auth token. + Authenticates a storefront customer with an email or phone identity and password. The response returns the customer profile and access 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 new file mode 100644 index 0000000..c4e9cce --- /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: "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 f1a762d..de9ecd1 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 account closure with the verification code sent to the customer. The response returns the closure result. 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 1436711..c891390 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 storefront customer after verifying the supplied creation code. The response includes the customer profile and an auth token. + Creates a customer resource. The response returns the created resource with its generated identifier. 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 new file mode 100644 index 0000000..8454803 --- /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..5d36815 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: |- + Retrieves a customer. The response includes the current API representation of the resource. 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..8454803 --- /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..300eaf0 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: |- + Retrieves a customer. The response includes the current API representation of the resource. 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 d8db385..1b2006e 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 orders that belong to the authenticated storefront customer. Use pagination and filters to browse the customer order history. + Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. 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 8b56922..9165265 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 saved places for the authenticated storefront customer. Use these places for delivery addresses and checkout defaults. + Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. 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 16eb9d9..2162ae5 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 storefront customers for the current company. Use query and pagination parameters to find matching customer records. + Returns customer matching the supplied filters. Use pagination and query parameters to control the result set. 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 new file mode 100644 index 0000000..e7648db --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.params.yaml @@ -0,0 +1,9 @@ +$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 308dd89..8ce43ad 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 device token for the authenticated storefront customer. Use this to enable push notifications for the customer device. + Registers a push notification device token for the authenticated storefront customer. Use this endpoint to enable customer device notifications. 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 new file mode 100644 index 0000000..946203d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.params.yaml @@ -0,0 +1,5 @@ +$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 c986afe..07692b7 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 phone verification code to the authenticated storefront customer. Use the code with the verify phone number endpoint. 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..69b93ce 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 customer. The response includes the current API representation of the resource. 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..fd81b7a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.params.yaml @@ -0,0 +1,8 @@ +$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 d52d2c1..f921307 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 storefront customer creation. The code is required when creating the customer account. + Sends a verification code for creating a storefront customer. Use the code when submitting the customer creation request. 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 new file mode 100644 index 0000000..8454803 --- /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..1117956 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 account closure for the authenticated storefront customer. Fleetbase sends a confirmation code before the account can be closed. 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..765896a 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 customer resource. Parameters not supplied remain unchanged. 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 b24a815..d37f1de 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 storefront customer profile. The response returns the customer with the new values applied. + Updates a customer resource. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..8f5e890 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.params.yaml @@ -0,0 +1,9 @@ +$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 b0f073a..c306468 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 a customer phone number with a previously issued code. The response confirms the phone verification result. 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..c4e9cce --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.params.yaml @@ -0,0 +1,6 @@ +$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 ed3496c..0e32cfd 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 creation code. The response includes the customer profile and auth token when verification succeeds. + Verifies a storefront SMS or account-creation code. The response returns the customer profile and access 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" new file mode 100644 index 0000000..0c27300 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/Retrieve a Delivery Service Quote \342\235\227.resources/examples/Successful Response.example.yaml" @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..500d50d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 499a6a3..998fd86 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: |- - Returns a delivery service quote for the supplied cart, origin, and destination. Use the quote during checkout to include delivery pricing. + Retrieves a delivery service quote. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..cde6160 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Query Food Trucks.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..c4eba9f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/Retrieve Food Truck.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..e30f2ee --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 2edce6e..6e91652 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,5 +1,6 @@ $kind: http-request -description: Query Food Trucks +description: |- + Returns food trucks matching the supplied filters. Use pagination and query parameters to control the result set. 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 a31d6f5..9f39719 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,5 +1,6 @@ $kind: http-request -description: Retrieve Food Truck +description: |- + Retrieves a food truck. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..b1d80c0 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/Complete Order Pickup.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..ff3a6cc --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/Get Order Receipt.resources/examples/Successful Response.example.yaml @@ -0,0 +1,37 @@ +$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 new file mode 100644 index 0000000..a9ddfc2 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/object.yaml @@ -0,0 +1,53 @@ +$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 new file mode 100644 index 0000000..614efd7 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.params.yaml @@ -0,0 +1,5 @@ +$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 07ceca9..70fc6d1 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 a pickup order as completed by the authenticated customer. The response returns the updated order pickup 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..8aff64e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.params.yaml @@ -0,0 +1,11 @@ +$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 da6ad7a..468ab98 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: |- + Retrieves a order. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..1a92bd4 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/Create Product.resources/examples/Successful Response.example.yaml @@ -0,0 +1,32 @@ +$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 new file mode 100644 index 0000000..f3de173 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/Query Products.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..18bf629 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/Retrieve a Product.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..ef8e787 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/Update Product.resources/examples/Successful Response.example.yaml @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..693c8ba --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/.resources/object.yaml @@ -0,0 +1,37 @@ +$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 cb6620b..4c0b66a 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create Product +description: |- + Creates a product. The response returns the created resource with its generated identifier. 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 5e29e71..d5f2957 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 available in the current storefront. Use pagination and filters to browse the catalog. + Returns products matching the supplied filters. Use pagination and query parameters to control the result set. 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 763d3b7..11fbfaf 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 single storefront product by ID. The response includes product details, pricing, variants, and related catalog data when available. + Retrieves a product. The response includes the current API representation of the resource. 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 27dc468..10305c0 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Update Product +description: |- + Updates a product. Parameters not supplied remain unchanged. 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 new file mode 100644 index 0000000..ae0a557 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Counts the number of ratings for a store.resources/examples/Successful Response.example.yaml @@ -0,0 +1,18 @@ +$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 new file mode 100644 index 0000000..6a2cd0e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Create a review.resources/examples/Successful Response.example.yaml @@ -0,0 +1,29 @@ +$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 new file mode 100644 index 0000000..36a46d9 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Delete a Review.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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" new file mode 100644 index 0000000..1006d47 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Query Reviews \342\235\227.resources/examples/Successful Response.example.yaml" @@ -0,0 +1,34 @@ +$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 new file mode 100644 index 0000000..0fdce01 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/Retrieve a Store review.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..295600d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 83fc76b..9b5c49b 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,5 +1,6 @@ $kind: http-request -description: Counts the number of ratings for a store +description: |- + Returns the number of storefront ratings for the current store. Use it to display aggregate review counts without fetching the full review list. 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 8af1d4a..9ed9514 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,5 +1,6 @@ $kind: http-request -description: Create a review +description: |- + Creates a review. The response returns the created resource with its generated identifier. 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 6012d8f..563fa95 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,5 +1,6 @@ $kind: http-request -description: Delete a Review +description: |- + Deletes a reviews resource. The response confirms the resource that was removed. 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 37a20bf..ebd784f 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,5 +1,6 @@ $kind: http-request -description: Query Reviews ❗ +description: |- + Returns reviews matching the supplied filters. Use pagination and query parameters to control the result set. 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 ba5494c..30e98e5 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,5 +1,6 @@ $kind: http-request -description: Retrieve a Store review +description: |- + Retrieves a review. The response includes the current API representation of the resource. 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 new file mode 100644 index 0000000..dfe16ae --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/Query Store Locations.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..4e3767b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store Locations/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 5ff1a37..6a5b140 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 available through the current storefront or network. Use these locations for browsing, pickup, and fulfillment selection. + Returns store locations matching the supplied filters. Use pagination and query parameters to control the result set. 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 new file mode 100644 index 0000000..bdcc98f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/About Store.resources/examples/Successful Response.example.yaml @@ -0,0 +1,22 @@ +$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 new file mode 100644 index 0000000..c604b3b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/List Locations.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..e5e4b22 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/List Network Stores.resources/examples/Successful Response.example.yaml @@ -0,0 +1,35 @@ +$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 new file mode 100644 index 0000000..541d8aa --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/List Tags.resources/examples/Successful Response.example.yaml @@ -0,0 +1,30 @@ +$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 new file mode 100644 index 0000000..80dd911 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/Lookup Store.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..b0e9bbb --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/Payment gateways for the current store.resources/examples/Successful Response.example.yaml @@ -0,0 +1,25 @@ +$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 new file mode 100644 index 0000000..f38c3b4 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/Retrieve Location.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..98d3f6d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/Search Store.resources/examples/Successful Response.example.yaml @@ -0,0 +1,26 @@ +$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 new file mode 100644 index 0000000..26620a7 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/Specific payment gateway given the id.resources/examples/Successful Response.example.yaml @@ -0,0 +1,24 @@ +$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 new file mode 100644 index 0000000..8088551 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml @@ -0,0 +1,29 @@ +$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 bc8c0df..576eb3f 100644 --- a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: About Store +description: |- + Returns public profile and configuration details for the current storefront. Use this endpoint to initialize storefront clients. 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 e864e53..ac774d7 100644 --- a/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: List Locations +description: |- + Returns store matching the supplied filters. Use pagination and query parameters to control the result set. 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 f732ec9..818afc3 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,5 +1,6 @@ $kind: http-request -description: List Network Stores +description: |- + Returns store matching the supplied filters. Use pagination and query parameters to control the result set. 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 5b0a239..8293c63 100644 --- a/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: List Tags +description: |- + Returns store matching the supplied filters. Use pagination and query parameters to control the result set. 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 fd93ffa..7227754 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Lookup Store +description: |- + Looks up a storefront by identifier. The response returns the matching store profile when it is available to the caller. 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 267b6a4..3831c82 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,5 +1,6 @@ $kind: http-request -description: Payment gateways for the current store +description: |- + Lists payment gateways available to the current storefront. Use the response to decide which payment methods can be offered at checkout. 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 9b051e7..16b2632 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Retrieve Location +description: |- + Retrieves a store. The response includes the current API representation of the resource. 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 24891d7..fb180b7 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Search Storefront +description: |- + Searches the current storefront catalog and related store data. Use query parameters to narrow the results returned to the shopper. 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 0dab8db..f9dd6c4 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,5 +1,6 @@ $kind: http-request -description: Specific payment gateway given the id +description: |- + Retrieves a payment gateway by ID for the current storefront. The response includes the gateway metadata safe for storefront clients. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways/{id}" method: GET headers: