API Calls

Base: https://api.g3nretailstack.com/rbs

Source of truth: /internal-docs/rbs-openapi.yaml → /rbs/openapi.yaml

Notes: samples are schema-derived placeholders. Replace placeholder values (ORGCODE, SESSION_GUID, etc.) with real values.

Inventory

Method	Path	Summary	Request schema	Response schema
POST	/notification/log/list	List notification delivery logs	None	Envelope
POST	/notification/send	Queue a notification for delivery (G92)	None	Envelope
POST	/notification/template/get	Get a notification template by ID	None	Envelope
POST	/notification/template/list	List notification templates	None	Envelope
POST	/notification/template/set	Create or update a notification template (G92)	None	Envelope
POST	/notification/template/status/set	Update notification template status	None	Envelope
GET	/stat	Health check	None	Envelope
POST	/subscription/get	Get subscription	SubscriptionGetRequest	Envelope
POST	/subscription/list	List subscriptions	SubscriptionListRequest	Envelope
POST	/subscription/register	Register a subscription	SubscriptionRegisterRequest	Envelope
POST	/subscription/status/set	Update subscription status	SubscriptionStatusSetRequest	Envelope
POST	/subscription/test	Send a test delivery	SubscriptionTestRequest	Envelope
POST	/subscription/unregister	Revoke subscription	SubscriptionUnregisterRequest	Envelope
POST	/subscription/update	Update subscription	SubscriptionUpdateRequest	Envelope
POST	/subscription/verify	Verify subscription token	SubscriptionVerifyRequest	Envelope

Call details

POST /notification/log/list

Purpose: List notification delivery logs

Notes: Paginated; use limit and next_token.

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "items": [
      {}
    ],
    "next_token": {}
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/log/list",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /notification/send

Purpose: Queue a notification for delivery (G92)

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "notification_id": "string",
    "status": "active"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/send",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /notification/template/get

Purpose: Get a notification template by ID

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {},
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/template/get",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /notification/template/list

Purpose: List notification templates

Notes: Paginated; use limit and next_token.

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "items": [
      {}
    ],
    "next_token": {}
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/template/list",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /notification/template/set

Purpose: Create or update a notification template (G92)

Notes: If this updates a revisioned record, expected_revision is required.

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "template_id": "string",
    "status": "active"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/template/set",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /notification/template/status/set

Purpose: Update notification template status

Notes: If this updates a revisioned record, expected_revision is required.

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "template_id": "string",
    "status": "active"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /notification/template/status/set",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /stat

Purpose: Health check

Notes: Health check. Tenant routes require x-orgcode; /stat health checks do not. Org-scoped reads may return 404 for non-associated callers (anti-enumeration). Route class Tier A (p95 500ms).

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "service": "string",
    "status": "active"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /stat",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/get

Purpose: Get subscription

Notes: Get subscription. Tenant routes require x-orgcode; /stat health checks do not. Org-scoped reads may return 404 for non-associated callers (anti-enumeration). Route class Tier B (p95 400ms).

Request schema: SubscriptionGetRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "subscription_id": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/get",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/list

Purpose: List subscriptions

Notes: List subscriptions. Tenant routes require x-orgcode; /stat health checks do not. Paginated with limit/next_token (default 8; clamp 1–256). Route class Tier B (p95 400ms).

Request schema: SubscriptionListRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "limit": 8,
  "next_token": {}
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "items": [
      {
        "subscription_id": "string",
        "orgcode": "ORGCODE",
        "queue_url": "string",
        "queue_region": "string",
        "status": "pending_verify",
        "created_at": "2026-01-01T00:00:00Z",
        "updated_at": "2026-01-01T00:00:00Z",
        "revision": "string"
      }
    ],
    "next_token": {}
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/list",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/register

Purpose: Register a subscription

Notes: Register a subscription. Tenant routes require x-orgcode; /stat health checks do not. Route class Tier D (p95 2000ms, p99 4000ms).

Request schema: SubscriptionRegisterRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "queue_url": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/register",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/status/set

Purpose: Update subscription status

Notes: Update subscription status. Tenant routes require x-orgcode; /stat health checks do not. If this updates a revisioned record, expected_revision is required (428 if missing; 409 on mismatch). Route class Tier D (p95 1500ms, p99 3000ms).

Request schema: SubscriptionStatusSetRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "subscription_id": "string",
  "status": "active",
  "expected_revision": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/status/set",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/test

Purpose: Send a test delivery

Notes: Send a test delivery. Tenant routes require x-orgcode; /stat health checks do not. Route class Tier D (p95 2000ms, p99 4000ms).

Request schema: SubscriptionTestRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "subscription_id": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "status": "active"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/test",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/unregister

Purpose: Revoke subscription

Notes: Revoke subscription. Tenant routes require x-orgcode; /stat health checks do not. Route class Tier D (p95 1500ms, p99 3000ms).

Request schema: SubscriptionUnregisterRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "subscription_id": "string",
  "expected_revision": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/unregister",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/update

Purpose: Update subscription

Notes: Update subscription. Tenant routes require x-orgcode; /stat health checks do not. If this updates a revisioned record, expected_revision is required (428 if missing; 409 on mismatch). Route class Tier D (p95 2000ms, p99 4000ms).

Request schema: SubscriptionUpdateRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "subscription_id": "string",
  "expected_revision": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/update",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /subscription/verify

Purpose: Verify subscription token

Notes: Verify subscription token. Tenant routes require x-orgcode; /stat health checks do not. Route class Tier D (p95 2000ms, p99 4000ms).

Request schema: SubscriptionVerifyRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "request_context": {
    "orgcode": "ORGCODE",
    "actor": "string",
    "context_source": "session"
  },
  "reason": "example",
  "source_refs": [
    {
      "kind": "string",
      "id": "string"
    }
  ],
  "subscription_id": "string",
  "verification_token": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "subscription_id": "string",
    "orgcode": "ORGCODE",
    "queue_url": "string",
    "queue_region": "string",
    "status": "pending_verify",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "revision": "string"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /subscription/verify",
    "service": "rbs",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

API Calls ​

Inventory ​

Call details ​

POST /notification/log/list ​

POST /notification/send ​

POST /notification/template/get ​

POST /notification/template/list ​

POST /notification/template/set ​

POST /notification/template/status/set ​

GET /stat ​

POST /subscription/get ​

POST /subscription/list ​

POST /subscription/register ​

POST /subscription/status/set ​

POST /subscription/test ​

POST /subscription/unregister ​

POST /subscription/update ​

POST /subscription/verify ​

API Calls

Inventory

Call details

POST /notification/log/list

POST /notification/send

POST /notification/template/get

POST /notification/template/list

POST /notification/template/set

POST /notification/template/status/set

GET /stat

POST /subscription/get

POST /subscription/list

POST /subscription/register

POST /subscription/status/set

POST /subscription/test

POST /subscription/unregister

POST /subscription/update

POST /subscription/verify