For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Guides

X2BEE API guides in English

The X2BEE API Guides explain how to integrate Store Front APIs and Back Office APIs, from customer-facing experiences to operational management.

X2BEE RESTful APIs use an independent microservice architecture (MSA), allowing each capability to scale by function while services are continuously improved for stability and performance.

Store Front API Guides

Learn the main capabilities by module, review the defined workflows, and follow the API details used in each process.

Back Office API Guides

Learn how to integrate X2BEE operational and management capabilities.

Common API

The Common API provides shared capabilities for other modules, including common-code lookup, prohibited-word lookup, and business-specific notices.

API
Description
Server
Method

Get common-code list

Retrieves multiple common codes.

Common

POST

Get prohibited-word list

Retrieves the prohibited-word list.

Common

GET

Get a common code

Retrieves one common code.

Common

GET

Get common-code reference value 1

Retrieves a common code using the group code and ref1Val.

Common

GET

Get customer notices for a screen

Retrieves customer notices displayed on the Store Front screen.

Common

GET

API Reference

For endpoint-level documentation, use the separate English API Reference draft. OpenAPI-generated reference content is intentionally left empty and is not translated.

Last updated