Skip to content

Document Storefront verified reviews, promotion availability, order chat and add-on limits - #65

Open
roncodes wants to merge 1 commit into
mainfrom
docs/storefront-reviews-promotions-chat
Open

roncodes wants to merge 1 commit into
mainfrom
docs/storefront-reviews-promotions-chat

Conversation

@roncodes

@roncodes roncodes commented Oct 6, 2026

Copy link
Copy Markdown
Member

Summary

Documents the Storefront API changes from fleetbase/storefront#115, #116, #117 and #118, which the redesigned app uses:

  • Reviews (#115):
    • New Check Review Eligibility request (GET reviews/eligibility), returning can_review, reason, message, order and review.
    • Create a review: documents the verified-purchase rule, the optional order and files, and the 403 { error, reason } refusal.
    • Delete a Review: now sends the customer token, since customers can only delete their own reviews.
    • Query Reviews: documents the store param (required with network keys) and the sort values.
    • Review object: gains subject_type, verified and is_mine. The reviewer is shown as first name and last initial, with no email or phone.
  • Promotions (#116):
    • Query Promotions: documents include=scheduled.
    • Retrieve a Promotion: now also returns scheduled and ended promotions.
    • Promotion object: gains code (a shareable code), availability, next_starts_at and owner. applies_to lists public IDs.
  • Order Chat (#117): new folder with Get Order Chat, List Order Chat Messages (before/limit), Send Order Chat Message and Mark Order Chat as Read. It covers the Order Chat object, the chat.{id} socket channel and events, and the 401/403/404/409 driver_not_assigned/423 chat_closed refusals.
  • Products (#118): add-on categories document is_required and max_selectable.

Related Issue

Closes #

Type of Change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Test
  • Chore

Implementation Notes

Requests whose result depends on data the run may not have follow the collection's existing expected_status pattern:

  • Create a review: expects the 403 refusal unless the environment sets review_eligible.
  • Order Chat requests:
    • with chat_order_id set (an order with an assigned driver), they expect success;
    • otherwise they address order_id and expect 409 driver_not_assigned;
    • with no order at all, they expect 404.

Validation

  • Tests
  • Lint
  • Build
  • Manual validation

Command output / summary:

npm run postman:lint
Validated 5 Postman Native Git collections and 3 environments.
Linting Fleetbase Storefront API...
No issues found.
Scanned: 81 | Errors: 0 | Warnings: 0

Not run: postman:run:storefront. It needs a running stack with the backend PRs deployed.

Documentation Impact

  • No documentation changes needed
  • Documentation updated in fleetbase/fleetbase.io
  • Documentation needed but not included: the API reference on fleetbase.io needs regenerating once this and the backend PRs merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant