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

Shop Role Schema

Schema-ID
shop_role
Collection
shop_roles
Permissions
  • Lesenshop_role_view
  • Anlegenshop_role_create
  • Ändernshop_role_edit
  • Löschenshop_role_delete

Felder

Shop Role Schema

shop_roles4 Permissions

Customer-tenant-defined shop role granting a permission bundle to a customer organization. Roles are owned by a single customer party (the organization) and assigned per-person via party_relationship.shopRoleId. Visibility (which articles/bundles a customer sees in the shop) lives on the entity itself via availableForPartyIds — not on the role.

partyIduuiderforderlich

Owner organization party ID (the customer this role belongs to).

namestringerforderlich

Display name (e.g. "Admin", "Einkäufer", "Leseberechtigt")

1–200 Zeichen
descriptionstringoptional

Free-text description of what this role is for

max 1000 ZeichenDefault: nullnullable
isDefaultbooleanoptional

When true, this role is auto-assigned to new contacts that have no explicit shopRoleId. Exactly one role per partyId may carry this flag.

Default: false
permissionsstring[]optional

Capabilities this role grants in the customer portal (view products/prices, place orders, subscribe, view invoices/orders, manage users). Org-level shopConfig.featureFlags can mask these (kill switches).

Default: []

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

Suche