Integration Checklist (External Teams)

Use this page as the canonical checklist for external integrations. It ties together identity, org context, and the minimal product → publish → inventory → order flow.

1) Acquire credentials

• Human sessions: create/verify a user in UAS, then POST /usm/session/create.
• Service accounts: create a service account and API key in USM (owner-only).

See:

• https://doc.g3nretailstack.com/uas/surfaces/
• https://doc.g3nretailstack.com/usm/surfaces/

2) Validate credentials

• POST /usm/session/validate for sessions
• POST /usm/api_key/validate for API keys

3) Confirm org association (anti-enumeration self-check)

• POST /ofm/member/resolve with orgcode (and logical_guid if facility-scoped)

If this returns 404, you are not associated with the org.

4) Establish org + facility + channel context

Minimum setup:

• Create org (operator flow) → verify org status
• Create physical/legal/logical facilities
• Declare a sales channel (channel_code + market/locale)

See:

• /common/minimum-viable-flow.html
• https://doc.g3nretailstack.com/ofm/surfaces/

5) Create product model (PVM)

Minimum:

• Create vendors + manufacturers
• Create taxonomy category
• Create style + variants
• Add identifiers/barcodes

See:

• https://doc.g3nretailstack.com/pvm/surfaces/

6) Publish product (PMC)

Minimum:

• Set or confirm publish profile
• Start publish run → step until complete
• Set online revision

See:

• https://doc.g3nretailstack.com/pmc/surfaces/

7) Stock and inventory (ICS)

Minimum:

• Record receipt / adjustments
• POST /ics/stock/get or /stock/list
• Reserve/allocate for orders

See:

• https://doc.g3nretailstack.com/ics/surfaces/

8) Order lifecycle (SCM)

Minimum:

• Promise/quote (if used)
• Place order
• Allocate/commit
• Fulfill shipments

See:

• https://doc.g3nretailstack.com/scm/surfaces/

9) Procurement (PCM)

Minimum:

• Create worksheet / PO
• Record receipt
• Match invoice

See:

• https://doc.g3nretailstack.com/pcm/surfaces/

10) Pricing & promos (PPM)

Minimum:

• Resolve price for a cart or order context
• Apply promos (if used)

See:

• https://doc.g3nretailstack.com/ppm/surfaces/

11) Loyalty & CRM (CRM)

Minimum:

• Create customer
• Earn/redeem loyalty

See:

• https://doc.g3nretailstack.com/crm/surfaces/

12) Events & subscriptions (RBS / IPM)

Minimum:

• Register subscription (RBS)
• Verify and consume deliveries
• Use IPM CDC / exports where applicable

See:

• https://doc.g3nretailstack.com/rbs/surfaces/
• https://doc.g3nretailstack.com/ipm/surfaces/

13) Exports & offboarding (Accounting / UTL)

Minimum:

• Request exports
• Offboarding request (when needed)

See:

• https://doc.g3nretailstack.com/accounting/surfaces/
• https://doc.g3nretailstack.com/utl/surfaces/

Troubleshooting quick map

• 401: invalid session / API key
• 403: valid auth but insufficient role, or org write blocked
• 404: not found or not associated (anti-enumeration)
• 409: conflict (expected_revision mismatch)
• 428: missing expected_revision
• 429: throttled; retry with backoff

See /common/troubleshooting.html for full flow.