From 8bb6fbc1a1cad4f554ef5e14b04f95d88212add4 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Wed, 27 May 2026 15:42:39 +0800 Subject: [PATCH 1/3] chore: add AI agent groundwork --- .github/ISSUE_TEMPLATE/bug.yml | 85 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 +++ .github/ISSUE_TEMPLATE/feature.yml | 73 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++ AGENTS.md | 136 +++++++++++++++++++++++++++++ 5 files changed, 364 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 AGENTS.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..48cb0aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,85 @@ +name: Bug Report +description: Report a reproducible bug for this repository. +title: "[Bug]: " +labels: + - type:bug + +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Describe the bug clearly. + validations: + required: true + + - type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: What is happening now? + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: What should happen instead? + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide exact reproduction steps. + placeholder: | + 1. + 2. + 3. + validations: + required: true + + - type: textarea + id: affected_area + attributes: + label: Affected Area + description: Mention routes, components, models, APIs, commands, or workflows affected. + validations: + required: false + + - type: textarea + id: proposed_fix + attributes: + label: Proposed Fix + description: Optional implementation direction. + validations: + required: false + + - type: textarea + id: acceptance_criteria + attributes: + label: Acceptance Criteria + description: Define what must be true for this bug to be fixed. + placeholder: | + - [ ] + - [ ] + validations: + required: true + + - type: textarea + id: docs_impact + attributes: + label: Documentation Impact + description: Does this require updates to fleetbase/fleetbase.io? + validations: + required: false + + - type: textarea + id: api_impact + attributes: + label: API Reference Impact + description: Does this require updates to fleetbase/postman? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..918cf4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +blank_issues_enabled: true + +contact_links: + - name: Fleetbase Documentation + url: https://fleetbase.io/docs + about: Read Fleetbase documentation. + + - name: Fleetbase Website + url: https://fleetbase.io + about: Visit the Fleetbase website. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..da6d01f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,73 @@ +name: Feature Request +description: Request a new feature or enhancement. +title: "[Feature]: " +labels: + - type:feature + +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Describe the feature clearly. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem / Use Case + description: What problem does this solve? + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: Proposed Solution + description: Describe the desired implementation or behavior. + validations: + required: false + + - type: textarea + id: affected_area + attributes: + label: Affected Area + description: Mention routes, components, models, APIs, commands, or workflows affected. + validations: + required: false + + - type: textarea + id: acceptance_criteria + attributes: + label: Acceptance Criteria + description: Define what must be true for this feature to be complete. + placeholder: | + - [ ] + - [ ] + validations: + required: true + + - type: textarea + id: implementation_notes + attributes: + label: Implementation Notes + description: Optional technical direction for agents or maintainers. + validations: + required: false + + - type: textarea + id: docs_impact + attributes: + label: Documentation Impact + description: Does this require updates to fleetbase/fleetbase.io? + validations: + required: false + + - type: textarea + id: api_impact + attributes: + label: API Reference Impact + description: Does this require updates to fleetbase/postman? + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..eb04b55 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +## Summary + +Describe what changed and why. + +## Related Issue + +Closes # + +## Type of Change + +- [ ] Bug fix +- [ ] Feature +- [ ] Refactor +- [ ] Documentation +- [ ] Test +- [ ] Chore + +## Implementation Notes + +Explain the important implementation details. + +## Validation + +List commands run: + +- [ ] Tests +- [ ] Lint +- [ ] Build +- [ ] Manual validation + +Command output / summary: + +```txt +``` + +## Documentation Impact + +- [ ] No documentation changes needed +- [ ] Documentation updated in `fleetbase/fleetbase.io` +- [ ] Documentation needed but not included + +## API Reference Impact + +- [ ] No API reference changes needed +- [ ] Updated `fleetbase/postman` +- [ ] API reference updates required but not included + +API reference notes: + +## Documentation Notes + +Describe documentation or API specification updates. + +## Risk + +Describe possible risks, migrations, compatibility issues, or rollout concerns. + +## Screenshots / Recordings + +Add screenshots or recordings for UI changes. diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..cc20743 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,136 @@ +# AI Agent Instructions + +## Repository Scope + +Fleetbase Postman and OpenAPI specification source for API collections, workflow examples, environments, and API reference generation. + +## Allowed Work + +- Updates to Postman/OpenAPI YAML collections, examples, workflow requests, and API documentation source files. +- Lint fixes, collection organization, and examples that preserve real API behavior. +- Spec updates that correspond to verified API behavior changes in Fleetbase modules. + +## Restricted Work + +- Committing real tokens, cookies, IDs, exported Vault data, or production credentials. +- Inventing API behavior not backed by implementation or approved design. +- Changing generated public documentation without coordinating required `fleetbase/fleetbase.io` regeneration or PRs. + +## Global Agent Rules + +- Do not merge pull requests. +- Do not publish packages. +- Do not rotate, expose, modify, or invent secrets. +- Do not change production credentials or deployment configuration unless explicitly requested. +- Do not perform large rewrites unless explicitly requested. +- Prefer small, reviewable changes. +- Preserve existing architecture and conventions. +- Follow the repository's existing naming, formatting, and test patterns. +- Add or update tests where practical. +- If tests are not added, explain why in the PR. +- Run available lint/test/build commands before finalizing the PR. +- Include command output or a clear summary of validation performed. +- If the issue is ambiguous, comment with questions instead of guessing. + +## Local Setup + +- `npm install` + +## Test Commands + +- Lint collections: `npm run postman:lint` +- Run collections: `npm run postman:run` +- Run scoped collections with scripts such as `npm run postman:run:fleetbase`, `npm run postman:run:core`, `npm run postman:run:storefront`, or `npm run postman:run:ledger` + +## Pull Request Rules + +- Work on a dedicated branch for each task. +- Keep changes small and reviewable. +- Stage only files related to the task. +- Do not include unrelated local changes in commits. +- Use clear PR titles and descriptions that explain what changed and why. +- Link the related issue when one exists. +- Include validation commands and a concise summary of results. +- Explain any skipped tests, missing coverage, or known follow-up work. +- Call out documentation and API reference impact using the PR template. +- Do not merge the PR after opening it. + +## Documentation Rules + +Some changes require documentation updates in `fleetbase/fleetbase.io`. + +Some API-related changes additionally require updates to API specification files in `fleetbase/postman`. + +Update or create documentation when a change affects: + +- user-facing behavior +- configuration +- installation steps +- environment variables +- API behavior +- request/response schemas +- authentication behavior +- extension behavior +- permissions or IAM behavior +- billing, invoicing, wallets, or gateway behavior +- developer workflows +- CLI commands +- mobile app workflows +- onboarding flows +- breaking changes +- deprecated behavior + +If API behavior changes, the agent must determine whether corresponding specification updates are needed in `fleetbase/postman`. + +Examples include: + +- new endpoints +- modified endpoints +- payload changes +- validation changes +- authentication changes +- response schema changes +- enum changes +- new query parameters +- deprecated API behavior + +If API specification files are updated in `fleetbase/postman`, the agent should also determine whether a documentation PR or regeneration step is required in `fleetbase/fleetbase.io`. + +If documentation should be updated but cannot be updated in the same PR, the agent must: + +1. mention this clearly in the PR description; +2. add a `needs-docs` label if available; +3. reference the expected documentation area in `fleetbase/fleetbase.io`; +4. reference any required specification updates in `fleetbase/postman`. + +## Escalation Rules + +Stop and request human clarification when: + +- the requested behavior is ambiguous or conflicts with existing architecture; +- the change would alter public APIs, authentication, permissions, billing, financial records, or production configuration; +- secrets, credentials, signing assets, deployment settings, or release automation are involved; +- the safest implementation requires a large rewrite or broad cross-repository coordination; +- tests fail for reasons that are not clearly related to the change; +- documentation or API specification ownership is unclear. + +## Recommended Labels + +Use these labels when they are available: + +- `type:bug` +- `type:feature` +- `type:docs` +- `type:refactor` +- `type:chore` +- `agent:ready` +- `agent:blocked` +- `agent:in-progress` +- `needs-docs` +- `needs-api-spec` +- `needs-human-review` +- `needs-product-decision` +- `priority:p0` +- `priority:p1` +- `priority:p2` +- `priority:p3` From b191b782cd581c18095b9a1853599b2c0a883c71 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Mon, 22 Jun 2026 10:24:02 +0800 Subject: [PATCH 2/3] Document FleetOps resource endpoints --- .../examples/OK.example.yaml | 18 +++++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../Devices/.resources/definition.yaml | 4 ++ .../Devices/.resources/object.yaml | 48 +++++++++++++++++ .../Devices/Attach Device.params.yaml | 5 ++ .../Devices/Attach Device.request.yaml | 12 +++++ .../Devices/Create a Device.params.yaml | 29 +++++++++++ .../Devices/Create a Device.request.yaml | 16 ++++++ .../Devices/Delete a Device.request.yaml | 6 +++ .../Devices/Detach Device.request.yaml | 6 +++ .../Devices/Query Devices.queryParams.yaml | 26 ++++++++++ .../Devices/Query Devices.request.yaml | 6 +++ .../Devices/Retrieve a Device.request.yaml | 6 +++ .../Devices/Update a Device.params.yaml | 29 +++++++++++ .../Devices/Update a Device.request.yaml | 12 +++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../Equipment/.resources/definition.yaml | 4 ++ .../Equipment/.resources/object.yaml | 51 +++++++++++++++++++ .../Equipment/Create Equipment.params.yaml | 29 +++++++++++ .../Equipment/Create Equipment.request.yaml | 19 +++++++ .../Equipment/Delete Equipment.request.yaml | 6 +++ .../Query Equipment.queryParams.yaml | 23 +++++++++ .../Equipment/Query Equipment.request.yaml | 6 +++ .../Equipment/Retrieve Equipment.request.yaml | 6 +++ .../Equipment/Update Equipment.params.yaml | 29 +++++++++++ .../Equipment/Update Equipment.request.yaml | 12 +++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../.resources/definition.yaml | 4 ++ .../Fuel Transactions/.resources/object.yaml | 50 ++++++++++++++++++ .../Create a Fuel Transaction.params.yaml | 32 ++++++++++++ .../Create a Fuel Transaction.request.yaml | 20 ++++++++ .../Delete a Fuel Transaction.request.yaml | 6 +++ .../Match Fuel Transaction Order.params.yaml | 5 ++ .../Match Fuel Transaction Order.request.yaml | 12 +++++ ...Match Fuel Transaction Vehicle.params.yaml | 5 ++ ...atch Fuel Transaction Vehicle.request.yaml | 12 +++++ .../Query Fuel Transactions.queryParams.yaml | 29 +++++++++++ .../Query Fuel Transactions.request.yaml | 6 +++ .../Reprocess Fuel Transaction.request.yaml | 6 +++ .../Retrieve a Fuel Transaction.request.yaml | 6 +++ .../Review Fuel Transaction.params.yaml | 5 ++ .../Review Fuel Transaction.request.yaml | 12 +++++ .../Update a Fuel Transaction.params.yaml | 32 ++++++++++++ .../Update a Fuel Transaction.request.yaml | 12 +++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../Parts/.resources/definition.yaml | 4 ++ .../Parts/.resources/object.yaml | 49 ++++++++++++++++++ .../Parts/Create a Part.params.yaml | 29 +++++++++++ .../Parts/Create a Part.request.yaml | 17 +++++++ .../Parts/Delete a Part.request.yaml | 6 +++ .../Parts/Query Parts.queryParams.yaml | 23 +++++++++ .../Parts/Query Parts.request.yaml | 6 +++ .../Parts/Retrieve a Part.request.yaml | 6 +++ .../Parts/Update a Part.params.yaml | 29 +++++++++++ .../Parts/Update a Part.request.yaml | 12 +++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../Sensors/.resources/definition.yaml | 4 ++ .../Sensors/.resources/object.yaml | 44 ++++++++++++++++ .../Sensors/Create a Sensor.params.yaml | 29 +++++++++++ .../Sensors/Create a Sensor.request.yaml | 18 +++++++ .../Sensors/Delete a Sensor.request.yaml | 6 +++ .../Sensors/Query Sensors.queryParams.yaml | 23 +++++++++ .../Sensors/Query Sensors.request.yaml | 6 +++ .../Sensors/Retrieve a Sensor.request.yaml | 6 +++ .../Sensors/Update a Sensor.params.yaml | 29 +++++++++++ .../Sensors/Update a Sensor.request.yaml | 13 +++++ .../examples/Created.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../examples/OK.example.yaml | 18 +++++++ .../Work Orders/.resources/definition.yaml | 4 ++ .../Work Orders/.resources/object.yaml | 49 ++++++++++++++++++ .../Create a Work Order.params.yaml | 32 ++++++++++++ .../Create a Work Order.request.yaml | 19 +++++++ .../Delete a Work Order.request.yaml | 6 +++ .../Query Work Orders.queryParams.yaml | 23 +++++++++ .../Query Work Orders.request.yaml | 6 +++ .../Retrieve a Work Order.request.yaml | 6 +++ .../Work Orders/Send Work Order.request.yaml | 6 +++ .../Update a Work Order.params.yaml | 32 ++++++++++++ .../Update a Work Order.request.yaml | 12 +++++ 108 files changed, 1864 insertions(+) create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Attach Device.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Create a Device.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Delete a Device.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Detach Device.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Query Devices.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Retrieve a Device.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/Update a Device.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Devices/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Attach Device.params.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Attach Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Create a Device.params.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Create a Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Delete a Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Detach Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Query Devices.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Query Devices.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Retrieve a Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Update a Device.params.yaml create mode 100644 postman/collections/Fleetbase API/Devices/Update a Device.request.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/Create Equipment.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/Delete Equipment.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/Query Equipment.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/Retrieve Equipment.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/Update Equipment.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Create Equipment.params.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Create Equipment.request.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Delete Equipment.request.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Query Equipment.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Query Equipment.request.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Retrieve Equipment.request.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Update Equipment.params.yaml create mode 100644 postman/collections/Fleetbase API/Equipment/Update Equipment.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Create a Fuel Transaction.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Delete a Fuel Transaction.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Order.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Vehicle.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Query Fuel Transactions.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Reprocess Fuel Transaction.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Retrieve a Fuel Transaction.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Review Fuel Transaction.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/Update a Fuel Transaction.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.params.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Delete a Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.params.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Reprocess Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Retrieve a Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.params.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.params.yaml create mode 100644 postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.request.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/Create a Part.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/Delete a Part.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/Query Parts.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/Retrieve a Part.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/Update a Part.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Parts/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Create a Part.params.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Create a Part.request.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Delete a Part.request.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Query Parts.request.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Retrieve a Part.request.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Update a Part.params.yaml create mode 100644 postman/collections/Fleetbase API/Parts/Update a Part.request.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/Create a Sensor.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/Delete a Sensor.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/Query Sensors.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/Retrieve a Sensor.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/Update a Sensor.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Create a Sensor.params.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Create a Sensor.request.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Delete a Sensor.request.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Query Sensors.request.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Retrieve a Sensor.request.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Update a Sensor.params.yaml create mode 100644 postman/collections/Fleetbase API/Sensors/Update a Sensor.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Create a Work Order.resources/examples/Created.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Delete a Work Order.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Query Work Orders.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Retrieve a Work Order.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Send Work Order.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/Update a Work Order.resources/examples/OK.example.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/definition.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/.resources/object.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Create a Work Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Create a Work Order.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Delete a Work Order.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Query Work Orders.queryParams.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Query Work Orders.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Retrieve a Work Order.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Send Work Order.request.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Update a Work Order.params.yaml create mode 100644 postman/collections/Fleetbase API/Work Orders/Update a Work Order.request.yaml diff --git a/postman/collections/Fleetbase API/Devices/.resources/Attach Device.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Attach Device.resources/examples/OK.example.yaml new file mode 100644 index 0000000..ee6d05e --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Attach Device.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices/{{device_id}}/attach" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Create a Device.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Create a Device.resources/examples/Created.example.yaml new file mode 100644 index 0000000..920edcb --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Create a Device.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Delete a Device.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Delete a Device.resources/examples/OK.example.yaml new file mode 100644 index 0000000..0453c31 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Delete a Device.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Detach Device.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Detach Device.resources/examples/OK.example.yaml new file mode 100644 index 0000000..bc182dc --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Detach Device.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices/{{device_id}}/detach" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Query Devices.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Query Devices.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a72b8ac --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Query Devices.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Retrieve a Device.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Retrieve a Device.resources/examples/OK.example.yaml new file mode 100644 index 0000000..156ff84 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Retrieve a Device.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/Update a Device.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Devices/.resources/Update a Device.resources/examples/OK.example.yaml new file mode 100644 index 0000000..7dda913 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/Update a Device.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "devices" + } diff --git a/postman/collections/Fleetbase API/Devices/.resources/definition.yaml b/postman/collections/Fleetbase API/Devices/.resources/definition.yaml new file mode 100644 index 0000000..538f110 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Devices represent physical telematics or tracking hardware that can be attached to vehicles or other fleet resources. +order: 8100 diff --git a/postman/collections/Fleetbase API/Devices/.resources/object.yaml b/postman/collections/Fleetbase API/Devices/.resources/object.yaml new file mode 100644 index 0000000..ef02a34 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/.resources/object.yaml @@ -0,0 +1,48 @@ +$kind: object +name: Device +description: |- + A device stores hardware identity, provider data, attachment state, telemetry status, and latest connectivity information. +example: | + { + "id": "device_7YqM3KpL2n", + "name": "OBD Tracker 12", + "type": "obd", + "device_id": "OBD-12", + "serial_number": "SN-10001", + "status": "active", + "connection_status": "online", + "attached_to_name": "ABC123", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public device identifier. + - name: name + type: string + description: Device name. + - name: type + type: string + description: Device type. + - name: device_id + type: string + description: Provider or hardware device identifier. + - name: serial_number + type: string + description: Device serial number. + - name: telematic + type: string + description: Telematic public ID, when loaded. + - name: attachable + type: string + description: Attached resource public ID, when loaded. + - name: status + type: string + description: Device status. + - name: connection_status + type: string + description: Derived connection status. + - name: meta + type: object + description: Additional device metadata. diff --git a/postman/collections/Fleetbase API/Devices/Attach Device.params.yaml b/postman/collections/Fleetbase API/Devices/Attach Device.params.yaml new file mode 100644 index 0000000..0647e6b --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Attach Device.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: vehicle + type: string + description: Vehicle public ID. diff --git a/postman/collections/Fleetbase API/Devices/Attach Device.request.yaml b/postman/collections/Fleetbase API/Devices/Attach Device.request.yaml new file mode 100644 index 0000000..2102a38 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Attach Device.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Attach this device to a vehicle." +url: "{{base_url}}/{{namespace}}/devices/{{device_id}}/attach" +method: POST +body: + type: json + content: |- + { + "vehicle": "{{vehicle_id}}" + } +order: 6000 +examples: ./.resources/Attach Device.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Create a Device.params.yaml b/postman/collections/Fleetbase API/Devices/Create a Device.params.yaml new file mode 100644 index 0000000..692e5c8 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Create a Device.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Device name. + - name: type + type: string + description: Device type. + - name: device_id + type: string + description: Provider or hardware device identifier. + - name: telematic + type: string + description: Telematic public ID. + - name: attachable_type + type: string + description: Attachable resource type, usually `fleet-ops:vehicle`. + - name: attachable + type: string + description: Attachable resource public ID. + - name: latitude + type: number + description: Last known latitude. Required with `longitude`. + - name: longitude + type: number + description: Last known longitude. Required with `latitude`. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Devices/Create a Device.request.yaml b/postman/collections/Fleetbase API/Devices/Create a Device.request.yaml new file mode 100644 index 0000000..1424d84 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Create a Device.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Create a device." +url: "{{base_url}}/{{namespace}}/devices" +method: POST +body: + type: json + content: |- + { + "name": "OBD Tracker 12", + "type": "obd", + "device_id": "OBD-12", + "serial_number": "SN-10001", + "status": "active" + } +order: 1000 +examples: ./.resources/Create a Device.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Delete a Device.request.yaml b/postman/collections/Fleetbase API/Devices/Delete a Device.request.yaml new file mode 100644 index 0000000..678899a --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Delete a Device.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete a device." +url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete a Device.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Detach Device.request.yaml b/postman/collections/Fleetbase API/Devices/Detach Device.request.yaml new file mode 100644 index 0000000..d9341a4 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Detach Device.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Detach this device from its current resource." +url: "{{base_url}}/{{namespace}}/devices/{{device_id}}/detach" +method: POST +order: 7000 +examples: ./.resources/Detach Device.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Query Devices.queryParams.yaml b/postman/collections/Fleetbase API/Devices/Query Devices.queryParams.yaml new file mode 100644 index 0000000..bfd405c --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Query Devices.queryParams.yaml @@ -0,0 +1,26 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for devices. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: status + type: string + description: Filter by status. + - name: attachment_state + type: string + description: Filter by `attached` or `unattached`. + - name: vehicle + type: string + description: Filter by attached vehicle public ID. + - name: connection_status + type: string + description: Filter by connection status. diff --git a/postman/collections/Fleetbase API/Devices/Query Devices.request.yaml b/postman/collections/Fleetbase API/Devices/Query Devices.request.yaml new file mode 100644 index 0000000..56f322e --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Query Devices.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query devices." +url: "{{base_url}}/{{namespace}}/devices" +method: GET +order: 2000 +examples: ./.resources/Query Devices.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Retrieve a Device.request.yaml b/postman/collections/Fleetbase API/Devices/Retrieve a Device.request.yaml new file mode 100644 index 0000000..2ccf58a --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Retrieve a Device.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve a device." +url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve a Device.resources/examples diff --git a/postman/collections/Fleetbase API/Devices/Update a Device.params.yaml b/postman/collections/Fleetbase API/Devices/Update a Device.params.yaml new file mode 100644 index 0000000..692e5c8 --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Update a Device.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Device name. + - name: type + type: string + description: Device type. + - name: device_id + type: string + description: Provider or hardware device identifier. + - name: telematic + type: string + description: Telematic public ID. + - name: attachable_type + type: string + description: Attachable resource type, usually `fleet-ops:vehicle`. + - name: attachable + type: string + description: Attachable resource public ID. + - name: latitude + type: number + description: Last known latitude. Required with `longitude`. + - name: longitude + type: number + description: Last known longitude. Required with `latitude`. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Devices/Update a Device.request.yaml b/postman/collections/Fleetbase API/Devices/Update a Device.request.yaml new file mode 100644 index 0000000..e0f6c2e --- /dev/null +++ b/postman/collections/Fleetbase API/Devices/Update a Device.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Update a device." +url: "{{base_url}}/{{namespace}}/devices/{{device_id}}" +method: PUT +body: + type: json + content: |- + { + "status": "maintenance" + } +order: 4000 +examples: ./.resources/Update a Device.resources/examples diff --git a/postman/collections/Fleetbase API/Equipment/.resources/Create Equipment.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Equipment/.resources/Create Equipment.resources/examples/Created.example.yaml new file mode 100644 index 0000000..a0873d5 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/Create Equipment.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/equipment" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "equipment" + } diff --git a/postman/collections/Fleetbase API/Equipment/.resources/Delete Equipment.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Equipment/.resources/Delete Equipment.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a02f0d6 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/Delete Equipment.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Equipment/.resources/Query Equipment.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Equipment/.resources/Query Equipment.resources/examples/OK.example.yaml new file mode 100644 index 0000000..620b568 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/Query Equipment.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/equipment" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "equipment" + } diff --git a/postman/collections/Fleetbase API/Equipment/.resources/Retrieve Equipment.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Equipment/.resources/Retrieve Equipment.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a9ccd9f --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/Retrieve Equipment.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "equipment" + } diff --git a/postman/collections/Fleetbase API/Equipment/.resources/Update Equipment.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Equipment/.resources/Update Equipment.resources/examples/OK.example.yaml new file mode 100644 index 0000000..35f4ea3 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/Update Equipment.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "equipment" + } diff --git a/postman/collections/Fleetbase API/Equipment/.resources/definition.yaml b/postman/collections/Fleetbase API/Equipment/.resources/definition.yaml new file mode 100644 index 0000000..5ca96c9 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Equipment represents auxiliary fleet gear such as PPE, refrigeration units, tools, liftgates, ramps, containers, and other assignable operational equipment. +order: 7800 diff --git a/postman/collections/Fleetbase API/Equipment/.resources/object.yaml b/postman/collections/Fleetbase API/Equipment/.resources/object.yaml new file mode 100644 index 0000000..6769887 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/.resources/object.yaml @@ -0,0 +1,51 @@ +$kind: object +name: Equipment +description: |- + An equipment record stores identity, assignment, warranty, purchase, and status details for reusable fleet equipment. +example: | + { + "id": "equipment_4Mnp8Qx2Vz", + "name": "Liftgate LG-12", + "code": "LG-12", + "type": "liftgate", + "status": "available", + "serial_number": "LG120045", + "manufacturer": "Maxon", + "model": "BMR", + "currency": "USD", + "is_equipped": false, + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public equipment identifier. + - name: name + type: string + description: Equipment name. + - name: code + type: string + description: Internal equipment code. + - name: type + type: string + description: Equipment type. + - name: status + type: string + description: Equipment availability status. + - name: serial_number + type: string + description: Equipment serial number. + - name: manufacturer + type: string + description: Equipment manufacturer. + - name: model + type: string + description: Equipment model. + - name: equipable + type: string + description: Public ID of the assigned resource, when loaded. + - name: meta + type: object + description: Additional equipment metadata. diff --git a/postman/collections/Fleetbase API/Equipment/Create Equipment.params.yaml b/postman/collections/Fleetbase API/Equipment/Create Equipment.params.yaml new file mode 100644 index 0000000..c26ec73 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Create Equipment.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Equipment name. + - name: code + type: string + description: Internal equipment code. + - name: type + type: string + description: Equipment type. + - name: status + type: string + description: Equipment status. + - name: warranty + type: string + description: Warranty public ID. + - name: photo + type: string + description: File public ID for the equipment photo. + - name: equipable_type + type: string + description: Polymorphic resource type such as `fleet-ops:vehicle` or `fleet-ops:driver`. + - name: equipable + type: string + description: Public ID of the resource to assign equipment to. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Equipment/Create Equipment.request.yaml b/postman/collections/Fleetbase API/Equipment/Create Equipment.request.yaml new file mode 100644 index 0000000..8b9970b --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Create Equipment.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: "Create equipment." +url: "{{base_url}}/{{namespace}}/equipment" +method: POST +body: + type: json + content: |- + { + "name": "Liftgate LG-12", + "code": "LG-12", + "type": "liftgate", + "status": "available", + "serial_number": "LG120045", + "manufacturer": "Maxon", + "model": "BMR", + "currency": "USD" + } +order: 1000 +examples: ./.resources/Create Equipment.resources/examples diff --git a/postman/collections/Fleetbase API/Equipment/Delete Equipment.request.yaml b/postman/collections/Fleetbase API/Equipment/Delete Equipment.request.yaml new file mode 100644 index 0000000..b185073 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Delete Equipment.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete equipment." +url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete Equipment.resources/examples diff --git a/postman/collections/Fleetbase API/Equipment/Query Equipment.queryParams.yaml b/postman/collections/Fleetbase API/Equipment/Query Equipment.queryParams.yaml new file mode 100644 index 0000000..e193076 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Query Equipment.queryParams.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for equipment. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: type + type: string + description: Filter by equipment type. + - name: status + type: string + description: Filter by equipment status. + - name: manufacturer + type: string + description: Filter by manufacturer. diff --git a/postman/collections/Fleetbase API/Equipment/Query Equipment.request.yaml b/postman/collections/Fleetbase API/Equipment/Query Equipment.request.yaml new file mode 100644 index 0000000..b054fa1 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Query Equipment.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query equipment." +url: "{{base_url}}/{{namespace}}/equipment" +method: GET +order: 2000 +examples: ./.resources/Query Equipment.resources/examples diff --git a/postman/collections/Fleetbase API/Equipment/Retrieve Equipment.request.yaml b/postman/collections/Fleetbase API/Equipment/Retrieve Equipment.request.yaml new file mode 100644 index 0000000..cbbc7fa --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Retrieve Equipment.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve equipment." +url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve Equipment.resources/examples diff --git a/postman/collections/Fleetbase API/Equipment/Update Equipment.params.yaml b/postman/collections/Fleetbase API/Equipment/Update Equipment.params.yaml new file mode 100644 index 0000000..c26ec73 --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Update Equipment.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Equipment name. + - name: code + type: string + description: Internal equipment code. + - name: type + type: string + description: Equipment type. + - name: status + type: string + description: Equipment status. + - name: warranty + type: string + description: Warranty public ID. + - name: photo + type: string + description: File public ID for the equipment photo. + - name: equipable_type + type: string + description: Polymorphic resource type such as `fleet-ops:vehicle` or `fleet-ops:driver`. + - name: equipable + type: string + description: Public ID of the resource to assign equipment to. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Equipment/Update Equipment.request.yaml b/postman/collections/Fleetbase API/Equipment/Update Equipment.request.yaml new file mode 100644 index 0000000..e2bdd3b --- /dev/null +++ b/postman/collections/Fleetbase API/Equipment/Update Equipment.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Update equipment." +url: "{{base_url}}/{{namespace}}/equipment/{{equipment_id}}" +method: PUT +body: + type: json + content: |- + { + "status": "maintenance" + } +order: 4000 +examples: ./.resources/Update Equipment.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Create a Fuel Transaction.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Create a Fuel Transaction.resources/examples/Created.example.yaml new file mode 100644 index 0000000..50cb559 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Create a Fuel Transaction.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Delete a Fuel Transaction.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Delete a Fuel Transaction.resources/examples/OK.example.yaml new file mode 100644 index 0000000..4f9f26e --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Delete a Fuel Transaction.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a6f3777 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Order.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/match-order" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Vehicle.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Vehicle.resources/examples/OK.example.yaml new file mode 100644 index 0000000..556fca8 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Match Fuel Transaction Vehicle.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/match-vehicle" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Query Fuel Transactions.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Query Fuel Transactions.resources/examples/OK.example.yaml new file mode 100644 index 0000000..03736d8 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Query Fuel Transactions.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Reprocess Fuel Transaction.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Reprocess Fuel Transaction.resources/examples/OK.example.yaml new file mode 100644 index 0000000..1e80fc5 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Reprocess Fuel Transaction.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/reprocess" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Retrieve a Fuel Transaction.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Retrieve a Fuel Transaction.resources/examples/OK.example.yaml new file mode 100644 index 0000000..438333a --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Retrieve a Fuel Transaction.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Review Fuel Transaction.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Review Fuel Transaction.resources/examples/OK.example.yaml new file mode 100644 index 0000000..3c4c31b --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Review Fuel Transaction.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/review" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/Update a Fuel Transaction.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Update a Fuel Transaction.resources/examples/OK.example.yaml new file mode 100644 index 0000000..50d0b6d --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/Update a Fuel Transaction.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "fuel_transactions" + } diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/definition.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/definition.yaml new file mode 100644 index 0000000..c5643b3 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Fuel transactions represent imported or recorded fuel-card/provider transactions exposed to API users as fuel transactions. +order: 8300 diff --git a/postman/collections/Fleetbase API/Fuel Transactions/.resources/object.yaml b/postman/collections/Fleetbase API/Fuel Transactions/.resources/object.yaml new file mode 100644 index 0000000..800fce8 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/.resources/object.yaml @@ -0,0 +1,50 @@ +$kind: object +name: Fuel Transaction +description: |- + A fuel transaction stores provider transaction identity, matched vehicle/order/fuel report links, station data, volume, amount, odometer, and sync status. +example: | + { + "id": "fuel_provider_transaction_3KpL7Vz9Qx", + "provider": "petroapp", + "provider_transaction_id": "TX-10001", + "vehicle": "vehicle_7YqM3KpL2n", + "station_name": "North Depot Fuel", + "volume": 42.5, + "metric_unit": "liter", + "amount": 6500, + "currency": "USD", + "sync_status": "matched", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public fuel transaction identifier. + - name: provider + type: string + description: Fuel provider key. + - name: provider_transaction_id + type: string + description: Provider transaction identifier. + - name: vehicle + type: string + description: Matched vehicle public ID, when loaded. + - name: driver + type: string + description: Matched driver public ID, when loaded. + - name: order + type: string + description: Matched order public ID, when loaded. + - name: fuel_report + type: string + description: Generated fuel report public ID, when loaded. + - name: station_name + type: string + description: Fuel station name. + - name: volume + type: number + description: Fuel volume. + - name: sync_status + type: string + description: Sync or review status. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.params.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.params.yaml new file mode 100644 index 0000000..c585d08 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.params.yaml @@ -0,0 +1,32 @@ +$kind: params +fields: + - name: provider + type: string + description: Fuel provider key. + - name: provider_transaction_id + type: string + description: Provider transaction identifier. + - name: connection + type: string + description: Fuel provider connection public ID. + - name: vehicle + type: string + description: Vehicle public ID. + - name: driver + type: string + description: Driver public ID. + - name: order + type: string + description: Order public ID. + - name: fuel_report + type: string + description: Fuel report public ID. + - name: transaction_at + type: timestamp + description: Transaction timestamp. + - name: volume + type: number + description: Fuel volume. + - name: amount + type: currency + description: Transaction amount. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.request.yaml new file mode 100644 index 0000000..69a4586 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Create a Fuel Transaction.request.yaml @@ -0,0 +1,20 @@ +$kind: http-request +description: "Create a fuel transaction." +url: "{{base_url}}/{{namespace}}/fuel-transactions" +method: POST +body: + type: json + content: |- + { + "provider": "petroapp", + "provider_transaction_id": "TX-10001", + "vehicle": "{{vehicle_id}}", + "station_name": "North Depot Fuel", + "transaction_at": "2026-05-07T08:30:00Z", + "volume": 42.5, + "metric_unit": "liter", + "amount": 6500, + "currency": "USD" + } +order: 1000 +examples: ./.resources/Create a Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Delete a Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Delete a Fuel Transaction.request.yaml new file mode 100644 index 0000000..d7c4277 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Delete a Fuel Transaction.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete a fuel transaction." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete a Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.params.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.params.yaml new file mode 100644 index 0000000..e44c445 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: order + type: string + description: Order public ID. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.request.yaml new file mode 100644 index 0000000..1946a85 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Order.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Match this fuel transaction to an order." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/match-order" +method: POST +body: + type: json + content: |- + { + "order": "{{order_id}}" + } +order: 7000 +examples: ./.resources/Match Fuel Transaction Order.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.params.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.params.yaml new file mode 100644 index 0000000..0647e6b --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: vehicle + type: string + description: Vehicle public ID. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.request.yaml new file mode 100644 index 0000000..48e583f --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Match Fuel Transaction Vehicle.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Match this fuel transaction to a vehicle." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/match-vehicle" +method: POST +body: + type: json + content: |- + { + "vehicle": "{{vehicle_id}}" + } +order: 6000 +examples: ./.resources/Match Fuel Transaction Vehicle.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.queryParams.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.queryParams.yaml new file mode 100644 index 0000000..abd5ed2 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.queryParams.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for fuel transactions. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: provider + type: string + description: Filter by provider. + - name: sync_status + type: string + description: Filter by sync status. + - name: vehicle + type: string + description: Filter by vehicle public ID. + - name: connection + type: string + description: Filter by connection public ID. + - name: transaction_at + type: timestamp + description: Filter by transaction date or range. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.request.yaml new file mode 100644 index 0000000..537f3f0 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Query Fuel Transactions.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query fuel transactions." +url: "{{base_url}}/{{namespace}}/fuel-transactions" +method: GET +order: 2000 +examples: ./.resources/Query Fuel Transactions.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Reprocess Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Reprocess Fuel Transaction.request.yaml new file mode 100644 index 0000000..ec32f03 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Reprocess Fuel Transaction.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Reprocess matching and fuel report generation for this fuel transaction." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/reprocess" +method: POST +order: 8000 +examples: ./.resources/Reprocess Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Retrieve a Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Retrieve a Fuel Transaction.request.yaml new file mode 100644 index 0000000..5939c6b --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Retrieve a Fuel Transaction.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve a fuel transaction." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve a Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.params.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.params.yaml new file mode 100644 index 0000000..99c90eb --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: status + type: enum + description: `reviewed` or `ignored`. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.request.yaml new file mode 100644 index 0000000..7e8188f --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Review Fuel Transaction.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Mark this fuel transaction as reviewed or ignored." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}/review" +method: POST +body: + type: json + content: |- + { + "status": "reviewed" + } +order: 9000 +examples: ./.resources/Review Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.params.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.params.yaml new file mode 100644 index 0000000..c585d08 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.params.yaml @@ -0,0 +1,32 @@ +$kind: params +fields: + - name: provider + type: string + description: Fuel provider key. + - name: provider_transaction_id + type: string + description: Provider transaction identifier. + - name: connection + type: string + description: Fuel provider connection public ID. + - name: vehicle + type: string + description: Vehicle public ID. + - name: driver + type: string + description: Driver public ID. + - name: order + type: string + description: Order public ID. + - name: fuel_report + type: string + description: Fuel report public ID. + - name: transaction_at + type: timestamp + description: Transaction timestamp. + - name: volume + type: number + description: Fuel volume. + - name: amount + type: currency + description: Transaction amount. diff --git a/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.request.yaml b/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.request.yaml new file mode 100644 index 0000000..78aaa97 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Transactions/Update a Fuel Transaction.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Update a fuel transaction." +url: "{{base_url}}/{{namespace}}/fuel-transactions/{{fuel_transaction_id}}" +method: PUT +body: + type: json + content: |- + { + "sync_status": "reviewed" + } +order: 4000 +examples: ./.resources/Update a Fuel Transaction.resources/examples diff --git a/postman/collections/Fleetbase API/Parts/.resources/Create a Part.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Parts/.resources/Create a Part.resources/examples/Created.example.yaml new file mode 100644 index 0000000..ece6617 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/Create a Part.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/parts" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "parts" + } diff --git a/postman/collections/Fleetbase API/Parts/.resources/Delete a Part.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Parts/.resources/Delete a Part.resources/examples/OK.example.yaml new file mode 100644 index 0000000..152116e --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/Delete a Part.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Parts/.resources/Query Parts.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Parts/.resources/Query Parts.resources/examples/OK.example.yaml new file mode 100644 index 0000000..78f3d41 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/Query Parts.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/parts" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "parts" + } diff --git a/postman/collections/Fleetbase API/Parts/.resources/Retrieve a Part.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Parts/.resources/Retrieve a Part.resources/examples/OK.example.yaml new file mode 100644 index 0000000..921c884 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/Retrieve a Part.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "parts" + } diff --git a/postman/collections/Fleetbase API/Parts/.resources/Update a Part.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Parts/.resources/Update a Part.resources/examples/OK.example.yaml new file mode 100644 index 0000000..bf290c2 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/Update a Part.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "parts" + } diff --git a/postman/collections/Fleetbase API/Parts/.resources/definition.yaml b/postman/collections/Fleetbase API/Parts/.resources/definition.yaml new file mode 100644 index 0000000..927d27f --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Parts represent stocked replacement components such as tires, filters, belts, electronics, and other inventory used for fleet maintenance. +order: 7900 diff --git a/postman/collections/Fleetbase API/Parts/.resources/object.yaml b/postman/collections/Fleetbase API/Parts/.resources/object.yaml new file mode 100644 index 0000000..6ec4aeb --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/.resources/object.yaml @@ -0,0 +1,49 @@ +$kind: object +name: Part +description: |- + A part stores stock quantity, cost, supplier, warranty, asset association, and inventory status data. +example: | + { + "id": "part_8KqM3KpL2n", + "sku": "FLT-OIL-001", + "name": "Oil Filter", + "quantity_on_hand": 24, + "unit_cost": 1200, + "currency": "USD", + "status": "in_stock", + "is_in_stock": true, + "meta": {}, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public part identifier. + - name: sku + type: string + description: Part SKU. + - name: name + type: string + description: Part name. + - name: quantity_on_hand + type: integer + description: Current stock quantity. + - name: unit_cost + type: currency + description: Unit cost. + - name: msrp + type: currency + description: Suggested retail price. + - name: vendor + type: string + description: Vendor public ID, when loaded. + - name: asset + type: string + description: Associated asset public ID, when loaded. + - name: is_in_stock + type: boolean + description: Whether quantity is above zero. + - name: meta + type: object + description: Additional part metadata. diff --git a/postman/collections/Fleetbase API/Parts/Create a Part.params.yaml b/postman/collections/Fleetbase API/Parts/Create a Part.params.yaml new file mode 100644 index 0000000..f7bc566 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Create a Part.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: sku + type: string + description: Part SKU. + - name: name + type: string + description: Part name. + - name: quantity_on_hand + type: integer + description: Current stock quantity. + - name: unit_cost + type: currency + description: Unit cost. + - name: vendor + type: string + description: Vendor public ID. + - name: asset_type + type: string + description: Polymorphic resource type such as `fleet-ops:vehicle` or `fleet-ops:equipment`. + - name: asset + type: string + description: Public ID of the associated asset. + - name: specs + type: object + description: Part specification data. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Parts/Create a Part.request.yaml b/postman/collections/Fleetbase API/Parts/Create a Part.request.yaml new file mode 100644 index 0000000..a6157e0 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Create a Part.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: "Create a part." +url: "{{base_url}}/{{namespace}}/parts" +method: POST +body: + type: json + content: |- + { + "sku": "FLT-OIL-001", + "name": "Oil Filter", + "quantity_on_hand": 24, + "unit_cost": 1200, + "currency": "USD", + "status": "in_stock" + } +order: 1000 +examples: ./.resources/Create a Part.resources/examples diff --git a/postman/collections/Fleetbase API/Parts/Delete a Part.request.yaml b/postman/collections/Fleetbase API/Parts/Delete a Part.request.yaml new file mode 100644 index 0000000..8dc9169 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Delete a Part.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete a part." +url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete a Part.resources/examples diff --git a/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml b/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml new file mode 100644 index 0000000..8b5b116 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for parts. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: status + type: string + description: Filter by part status. + - name: manufacturer + type: string + description: Filter by manufacturer. + - name: vendor_uuid + type: string + description: Filter by vendor UUID. diff --git a/postman/collections/Fleetbase API/Parts/Query Parts.request.yaml b/postman/collections/Fleetbase API/Parts/Query Parts.request.yaml new file mode 100644 index 0000000..caf36fb --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Query Parts.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query parts." +url: "{{base_url}}/{{namespace}}/parts" +method: GET +order: 2000 +examples: ./.resources/Query Parts.resources/examples diff --git a/postman/collections/Fleetbase API/Parts/Retrieve a Part.request.yaml b/postman/collections/Fleetbase API/Parts/Retrieve a Part.request.yaml new file mode 100644 index 0000000..f35826d --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Retrieve a Part.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve a part." +url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve a Part.resources/examples diff --git a/postman/collections/Fleetbase API/Parts/Update a Part.params.yaml b/postman/collections/Fleetbase API/Parts/Update a Part.params.yaml new file mode 100644 index 0000000..f7bc566 --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Update a Part.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: sku + type: string + description: Part SKU. + - name: name + type: string + description: Part name. + - name: quantity_on_hand + type: integer + description: Current stock quantity. + - name: unit_cost + type: currency + description: Unit cost. + - name: vendor + type: string + description: Vendor public ID. + - name: asset_type + type: string + description: Polymorphic resource type such as `fleet-ops:vehicle` or `fleet-ops:equipment`. + - name: asset + type: string + description: Public ID of the associated asset. + - name: specs + type: object + description: Part specification data. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Parts/Update a Part.request.yaml b/postman/collections/Fleetbase API/Parts/Update a Part.request.yaml new file mode 100644 index 0000000..0d21afa --- /dev/null +++ b/postman/collections/Fleetbase API/Parts/Update a Part.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Update a part." +url: "{{base_url}}/{{namespace}}/parts/{{part_id}}" +method: PUT +body: + type: json + content: |- + { + "quantity_on_hand": 18 + } +order: 4000 +examples: ./.resources/Update a Part.resources/examples diff --git a/postman/collections/Fleetbase API/Sensors/.resources/Create a Sensor.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Sensors/.resources/Create a Sensor.resources/examples/Created.example.yaml new file mode 100644 index 0000000..69fc370 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/Create a Sensor.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/sensors" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "sensors" + } diff --git a/postman/collections/Fleetbase API/Sensors/.resources/Delete a Sensor.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Sensors/.resources/Delete a Sensor.resources/examples/OK.example.yaml new file mode 100644 index 0000000..d3790f3 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/Delete a Sensor.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Sensors/.resources/Query Sensors.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Sensors/.resources/Query Sensors.resources/examples/OK.example.yaml new file mode 100644 index 0000000..d9ecf0e --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/Query Sensors.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/sensors" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "sensors" + } diff --git a/postman/collections/Fleetbase API/Sensors/.resources/Retrieve a Sensor.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Sensors/.resources/Retrieve a Sensor.resources/examples/OK.example.yaml new file mode 100644 index 0000000..24b55c6 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/Retrieve a Sensor.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "sensors" + } diff --git a/postman/collections/Fleetbase API/Sensors/.resources/Update a Sensor.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Sensors/.resources/Update a Sensor.resources/examples/OK.example.yaml new file mode 100644 index 0000000..84d97a9 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/Update a Sensor.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "sensors" + } diff --git a/postman/collections/Fleetbase API/Sensors/.resources/definition.yaml b/postman/collections/Fleetbase API/Sensors/.resources/definition.yaml new file mode 100644 index 0000000..aa9811d --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Sensors represent measurable telemetry channels such as temperature, door state, vibration, fuel level, or tire pressure. +order: 8200 diff --git a/postman/collections/Fleetbase API/Sensors/.resources/object.yaml b/postman/collections/Fleetbase API/Sensors/.resources/object.yaml new file mode 100644 index 0000000..5900cf8 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/.resources/object.yaml @@ -0,0 +1,44 @@ +$kind: object +name: Sensor +description: |- + A sensor stores measurement type, thresholds, latest reading, associated device, and attachment metadata. +example: | + { + "id": "sensor_2Qx9KpL7Vz", + "name": "Cargo Temperature", + "type": "temperature", + "unit": "celsius", + "last_value": "4.2", + "status": "active", + "threshold_status": "normal", + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public sensor identifier. + - name: name + type: string + description: Sensor name. + - name: type + type: string + description: Sensor type. + - name: device + type: string + description: Device public ID, when loaded. + - name: unit + type: string + description: Measurement unit. + - name: last_value + type: string + description: Latest recorded value. + - name: threshold_status + type: string + description: Derived threshold status. + - name: status + type: string + description: Sensor status. + - name: meta + type: object + description: Additional sensor metadata. diff --git a/postman/collections/Fleetbase API/Sensors/Create a Sensor.params.yaml b/postman/collections/Fleetbase API/Sensors/Create a Sensor.params.yaml new file mode 100644 index 0000000..9ba5fb6 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Create a Sensor.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Sensor name. + - name: type + type: string + description: Sensor type. + - name: device + type: string + description: Device public ID. + - name: telematic + type: string + description: Telematic public ID. + - name: unit + type: string + description: Measurement unit. + - name: min_threshold + type: number + description: Minimum threshold. + - name: max_threshold + type: number + description: Maximum threshold. + - name: sensorable_type + type: string + description: Attachable resource type. + - name: sensorable + type: string + description: Attachable resource public ID. diff --git a/postman/collections/Fleetbase API/Sensors/Create a Sensor.request.yaml b/postman/collections/Fleetbase API/Sensors/Create a Sensor.request.yaml new file mode 100644 index 0000000..26259ec --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Create a Sensor.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: "Create a sensor." +url: "{{base_url}}/{{namespace}}/sensors" +method: POST +body: + type: json + content: |- + { + "name": "Cargo Temperature", + "type": "temperature", + "device": "{{device_id}}", + "unit": "celsius", + "status": "active", + "min_threshold": 0, + "max_threshold": 8 + } +order: 1000 +examples: ./.resources/Create a Sensor.resources/examples diff --git a/postman/collections/Fleetbase API/Sensors/Delete a Sensor.request.yaml b/postman/collections/Fleetbase API/Sensors/Delete a Sensor.request.yaml new file mode 100644 index 0000000..5c6e63d --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Delete a Sensor.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete a sensor." +url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete a Sensor.resources/examples diff --git a/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml b/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml new file mode 100644 index 0000000..ea7c028 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for sensors. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: type + type: string + description: Filter by sensor type. + - name: status + type: string + description: Filter by sensor status. + - name: device + type: string + description: Filter by device UUID. diff --git a/postman/collections/Fleetbase API/Sensors/Query Sensors.request.yaml b/postman/collections/Fleetbase API/Sensors/Query Sensors.request.yaml new file mode 100644 index 0000000..c4ef9d6 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Query Sensors.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query sensors." +url: "{{base_url}}/{{namespace}}/sensors" +method: GET +order: 2000 +examples: ./.resources/Query Sensors.resources/examples diff --git a/postman/collections/Fleetbase API/Sensors/Retrieve a Sensor.request.yaml b/postman/collections/Fleetbase API/Sensors/Retrieve a Sensor.request.yaml new file mode 100644 index 0000000..4472013 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Retrieve a Sensor.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve a sensor." +url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve a Sensor.resources/examples diff --git a/postman/collections/Fleetbase API/Sensors/Update a Sensor.params.yaml b/postman/collections/Fleetbase API/Sensors/Update a Sensor.params.yaml new file mode 100644 index 0000000..9ba5fb6 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Update a Sensor.params.yaml @@ -0,0 +1,29 @@ +$kind: params +fields: + - name: name + type: string + description: Sensor name. + - name: type + type: string + description: Sensor type. + - name: device + type: string + description: Device public ID. + - name: telematic + type: string + description: Telematic public ID. + - name: unit + type: string + description: Measurement unit. + - name: min_threshold + type: number + description: Minimum threshold. + - name: max_threshold + type: number + description: Maximum threshold. + - name: sensorable_type + type: string + description: Attachable resource type. + - name: sensorable + type: string + description: Attachable resource public ID. diff --git a/postman/collections/Fleetbase API/Sensors/Update a Sensor.request.yaml b/postman/collections/Fleetbase API/Sensors/Update a Sensor.request.yaml new file mode 100644 index 0000000..3246415 --- /dev/null +++ b/postman/collections/Fleetbase API/Sensors/Update a Sensor.request.yaml @@ -0,0 +1,13 @@ +$kind: http-request +description: "Update a sensor." +url: "{{base_url}}/{{namespace}}/sensors/{{sensor_id}}" +method: PUT +body: + type: json + content: |- + { + "last_value": "4.2", + "last_reading_at": "2026-05-07T08:30:00Z" + } +order: 4000 +examples: ./.resources/Update a Sensor.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Create a Work Order.resources/examples/Created.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Create a Work Order.resources/examples/Created.example.yaml new file mode 100644 index 0000000..65edac8 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Create a Work Order.resources/examples/Created.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders" + method: POST + headers: + Accept: application/json +response: + statusCode: 201 + statusText: Created + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "work_orders" + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Delete a Work Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Delete a Work Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..a49ba17 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Delete a Work Order.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" + method: DELETE + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "deleted": true + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Query Work Orders.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Query Work Orders.resources/examples/OK.example.yaml new file mode 100644 index 0000000..4eab547 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Query Work Orders.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "work_orders" + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Retrieve a Work Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Retrieve a Work Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..f0051d5 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Retrieve a Work Order.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" + method: GET + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "work_orders" + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Send Work Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Send Work Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..7a65a35 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Send Work Order.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}/send" + method: POST + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "work_orders" + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/Update a Work Order.resources/examples/OK.example.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/Update a Work Order.resources/examples/OK.example.yaml new file mode 100644 index 0000000..bc32ad3 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/Update a Work Order.resources/examples/OK.example.yaml @@ -0,0 +1,18 @@ +$kind: http-example +request: + url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" + method: PUT + headers: + Accept: application/json +response: + statusCode: 200 + statusText: OK + headers: + Content-Type: application/json + body: + type: json + content: |- + { + "id": "", + "object": "work_orders" + } diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/definition.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/definition.yaml new file mode 100644 index 0000000..fdaefdd --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/definition.yaml @@ -0,0 +1,4 @@ +$kind: collection +description: |- + Work orders coordinate maintenance or operational jobs, including target asset, assignee, priority, checklist, budget, due date, and completion state. +order: 8000 diff --git a/postman/collections/Fleetbase API/Work Orders/.resources/object.yaml b/postman/collections/Fleetbase API/Work Orders/.resources/object.yaml new file mode 100644 index 0000000..4145439 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/.resources/object.yaml @@ -0,0 +1,49 @@ +$kind: object +name: Work Order +description: |- + A work order is an operational task wrapper used to assign and track maintenance or other fleet work. +example: | + { + "id": "work_order_6JpL9Qx2Vz", + "code": "WO-AB12CD34", + "subject": "Replace rear tire", + "category": "corrective_maintenance", + "status": "open", + "priority": "high", + "target_name": "ABC123", + "assignee_name": "Acme Parts", + "completion_percentage": 0, + "updated_at": "2026-05-07T08:30:00.000000Z", + "created_at": "2026-05-07T08:30:00.000000Z" + } +fields: + - name: id + type: string + description: Public work order identifier. + - name: code + type: string + description: Work order code. + - name: subject + type: string + description: Work order subject. + - name: category + type: string + description: Work order category. + - name: status + type: string + description: Work order status. + - name: priority + type: string + description: Work order priority. + - name: target + type: object + description: Target resource, when loaded. + - name: assignee + type: object + description: Assigned vendor or contact, when loaded. + - name: checklist + type: array + description: Checklist items. + - name: meta + type: object + description: Additional work order metadata. diff --git a/postman/collections/Fleetbase API/Work Orders/Create a Work Order.params.yaml b/postman/collections/Fleetbase API/Work Orders/Create a Work Order.params.yaml new file mode 100644 index 0000000..1821952 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Create a Work Order.params.yaml @@ -0,0 +1,32 @@ +$kind: params +fields: + - name: subject + type: string + description: Work order subject. + - name: category + type: string + description: Work order category. + - name: status + type: string + description: Work order status. + - name: priority + type: string + description: Priority value. + - name: target_type + type: string + description: Target resource type such as `fleet-ops:vehicle` or `fleet-ops:equipment`. + - name: target + type: string + description: Target resource public ID. + - name: assignee_type + type: string + description: Assignee resource type such as `fleet-ops:vendor` or `fleet-ops:contact`. + - name: assignee + type: string + description: Assignee public ID. + - name: checklist + type: array + description: Checklist items. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Work Orders/Create a Work Order.request.yaml b/postman/collections/Fleetbase API/Work Orders/Create a Work Order.request.yaml new file mode 100644 index 0000000..18b6b2a --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Create a Work Order.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: "Create a work order." +url: "{{base_url}}/{{namespace}}/work-orders" +method: POST +body: + type: json + content: |- + { + "subject": "Replace rear tire", + "category": "corrective_maintenance", + "status": "open", + "priority": "high", + "target_type": "fleet-ops:vehicle", + "target": "{{vehicle_id}}", + "assignee_type": "fleet-ops:vendor", + "assignee": "{{vendor_id}}" + } +order: 1000 +examples: ./.resources/Create a Work Order.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/Delete a Work Order.request.yaml b/postman/collections/Fleetbase API/Work Orders/Delete a Work Order.request.yaml new file mode 100644 index 0000000..f265027 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Delete a Work Order.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Delete a work order." +url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" +method: DELETE +order: 5000 +examples: ./.resources/Delete a Work Order.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/Query Work Orders.queryParams.yaml b/postman/collections/Fleetbase API/Work Orders/Query Work Orders.queryParams.yaml new file mode 100644 index 0000000..4e081f5 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Query Work Orders.queryParams.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: query + type: string + description: Search query for work orders. + - name: limit + type: integer + description: Maximum number of records to return. + - name: page + type: integer + description: Page number for paginated results. + - name: sort + type: string + description: Sort expression, such as `-created_at`. + - name: category + type: string + description: Filter by work order category. + - name: status + type: string + description: Filter by work order status. + - name: priority + type: string + description: Filter by priority. diff --git a/postman/collections/Fleetbase API/Work Orders/Query Work Orders.request.yaml b/postman/collections/Fleetbase API/Work Orders/Query Work Orders.request.yaml new file mode 100644 index 0000000..7340893 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Query Work Orders.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Query work orders." +url: "{{base_url}}/{{namespace}}/work-orders" +method: GET +order: 2000 +examples: ./.resources/Query Work Orders.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/Retrieve a Work Order.request.yaml b/postman/collections/Fleetbase API/Work Orders/Retrieve a Work Order.request.yaml new file mode 100644 index 0000000..2094d16 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Retrieve a Work Order.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Retrieve a work order." +url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" +method: GET +order: 3000 +examples: ./.resources/Retrieve a Work Order.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/Send Work Order.request.yaml b/postman/collections/Fleetbase API/Work Orders/Send Work Order.request.yaml new file mode 100644 index 0000000..99596b6 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Send Work Order.request.yaml @@ -0,0 +1,6 @@ +$kind: http-request +description: "Send this work order to its assigned vendor or contact." +url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}/send" +method: POST +order: 6000 +examples: ./.resources/Send Work Order.resources/examples diff --git a/postman/collections/Fleetbase API/Work Orders/Update a Work Order.params.yaml b/postman/collections/Fleetbase API/Work Orders/Update a Work Order.params.yaml new file mode 100644 index 0000000..1821952 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Update a Work Order.params.yaml @@ -0,0 +1,32 @@ +$kind: params +fields: + - name: subject + type: string + description: Work order subject. + - name: category + type: string + description: Work order category. + - name: status + type: string + description: Work order status. + - name: priority + type: string + description: Priority value. + - name: target_type + type: string + description: Target resource type such as `fleet-ops:vehicle` or `fleet-ops:equipment`. + - name: target + type: string + description: Target resource public ID. + - name: assignee_type + type: string + description: Assignee resource type such as `fleet-ops:vendor` or `fleet-ops:contact`. + - name: assignee + type: string + description: Assignee public ID. + - name: checklist + type: array + description: Checklist items. + - name: meta + type: object + description: Additional metadata. diff --git a/postman/collections/Fleetbase API/Work Orders/Update a Work Order.request.yaml b/postman/collections/Fleetbase API/Work Orders/Update a Work Order.request.yaml new file mode 100644 index 0000000..cbf95f1 --- /dev/null +++ b/postman/collections/Fleetbase API/Work Orders/Update a Work Order.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Update a work order." +url: "{{base_url}}/{{namespace}}/work-orders/{{work_order_id}}" +method: PUT +body: + type: json + content: |- + { + "status": "in_progress" + } +order: 4000 +examples: ./.resources/Update a Work Order.resources/examples From 012e255a6bbeb49045924ec6f4b0708e41b73fe8 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Mon, 22 Jun 2026 10:44:57 +0800 Subject: [PATCH 3/3] Remove UUID references from new FleetOps docs --- .../Fleetbase API/Parts/Query Parts.queryParams.yaml | 4 ++-- .../Fleetbase API/Sensors/Query Sensors.queryParams.yaml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml b/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml index 8b5b116..6145c07 100644 --- a/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml +++ b/postman/collections/Fleetbase API/Parts/Query Parts.queryParams.yaml @@ -18,6 +18,6 @@ fields: - name: manufacturer type: string description: Filter by manufacturer. - - name: vendor_uuid + - name: vendor type: string - description: Filter by vendor UUID. + description: Filter by vendor public ID or internal ID. diff --git a/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml b/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml index ea7c028..cab34e5 100644 --- a/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml +++ b/postman/collections/Fleetbase API/Sensors/Query Sensors.queryParams.yaml @@ -20,4 +20,4 @@ fields: description: Filter by sensor status. - name: device type: string - description: Filter by device UUID. + description: Filter by device public ID or internal ID.