API Calls

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

Source of truth: /internal-docs/ucp-openapi.yaml → /ucp/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	/.well-known/ucp	UCP capability profile per org	None	Envelope
POST	/checkout/cancel	Cancel checkout session	None	Envelope
POST	/checkout/complete	Finalize checkout → SCM order	None	Envelope
POST	/checkout/create	Create checkout session with cart	None	Envelope
POST	/checkout/get	Get checkout session state	None	Envelope
POST	/checkout/update	Full cart replacement	None	Envelope
POST	/config/get	Get UCP org config	None	Envelope
POST	/config/set	Set UCP org config	None	Envelope
GET	/identity/.well-known/oauth-authorization-server	RFC 8414 OAuth Authorization Server Metadata	None	Envelope
POST	/identity/authorize	Admin generates auth code for customer↔platform link	AuthCodeRequest	Envelope
POST	/identity/link/list	List identity links per platform or customer	None	LinkListResponse
POST	/identity/link/revoke	Admin revokes an identity link (cascades to tokens)	None	Envelope
POST	/identity/revoke	Revoke access or refresh token (RFC 7009)	RevokeRequest	Envelope
POST	/identity/token	Exchange auth code for access + refresh tokens	TokenRequest	TokenResponse
POST	/identity/userinfo	Get linked customer info via bearer token	None	UserinfoResponse
POST	/platform/get	Get platform details	None	Envelope
POST	/platform/list	List org platforms	None	Envelope
POST	/platform/register	Register platform credentials	None	Envelope
POST	/platform/revoke	Revoke platform	None	Envelope
POST	/platform/rotate	Rotate client secret	None	Envelope
GET	/stat	Health/build check	None	Envelope
POST	/webhook/config/get	Get webhook config	None	Envelope
POST	/webhook/config/set	Set webhook event filters per platform	None	Envelope
POST	/webhook/test	Send test webhook to platform callback_url	None	Envelope

Call details

GET /.well-known/ucp

Purpose: UCP capability profile per org

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /.well-known/ucp",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /checkout/cancel

Purpose: Cancel checkout session

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /checkout/cancel",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /checkout/complete

Purpose: Finalize checkout → SCM order

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /checkout/complete",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /checkout/create

Purpose: Create checkout session with cart

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /checkout/create",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /checkout/get

Purpose: Get checkout session state

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /checkout/get",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /checkout/update

Purpose: Full cart replacement

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /checkout/update",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /config/get

Purpose: Get UCP org config

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /config/get",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /config/set

Purpose: Set UCP org config

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /config/set",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /identity/.well-known/oauth-authorization-server

Purpose: RFC 8414 OAuth Authorization Server Metadata

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /identity/.well-known/oauth-authorization-server",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/authorize

Purpose: Admin generates auth code for customer↔platform link

Request schema: AuthCodeRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "platform_guid": "string",
  "customer_guid": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/authorize",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/link/list

Purpose: List identity links per platform or customer

Notes: Paginated; use limit and next_token.

Request schema: None Response schema: LinkListResponse

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See LinkListResponse"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/link/list",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/link/revoke

Purpose: Admin revokes an identity link (cascades to tokens)

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/link/revoke",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/revoke

Purpose: Revoke access or refresh token (RFC 7009)

Request schema: RevokeRequest Response schema: Envelope

Sample request (schema-derived)

json

{
  "client_id": "string",
  "client_secret": "string",
  "token": "string"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/revoke",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/token

Purpose: Exchange auth code for access + refresh tokens

Request schema: TokenRequest Response schema: TokenResponse

Sample request (schema-derived)

json

{
  "client_id": "string",
  "client_secret": "string",
  "grant_type": "authorization_code"
}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See TokenResponse"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/token",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /identity/userinfo

Purpose: Get linked customer info via bearer token

Request schema: None Response schema: UserinfoResponse

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See UserinfoResponse"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /identity/userinfo",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /platform/get

Purpose: Get platform details

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /platform/get",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /platform/list

Purpose: List org platforms

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /platform/list",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /platform/register

Purpose: Register platform credentials

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /platform/register",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /platform/revoke

Purpose: Revoke platform

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /platform/revoke",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /platform/rotate

Purpose: Rotate client secret

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /platform/rotate",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

GET /stat

Purpose: Health/build check

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "GET /stat",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /webhook/config/get

Purpose: Get webhook config

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /webhook/config/get",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /webhook/config/set

Purpose: Set webhook event filters per platform

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": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /webhook/config/set",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

POST /webhook/test

Purpose: Send test webhook to platform callback_url

Request schema: None Response schema: Envelope

Sample request (schema-derived)

json

{}

Sample response (shape-only)

json

{
  "success": true,
  "data": {
    "note": "See Envelope"
  },
  "build": {
    "build_id": "MONDAY-0000000000"
  },
  "stats": {
    "call": "POST /webhook/test",
    "service": "ucp",
    "timestamp_utc": "2026-01-01T00:00:00Z"
  }
}

API Calls ​

Inventory ​

Call details ​

GET /.well-known/ucp ​

POST /checkout/cancel ​

POST /checkout/complete ​

POST /checkout/create ​

POST /checkout/get ​

POST /checkout/update ​

POST /config/get ​

POST /config/set ​

GET /identity/.well-known/oauth-authorization-server ​

POST /identity/authorize ​

POST /identity/link/list ​

POST /identity/link/revoke ​

POST /identity/revoke ​

POST /identity/token ​

POST /identity/userinfo ​

POST /platform/get ​

POST /platform/list ​

POST /platform/register ​

POST /platform/revoke ​

POST /platform/rotate ​

GET /stat ​

POST /webhook/config/get ​

POST /webhook/config/set ​

POST /webhook/test ​

API Calls

Inventory

Call details

GET /.well-known/ucp

POST /checkout/cancel

POST /checkout/complete

POST /checkout/create

POST /checkout/get

POST /checkout/update

POST /config/get

POST /config/set

GET /identity/.well-known/oauth-authorization-server

POST /identity/authorize

POST /identity/link/list

POST /identity/link/revoke

POST /identity/revoke

POST /identity/token

POST /identity/userinfo

POST /platform/get

POST /platform/list

POST /platform/register

POST /platform/revoke

POST /platform/rotate

GET /stat

POST /webhook/config/get

POST /webhook/config/set

POST /webhook/test