diff --git a/.postman/resources.yaml b/.postman/resources.yaml index 154b365..359e9f8 100644 --- a/.postman/resources.yaml +++ b/.postman/resources.yaml @@ -5,6 +5,8 @@ workspace: localResources: collections: - ../postman/collections/Fleetbase API + - ../postman/collections/Fleetbase Core API + - ../postman/collections/Fleetbase Ledger API - ../postman/collections/Fleetbase Storefront API - ../postman/collections/Fleetbase Integrated Vendor Flow environments: diff --git a/README.md b/README.md index 2a8dc5c..d4968a5 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,16 @@ Official Git-first Postman workspace for Fleetbase API collections and workflow | Collection | Path | Purpose | | --- | --- | --- | -| Fleetbase API | `postman/collections/fleetbase-api.postman_collection.json` | Core Fleetbase platform API requests. | -| Storefront API | `postman/collections/storefront-api.postman_collection.json` | Storefront and customer-facing commerce API requests. | -| Ledger API | `collections/apis/ledger-api/collection.yaml` | Ledger, balances, accounts, and transaction API requests. | -| Integrated Vendor | `postman/collections/integrated-vendor-flow.postman_collection.json` | End-to-end vendor integration workflow examples. | +| Fleetbase API | `postman/collections/Fleetbase API` | FleetOps API and platform logistics requests. | +| Fleetbase Core API | `postman/collections/Fleetbase Core API` | Core API requests shared across Fleetbase modules. | +| Storefront API | `postman/collections/Fleetbase Storefront API` | Storefront and customer-facing commerce API requests. | +| Ledger API | `postman/collections/Fleetbase Ledger API` | Public Ledger wallet, invoice payment, and gateway webhook requests. | +| Integrated Vendor | `postman/collections/Fleetbase Integrated Vendor Flow` | End-to-end vendor integration workflow examples. | ## Getting Started 1. Install the Postman CLI. -2. Import one of the environment templates from `environments/`. +2. Select one of the environments from `postman/environments/`. 3. Fill local values in Postman or use Postman Vault for secrets. 4. Run linting locally: @@ -33,14 +34,14 @@ npm run postman:lint Run a collection with an environment template or local environment copy: ```sh -npm run postman:run:fleetbase -- --environment postman/environments/local.postman_environment.json +npm run postman:run:fleetbase -- --environment postman/environments/local.environment.yaml ``` Workflow collections can also use iteration data: ```sh npm run postman:run:integrated-vendor -- \ - --environment postman/environments/local.postman_environment.json \ + --environment postman/environments/local.environment.yaml \ --iteration-data collections/workflows/integrated-vendor/data/happy-path.example.json ``` @@ -50,10 +51,16 @@ Use collection or environment variables instead of hard-coded values: - `base_url` - `namespace` +- `api_prefix` - `api_key` +Collection-level `api_prefix` values handle package routing while keeping shared environments simple: + +- Storefront API uses `api_prefix=storefront`, producing `/storefront/{{namespace}}/...`. +- Ledger API uses `api_prefix=ledger`, producing `/ledger/{{namespace}}/...` for wallet routes and `/ledger/public/...` or `/ledger/webhooks/...` for non-versioned public routes. + Do not commit real tokens, keys, IDs, cookies, exported Vault data, or production credentials. ## Format -The imported Fleetbase API, Storefront API, and Integrated Vendor Flow collections are currently Postman v2.1 JSON exports. They should remain normalized to snake_case variables. Future migrations to Postman v3 YAML should be generated from these canonical collection exports with Postman CLI. +The source format for Local Mode is Postman v3 YAML / Native Git layout under `postman/`. JSON exports are treated as import/export artifacts only. diff --git a/collections/apis/ledger-api/README.md b/collections/apis/ledger-api/README.md index 5354d3f..e035fab 100644 --- a/collections/apis/ledger-api/README.md +++ b/collections/apis/ledger-api/README.md @@ -5,13 +5,14 @@ Reference collection for Fleetbase Ledger API requests. ## Variables - `base_url` +- `namespace` +- `api_prefix` - `api_key` -- `ledger_account_id` ## Auth Requests inherit bearer token authentication from the collection. Store real API keys locally or in Postman Vault. -## Starter Coverage +## Coverage -This collection starts with account and transaction placeholders for the ledger surface. +The editable Postman Local Mode collection lives at `postman/collections/Fleetbase Ledger API`. It uses `api_prefix=ledger`, so wallet URLs resolve as `{{base_url}}/{{api_prefix}}/{{namespace}}/...`, while public invoice and webhook URLs resolve under `/ledger/public/...` and `/ledger/webhooks/...`. diff --git a/collections/apis/ledger-api/collection.yaml b/collections/apis/ledger-api/collection.yaml index 8853157..4be3fbe 100644 --- a/collections/apis/ledger-api/collection.yaml +++ b/collections/apis/ledger-api/collection.yaml @@ -1,6 +1,7 @@ type: collection name: Ledger API version: 1.0.0 +description: Legacy single-file placeholder. The editable Postman Local Mode collection lives at postman/collections/Fleetbase Ledger API. auth: type: bearer bearer: @@ -10,18 +11,46 @@ auth: variables: - key: base_url value: "{{base_url}}" - - key: ledger_account_id - value: "{{ledger_account_id}}" + - key: namespace + value: "{{namespace}}" + - key: api_prefix + value: ledger items: - - name: Accounts + - name: Wallet items: - - name: Get Ledger Account + - name: Get Wallet request: method: GET - url: "{{base_url}}/ledger/accounts/{{ledger_account_id}}" - - name: Transactions + url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet" + - name: Get Wallet Balance + request: + method: GET + url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/balance" + - name: List Wallet Transactions + request: + method: GET + url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/transactions" + - name: Top Up Wallet + request: + method: POST + url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/topup" + - name: Public Invoices items: - - name: List Transactions + - name: Get Public Invoice request: method: GET - url: "{{base_url}}/ledger/accounts/{{ledger_account_id}}/transactions" + url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}" + - name: List Public Invoice Gateways + request: + method: GET + url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/gateways" + - name: Pay Public Invoice + request: + method: POST + url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/pay" + - name: Webhooks + items: + - name: Handle Gateway Webhook + request: + method: POST + url: "{{base_url}}/{{api_prefix}}/webhooks/{{gateway_driver}}" diff --git a/collections/apis/storefront-api/README.md b/collections/apis/storefront-api/README.md index b974e32..4e427f1 100644 --- a/collections/apis/storefront-api/README.md +++ b/collections/apis/storefront-api/README.md @@ -6,6 +6,7 @@ Reference collection for Fleetbase Storefront API requests. - `base_url` - `namespace` +- `api_prefix` - `api_key` ## Auth @@ -14,4 +15,4 @@ Requests inherit bearer token authentication from the collection. Set `api_key` ## Coverage -This collection is based on the exported Fleetbase Storefront API Postman collection and uses `{{base_url}}/{{namespace}}` for request URLs. +The editable Postman Local Mode collection lives at `postman/collections/Fleetbase Storefront API`. It uses `api_prefix=storefront`, so versioned request URLs resolve as `{{base_url}}/{{api_prefix}}/{{namespace}}/...`. diff --git a/package.json b/package.json index 5094d98..8b872bc 100644 --- a/package.json +++ b/package.json @@ -6,10 +6,11 @@ "scripts": { "postman:lint": "./scripts/lint-collections.sh", "postman:run": "./scripts/run-collection.sh", - "postman:run:fleetbase": "./scripts/run-collection.sh postman/collections/fleetbase-api.postman_collection.json", - "postman:run:storefront": "./scripts/run-collection.sh postman/collections/storefront-api.postman_collection.json", - "postman:run:ledger": "./scripts/run-collection.sh collections/apis/ledger-api/collection.yaml", - "postman:run:integrated-vendor": "./scripts/run-collection.sh postman/collections/integrated-vendor-flow.postman_collection.json" + "postman:run:fleetbase": "./scripts/run-collection.sh postman/collections/Fleetbase API", + "postman:run:core": "./scripts/run-collection.sh postman/collections/Fleetbase Core API", + "postman:run:storefront": "./scripts/run-collection.sh postman/collections/Fleetbase Storefront API", + "postman:run:ledger": "./scripts/run-collection.sh postman/collections/Fleetbase Ledger API", + "postman:run:integrated-vendor": "./scripts/run-collection.sh postman/collections/Fleetbase Integrated Vendor Flow" }, "keywords": [ "fleetbase", diff --git a/postman.config.json b/postman.config.json index bfa81d2..a95e8f7 100644 --- a/postman.config.json +++ b/postman.config.json @@ -1,8 +1,8 @@ { - "collectionFormat": "postman-v2.1-json", + "collectionFormat": "postman-v3-yaml-native-git", "collectionsRoot": "postman/collections", "environmentsRoot": "postman/environments", - "defaultEnvironment": "postman/environments/local.postman_environment.json", + "defaultEnvironment": "postman/environments/local.environment.yaml", "secretPolicy": { "commitTemplatesOnly": true, "usePostmanVaultForSecrets": true diff --git a/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml b/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml new file mode 100644 index 0000000..e8cee16 --- /dev/null +++ b/postman/collections/Fleetbase API/Contacts/Create a Contact.params.yaml @@ -0,0 +1,19 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: title + type: string + description: "Optional title associated with the contact or person." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml b/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml new file mode 100644 index 0000000..3a1deea --- /dev/null +++ b/postman/collections/Fleetbase API/Contacts/Query Contacts.queryParams.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this contacts request." + - name: limit + type: string + description: "Limit value for this contacts request." + - name: offset + type: string + description: "Offset value for this contacts request." + - name: sort + type: string + description: "Sort value for this contacts request." diff --git a/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml b/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml index c4227ed..d36c549 100644 --- a/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml +++ b/postman/collections/Fleetbase API/Contacts/Query Contacts.request.yaml @@ -1,21 +1,14 @@ $kind: http-request -description: Returns a list of your contacts. The contacts are returned sorted by creation date, with the most recent customers appearing first. -url: "{{base_url}}/{{namespace}}/contacts?query={{contact_name}}&limit=25&offset=0&sort=created_at" +description: |- + Returns a paginated list of contacts for the current organization. Use filters such as `query`, `limit`, `offset`, and `sort` to narrow and order the results. +url: "{{base_url}}/{{namespace}}/contacts" method: GET headers: Accept: application/json -queryParams: - - key: query - value: "{{contact_name}}" - description: This parameter allows you to filter the results by their name. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: A cursor used to sort results. Sort can be any property of the object, to sort descending sort must append the minus symbol. To sort by created date descending sort would be `-created_at` to sort in ascending order the sort would be `created_at`. examples: ./.resources/Query Contacts.resources/examples +queryParams: + query: "{{contact_name}}" + limit: "25" + offset: "0" + sort: "created_at" order: 2000 diff --git a/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml b/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml new file mode 100644 index 0000000..d22d77d --- /dev/null +++ b/postman/collections/Fleetbase API/Contacts/Update a Contact.params.yaml @@ -0,0 +1,21 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: title + type: string + description: "Optional title associated with the contact or person." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: slug + type: string + description: "URL-friendly identifier for the resource." diff --git a/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Create a Driver.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Drivers/Get Driver Current Organization.request.yaml b/postman/collections/Fleetbase API/Drivers/Get Driver Current Organization.request.yaml new file mode 100644 index 0000000..6c9681b --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Get Driver Current Organization.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Get Driver Current Organization" +description: "Returns the driver current organization." +url: "{{base_url}}/{{namespace}}/drivers/:id/current-organization" +method: GET +pathVariables: + - key: id + value: "{{driver_id}}" + +order: 12800 diff --git a/postman/collections/Fleetbase API/Drivers/List Driver Organizations.request.yaml b/postman/collections/Fleetbase API/Drivers/List Driver Organizations.request.yaml new file mode 100644 index 0000000..0e06bdb --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/List Driver Organizations.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "List Driver Organizations" +description: "Lists organizations a driver belongs to." +url: "{{base_url}}/{{namespace}}/drivers/:id/organizations" +method: GET +pathVariables: + - key: id + value: "{{driver_id}}" + +order: 12700 diff --git a/postman/collections/Fleetbase API/Drivers/Login Driver.request.yaml b/postman/collections/Fleetbase API/Drivers/Login Driver.request.yaml new file mode 100644 index 0000000..a0bc009 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Login Driver.request.yaml @@ -0,0 +1,14 @@ +$kind: http-request +name: "Login Driver" +description: "Authenticates a driver with email/phone and password." +url: "{{base_url}}/{{namespace}}/drivers/login" +method: POST +body: + type: json + content: |- + { + "identity": "{{driver_identity}}", + "password": "{{driver_password}}" + } + +order: 12000 diff --git a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml index 95e0620..e2e9da3 100644 --- a/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml +++ b/postman/collections/Fleetbase API/Drivers/Query Drivers.request.yaml @@ -1,12 +1,10 @@ $kind: http-request description: This endpoint allows you to retrieve a driver object to view it's details. -url: "{{base_url}}/{{namespace}}/drivers?id={{driver_id}}" +url: "{{base_url}}/{{namespace}}/drivers" method: GET headers: Accept: application/json -queryParams: - - key: id - value: "{{driver_id}}" - description: The id of the driver you want to retrieve. examples: ./.resources/Query Drivers.resources/examples +queryParams: + id: "{{driver_id}}" order: 2000 diff --git a/postman/collections/Fleetbase API/Drivers/Register Device.request.yaml b/postman/collections/Fleetbase API/Drivers/Register Device.request.yaml new file mode 100644 index 0000000..9306f4b --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Device.request.yaml @@ -0,0 +1,14 @@ +$kind: http-request +name: "Register Device" +description: "Registers a driver device token through the non-id route." +url: "{{base_url}}/{{namespace}}/drivers/register-device" +method: POST +body: + type: json + content: |- + { + "token": "{{device_token}}", + "platform": "ios" + } + +order: 12400 diff --git a/postman/collections/Fleetbase API/Drivers/Register Driver Device.request.yaml b/postman/collections/Fleetbase API/Drivers/Register Driver Device.request.yaml new file mode 100644 index 0000000..5054044 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Register Driver Device.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +name: "Register Driver Device" +description: "Registers a device token for a specific driver." +url: "{{base_url}}/{{namespace}}/drivers/:id/register-device" +method: POST +pathVariables: + - key: id + value: "{{driver_id}}" + +body: + type: json + content: |- + { + "token": "{{device_token}}", + "platform": "ios" + } + +order: 12300 diff --git a/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.request.yaml b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.request.yaml new file mode 100644 index 0000000..1a34486 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Request Driver Login SMS.request.yaml @@ -0,0 +1,13 @@ +$kind: http-request +name: "Request Driver Login SMS" +description: "Starts driver SMS verification login." +url: "{{base_url}}/{{namespace}}/drivers/login-with-sms" +method: POST +body: + type: json + content: |- + { + "phone": "{{driver_phone}}" + } + +order: 12100 diff --git a/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.request.yaml b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.request.yaml new file mode 100644 index 0000000..8c165ad --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Simulate Driver Route.request.yaml @@ -0,0 +1,24 @@ +$kind: http-request +name: "Simulate Driver Route" +description: "Simulates driver movement between two resolvable points, or pass order to simulate an order route." +url: "{{base_url}}/{{namespace}}/drivers/:id/simulate" +method: POST +pathVariables: + - key: id + value: "{{driver_id}}" + +body: + type: json + content: |- + { + "start": { + "latitude": 1.3521, + "longitude": 103.8198 + }, + "end": { + "latitude": 1.2903, + "longitude": 103.8519 + } + } + +order: 12900 diff --git a/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.request.yaml b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.request.yaml new file mode 100644 index 0000000..b47e1dc --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Switch Driver Organization.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +name: "Switch Driver Organization" +description: "Switches the driver session to another organization." +url: "{{base_url}}/{{namespace}}/drivers/:id/switch-organization" +method: POST +pathVariables: + - key: id + value: "{{driver_id}}" + +body: + type: json + content: |- + { + "next": "{{organization_id}}" + } + +order: 12500 diff --git a/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.request.yaml b/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.request.yaml new file mode 100644 index 0000000..ee7cad9 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Toggle Driver Online.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +name: "Toggle Driver Online" +description: "Toggles or sets driver online status." +url: "{{base_url}}/{{namespace}}/drivers/:id/toggle-online" +method: POST +pathVariables: + - key: id + value: "{{driver_id}}" + +body: + type: json + content: |- + { + "online": true + } + +order: 12600 diff --git a/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml b/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml new file mode 100644 index 0000000..2ef5153 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Update a Driver.params.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.request.yaml b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.request.yaml new file mode 100644 index 0000000..46c97c7 --- /dev/null +++ b/postman/collections/Fleetbase API/Drivers/Verify Driver Login Code.request.yaml @@ -0,0 +1,14 @@ +$kind: http-request +name: "Verify Driver Login Code" +description: "Verifies driver login code and returns a driver token." +url: "{{base_url}}/{{namespace}}/drivers/verify-code" +method: POST +body: + type: json + content: |- + { + "identity": "{{driver_identity}}", + "code": "{{verification_code}}" + } + +order: 12200 diff --git a/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml b/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/Create an Entity.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml b/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml new file mode 100644 index 0000000..209ecb0 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/Query Entities.queryParams.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this entities request." + - name: offset + type: string + description: "Offset value for this entities request." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." diff --git a/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml b/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml index e7174e3..eb07b1f 100644 --- a/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml +++ b/postman/collections/Fleetbase API/Entities/Query Entities.request.yaml @@ -1,24 +1,9 @@ $kind: http-request description: List all entities. -url: "{{base_url}}/{{namespace}}/entities?limit=25&offset=0&type=parcel" +url: "{{base_url}}/{{namespace}}/entities" method: GET queryParams: - - key: limit - value: "25" - - key: sort - value: created_at - disabled: true - - key: offset - value: "0" - - key: query - value: test - disabled: true - description: This parameter allows you to filter the results by their name. - - key: type - value: parcel - description: Filter entities by their type. - - key: payload - value: "{{payload_id}}" - disabled: true - description: Filter entites by payload they belong to. + limit: "25" + offset: "0" + type: "parcel" order: 2000 diff --git a/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml b/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml new file mode 100644 index 0000000..5256277 --- /dev/null +++ b/postman/collections/Fleetbase API/Entities/Update a Entity.params.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: internal_id + type: string + description: "External or internal identifier supplied by your system." + - name: description + type: string + description: "Human-readable description of the resource." + - name: destination + type: string + description: "Destination value for this entities request." + - name: sku + type: string + description: "Sku value for this entities request." + - name: currency + type: currency + description: "Three-letter currency code for monetary values." diff --git a/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml b/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml new file mode 100644 index 0000000..cb75256 --- /dev/null +++ b/postman/collections/Fleetbase API/Fleets/Create a Fleet.params.yaml @@ -0,0 +1,10 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml b/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml new file mode 100644 index 0000000..45461ca --- /dev/null +++ b/postman/collections/Fleetbase API/Fleets/Query Fleets.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this fleets request." + - name: offset + type: string + description: "Offset value for this fleets request." + - name: sort + type: string + description: "Sort value for this fleets request." diff --git a/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml b/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml index 9eb9b24..56022f0 100644 --- a/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml +++ b/postman/collections/Fleetbase API/Fleets/Query Fleets.request.yaml @@ -1,26 +1,13 @@ $kind: http-request -description: Returns a list of your fleets. The fleet are returned sorted by creation date, with the most recent customers appearing first. -url: "{{base_url}}/{{namespace}}/fleets?limit=25&offset=0&sort=created_at" +description: |- + Returns a paginated list of fleets for the current organization. Use pagination and sorting parameters to control the result set. +url: "{{base_url}}/{{namespace}}/fleets" method: GET headers: Accept: application/json -queryParams: - - key: query - value: "{{fleet_name}}" - disabled: true - description: This parameter allows you to filter the results by their name. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: A cursor used to sort results. Sort can be any property of the object, to sort descending sort must append the minus symbol. To sort by created date descending sort would be `-created_at` to sort in ascending order the sort would be `created_at`. - - key: status - value: active - disabled: true - description: Filter for filtering results by status. examples: ./.resources/Query Fleets.resources/examples +queryParams: + limit: "25" + offset: "0" + sort: "created_at" order: 2000 diff --git a/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml b/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml new file mode 100644 index 0000000..ecc1a5d --- /dev/null +++ b/postman/collections/Fleetbase API/Fleets/Update a Fleet.params.yaml @@ -0,0 +1,9 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml b/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml new file mode 100644 index 0000000..7f9cc0c --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 7700 diff --git a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml new file mode 100644 index 0000000..70b5679 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Create a Fuel Report.request.yaml @@ -0,0 +1,22 @@ +$kind: http-request +description: "Create a Fuel Report" +url: "{{base_url}}/{{namespace}}/fuel-reports" +method: POST +body: + type: json + content: |- + { + "driver": "{{driver_id}}", + "odometer": 12042, + "volume": 42.5, + "metric_unit": "liter", + "location": { + "latitude": 1.3521, + "longitude": 103.8198 + }, + "amount": 120.5, + "currency": "USD", + "status": "submitted" + } + +order: 1000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml new file mode 100644 index 0000000..4013917 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Delete a Fuel Report.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete a Fuel Report" +url: "{{base_url}}/{{namespace}}/fuel-reports/:id" +method: DELETE +pathVariables: + - key: id + value: "{{fuel_report_id}}" + +order: 5000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml new file mode 100644 index 0000000..56abbf5 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this fuel reports request." + - name: offset + type: string + description: "Offset value for this fuel reports request." + - name: sort + type: string + description: "Sort value for this fuel reports request." diff --git a/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml new file mode 100644 index 0000000..dffc1a8 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Query Fuel Reports.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Query Fuel Reports" +url: "{{base_url}}/{{namespace}}/fuel-reports" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 2000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml new file mode 100644 index 0000000..4d00050 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Retrieve a Fuel Report.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieve a Fuel Report" +url: "{{base_url}}/{{namespace}}/fuel-reports/:id" +method: GET +pathVariables: + - key: id + value: "{{fuel_report_id}}" + +order: 3000 diff --git a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml new file mode 100644 index 0000000..3f58da6 --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.params.yaml @@ -0,0 +1,21 @@ +$kind: params +fields: + - name: odometer + type: integer + description: "Vehicle odometer reading at the time of the report." + - name: volume + type: number + description: "Fuel volume purchased or reported." + - name: metric_unit + type: string + description: "Unit used for the fuel volume." + - name: amount + type: number + description: "Monetary amount for the request." + - name: currency + type: currency + description: "Three-letter currency code for monetary values." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml new file mode 100644 index 0000000..073156a --- /dev/null +++ b/postman/collections/Fleetbase API/Fuel Reports/Update a Fuel Report.request.yaml @@ -0,0 +1,21 @@ +$kind: http-request +description: "Update a Fuel Report" +url: "{{base_url}}/{{namespace}}/fuel-reports/:id" +method: PUT +pathVariables: + - key: id + value: "{{fuel_report_id}}" + +body: + type: json + content: |- + { + "odometer": 12050, + "volume": 43.1, + "metric_unit": "liter", + "amount": 122.75, + "currency": "USD", + "status": "approved" + } + +order: 4000 diff --git a/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml b/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml new file mode 100644 index 0000000..8392130 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 8050 diff --git a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml new file mode 100644 index 0000000..63df82a --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: per_page + type: string + description: "Per page value for this geofences request." diff --git a/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml new file mode 100644 index 0000000..9e663cc --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/Get Driver Geofence History.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Get Driver Geofence History" +url: "{{base_url}}/{{namespace}}/geofences/driver/:driverUuid/history" +method: GET + +pathVariables: + - key: driverUuid + value: "{{driver_uuid}}" + +queryParams: + per_page: "50" +order: 4000 diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml new file mode 100644 index 0000000..91e06b7 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: from + type: string + description: "From value for this geofences request." + - name: to + type: string + description: "To value for this geofences request." diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml new file mode 100644 index 0000000..58b3b65 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Dwell Report.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Get Geofence Dwell Report" +url: "{{base_url}}/{{namespace}}/geofences/dwell-report" +method: GET + +queryParams: + from: "{{from_datetime}}" + to: "{{to_datetime}}" +order: 3000 diff --git a/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml b/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml new file mode 100644 index 0000000..858d4da --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/Get Geofence Inventory.request.yaml @@ -0,0 +1,5 @@ +$kind: http-request +description: "Get Geofence Inventory" +url: "{{base_url}}/{{namespace}}/geofences/inventory" +method: GET +order: 2000 diff --git a/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml b/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml new file mode 100644 index 0000000..df271b1 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/List Geofence Events.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: per_page + type: string + description: "Per page value for this geofences request." + - name: event_type + type: string + description: "Event type value for this geofences request." diff --git a/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml b/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml new file mode 100644 index 0000000..08f3c60 --- /dev/null +++ b/postman/collections/Fleetbase API/Geofences/List Geofence Events.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "List Geofence Events" +url: "{{base_url}}/{{namespace}}/geofences/events" +method: GET + +queryParams: + per_page: "50" + event_type: "entered" +order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/.resources/definition.yaml b/postman/collections/Fleetbase API/Issues/.resources/definition.yaml new file mode 100644 index 0000000..a9d80d8 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 7600 diff --git a/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml b/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Create an Issue.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml new file mode 100644 index 0000000..af0443a --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Create an Issue.request.yaml @@ -0,0 +1,21 @@ +$kind: http-request +description: "Create an Issue" +url: "{{base_url}}/{{namespace}}/issues" +method: POST +body: + type: json + content: |- + { + "driver": "{{driver_id}}", + "location": { + "latitude": 1.3521, + "longitude": 103.8198 + }, + "report": "Vehicle tire pressure warning", + "category": "vehicle", + "type": "maintenance", + "priority": "medium", + "status": "open" + } + +order: 1000 diff --git a/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml new file mode 100644 index 0000000..28124df --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Delete an Issue.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete an Issue" +url: "{{base_url}}/{{namespace}}/issues/:id" +method: DELETE +pathVariables: + - key: id + value: "{{issue_id}}" + +order: 5000 diff --git a/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml b/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml new file mode 100644 index 0000000..f23b386 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Query Issues.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this issues request." + - name: offset + type: string + description: "Offset value for this issues request." + - name: sort + type: string + description: "Sort value for this issues request." diff --git a/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml b/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml new file mode 100644 index 0000000..5ef773e --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Query Issues.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Query Issues" +url: "{{base_url}}/{{namespace}}/issues" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 2000 diff --git a/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml new file mode 100644 index 0000000..8e0209b --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Retrieve an Issue.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieve an Issue" +url: "{{base_url}}/{{namespace}}/issues/:id" +method: GET +pathVariables: + - key: id + value: "{{issue_id}}" + +order: 3000 diff --git a/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml b/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml new file mode 100644 index 0000000..c61839a --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Update an Issue.params.yaml @@ -0,0 +1,20 @@ +$kind: params +fields: + - name: report + type: string + description: "Issue report text submitted by the caller." + - name: category + type: enum + description: "Category used to classify the issue or resource." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: priority + type: enum + values: ["low", "medium", "high"] + description: "Priority level for the issue." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml b/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml new file mode 100644 index 0000000..444f164 --- /dev/null +++ b/postman/collections/Fleetbase API/Issues/Update an Issue.request.yaml @@ -0,0 +1,20 @@ +$kind: http-request +description: "Update an Issue" +url: "{{base_url}}/{{namespace}}/issues/:id" +method: PUT +pathVariables: + - key: id + value: "{{issue_id}}" + +body: + type: json + content: |- + { + "report": "Updated issue report", + "category": "vehicle", + "type": "maintenance", + "priority": "high", + "status": "resolved" + } + +order: 4000 diff --git a/postman/collections/Fleetbase API/Labels/.resources/definition.yaml b/postman/collections/Fleetbase API/Labels/.resources/definition.yaml new file mode 100644 index 0000000..015248f --- /dev/null +++ b/postman/collections/Fleetbase API/Labels/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 13000 diff --git a/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml b/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml new file mode 100644 index 0000000..7bb1673 --- /dev/null +++ b/postman/collections/Fleetbase API/Labels/Render Label.queryParams.yaml @@ -0,0 +1,10 @@ +$kind: params +fields: + - name: format + type: enum + values: ["stream", "base64", "url"] + description: "Format value for this labels request." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." diff --git a/postman/collections/Fleetbase API/Labels/Render Label.request.yaml b/postman/collections/Fleetbase API/Labels/Render Label.request.yaml new file mode 100644 index 0000000..afab145 --- /dev/null +++ b/postman/collections/Fleetbase API/Labels/Render Label.request.yaml @@ -0,0 +1,13 @@ +$kind: http-request +description: "Renders a PDF, text, or base64 label for an order, waypoint, or entity id." +url: "{{base_url}}/{{namespace}}/labels/:id" +method: GET + +pathVariables: + - key: id + value: "{{label_subject_id}}" + +queryParams: + format: "stream" + type: "order" +order: 1000 diff --git a/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml b/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml new file mode 100644 index 0000000..9668770 --- /dev/null +++ b/postman/collections/Fleetbase API/Onboard/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 13100 diff --git a/postman/collections/Fleetbase API/Onboard/Get Driver Onboard Settings.request.yaml b/postman/collections/Fleetbase API/Onboard/Get Driver Onboard Settings.request.yaml new file mode 100644 index 0000000..2f3d0cd --- /dev/null +++ b/postman/collections/Fleetbase API/Onboard/Get Driver Onboard Settings.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Returns driver onboarding settings for an organization." +url: "{{base_url}}/{{namespace}}/onboard/driver-onboard-settings/:companyId" +method: GET +pathVariables: + - key: companyId + value: "{{organization_id}}" + +order: 1000 diff --git a/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml b/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml index 00e4ce3..5d0fca1 100644 --- a/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Cancel an Order-.request.yaml @@ -1,7 +1,7 @@ $kind: http-request name: Cancel an Order. -description: Cancel an Order. -url: "{{base_url}}/{{namespace}}/orders/:id" +description: Cancels an order without deleting the order resource. +url: "{{base_url}}/{{namespace}}/orders/:id/cancel" method: DELETE pathVariables: - key: id diff --git a/postman/collections/Fleetbase API/Orders/Capture Photo for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.request.yaml new file mode 100644 index 0000000..0f5c3c4 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Capture Photo for Order.request.yaml @@ -0,0 +1,23 @@ +$kind: http-request +name: "Capture Photo for Order" +description: "Captures proof photos for an order or order subject." +url: "{{base_url}}/{{namespace}}/orders/:id/capture-photo/:subjectId" +method: POST +pathVariables: + - key: id + value: "{{order_id}}" + - key: subjectId + value: "{{subject_id}}" + +body: + type: json + content: |- + { + "photos": [ + "{{proof_photo_base64}}" + ], + "remarks": "Verified by Photo", + "data": {} + } + +order: 14500 diff --git a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml index d1473e9..e194292 100644 --- a/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture QR Code for Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Captures a QR code proof for an order or order subject. The response includes the updated proof data associated with the order. url: "{{base_url}}/{{namespace}}/orders/:id/capture-qr/:subject-id" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml index 905eb20..80cabdc 100644 --- a/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Capture Signature for Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Captures a signature proof for an order or order subject. Use this when a workflow requires signed proof of delivery or pickup. url: "{{base_url}}/{{namespace}}/orders/:id/capture-signature/:subject-id" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Complete an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Complete an Order.request.yaml new file mode 100644 index 0000000..584dc9c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Complete an Order.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Complete an Order" +description: "Completes an order after all waypoints are complete." +url: "{{base_url}}/{{namespace}}/orders/:id/complete" +method: POST +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14100 diff --git a/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Create an Order.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Orders/Delete an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Delete an Order.request.yaml new file mode 100644 index 0000000..665ea87 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Delete an Order.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +description: "Deletes an order resource." +url: "{{base_url}}/{{namespace}}/orders/:id" +method: DELETE +pathVariables: + - key: id + value: "{{order_id}}" + description: "The order id." + +order: 13500 diff --git a/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml index f46abf7..0605575 100644 --- a/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Dispatch an Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Dispatches an order to an assigned or eligible driver. The response returns the order after dispatch state has been applied. url: "{{base_url}}/{{namespace}}/orders/:id/dispatch" method: PATCH pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Get Editable Entity Fields.request.yaml b/postman/collections/Fleetbase API/Orders/Get Editable Entity Fields.request.yaml new file mode 100644 index 0000000..fbfc8d8 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Get Editable Entity Fields.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Get Editable Entity Fields" +description: "Returns configured editable entity fields for an order." +url: "{{base_url}}/{{namespace}}/orders/:id/editable-entity-fields" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14700 diff --git a/postman/collections/Fleetbase API/Orders/Get Order Distance and Time.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order Distance and Time.request.yaml new file mode 100644 index 0000000..eea06e4 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Get Order Distance and Time.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Get Order Distance and Time" +description: "Returns and updates the order distance/time matrix." +url: "{{base_url}}/{{namespace}}/orders/:id/distance-and-time" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14000 diff --git a/postman/collections/Fleetbase API/Orders/Get Order ETA.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order ETA.request.yaml new file mode 100644 index 0000000..9b9afc8 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Get Order ETA.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Get Order ETA" +description: "Returns ETA data for an order." +url: "{{base_url}}/{{namespace}}/orders/:id/eta" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14300 diff --git a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml index 8895aab..cc66b8b 100644 --- a/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Get Order Next Activity.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Returns the next workflow activity for an order. Use it to determine the next operational step available to the assigned driver or dispatcher. url: "{{base_url}}/{{namespace}}/orders/:id/next-activity" method: GET pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Get Order Tracker.request.yaml b/postman/collections/Fleetbase API/Orders/Get Order Tracker.request.yaml new file mode 100644 index 0000000..4f8c7d9 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Get Order Tracker.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "Get Order Tracker" +description: "Returns public tracking data for an order." +url: "{{base_url}}/{{namespace}}/orders/:id/tracker" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14200 diff --git a/postman/collections/Fleetbase API/Orders/List Order Comments.request.yaml b/postman/collections/Fleetbase API/Orders/List Order Comments.request.yaml new file mode 100644 index 0000000..54f2788 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/List Order Comments.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +name: "List Order Comments" +description: "Lists comments attached to an order." +url: "{{base_url}}/{{namespace}}/orders/:id/comments" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + +order: 14400 diff --git a/postman/collections/Fleetbase API/Orders/List Order Proofs.request.yaml b/postman/collections/Fleetbase API/Orders/List Order Proofs.request.yaml new file mode 100644 index 0000000..1d569e1 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/List Order Proofs.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +name: "List Order Proofs" +description: "Lists proof of delivery resources for an order or subject." +url: "{{base_url}}/{{namespace}}/orders/:id/proofs/:subjectId" +method: GET +pathVariables: + - key: id + value: "{{order_id}}" + - key: subjectId + value: "{{subject_id}}" + +order: 14600 diff --git a/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml b/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml new file mode 100644 index 0000000..f3a0de0 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Query Orders.queryParams.yaml @@ -0,0 +1,15 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this orders request." + - name: offset + type: string + description: "Offset value for this orders request." + - name: sort + type: string + description: "Sort value for this orders request." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml index 3b8334c..840c8c7 100644 --- a/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Query Orders.request.yaml @@ -1,17 +1,10 @@ $kind: http-request description: List all orders. -url: "{{base_url}}/{{namespace}}/orders?limit=25&offset=0&sort=created_at&status=active" +url: "{{base_url}}/{{namespace}}/orders" method: GET queryParams: - - key: query - value: "" - disabled: true - - key: limit - value: "25" - - key: offset - value: "0" - - key: sort - value: created_at - - key: status - value: active + limit: "25" + offset: "0" + sort: "created_at" + status: "active" order: 2000 diff --git a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml index f8c7a32..f9b6753 100644 --- a/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Set Order Destination.request.yaml @@ -1,13 +1,14 @@ $kind: http-request -description: Dispatches order to Driver. -url: "{{base_url}}/{{namespace}}/orders/:id/set-destination/:waypoint-id" +description: |- + Sets the destination waypoint or place for an order. The response returns the updated order after the destination is changed. +url: "{{base_url}}/{{namespace}}/orders/:id/set-destination/:placeId" method: PATCH pathVariables: - key: id value: "{{order_id}}" description: (Required) The id of the order to dispatch. - - key: waypoint-id - value: "{{waypoint_id}}" + - key: placeId + value: "{{place_id}}" body: type: json content: "" diff --git a/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml b/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml index c003aa6..3f94612 100644 --- a/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Start an Order.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Starts an order and transitions it into active execution. Use this when a driver or dispatcher begins fulfillment. url: "{{base_url}}/{{namespace}}/orders/:id/start" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml b/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml new file mode 100644 index 0000000..423ed33 --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Update Order Activity.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: skip_dispatch + type: boolean + description: "Skip dispatch value for this orders request." diff --git a/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml b/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml index 14d6126..c0ce834 100644 --- a/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml +++ b/postman/collections/Fleetbase API/Orders/Update Order Activity.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Dispatches order to Driver. +description: |- + Updates the current activity state for an order. The response returns the order with the latest workflow activity applied. url: "{{base_url}}/{{namespace}}/orders/:id/update-activity" method: POST pathVariables: diff --git a/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml b/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml new file mode 100644 index 0000000..865a32c --- /dev/null +++ b/postman/collections/Fleetbase API/Orders/Update an Order.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: service_quote + type: string + description: "Service quote ID used by the request." diff --git a/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml b/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml new file mode 100644 index 0000000..4b9abd9 --- /dev/null +++ b/postman/collections/Fleetbase API/Organizations/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 500 diff --git a/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml b/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml new file mode 100644 index 0000000..76890d1 --- /dev/null +++ b/postman/collections/Fleetbase API/Organizations/List Organizations.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this organizations request." + - name: with_driver_onboard + type: string + description: "With driver onboard value for this organizations request." diff --git a/postman/collections/Fleetbase API/Organizations/List Organizations.request.yaml b/postman/collections/Fleetbase API/Organizations/List Organizations.request.yaml new file mode 100644 index 0000000..b300065 --- /dev/null +++ b/postman/collections/Fleetbase API/Organizations/List Organizations.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Lists organizations available for driver onboarding and organization selection." +url: "{{base_url}}/{{namespace}}/organizations" +method: GET + +queryParams: + limit: "10" + with_driver_onboard: "false" +order: 1000 diff --git a/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml b/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/Create a Payload.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml b/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml new file mode 100644 index 0000000..84af84d --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/Query Payloads.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this payloads request." + - name: offset + type: string + description: "Offset value for this payloads request." + - name: sort + type: string + description: "Sort value for this payloads request." diff --git a/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml b/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml new file mode 100644 index 0000000..5e0acb4 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/Query Payloads.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Queries payload resources." +url: "{{base_url}}/{{namespace}}/payloads" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 2500 diff --git a/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml b/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml new file mode 100644 index 0000000..b5dc316 --- /dev/null +++ b/postman/collections/Fleetbase API/Payloads/Update a Payload.params.yaml @@ -0,0 +1,18 @@ +$kind: params +fields: + - name: entities + type: array of objects + description: "Entities included in the payload or order." + fields: + - name: name + type: string + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: currency + type: currency + description: "Three-letter currency code for monetary values." + - name: price + type: integer + description: "Price for the item or entity." diff --git a/postman/collections/Fleetbase API/Places/Create a Place.params.yaml b/postman/collections/Fleetbase API/Places/Create a Place.params.yaml new file mode 100644 index 0000000..89b4dcb --- /dev/null +++ b/postman/collections/Fleetbase API/Places/Create a Place.params.yaml @@ -0,0 +1,40 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: street1 + type: string + description: "Primary street address." + - name: city + type: string + description: "City or locality for the address." + - name: province + type: string + description: "State, province, or region for the address." + - name: postal_code + type: string + description: "Postal or ZIP code for the address." + - name: neighborhood + type: string + description: "Neighborhood or local area for the address." + - name: district + type: string + description: "District or administrative subdivision for the address." + - name: building + type: string + description: "Building name, number, or additional address detail." + - name: country + type: string + description: "ISO country code for the address." + - name: phone_number + type: string + description: "Local phone number for the place or contact." + - name: phone_country_code + type: string + description: "International dialing code for the phone number." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." diff --git a/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml new file mode 100644 index 0000000..d7b8283 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/List all Places.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this places request." + - name: offset + type: string + description: "Offset value for this places request." + - name: sort + type: string + description: "Sort value for this places request." diff --git a/postman/collections/Fleetbase API/Places/List all Places.request.yaml b/postman/collections/Fleetbase API/Places/List all Places.request.yaml index 603092b..77576aa 100644 --- a/postman/collections/Fleetbase API/Places/List all Places.request.yaml +++ b/postman/collections/Fleetbase API/Places/List all Places.request.yaml @@ -1,17 +1,12 @@ $kind: http-request -description: Returns a list of your places. The places are returned sorted by creation date, with the most recent customers appearing first. -url: "{{base_url}}/{{namespace}}/places?limit=25&offset=0&sort=created_at" +description: |- + Returns a paginated list of places for the current organization. Places are sorted by creation date unless another sort order is provided. +url: "{{base_url}}/{{namespace}}/places" method: GET headers: Accept: application/json queryParams: - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: You can order the results by any property of the Place object. + limit: "25" + offset: "0" + sort: "created_at" order: 3000 diff --git a/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml new file mode 100644 index 0000000..385a213 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/Query Places.queryParams.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this places request." + - name: limit + type: string + description: "Limit value for this places request." + - name: offset + type: string + description: "Offset value for this places request." + - name: sort + type: string + description: "Sort value for this places request." diff --git a/postman/collections/Fleetbase API/Places/Query Places.request.yaml b/postman/collections/Fleetbase API/Places/Query Places.request.yaml index 2a5e1f4..bbeb3e3 100644 --- a/postman/collections/Fleetbase API/Places/Query Places.request.yaml +++ b/postman/collections/Fleetbase API/Places/Query Places.request.yaml @@ -1,20 +1,13 @@ $kind: http-request -description: Returns a list of your places. The places are returned sorted by creation date, with the most recent customers appearing first. -url: "{{base_url}}/{{namespace}}/places?query={{place_name}}&limit=25&offset=&sort=created_at" +description: |- + Searches and filters places for the current organization. Use query and pagination parameters to find matching saved locations. +url: "{{base_url}}/{{namespace}}/places" method: GET headers: Accept: application/json queryParams: - - key: query - value: "{{place_name}}" - description: This parameter allows you to filter the results by their name. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: A cursor used to sort results. Sort can be any property of the object, to sort descending sort must append the minus symbol. To sort by created date descending sort would be `-created_at` to sort in ascending order the sort would be `created_at`. + query: "{{place_name}}" + limit: "25" + offset: "" + sort: "created_at" order: 2000 diff --git a/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml b/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml new file mode 100644 index 0000000..995ba06 --- /dev/null +++ b/postman/collections/Fleetbase API/Places/Search Places.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this places request." + - name: ll + type: string + description: "Ll value for this places request." + - name: locale + type: string + description: "Locale value for this places request." diff --git a/postman/collections/Fleetbase API/Places/Search Places.request.yaml b/postman/collections/Fleetbase API/Places/Search Places.request.yaml new file mode 100644 index 0000000..81920bd --- /dev/null +++ b/postman/collections/Fleetbase API/Places/Search Places.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +description: "Searches places by free-form query and optional lat/lng locale context." +url: "{{base_url}}/{{namespace}}/places/search" +method: GET + +queryParams: + query: "{{place_query}}" + ll: "{{place_ll}}" + locale: "{{locale}}" +order: 2500 diff --git a/postman/collections/Fleetbase API/Places/Update a Place.params.yaml b/postman/collections/Fleetbase API/Places/Update a Place.params.yaml new file mode 100644 index 0000000..087ca2d --- /dev/null +++ b/postman/collections/Fleetbase API/Places/Update a Place.params.yaml @@ -0,0 +1,39 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: street1 + type: string + description: "Primary street address." + - name: city + type: string + description: "City or locality for the address." + - name: province + type: string + description: "State, province, or region for the address." + - name: postal_code + type: string + description: "Postal or ZIP code for the address." + - name: neighborhood + type: string + description: "Neighborhood or local area for the address." + - name: district + type: string + description: "District or administrative subdivision for the address." + - name: building + type: string + description: "Building name, number, or additional address detail." + - name: country + type: string + description: "ISO country code for the address." + - name: phone_number + type: string + description: "Local phone number for the place or contact." + - name: phone_country_code + type: string + description: "International dialing code for the phone number." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." diff --git a/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml b/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Purchase Rates/Create a Purchase Rate.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml new file mode 100644 index 0000000..6111f08 --- /dev/null +++ b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this purchase rates request." + - name: offset + type: string + description: "Offset value for this purchase rates request." + - name: sort + type: string + description: "Sort value for this purchase rates request." diff --git a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml index 7fdabf6..3dbb7a2 100644 --- a/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml +++ b/postman/collections/Fleetbase API/Purchase Rates/Query Purchase Rates.request.yaml @@ -1,19 +1,9 @@ $kind: http-request description: This endpoint allows you to query purchase-rates you have created, it also provides paginated results on all the purchase-rates in your Fleetbase. -url: "{{base_url}}/{{namespace}}/purchase-rates?limit=25&offset=0&sort=created_at" +url: "{{base_url}}/{{namespace}}/purchase-rates" method: GET queryParams: - - key: customer - value: - disabled: true - description: The id of the customer the rate was purchased for. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: You can order the results by any property of the Purchase Rate object. + limit: "25" + offset: "0" + sort: "created_at" order: 3000 diff --git a/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml new file mode 100644 index 0000000..b115787 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/Create a Service Area.params.yaml @@ -0,0 +1,26 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: latitude + type: number + description: "Decimal latitude coordinate." + - name: longitude + type: number + description: "Decimal longitude coordinate." + - name: radius + type: number + description: "Radius in meters when creating a circular zone." + - name: country + type: string + description: "ISO country code for the address." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml new file mode 100644 index 0000000..8e0ec7d --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." diff --git a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml index e92279d..9521202 100644 --- a/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml +++ b/postman/collections/Fleetbase API/Service Areas/Query Service Areas.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a service area object to view it's details. -url: "{{base_url}}/{{namespace}}/service-areas?name={{service_area_name}}" +description: |- + Returns service areas matching the supplied filters. Use this to find configured operating regions by name or other query parameters. +url: "{{base_url}}/{{namespace}}/service-areas" method: GET queryParams: name: "{{service_area_name}}" diff --git a/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml b/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml new file mode 100644 index 0000000..dd778cd --- /dev/null +++ b/postman/collections/Fleetbase API/Service Areas/Update a Service Area.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.queryParams.yaml b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.queryParams.yaml new file mode 100644 index 0000000..59075fa --- /dev/null +++ b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: payload + type: string + description: "Payload ID or embedded payload object associated with the resource." diff --git a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml index 8af53ed..68d007c 100644 --- a/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml +++ b/postman/collections/Fleetbase API/Service Quotes/Query Service Quotes.request.yaml @@ -3,24 +3,12 @@ description: |- This endpoint is used to get the ServiceRate quotes based on pickup point location and drop off point location, or payload. For some quotes such as parcel based, the payload must be included for calculation of the payload cost. -url: "{{base_url}}/{{namespace}}/service-quotes?payload={{payload_id}}" +url: "{{base_url}}/{{namespace}}/service-quotes" method: GET headers: Accept: application/json queryParams: - - key: payload - value: "{{payload_id}}" - description: The id of a Payload object, the payload type should match the service_type of the rates being retrieved. When the payload is supplied the other parameters are not required. - - key: service_type - value: food_delivery - disabled: true - description: The service_type to calculate the rates for. This required field is defined in all ServiceRate objects. Required when payload is not supplied. - - key: pickup - value: 10 Bayfront Avenue, Singapore 018956 - disabled: true - - key: dropoff - value: 18 Marina Gardens Drive, Singapore 018953 - disabled: true + payload: "{{payload_id}}" body: type: json content: "" diff --git a/postman/collections/Fleetbase API/Service Quotes/Retrieve a Service Quote.request.yaml b/postman/collections/Fleetbase API/Service Quotes/Retrieve a Service Quote.request.yaml new file mode 100644 index 0000000..0bf4e07 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Quotes/Retrieve a Service Quote.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieves a service quote by id." +url: "{{base_url}}/{{namespace}}/service-quotes/:id" +method: GET +pathVariables: + - key: id + value: "{{service_quote_id}}" + +order: 2000 diff --git a/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Create a Service Rate.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml new file mode 100644 index 0000000..60fc58d --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this service rates request." + - name: offset + type: string + description: "Offset value for this service rates request." + - name: currency + type: currency + description: "Three-letter currency code for monetary values." diff --git a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.request.yaml b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.request.yaml index c4cf0bf..0fd7574 100644 --- a/postman/collections/Fleetbase API/Service Rates/Query Service Rates.request.yaml +++ b/postman/collections/Fleetbase API/Service Rates/Query Service Rates.request.yaml @@ -1,23 +1,11 @@ $kind: http-request description: List all service rates. -url: "{{base_url}}/{{namespace}}/service-rates?limit=25&offset=0¤cy=USD" +url: "{{base_url}}/{{namespace}}/service-rates" method: GET queryParams: - - key: limit - value: "25" - - key: sort - value: created_at - disabled: true - - key: offset - value: "0" - - key: query - value: test - disabled: true - - key: service_type - value: parcel - disabled: true - - key: currency - value: USD + limit: "25" + offset: "0" + currency: "USD" body: type: json content: "" diff --git a/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml b/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml new file mode 100644 index 0000000..ee36024 --- /dev/null +++ b/postman/collections/Fleetbase API/Service Rates/Update a Service Rate.params.yaml @@ -0,0 +1,15 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/Create a Tracking Number.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.request.yaml new file mode 100644 index 0000000..d50c90a --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/Decode Tracking Number QR.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: "Decodes a tracking/entity/order QR code UUID and returns the matching resource." +url: "{{base_url}}/{{namespace}}/tracking-numbers/from-qr" +method: POST +body: + type: json + content: |- + { + "code": "{{qr_code}}" + } + +order: 1500 diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml new file mode 100644 index 0000000..12a5ce3 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.queryParams.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this tracking numbers request." + - name: limit + type: string + description: "Limit value for this tracking numbers request." + - name: offset + type: string + description: "Offset value for this tracking numbers request." + - name: sort + type: string + description: "Sort value for this tracking numbers request." diff --git a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml index df60b16..99306aa 100644 --- a/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Numbers/Query Tracking Numbers.request.yaml @@ -1,25 +1,13 @@ $kind: http-request description: This endpoint allows you to query tracking-numbers you have created, it also provides paginated results on all the tracking-numbers in your Fleetbase. -url: "{{base_url}}/{{namespace}}/tracking-numbers?query=SG&limit=25&offset=0&sort=created_at" +url: "{{base_url}}/{{namespace}}/tracking-numbers" method: GET headers: Accept: application/json -queryParams: - - key: query - value: SG - description: This parameter allows you to filter the results by their name. - - key: status - value: created - disabled: true - description: Filter the tracking-numbers by their status. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: You can order the results by any property of the Tracking Number object. examples: ./.resources/Query Tracking Numbers.resources/examples +queryParams: + query: "SG" + limit: "25" + offset: "0" + sort: "created_at" order: 3000 diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Statuses/Create a Tracking Status.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml new file mode 100644 index 0000000..c818d7c --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this tracking statuses request." + - name: tracking_number + type: string + description: "Tracking number ID associated with the status." diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.request.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.request.yaml index d2a022c..5e80253 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Query Tracking Statuses.request.yaml @@ -1,11 +1,11 @@ $kind: http-request description: List all Tracking Statuses -url: "{{base_url}}/{{namespace}}/tracking-statuses?limit=25&tracking_number={{tracking_number_id}}" +url: "{{base_url}}/{{namespace}}/tracking-statuses" method: GET headers: Accept: application/json +examples: ./.resources/Query Tracking Statuses.resources/examples queryParams: limit: "25" tracking_number: "{{tracking_number_id}}" -examples: ./.resources/Query Tracking Statuses.resources/examples order: 4000 diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml new file mode 100644 index 0000000..7e0f9ba --- /dev/null +++ b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: country + type: string + description: "ISO country code for the address." diff --git a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml index 675d3de..9631177 100644 --- a/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml +++ b/postman/collections/Fleetbase API/Tracking Statuses/Update a Tracking Status.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: Create a new Tracking Status. +description: |- + Updates an existing tracking status. The response returns the tracking status with the new values applied. url: "{{base_url}}/{{namespace}}/tracking-statuses/:id" method: PUT headers: diff --git a/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml new file mode 100644 index 0000000..c493a5e --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/Create a Vehicle.params.yaml @@ -0,0 +1,24 @@ +$kind: params +fields: + - name: vin + type: string + description: "Vehicle identification number." + - name: year + type: integer + description: "Model year of the vehicle." + - name: make + type: string + description: "Vehicle manufacturer." + - name: model + type: string + description: "Vehicle model." + - name: trim + type: string + description: "Vehicle trim or variant." + - name: plate_number + type: string + description: "Vehicle license plate number." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." diff --git a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml new file mode 100644 index 0000000..efc7f31 --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.queryParams.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this vehicles request." + - name: limit + type: string + description: "Limit value for this vehicles request." + - name: offset + type: string + description: "Offset value for this vehicles request." + - name: sort + type: string + description: "Sort value for this vehicles request." diff --git a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml index d77f05d..0dfdc28 100644 --- a/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml +++ b/postman/collections/Fleetbase API/Vehicles/Query Vehicles.request.yaml @@ -1,21 +1,13 @@ $kind: http-request description: This endpoint allows you to query vehicles you have created, it also provides paginated results on all the vehicles in your Fleetbase. -url: "{{base_url}}/{{namespace}}/vehicles?query={{vehicle_name}}&limit=25&offset=0&sort=created_at" +url: "{{base_url}}/{{namespace}}/vehicles" method: GET headers: Accept: application/json -queryParams: - - key: query - value: "{{vehicle_name}}" - description: This parameter allows you to filter the results by their name. - - key: limit - value: "25" - description: A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - - key: offset - value: "0" - description: A cursor for use in pagination. A offset for the results, when the offset is supplied the results will start from the offset. - - key: sort - value: created_at - description: A cursor used to sort results. Sort can be any property of the object, to sort descending sort must append the minus symbol. To sort by created date descending sort would be `-created_at` to sort in ascending order the sort would be `created_at`. examples: ./.resources/Query Vehicles.resources/examples +queryParams: + query: "{{vehicle_name}}" + limit: "25" + offset: "0" + sort: "created_at" order: 2000 diff --git a/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml new file mode 100644 index 0000000..b539059 --- /dev/null +++ b/postman/collections/Fleetbase API/Vehicles/Update a Vehicle.params.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: speed + type: integer + description: "Current speed for the tracked subject." + - name: bearing + type: number + description: "Current heading or bearing in degrees." + - name: latitude + type: number + description: "Decimal latitude coordinate." + - name: longitude + type: number + description: "Decimal longitude coordinate." diff --git a/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml b/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml new file mode 100644 index 0000000..6e66ba6 --- /dev/null +++ b/postman/collections/Fleetbase API/Vendors/Create a Vendor.params.yaml @@ -0,0 +1,19 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: internal_id + type: string + description: "External or internal identifier supplied by your system." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml index e1d6512..823c1bb 100644 --- a/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml +++ b/postman/collections/Fleetbase API/Vendors/Query Vendors.request.yaml @@ -1,12 +1,10 @@ $kind: http-request description: This endpoint allows you to retrieve a vendor object to view it's details. -url: "{{base_url}}/{{namespace}}/vendors?id={{vendor_id}}" +url: "{{base_url}}/{{namespace}}/vendors" method: GET headers: Accept: application/json -queryParams: - - key: id - value: "{{vendor_id}}" - description: The id of the vendor you want to retrieve. examples: ./.resources/Query Vendors.resources/examples +queryParams: + id: "{{vendor_id}}" order: 4000 diff --git a/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml b/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml new file mode 100644 index 0000000..b15a3c9 --- /dev/null +++ b/postman/collections/Fleetbase API/Vendors/Update a Vendor.params.yaml @@ -0,0 +1,18 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: internal_id + type: string + description: "External or internal identifier supplied by your system." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." diff --git a/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml b/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase API/Zones/Create a Zone.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml b/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml index f6dfc3f..893ab6e 100644 --- a/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Create a Zone.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. +description: |- + Creates a zone inside a service area. Provide either a GeoJSON boundary or a center point with radius, and Fleetbase will store the zone for geofencing and service coverage checks. url: "{{base_url}}/{{namespace}}/zones" method: POST body: diff --git a/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml b/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml new file mode 100644 index 0000000..8e0ec7d --- /dev/null +++ b/postman/collections/Fleetbase API/Zones/Query Zones.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." diff --git a/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml b/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml index 5d6536c..ae634f3 100644 --- a/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Query Zones.request.yaml @@ -1,12 +1,11 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/zones?name={{zone_name}}" +description: |- + Returns zones matching the supplied filters. Use this to find configured geofences by name or other query parameters. +url: "{{base_url}}/{{namespace}}/zones" method: GET headers: Accept: application/json -queryParams: - - key: name - value: "{{zone_name}}" - description: The id of the zone you want to retrieve. examples: ./.resources/Query Zones.resources/examples +queryParams: + name: "{{zone_name}}" order: 3000 diff --git a/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml b/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml index f870a4b..473b66a 100644 --- a/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml +++ b/postman/collections/Fleetbase API/Zones/Retrieve a zone.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. +description: |- + Retrieves a single zone by ID. The response includes the zone geometry, display styling, and service area relationship. url: "{{base_url}}/{{namespace}}/zones/:id" method: GET headers: diff --git a/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml b/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml new file mode 100644 index 0000000..88993ce --- /dev/null +++ b/postman/collections/Fleetbase API/Zones/Update a Zone.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: color + type: string + description: "Fill color used when rendering the zone." diff --git a/postman/collections/Fleetbase Core API/.resources/definition.yaml b/postman/collections/Fleetbase Core API/.resources/definition.yaml new file mode 100644 index 0000000..5db158e --- /dev/null +++ b/postman/collections/Fleetbase Core API/.resources/definition.yaml @@ -0,0 +1,11 @@ +$kind: collection +description: Core Fleetbase API endpoints shared across Fleetbase modules. +variables: + base_url: "" + namespace: v1 + api_key: "" +auth: + - type: bearer + name: bearer auth + credentials: + token: "{{api_key}}" diff --git a/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml new file mode 100644 index 0000000..40bbb1c --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 3000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml new file mode 100644 index 0000000..837fa51 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Add Participant.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Add Participant" +url: "{{base_url}}/{{namespace}}/chat-channels/:id/add-participant" +method: POST +pathVariables: + - key: id + value: "{{chat_channel_id}}" + +body: + type: json + content: |- + { + "user": "{{user_id}}" + } + +order: 10000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml new file mode 100644 index 0000000..5d75a1f --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Chat Channel.request.yaml @@ -0,0 +1,15 @@ +$kind: http-request +description: "Create Chat Channel" +url: "{{base_url}}/{{namespace}}/chat-channels" +method: POST +body: + type: json + content: |- + { + "name": "Dispatch", + "participants": [ + "{{user_id}}" + ] + } + +order: 5000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml new file mode 100644 index 0000000..7d96366 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Create Read Receipt.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Create Read Receipt" +url: "{{base_url}}/{{namespace}}/chat-channels/read-message/:chatMessageId" +method: POST +pathVariables: + - key: chatMessageId + value: "{{chat_message_id}}" + +body: + type: json + content: |- + { + "participant": "{{chat_participant_id}}" + } + +order: 4000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml new file mode 100644 index 0000000..857cdb4 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Chat Channel.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete Chat Channel" +url: "{{base_url}}/{{namespace}}/chat-channels/:id" +method: DELETE +pathVariables: + - key: id + value: "{{chat_channel_id}}" + +order: 9000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml new file mode 100644 index 0000000..5b59a87 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Delete Message.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete Message" +url: "{{base_url}}/{{namespace}}/chat-channels/delete-message/:chatMessageId" +method: DELETE +pathVariables: + - key: chatMessageId + value: "{{chat_message_id}}" + +order: 3000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.queryParams.yaml b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.queryParams.yaml new file mode 100644 index 0000000..8e198fb --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: channel + type: string + description: "Channel value for this chat channels request." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml new file mode 100644 index 0000000..3dbfe0c --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/List Available Participants.request.yaml @@ -0,0 +1,7 @@ +$kind: http-request +description: "List Available Participants" +url: "{{base_url}}/{{namespace}}/chat-channels/available-participants" +method: GET +queryParams: + channel: "{{chat_channel_id}}" +order: 1000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.queryParams.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.queryParams.yaml new file mode 100644 index 0000000..68a2005 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this chat channels request." + - name: offset + type: string + description: "Offset value for this chat channels request." + - name: sort + type: string + description: "Sort value for this chat channels request." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml new file mode 100644 index 0000000..e1bd12b --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Query Chat Channels.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Query Chat Channels" +url: "{{base_url}}/{{namespace}}/chat-channels" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 7000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml new file mode 100644 index 0000000..9abe7ad --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Remove Participant.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Remove Participant" +url: "{{base_url}}/{{namespace}}/chat-channels/remove-participant/:participantId" +method: DELETE +pathVariables: + - key: participantId + value: "{{chat_participant_id}}" + +order: 11000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml new file mode 100644 index 0000000..f9c25f0 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Retrieve Chat Channel.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieve Chat Channel" +url: "{{base_url}}/{{namespace}}/chat-channels/:id" +method: GET +pathVariables: + - key: id + value: "{{chat_channel_id}}" + +order: 8000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml new file mode 100644 index 0000000..408f880 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Send Message.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: "Send Message" +url: "{{base_url}}/{{namespace}}/chat-channels/:id/send-message" +method: POST +pathVariables: + - key: id + value: "{{chat_channel_id}}" + +body: + type: json + content: |- + { + "sender": "{{chat_participant_id}}", + "content": "Hello from Fleetbase API", + "files": [] + } + +order: 2000 diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml new file mode 100644 index 0000000..8e0ec7d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." diff --git a/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml new file mode 100644 index 0000000..3588970 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Chat Channels/Update Chat Channel.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Update Chat Channel" +url: "{{base_url}}/{{namespace}}/chat-channels/:id" +method: PUT +pathVariables: + - key: id + value: "{{chat_channel_id}}" + +body: + type: json + content: |- + { + "name": "Dispatch Updates" + } + +order: 6000 diff --git a/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml new file mode 100644 index 0000000..dcd7396 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 4000 diff --git a/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml b/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Create Comment.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml new file mode 100644 index 0000000..6275fb4 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Create Comment.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Create Comment" +url: "{{base_url}}/{{namespace}}/comments" +method: POST +body: + type: json + content: |- + { + "content": "Example comment", + "subject": { + "id": "{{subject_id}}", + "type": "{{subject_type}}" + } + } + +order: 1000 diff --git a/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml new file mode 100644 index 0000000..d087506 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Delete Comment.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete Comment" +url: "{{base_url}}/{{namespace}}/comments/:id" +method: DELETE +pathVariables: + - key: id + value: "{{comment_id}}" + +order: 5000 diff --git a/postman/collections/Fleetbase Core API/Comments/Query Comments.queryParams.yaml b/postman/collections/Fleetbase Core API/Comments/Query Comments.queryParams.yaml new file mode 100644 index 0000000..3e9bba7 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Query Comments.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this comments request." + - name: offset + type: string + description: "Offset value for this comments request." + - name: sort + type: string + description: "Sort value for this comments request." diff --git a/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml new file mode 100644 index 0000000..ee090f5 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Query Comments.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Query Comments" +url: "{{base_url}}/{{namespace}}/comments" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 3000 diff --git a/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml new file mode 100644 index 0000000..065b290 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Retrieve Comment.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieve Comment" +url: "{{base_url}}/{{namespace}}/comments/:id" +method: GET +pathVariables: + - key: id + value: "{{comment_id}}" + +order: 4000 diff --git a/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml b/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml new file mode 100644 index 0000000..1775f21 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Update Comment.params.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: content + type: string + description: "Text content for the comment or message." diff --git a/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml new file mode 100644 index 0000000..03fa4bb --- /dev/null +++ b/postman/collections/Fleetbase Core API/Comments/Update Comment.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Update Comment" +url: "{{base_url}}/{{namespace}}/comments/:id" +method: PUT +pathVariables: + - key: id + value: "{{comment_id}}" + +body: + type: json + content: |- + { + "content": "Updated comment" + } + +order: 2000 diff --git a/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml new file mode 100644 index 0000000..6522e17 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 2000 diff --git a/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml new file mode 100644 index 0000000..e1e8d5e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Delete a File.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Delete a File" +url: "{{base_url}}/{{namespace}}/files/:id" +method: DELETE +pathVariables: + - key: id + value: "{{file_id}}" + +order: 7000 diff --git a/postman/collections/Fleetbase Core API/Files/Download File.request.yaml b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml new file mode 100644 index 0000000..8620c9d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Download File.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Download File" +url: "{{base_url}}/{{namespace}}/files/:id/download" +method: GET +pathVariables: + - key: id + value: "{{file_id}}" + +order: 4000 diff --git a/postman/collections/Fleetbase Core API/Files/Query Files.queryParams.yaml b/postman/collections/Fleetbase Core API/Files/Query Files.queryParams.yaml new file mode 100644 index 0000000..1ce11dc --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Query Files.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this files request." + - name: offset + type: string + description: "Offset value for this files request." + - name: sort + type: string + description: "Sort value for this files request." diff --git a/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml new file mode 100644 index 0000000..0a89a2e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Query Files.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Query Files" +url: "{{base_url}}/{{namespace}}/files" +method: GET +queryParams: + limit: "25" + offset: "0" + sort: "created_at" +order: 5000 diff --git a/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml new file mode 100644 index 0000000..d0d0d39 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Retrieve a File.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: "Retrieve a File" +url: "{{base_url}}/{{namespace}}/files/:id" +method: GET +pathVariables: + - key: id + value: "{{file_id}}" + +order: 6000 diff --git a/postman/collections/Fleetbase Core API/Files/Update File.params.yaml b/postman/collections/Fleetbase Core API/Files/Update File.params.yaml new file mode 100644 index 0000000..297a857 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Update File.params.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: caption + type: string + description: "Caption displayed with the file." + - name: meta + type: object + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Core API/Files/Update File.request.yaml b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml new file mode 100644 index 0000000..8c8456e --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Update File.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: "Update File" +url: "{{base_url}}/{{namespace}}/files/:id" +method: PUT +pathVariables: + - key: id + value: "{{file_id}}" + +body: + type: json + content: |- + { + "caption": "Updated caption", + "meta": {} + } + +order: 3000 diff --git a/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml new file mode 100644 index 0000000..639e645 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Upload Base64 File.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: "Upload Base64 File" +url: "{{base_url}}/{{namespace}}/files/base64" +method: POST +body: + type: json + content: |- + { + "data": "{{base64_file_data}}", + "file_name": "example.png", + "file_type": "image", + "content_type": "image/png", + "path": "uploads" + } + +order: 2000 diff --git a/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml new file mode 100644 index 0000000..ab63486 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Files/Upload File.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: "Upload File" +url: "{{base_url}}/{{namespace}}/files" +method: POST +body: + type: formdata + content: + - type: file + key: file + src: [] + - type: text + key: path + value: "uploads" + - type: text + key: type + value: "attachment" + +order: 1000 diff --git a/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml b/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml new file mode 100644 index 0000000..53d990d --- /dev/null +++ b/postman/collections/Fleetbase Core API/Organizations/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 1000 diff --git a/postman/collections/Fleetbase Core API/Organizations/Get Current Organization.request.yaml b/postman/collections/Fleetbase Core API/Organizations/Get Current Organization.request.yaml new file mode 100644 index 0000000..4c06fa8 --- /dev/null +++ b/postman/collections/Fleetbase Core API/Organizations/Get Current Organization.request.yaml @@ -0,0 +1,5 @@ +$kind: http-request +description: "Returns the organization associated with the API credential." +url: "{{base_url}}/{{namespace}}/organizations/current" +method: GET +order: 1000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml new file mode 100644 index 0000000..533e820 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Create Order from Service Quote.params.yaml @@ -0,0 +1,6 @@ +$kind: params +fields: + - name: service_quote + type: string + required: true + description: "Service quote ID used by the request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml new file mode 100644 index 0000000..0a18471 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.queryParams.yaml @@ -0,0 +1,53 @@ +$kind: params +fields: + - name: service_type + type: string + description: "Service type code used for rating and dispatch logic." + - name: facilitator + type: string + description: "Vendor or contact ID that facilitates the order." + - name: is_route_optimized + type: boolean + description: "Is route optimized value for this get internal service quote.request.yaml request." + - name: waypoints[0][name] + type: string + description: "Waypoints[0][name] value for this get internal service quote.request.yaml request." + - name: waypoints[0][phone] + type: string + description: "Waypoints[0][phone] value for this get internal service quote.request.yaml request." + - name: waypoints[0][location][type] + type: string + description: "Waypoints[0][location][type] value for this get internal service quote.request.yaml request." + - name: waypoints[0][location][coordinates] + type: string + description: "Waypoints[0][location][coordinates] value for this get internal service quote.request.yaml request." + - name: waypoints[1][name] + type: string + description: "Waypoints[1][name] value for this get internal service quote.request.yaml request." + - name: waypoints[1][phone] + type: string + description: "Waypoints[1][phone] value for this get internal service quote.request.yaml request." + - name: waypoints[1][location][type] + type: string + description: "Waypoints[1][location][type] value for this get internal service quote.request.yaml request." + - name: waypoints[1][location][coordinates] + type: string + description: "Waypoints[1][location][coordinates] value for this get internal service quote.request.yaml request." + - name: waypoints[2][name] + type: string + description: "Waypoints[2][name] value for this get internal service quote.request.yaml request." + - name: waypoints[2][phone] + type: string + description: "Waypoints[2][phone] value for this get internal service quote.request.yaml request." + - name: waypoints[2][location][type] + type: string + description: "Waypoints[2][location][type] value for this get internal service quote.request.yaml request." + - name: waypoints[2][location][coordinates] + type: string + description: "Waypoints[2][location][coordinates] value for this get internal service quote.request.yaml request." + - name: specialRequests[0] + type: string + description: "SpecialRequests[0] value for this get internal service quote.request.yaml request." + - name: specialRequests[1] + type: string + description: "SpecialRequests[1] value for this get internal service quote.request.yaml request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml index 9bf1a7f..7b44e0c 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Internal Service Quote.request.yaml @@ -1,22 +1,22 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/service-quotes?service_type=SUV&facilitator=integrated_vendor_wa5AwdA&is_route_optimized=true&waypoints[0][name]=Stop 1&waypoints[0][phone]=+886970699044&waypoints[0][location][type]=Point&waypoints[0][location][coordinates]=121.526333,25.036688&waypoints[1][name]=Stop 2&waypoints[1][phone]=+886970699044&waypoints[1][location][type]=Point&waypoints[1][location][coordinates]=121.526333,25.036688&waypoints[2][name]=Stop 3&waypoints[2][phone]=+886970699044&waypoints[2][location][type]=Point&waypoints[2][location][coordinates]=121.526333,25.036688&specialRequests[0]=CASH_ON_DELIVERY&specialRequests[1]=FRAGILE_GOODS" +url: "{{base_url}}/{{namespace}}/service-quotes" method: GET queryParams: - service_type: SUV - facilitator: integrated_vendor_wa5AwdA + service_type: "SUV" + facilitator: "integrated_vendor_wa5AwdA" is_route_optimized: "true" - waypoints[0][name]: Stop 1 + waypoints[0][name]: "Stop 1" waypoints[0][phone]: "+886970699044" - waypoints[0][location][type]: Point - waypoints[0][location][coordinates]: 121.526333,25.036688 - waypoints[1][name]: Stop 2 + waypoints[0][location][type]: "Point" + waypoints[0][location][coordinates]: "121.526333,25.036688" + waypoints[1][name]: "Stop 2" waypoints[1][phone]: "+886970699044" - waypoints[1][location][type]: Point - waypoints[1][location][coordinates]: 121.526333,25.036688 - waypoints[2][name]: Stop 3 + waypoints[1][location][type]: "Point" + waypoints[1][location][coordinates]: "121.526333,25.036688" + waypoints[2][name]: "Stop 3" waypoints[2][phone]: "+886970699044" - waypoints[2][location][type]: Point - waypoints[2][location][coordinates]: 121.526333,25.036688 - specialRequests[0]: CASH_ON_DELIVERY - specialRequests[1]: FRAGILE_GOODS + waypoints[2][location][type]: "Point" + waypoints[2][location][coordinates]: "121.526333,25.036688" + specialRequests[0]: "CASH_ON_DELIVERY" + specialRequests[1]: "FRAGILE_GOODS" order: 4000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml new file mode 100644 index 0000000..be56511 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.queryParams.yaml @@ -0,0 +1,53 @@ +$kind: params +fields: + - name: service_type + type: string + description: "Service type code used for rating and dispatch logic." + - name: facilitator + type: string + description: "Vendor or contact ID that facilitates the order." + - name: is_route_optimized + type: boolean + description: "Is route optimized value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[0][name] + type: string + description: "Waypoints[0][name] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[0][phone] + type: string + description: "Waypoints[0][phone] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[0][location][type] + type: string + description: "Waypoints[0][location][type] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[0][location][coordinates] + type: string + description: "Waypoints[0][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[1][name] + type: string + description: "Waypoints[1][name] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[1][phone] + type: string + description: "Waypoints[1][phone] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[1][remarks] + type: string + description: "Waypoints[1][remarks] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[1][location][type] + type: string + description: "Waypoints[1][location][type] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[1][location][coordinates] + type: string + description: "Waypoints[1][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[2][name] + type: string + description: "Waypoints[2][name] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[2][phone] + type: string + description: "Waypoints[2][phone] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[2][remarks] + type: string + description: "Waypoints[2][remarks] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[2][location][type] + type: string + description: "Waypoints[2][location][type] value for this get service quote from integrated vendor.request.yaml request." + - name: waypoints[2][location][coordinates] + type: string + description: "Waypoints[2][location][coordinates] value for this get service quote from integrated vendor.request.yaml request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml index 0c26ec1..cb8e6c7 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Get Service Quote from Integrated Vendor.request.yaml @@ -1,22 +1,22 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/service-quotes?service_type=MOTORCYCLE&facilitator=integrated_vendor_wD5EJ7g&is_route_optimized=true&waypoints[0][name]=Stop 1&waypoints[0][phone]=+6596379222&waypoints[0][location][type]=Point&waypoints[0][location][coordinates]=103.8835179,1.3132044&waypoints[1][name]=Stop 2&waypoints[1][phone]=+6596379222&waypoints[1][remarks]=Testing remarks 1&waypoints[1][location][type]=Point&waypoints[1][location][coordinates]=103.8384048,1.3081903&waypoints[2][name]=Stop 3&waypoints[2][phone]=+6596379222&waypoints[2][remarks]=Testing remarks 2&waypoints[2][location][type]=Point&waypoints[2][location][coordinates]=103.8722585,1.3507723" +url: "{{base_url}}/{{namespace}}/service-quotes" method: GET queryParams: - service_type: MOTORCYCLE - facilitator: integrated_vendor_wD5EJ7g + service_type: "MOTORCYCLE" + facilitator: "integrated_vendor_wD5EJ7g" is_route_optimized: "true" - waypoints[0][name]: Stop 1 + waypoints[0][name]: "Stop 1" waypoints[0][phone]: "+6596379222" - waypoints[0][location][type]: Point - waypoints[0][location][coordinates]: 103.8835179,1.3132044 - waypoints[1][name]: Stop 2 + waypoints[0][location][type]: "Point" + waypoints[0][location][coordinates]: "103.8835179,1.3132044" + waypoints[1][name]: "Stop 2" waypoints[1][phone]: "+6596379222" - waypoints[1][remarks]: Testing remarks 1 - waypoints[1][location][type]: Point - waypoints[1][location][coordinates]: 103.8384048,1.3081903 - waypoints[2][name]: Stop 3 + waypoints[1][remarks]: "Testing remarks 1" + waypoints[1][location][type]: "Point" + waypoints[1][location][coordinates]: "103.8384048,1.3081903" + waypoints[2][name]: "Stop 3" waypoints[2][phone]: "+6596379222" - waypoints[2][remarks]: Testing remarks 2 - waypoints[2][location][type]: Point - waypoints[2][location][coordinates]: 103.8722585,1.3507723 + waypoints[2][remarks]: "Testing remarks 2" + waypoints[2][location][type]: "Point" + waypoints[2][location][coordinates]: "103.8722585,1.3507723" order: 5000 diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml new file mode 100644 index 0000000..0928eae --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this query orders.request.yaml request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml index ae37e1c..3d4d14b 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Orders.request.yaml @@ -1,5 +1,5 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/orders?limit=5" +url: "{{base_url}}/{{namespace}}/orders" method: GET headers: Authorization: Bearer {{api_key}} diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml new file mode 100644 index 0000000..4a21c34 --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this query places.request.yaml request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml index 30febaa..94874b3 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Query Places.request.yaml @@ -1,5 +1,5 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/places?limit=5" +url: "{{base_url}}/{{namespace}}/places" method: GET queryParams: limit: "5" diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml new file mode 100644 index 0000000..2144e8c --- /dev/null +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: ll + type: string + description: "Ll value for this search places.request.yaml request." + - name: locale + type: string + description: "Locale value for this search places.request.yaml request." + - name: query + type: string + description: "Query value for this search places.request.yaml request." diff --git a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml index 2793339..747b2cc 100644 --- a/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml +++ b/postman/collections/Fleetbase Integrated Vendor Flow/Search Places.request.yaml @@ -1,10 +1,10 @@ $kind: http-request -url: "{{base_url}}/{{namespace}}/places/search?ll=25.0147912108003,121.46998215767363&locale=zh-TW&query=臺北市中山區忠孝東歐物" +url: "{{base_url}}/{{namespace}}/places/search" method: GET headers: Authorization: Bearer {{api_key}} queryParams: - ll: 25.0147912108003,121.46998215767363 - locale: zh-TW - query: 臺北市中山區忠孝東歐物 + ll: "25.0147912108003,121.46998215767363" + locale: "zh-TW" + query: "臺北市中山區忠孝東歐物" order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/.resources/definition.yaml new file mode 100644 index 0000000..41dfbe7 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/.resources/definition.yaml @@ -0,0 +1,12 @@ +$kind: collection +description: Public Ledger API endpoints for wallets, public invoice payment, and gateway webhooks. +variables: + base_url: "" + namespace: v1 + api_prefix: ledger + api_key: "" +auth: + - type: bearer + name: bearer auth + credentials: + token: "{{api_key}}" diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml new file mode 100644 index 0000000..6522e17 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 2000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml new file mode 100644 index 0000000..9d61dd4 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Get Public Invoice.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Get Public Invoice +url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml new file mode 100644 index 0000000..de4fd2c --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/List Public Invoice Gateways.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: List Public Invoice Gateways +url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/gateways" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2000 diff --git a/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml new file mode 100644 index 0000000..3e11b74 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Public Invoices/Pay Public Invoice.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: Pay Public Invoice +url: "{{base_url}}/{{api_prefix}}/public/invoices/{{invoice_public_id}}/pay" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "gateway_id": "{{gateway_id}}", + "reference": "{{payment_reference}}" + } +order: 3000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml new file mode 100644 index 0000000..53d990d --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.queryParams.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.queryParams.yaml new file mode 100644 index 0000000..06677b3 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: currency + type: currency + description: "Three-letter currency code for monetary values." diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order \342\235\227.request.yaml" b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml similarity index 55% rename from "postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order \342\235\227.request.yaml" rename to postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml index 3bc480b..389864e 100644 --- "a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order \342\235\227.request.yaml" +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet Balance.request.yaml @@ -1,11 +1,11 @@ $kind: http-request -description: Capture checkout as order ❗ -url: "{{base_url}}/{{namespace}}/checkouts/capture?token=" +description: Get Wallet Balance +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/balance" method: GET headers: - key: Authorization value: "" description: Authentication header queryParams: - token: "" + currency: "USD" order: 2000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.queryParams.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.queryParams.yaml new file mode 100644 index 0000000..06677b3 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: currency + type: currency + description: "Three-letter currency code for monetary values." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml new file mode 100644 index 0000000..22d6ad3 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/Get Wallet.request.yaml @@ -0,0 +1,11 @@ +$kind: http-request +description: Get Wallet +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + currency: "USD" +order: 1000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.queryParams.yaml b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.queryParams.yaml new file mode 100644 index 0000000..91795fc --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.queryParams.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: type + type: enum + values: ["customer", "vendor", "driver"] + description: "Classification used to group or process the resource." + - name: direction + type: enum + values: ["credit", "debit"] + description: "Direction value for this wallet request." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: date_from + type: timestamp + description: "Date from value for this wallet request." + - name: date_to + type: timestamp + description: "Date to value for this wallet request." + - name: limit + type: string + description: "Limit value for this wallet request." diff --git a/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml new file mode 100644 index 0000000..44a0dc1 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/List Wallet Transactions.request.yaml @@ -0,0 +1,16 @@ +$kind: http-request +description: List Wallet Transactions +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/transactions" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + type: "" + direction: "" + status: "" + date_from: "" + date_to: "" + limit: "25" +order: 3000 diff --git a/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml new file mode 100644 index 0000000..a9c2fc4 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Wallet/Top Up Wallet.request.yaml @@ -0,0 +1,21 @@ +$kind: http-request +description: Top Up Wallet +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/wallet/topup" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "gateway": "{{gateway_id}}", + "amount": 1000, + "payment_method_token": "{{payment_method_token}}", + "customer_id": "{{gateway_customer_id}}", + "description": "Wallet top-up" + } +order: 4000 diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml new file mode 100644 index 0000000..40bbb1c --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 3000 diff --git a/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml new file mode 100644 index 0000000..f6dfc55 --- /dev/null +++ b/postman/collections/Fleetbase Ledger API/Webhooks/Handle Gateway Webhook.request.yaml @@ -0,0 +1,22 @@ +$kind: http-request +description: Handle Gateway Webhook +url: "{{base_url}}/{{api_prefix}}/webhooks/{{gateway_driver}}" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "company_uuid": "{{company_id}}", + "id": "{{gateway_event_id}}", + "type": "payment_intent.succeeded", + "data": { + "object": {} + } + } +order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/.resources/definition.yaml index e1fc553..c03defc 100644 --- a/postman/collections/Fleetbase Storefront API/.resources/definition.yaml +++ b/postman/collections/Fleetbase Storefront API/.resources/definition.yaml @@ -2,6 +2,7 @@ $kind: collection variables: base_url: "" namespace: v1 + api_prefix: storefront api_key: "" auth: - id: e8d21b47-4c30-4757-baa3-e0e5492aba20 diff --git a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml index cb3abc8..e46960e 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Add Item to Cart.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/carts/{id}/{product_id}" +description: |- + Adds a product to a cart and creates or updates the matching cart line item. Include quantity, variants, addons, scheduling, or store location details when needed. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{product_id}" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml new file mode 100644 index 0000000..6a031dc --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/Delete Cart.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Delete Cart +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{{cart_id}}" +method: DELETE +headers: + - key: Authorization + value: "" + description: Authentication header +order: 6000 diff --git a/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml index 487c6bb..dceb2e8 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Empty cart.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/carts/{id}/empty" +description: |- + Removes all line items from a cart. The response returns the emptied cart resource. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/empty" method: PUT headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml index 5bcf155..671fff6 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Remove item from cart.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: Use this endpoint to delete a zone. -url: "{{base_url}}/{{namespace}}/carts/{id}/{line_item_id}" +description: |- + Removes a line item or product from a cart. The response returns the updated cart after the item is removed. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" method: DELETE headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml index e6d313a..998c3ef 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Retrieve a Cart.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/carts/{id}" +description: |- + Retrieves an existing cart by its unique identifier. If the cart is still active, the response includes its current line items and totals. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml new file mode 100644 index 0000000..161214a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/Retrieve or Create Cart.request.yaml @@ -0,0 +1,10 @@ +$kind: http-request +description: |- + Retrieves the current cart or creates a new cart when no cart identifier is supplied. Use the returned cart ID for subsequent cart operations. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 900 diff --git a/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.params.yaml b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.params.yaml new file mode 100644 index 0000000..af04d1b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.params.yaml @@ -0,0 +1,17 @@ +$kind: params +fields: + - name: quantity + type: integer + description: "Number of units to add or update." + - name: variants + type: string + description: "Selected product variant IDs or option values." + - name: addons + type: string + description: "Selected addon IDs or addon option values." + - name: scheduled_at + type: timestamp + description: "ISO8601 timestamp for scheduled fulfillment." + - name: store_location + type: string + description: "Store location ID used for fulfillment." diff --git a/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml index 2ff7443..c6fb7b3 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/Update item in Cart.request.yaml @@ -2,7 +2,7 @@ $kind: http-request description: |+ You can update all properties of the Zone. -url: "{{base_url}}/{{namespace}}/carts/{id}/{line_item_id}" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/carts/{id}/{line_item_id}" method: PUT headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml b/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml index 23c3328..68be78e 100644 --- a/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Category/List categories.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/categories" +description: |- + Returns product categories available to the current storefront. Use this list to organize product browsing and filtering. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/categories" method: GET headers: - key: Authorization diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.queryParams.yaml" "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.queryParams.yaml" new file mode 100644 index 0000000..3a70ca9 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.queryParams.yaml" @@ -0,0 +1,26 @@ +$kind: params +fields: + - name: gateway + type: string + description: "Payment gateway ID or code." + - name: customer + type: string + description: "Customer ID associated with the request." + - name: cart + type: string + description: "Cart value for this checkout request." + - name: service_quote + type: string + description: "Service quote ID used by the request." + - name: cash + type: boolean + description: "Cash value for this checkout request." + - name: pickup + type: boolean + description: "Pickup address, place ID, or pickup payload for the order." + - name: tip + type: number + description: "Tip amount applied to the checkout." + - name: delivery_tip + type: number + description: "Tip amount allocated to delivery." diff --git "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" index ece54ef..050a86b 100644 --- "a/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Checkout/Before \342\235\227.request.yaml" @@ -1,6 +1,6 @@ $kind: http-request description: Before ❗ -url: "{{base_url}}/{{namespace}}/checkouts/before?gateway=&customer=&cart=&service_quote=&cash=&pickup=&tip=&delivery_tip=" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/before" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.queryParams.yaml new file mode 100644 index 0000000..3289772 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: checkout + type: string + description: "Checkout value for this checkout request." + - name: respond + type: boolean + description: "Respond value for this checkout request." + - name: test + type: string + description: "Test value for this checkout request." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml new file mode 100644 index 0000000..0bbf1f5 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback via GET.request.yaml @@ -0,0 +1,13 @@ +$kind: http-request +description: Capture QPay Callback via GET +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + checkout: "{{checkout_id}}" + respond: "true" + test: "success" +order: 4100 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml new file mode 100644 index 0000000..14808a1 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture QPay Callback.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Capture QPay Callback +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture-qpay" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "checkout": "{{checkout_id}}", + "respond": true, + "test": "success" + } +order: 4000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml new file mode 100644 index 0000000..e1578e5 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Capture checkout as order.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: |- + Captures a checkout token and creates the corresponding order. The response returns the completed order or the existing order when the checkout was already captured. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/capture" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "token": "{{checkout_token}}" + } +order: 3000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.params.yaml new file mode 100644 index 0000000..5159ab3 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.params.yaml @@ -0,0 +1,16 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml new file mode 100644 index 0000000..2bb4853 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Create Stripe Setup Intent.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: Create Stripe Setup Intent +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-setup-intent" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "customer": "{{customer_id}}" + } +order: 6000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.queryParams.yaml new file mode 100644 index 0000000..bb10818 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: checkout + type: string + description: "Checkout value for this checkout request." + - name: token + type: string + description: "Token used to authenticate or capture the checkout." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml new file mode 100644 index 0000000..ab86367 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Get Checkout Status.request.yaml @@ -0,0 +1,12 @@ +$kind: http-request +description: Get Checkout Status +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/status" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + checkout: "{{checkout_id}}" + token: "{{checkout_token}}" +order: 5000 diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.params.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.params.yaml new file mode 100644 index 0000000..ee36024 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.params.yaml @@ -0,0 +1,15 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: status + type: enum + values: ["active", "inactive"] + description: "Lifecycle status to apply to the resource." + - name: meta + type: string + description: "Arbitrary metadata stored with the resource." diff --git a/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml new file mode 100644 index 0000000..d500fb2 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Checkout/Update Stripe Payment Intent.request.yaml @@ -0,0 +1,23 @@ +$kind: http-request +description: Update Stripe Payment Intent +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/checkouts/stripe-update-payment-intent" +method: PUT +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "customer": "{{customer_id}}", + "cart": "{{cart_id}}", + "service_quote": "{{service_quote_id}}", + "payment_intent_id": "{{payment_intent_id}}", + "pickup": false, + "tip": 0, + "delivery_tip": 0 + } +order: 7000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml index f6dbf69..50b0752 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer via SMS.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/login-with-sms" +description: |- + Starts SMS authentication for an existing storefront customer. The customer receives a verification code that can be exchanged for an auth token. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-sms" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml new file mode 100644 index 0000000..d63270e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Apple.request.yaml @@ -0,0 +1,22 @@ +$kind: http-request +description: Authenticate a Customer with Apple +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-apple" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "identityToken": "{{apple_identity_token}}", + "authorizationCode": "{{apple_authorization_code}}", + "email": "{{customer_email}}", + "phone": "{{customer_phone}}", + "name": "{{customer_name}}", + "appleUserId": "{{apple_user_id}}" + } +order: 5200 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml new file mode 100644 index 0000000..37ac9c2 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Facebook.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Authenticate a Customer with Facebook +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-facebook" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "email": "{{customer_email}}", + "name": "{{customer_name}}", + "facebookUserId": "{{facebook_user_id}}" + } +order: 5300 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml new file mode 100644 index 0000000..b688eb2 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer with Google.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: Authenticate a Customer with Google +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login-with-google" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "idToken": "{{google_id_token}}", + "clientId": "{{google_client_id}}" + } +order: 5400 diff --git "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" index d112f19..2484f55 100644 --- "a/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Customer/Authenticate a Customer \342\235\227.request.yaml" @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/login" +description: |- + Authenticates a storefront customer with an email or phone identity and password. The response includes the customer profile and an auth token. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/login" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml new file mode 100644 index 0000000..f1a762d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Confirm Account Closure.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: Confirm Account Closure +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/confirm-account-closure" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "code": "{{verification_code}}" + } +order: 8100 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.params.yaml new file mode 100644 index 0000000..a04b25e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.params.yaml @@ -0,0 +1,23 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." + - name: identity + type: string + required: true + description: "Email address or phone number used for authentication." + - name: password + type: string + description: "Password used to authenticate the customer." + - name: code + type: string + required: true + description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml index 7d18db2..1436711 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Create a Customer.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers" +description: |- + Creates a storefront customer after verifying the supplied creation code. The response includes the customer profile and an auth token. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml new file mode 100644 index 0000000..9aaa60e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Ephemeral Key.request.yaml @@ -0,0 +1,15 @@ +$kind: http-request +description: Get Stripe Ephemeral Key +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-ephemeral-key" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + {} +order: 7000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml new file mode 100644 index 0000000..bf289e3 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Get Stripe Setup Intent.request.yaml @@ -0,0 +1,15 @@ +$kind: http-request +description: Get Stripe Setup Intent +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/stripe-setup-intent" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + {} +order: 7100 diff --git a/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml index 8523348..d8db385 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/List a customer orders.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/customers/orders" +description: |- + Returns orders that belong to the authenticated storefront customer. Use pagination and filters to browse the customer order history. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/orders" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml index 9f67cda..8b56922 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/List a customer saved places.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/customers/places" +description: |- + Returns saved places for the authenticated storefront customer. Use these places for delivery addresses and checkout defaults. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/places" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml index fd236d2..16eb9d9 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Query customers.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/customers" +description: |- + Returns storefront customers for the current company. Use query and pagination parameters to find matching customer records. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml index bb347b0..308dd89 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Register customer device.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/register-device" +description: |- + Registers a device token for the authenticated storefront customer. Use this to enable push notifications for the customer device. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/register-device" method: POST headers: - key: customer-token diff --git a/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml new file mode 100644 index 0000000..c986afe --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Request Phone Verification.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: Request Phone Verification +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-phone-verification" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "phone": "{{customer_phone}}" + } +order: 8200 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml new file mode 100644 index 0000000..707a424 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Retrieve a Customer.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Retrieve a Customer +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{{customer_id}}" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 3500 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml index 8f08ed1..d52d2c1 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Setups a verification request to create a new storefront custome.request.yaml @@ -1,7 +1,8 @@ $kind: http-request name: Setups a verification request to create a new storefront customer. ? -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/request-creation-code" +description: |- + Sends a verification code for storefront customer creation. The code is required when creating the customer account. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/request-creation-code" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml new file mode 100644 index 0000000..c28253b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Start Account Closure.request.yaml @@ -0,0 +1,15 @@ +$kind: http-request +description: Start Account Closure +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/account-closure" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + {} +order: 8000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.params.yaml new file mode 100644 index 0000000..f89be5e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.params.yaml @@ -0,0 +1,20 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." + - name: identity + type: string + description: "Email address or phone number used for authentication." + - name: password + type: string + description: "Password used to authenticate the customer." + - name: code + type: string + description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml new file mode 100644 index 0000000..6157f5f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Update Contact Customer Alias.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Update Contact Customer Alias +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/contacts/{{customer_id}}" +method: PUT +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "name": "{{customer_name}}", + "email": "{{customer_email}}", + "phone": "{{customer_phone}}" + } +order: 9000 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.params.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.params.yaml new file mode 100644 index 0000000..f89be5e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.params.yaml @@ -0,0 +1,20 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: email + type: string + description: "Email address for the person or customer." + - name: phone + type: string + description: "Phone number for the person or customer." + - name: identity + type: string + description: "Email address or phone number used for authentication." + - name: password + type: string + description: "Password used to authenticate the customer." + - name: code + type: string + description: "Verification or status code." diff --git a/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml index b0d4e2b..b24a815 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Update a Customer.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/{id}" +description: |- + Updates a storefront customer profile. The response returns the customer with the new values applied. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/{id}" method: PUT headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml new file mode 100644 index 0000000..b0f073a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify Phone Number.request.yaml @@ -0,0 +1,18 @@ +$kind: http-request +description: Verify Phone Number +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-phone-number" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "phone": "{{customer_phone}}", + "code": "{{verification_code}}" + } +order: 8300 diff --git a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml index abf7c73..ed3496c 100644 --- a/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Customer/Verify a SMS code.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: There is two primary ways to create a zone. The first method you can supply the boundary coordinates for the zone. The second method is you cann supply center coordinates and a radius in meters, and Fleetbase will automatically create a zone around the center coordinates. -url: "{{base_url}}/{{namespace}}/customers/verify-code" +description: |- + Verifies a storefront SMS or creation code. The response includes the customer profile and auth token when verification succeeds. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/customers/verify-code" method: POST headers: - key: Authorization diff --git "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.queryParams.yaml" "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.queryParams.yaml" new file mode 100644 index 0000000..12df804 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.queryParams.yaml" @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: origin + type: string + description: "Origin value for this delivery service quote request." + - name: destination + type: string + description: "Destination value for this delivery service quote request." + - name: cart + type: string + description: "Cart value for this delivery service quote request." diff --git "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" index 05ac766..499a6a3 100644 --- "a/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Delivery Service Quote/Retrieve a Delivery Service Quote \342\235\227.request.yaml" @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/service-quotes/from-cart?origin=&destination=&cart=" +description: |- + Returns a delivery service quote for the supplied cart, origin, and destination. Use the quote during checkout to include delivery pricing. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/service-quotes/from-cart" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml new file mode 100644 index 0000000..5e46d3b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 5500 diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.queryParams.yaml new file mode 100644 index 0000000..4112244 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this food trucks request." + - name: offset + type: string + description: "Offset value for this food trucks request." + - name: sort + type: string + description: "Sort value for this food trucks request." diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml new file mode 100644 index 0000000..2edce6e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/Query Food Trucks.request.yaml @@ -0,0 +1,13 @@ +$kind: http-request +description: Query Food Trucks +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + limit: "" + offset: "" + sort: "" +order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml new file mode 100644 index 0000000..a31d6f5 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/Retrieve Food Truck.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Retrieve Food Truck +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/food-trucks/{{food_truck_id}}" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2000 diff --git a/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml b/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml new file mode 100644 index 0000000..fa91a43 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/.resources/definition.yaml @@ -0,0 +1,2 @@ +$kind: collection +order: 7000 diff --git a/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml new file mode 100644 index 0000000..07ceca9 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Complete Order Pickup.request.yaml @@ -0,0 +1,17 @@ +$kind: http-request +description: Complete Order Pickup +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/picked-up" +method: PUT +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "order": "{{order_id}}" + } +order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml new file mode 100644 index 0000000..da6ad7a --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Orders/Get Order Receipt.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Get Order Receipt +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/orders/receipt" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "order": "{{order_id}}", + "ebarimt_receiver_type": "CITIZEN", + "ebarimt_receiver": "" + } +order: 2000 diff --git a/postman/collections/Fleetbase Storefront API/Products/Create Product.params.yaml b/postman/collections/Fleetbase Storefront API/Products/Create Product.params.yaml new file mode 100644 index 0000000..646b92d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/Create Product.params.yaml @@ -0,0 +1,12 @@ +$kind: params +fields: + - name: name + type: string + required: true + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: price + type: integer + description: "Price for the item or entity." diff --git a/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml new file mode 100644 index 0000000..cb6620b --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/Create Product.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Create Product +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" +method: POST +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "name": "Example Product", + "description": "Example storefront product", + "price": 1000 + } +order: 3000 diff --git a/postman/collections/Fleetbase Storefront API/Products/Query Products.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Products/Query Products.queryParams.yaml new file mode 100644 index 0000000..280f1bd --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/Query Products.queryParams.yaml @@ -0,0 +1,5 @@ +$kind: params +fields: + - name: offset + type: string + description: "Offset value for this products request." diff --git a/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml index 26e84d6..5e29e71 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Query Products.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/products?offset=" +description: |- + Returns products available in the current storefront. Use pagination and filters to browse the catalog. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml index f93f99e..763d3b7 100644 --- a/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Products/Retrieve a Product.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/products/{id}" +description: |- + Retrieves a single storefront product by ID. The response includes product details, pricing, variants, and related catalog data when available. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{id}" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Products/Update Product.params.yaml b/postman/collections/Fleetbase Storefront API/Products/Update Product.params.yaml new file mode 100644 index 0000000..f448da7 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/Update Product.params.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: name + type: string + description: "Display name for the resource." + - name: description + type: string + description: "Human-readable description of the resource." + - name: price + type: integer + description: "Price for the item or entity." diff --git a/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml b/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml new file mode 100644 index 0000000..27dc468 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Products/Update Product.request.yaml @@ -0,0 +1,19 @@ +$kind: http-request +description: Update Product +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/products/{{product_id}}" +method: PUT +headers: + - key: Authorization + value: "" + description: Authentication header + - key: Content-Type + value: application/json +body: + type: json + content: |- + { + "name": "Updated Product", + "description": "Updated storefront product", + "price": 1000 + } +order: 4000 diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml index 470753d..83fc76b 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Counts the number of ratings for a store.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Counts the number of ratings for a store -url: "{{base_url}}/{{namespace}}/reviews/count" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/count" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Create a review.params.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.params.yaml new file mode 100644 index 0000000..b25869f --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.params.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: content + type: string + description: "Text content for the comment or message." + - name: rating + type: integer + description: "Rating value for this reviews request." diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml index 35381d9..8af1d4a 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Create a review.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Create a review -url: "{{base_url}}/{{namespace}}/reviews" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" method: POST headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml index f13df23..6012d8f 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Delete a Review.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Delete a Review -url: "{{base_url}}/{{namespace}}/reviews/{id}" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" method: DELETE headers: - key: Authorization diff --git "a/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.queryParams.yaml" "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.queryParams.yaml" new file mode 100644 index 0000000..cf7f877 --- /dev/null +++ "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.queryParams.yaml" @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this reviews request." + - name: offset + type: string + description: "Offset value for this reviews request." + - name: sort + type: string + description: "Sort value for this reviews request." diff --git "a/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" index dd28cb1..37a20bf 100644 --- "a/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" +++ "b/postman/collections/Fleetbase Storefront API/Reviews/Query Reviews \342\235\227.request.yaml" @@ -1,6 +1,6 @@ $kind: http-request description: Query Reviews ❗ -url: "{{base_url}}/{{namespace}}/reviews?limit=&offset=&sort=" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml b/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml index e20f477..ba5494c 100644 --- a/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Reviews/Retrieve a Store review.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Retrieve a Store review -url: "{{base_url}}/{{namespace}}/reviews/{id}" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/reviews/{id}" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml b/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml index c59c572..5ff1a37 100644 --- a/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store Locations/Query Store Locations.request.yaml @@ -1,6 +1,7 @@ $kind: http-request -description: This endpoint allows you to retrieve a zone object to view it's details. -url: "{{base_url}}/{{namespace}}/store-locations" +description: |- + Returns store locations available through the current storefront or network. Use these locations for browsing, pickup, and fulfillment selection. +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/store-locations" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml index cf2c1c8..bc8c0df 100644 --- a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: About Store -url: "{{base_url}}/{{namespace}}/about" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/about" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml new file mode 100644 index 0000000..e864e53 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/List Locations.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: List Locations +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2400 diff --git a/postman/collections/Fleetbase Storefront API/Store/List Network Stores.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.queryParams.yaml new file mode 100644 index 0000000..62e61b4 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.queryParams.yaml @@ -0,0 +1,14 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this store request." + - name: limit + type: string + description: "Limit value for this store request." + - name: offset + type: string + description: "Offset value for this store request." + - name: store + type: string + description: "Store value for this store request." diff --git a/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml new file mode 100644 index 0000000..f732ec9 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/List Network Stores.request.yaml @@ -0,0 +1,14 @@ +$kind: http-request +description: List Network Stores +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/stores" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +queryParams: + query: "" + limit: "" + offset: "" + store: "" +order: 2700 diff --git a/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml b/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml new file mode 100644 index 0000000..5b0a239 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/List Tags.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: List Tags +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/tags" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2800 diff --git a/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml new file mode 100644 index 0000000..fd93ffa --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/Lookup Store.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Lookup Store +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/lookup/{{store_id}}" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2100 diff --git a/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.queryParams.yaml new file mode 100644 index 0000000..4e76d6e --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.queryParams.yaml @@ -0,0 +1,8 @@ +$kind: params +fields: + - name: limit + type: string + description: "Limit value for this store request." + - name: offset + type: string + description: "Offset value for this store request." diff --git a/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml index a3193ed..267b6a4 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Payment gateways for the current store.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Payment gateways for the current store -url: "{{base_url}}/{{namespace}}/gateways?limit=&offset=" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways" method: GET headers: - key: Authorization diff --git a/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml new file mode 100644 index 0000000..9b051e7 --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/Retrieve Location.request.yaml @@ -0,0 +1,9 @@ +$kind: http-request +description: Retrieve Location +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/locations/{{location_id}}" +method: GET +headers: + - key: Authorization + value: "" + description: Authentication header +order: 2500 diff --git a/postman/collections/Fleetbase Storefront API/Store/Search Store.queryParams.yaml b/postman/collections/Fleetbase Storefront API/Store/Search Store.queryParams.yaml new file mode 100644 index 0000000..a5c4e6d --- /dev/null +++ b/postman/collections/Fleetbase Storefront API/Store/Search Store.queryParams.yaml @@ -0,0 +1,11 @@ +$kind: params +fields: + - name: query + type: string + description: "Query value for this store request." + - name: limit + type: string + description: "Limit value for this store request." + - name: offset + type: string + description: "Offset value for this store request." diff --git a/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml index ded4cfd..24891d7 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Search Store.request.yaml @@ -1,6 +1,6 @@ $kind: http-request -description: Search Store -url: "{{base_url}}/{{namespace}}/stores?query=&limit=&store=" +description: Search Storefront +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/search" method: GET headers: - key: Authorization @@ -9,5 +9,5 @@ headers: queryParams: query: "" limit: "" - store: "" + offset: "" order: 1000 diff --git a/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml b/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml index f0a46dc..0dab8db 100644 --- a/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/Specific payment gateway given the id.request.yaml @@ -1,6 +1,6 @@ $kind: http-request description: Specific payment gateway given the id -url: "{{base_url}}/{{namespace}}/gateways/{id}" +url: "{{base_url}}/{{api_prefix}}/{{namespace}}/gateways/{id}" method: GET headers: - key: Authorization diff --git a/scripts/validate-collections.js b/scripts/validate-collections.js index 2ae1495..fe2bfd6 100644 --- a/scripts/validate-collections.js +++ b/scripts/validate-collections.js @@ -77,7 +77,7 @@ for (const file of environmentFiles) { } } -assert(collectionFiles.length === 3, `Expected 3 Postman collections, found ${collectionFiles.length}`); +assert(collectionFiles.length === 5, `Expected 5 Postman collections, found ${collectionFiles.length}`); assert(environmentFiles.length === 3, `Expected 3 environment templates, found ${environmentFiles.length}`); console.log(`Validated ${collectionFiles.length} Postman Native Git collections and ${environmentFiles.length} environments.`);