API Calls

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

Source of truth: /internal-docs/ops-openapi.yaml → /ops/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
GET	/maintenance/get	Get a single maintenance record	None	MaintenanceGetSuccess
POST	/maintenance/get	Get a single maintenance record (POST)	MaintenanceGetRequest	MaintenanceGetSuccess
GET	/maintenance/list	List maintenance records	None	MaintenanceListSuccess
POST	/maintenance/list	List maintenance records (POST)	MaintenanceListRequest	MaintenanceListSuccess
GET	/ping	Health check with maintenance status	None	PingSuccess
GET	/stat	Service status check	None	StatSuccess

Call details

GET /maintenance/get

Purpose: Get a single maintenance record

Notes: Returns a single maintenance record by maintenance_id. On success, revision is set on the envelope.

Request schema: None Response schema: MaintenanceGetSuccess

Sample request (schema-derived)

{}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "maintenance_id": "string",
    "status": "scheduled",
    "description": "string",
    "estimated_duration_seconds": 0,
    "scheduled_start_utc": "2026-01-01T00:00:00Z",
    "revision": 0,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /maintenance/get",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /maintenance/get

Purpose: Get a single maintenance record (POST)

Notes: POST variant of maintenance/get. Accepts maintenance_id in the body.

Request schema: MaintenanceGetRequest Response schema: MaintenanceGetSuccess

Sample request (schema-derived)

{
  "maintenance_id": "string"
}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "maintenance_id": "string",
    "status": "scheduled",
    "description": "string",
    "estimated_duration_seconds": 0,
    "scheduled_start_utc": "2026-01-01T00:00:00Z",
    "revision": 0,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /maintenance/get",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /maintenance/list

Purpose: List maintenance records

Notes: Lists maintenance records in reverse chronological order (GSI1). Supports pagination via next_token.

Request schema: None Response schema: MaintenanceListSuccess

Sample request (schema-derived)

{}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "items": [
      {
        "maintenance_id": "string",
        "status": "scheduled",
        "description": "string",
        "estimated_duration_seconds": 0,
        "scheduled_start_utc": "2026-01-01T00:00:00Z",
        "created_at": "2026-01-01T00:00:00Z"
      }
    ]
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /maintenance/list",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /maintenance/list

Purpose: List maintenance records (POST)

Notes: POST variant of maintenance/list. Accepts body parameters.

Request schema: MaintenanceListRequest Response schema: MaintenanceListSuccess

Sample request (schema-derived)

{
  "limit": 50,
  "next_token": "string",
  "session_guid": "SESSION_GUID"
}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "items": [
      {
        "maintenance_id": "string",
        "status": "scheduled",
        "description": "string",
        "estimated_duration_seconds": 0,
        "scheduled_start_utc": "2026-01-01T00:00:00Z",
        "created_at": "2026-01-01T00:00:00Z"
      }
    ]
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /maintenance/list",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /ping

Purpose: Health check with maintenance status

Notes: Returns { ok: true } plus current maintenance status. No authentication required.

Request schema: None Response schema: PingSuccess

Sample request (schema-derived)

{}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "ok": false,
    "maintenance_active": false
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /ping",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /stat

Purpose: Service status check

Notes: Returns { ok: true }. No authentication required.

Request schema: None Response schema: StatSuccess

Sample request (schema-derived)

{}

Sample response (shape-only)

{
  "success": true,
  "data": {
    "ok": false
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /stat",
    "service": "ops",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}