G3N Common Contract

Appearance

Start Here ​

This is the entry point for the external, contract-only documentation. It is intended for integrators who want a fast, correct path through the docs and examples.

Read order ​

  1. Start Here (this page)
  2. Common Contract: /common/
  3. Integration Checklist: /common/integration-checklist.html
  4. Integration Walkthroughs: /common/integration-walkthroughs.html
  5. User Provisioning (operator setup -> verified user -> first session): /common/user-provisioning.html
  6. Minimum Viable Flow (login -> org -> product -> publish): /common/minimum-viable-flow.html
  7. SDK Snippets (Node.js + Python): /common/sdk-snippets.html
  8. SDK Integration Checklist: /common/sdk-integration-checklist.html
  9. Client Shim (thin helper): /common/client-shim.html
  10. Service docs: /uas/, /usm/, /ofm/, /mrs/, /pvm/, /pmc/, /ics/, /ppm/, /scm/, /pcm/, /crm/, /influencer/, /accounting/, /ipm/, /rbs/, /utl/, /ops/, /ucp/, /slc/
  11. Stack Story (high-level narrative): /story/

Core invariants (do not skip) ​

  • Use custom domains: always call https://api.g3nretailstack.com/<service>/... and read docs on https://doc.g3nretailstack.com/....
  • Auth is required on protected surfaces: x-session-guid (human) or x-api-key (service account), plus x-orgcode where required.
  • Org writes are gated by org status: if the org is not verified, writes fail with 403 org-write-blocked.
  • Anti-enumeration is intentional: org-scoped reads may return 404 not-found when you are not associated with the org.
  • Optimistic concurrency is enforced: updates on revisioned records require expected_revision.
  • GET vs POST is strict: GET uses query params only (no JSON bodies). POST uses JSON bodies. See /common/http-methods.html.

If you are new to the stack ​

Start with Integration Walkthroughs and Minimum Viable Flow. They show the real call order, where auth headers go, and the boundary failure modes (409/428, 404 anti-enumeration, 403 org-write-blocked).