API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · product_reviews

Product Review Schema

Schema-ID
product_review
Collection
product_reviews
Permissions
  • Lesenproduct_review_view
  • Anlegenproduct_review_create
  • Ändernproduct_review_edit
  • Löschenproduct_review_delete

Felder

Product Review Schema

product_reviews4 Permissions

Customer-submitted product review with rating and free-text comment, displayed on the customer-portal article detail page.

articleIduuiderforderlich

FK to articles._id — the reviewed product.

ratingintegererforderlich

Star rating 1–5.

1 – 5
titlestringoptional

Optional short headline for the review.

max 200 ZeichenDefault: nullnullable
textstringoptional

Free-text review body (plain text).

max 4000 ZeichenDefault: nullnullable
authorPartyIdstringoptional

PERSON party of the review author. Set automatically from the user’s linked person on submit.

PatternDefault: nullread-onlynullable
authorNamestringoptional

Denormalised display name (first name + initial of surname). Stored at submit time so it stays stable when the user record changes.

max 200 ZeichenDefault: nullnullable
authorOrgPartyIdstringoptional

Optional ORG party of the author (the customer organisation they belong to).

PatternDefault: nullread-onlynullable
verifiedbooleanoptional

true if the author actually placed an order containing this article (set by the backend on submit).

Default: falseread-only

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/product_reviews — Liste, paginiert + filterbar
  • GET /api/v1/product_reviews/<id> — Einzelne Entity
  • POST /api/v1/product_reviews — Anlegen
  • PATCH /api/v1/product_reviews/<id> — Teil-Update
  • DELETE /api/v1/product_reviews/<id> — Soft-Delete
  • GET /api/v1/product_reviews/<id>/timeline — Audit + Aktivitäten

Suche