Skip to content

Glossary

Short definitions for common fields and identities used across services.

  • actor: optional caller-supplied string recorded for audit context (not authoritative identity).
  • api_key: service-account credential issued by USM; presented as x-api-key on API Gateway.
  • build_id: build stamp (e.g., MONDAY-1768706995) shown in response stats.build and docs footer.
  • cccode: cost centre code; optional telemetry field across services; OFM also uses cccode as a domain identifier for cost centres.
  • expected_revision: optimistic concurrency token required for updates on revisioned records; mismatch yields 409 conflict.
  • logical_guid: logical facility identifier in OFM (facility context for location-scoped operations).
  • org_guid: internal org identifier (UUID-like) used within OFM and other services.
  • orgcode: external org short code; used for API scoping and tenancy.
  • pmc_view / pmc_publish: PMC read/write roles (owner implied).
  • pvv / pma / vca: PVM role profiles for read, model admin, and supplier admin (owner implied).
  • revision: opaque per-record revision GUID returned by revisioned records.
  • session_guid: user session token issued by USM; bearer secret. Canonical auth is x-session-guid header for org-scoped APIs; body session_guid is accepted for compatibility where documented. Exceptions: USM and UTL require body auth.
  • session_fingerprint: SHA-256 fingerprint of session_guid used for correlation in stats/events.
  • status: lifecycle field used by many entities (values differ per entity; see FSM page).
  • user_guid / user_id: user identifier (UAS uses user_id in API surfaces).

Service Abbreviations

AbbreviationFull Name
UASUser Account Service
USMUser Session Management
OFMOrganization & Facility Management
MRSMetarecord Service
PVMProduct & Vendor Management
PMCProduct Merchandising Control
ICSInventory Control Service
PPMPricing & Promotions Management
SCMSales Cycle Management
PCMProcurement Cycle Management
CRMCustomer Relationship & Loyalty
InfluencerInfluencer & Referral Earnings
AccountingAccounting & ERP Integration Readiness
IPMIntegration Plane Management
RBSRetail Bus Service
UTLUtility Service
OPSOperations Management
UCPUniversal Commerce Protocol Adapter
SLCShopify Legacy Connector
VisualGridVisual Query Grid

See also: /common/state-machines.html and /common/headers-identity.html.