UCP
CDX Admin API
Public, operations, and partner APIs surfaced by CDX Admin.
API routes
Total: 10
GET
ucp-discovery
/.well-known/ucp
Read the UCP discovery profile.
- Access
- UCP
- Request
- Query string
- Response
- 200
GET
ucp-discovery
/api/ucp/capabilities
List merchant UCP capabilities.
- Access
- UCP
- Request
- Query string
- Response
- 200
GET
ucp-discovery
/api/ucp/reference/{documentId}
Read a UCP reference document.
- Access
- UCP
- Request
- Path parameters or query string
- Response
- 200, 404
GET
ucp-catalog
/api/ucp/catalog
List catalog entries for UCP checkout.
- Access
- UCP
- Request
- Query string
- Response
- 200
POST
ucp-checkout
/api/ucp/checkout-sessions
Create a UCP checkout session.
- Access
- UCP
- Request
- Validated mutation body or parameters
- Response
- 201, 400, 422, 503
GET
ucp-checkout
/api/ucp/checkout-sessions/{id}
Read a UCP checkout session.
- Access
- UCP
- Request
- Path parameters or query string
- Response
- 200, 400, 404, 409, 422, 503
PUT
ucp-checkout
/api/ucp/checkout-sessions/{id}
Update a UCP checkout session.
- Access
- UCP
- Request
- Validated mutation body or parameters
- Response
- 200, 400, 404, 409, 422, 503
POST
ucp-checkout
/api/ucp/checkout-sessions/{id}/complete
Complete a UCP checkout session.
- Access
- UCP
- Request
- Validated mutation body or parameters
- Response
- 200, 400, 404, 409, 422, 503
POST
ucp-checkout
/api/ucp/checkout-sessions/{id}/cancel
Cancel a UCP checkout session.
- Access
- UCP
- Request
- Path parameters or query string
- Response
- 200, 400, 404, 409, 422, 503
GET
ucp-orders
/api/ucp/orders/{id}
Read a UCP order.
- Access
- UCP
- Request
- Path parameters or query string
- Response
- 200, 404, 503