SAP Commerce Integration APIs

After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Discover and evaluate the basic concepts of Integration APIs and to distinguish between its components for SAP Commerce Cloud

Identify the Data Integration Interfaces with Inbound Communication and the functions of OData Services

SAP Commerce's Integration API Module offers a set of interfaces used for data integration with SAP Commerce. You can use the Integration API module to connect services to send data or receive data from SAP Commerce. The Integration API module simplifies data integration with SAP Commerce, using Integration Objects. These objects are used in the payload that’s sent or received from SAP Commerce to define data types.

Integration API features include:

  • Integration Objects
  • Enhancements to the OData protocol for use with Integration API services
  • Backoffice tools for modeling Integration Objects
  • Monitoring of Integration API requests


A new Integration Object creates a new integration.

A new integration creates API service endpoints that accept one or more objects, and define the object payloads.

Each Integration Object is specific to its own use case, or purpose. For example, a SAP Backend order object might use all available fields, but an SAP Marketing order object might use only the fields related to Marketing needs.

When you install the Integration API extensions, several services are available out-of-the-box, like the Meta API where you can view the provided Integration Objects and associated integration object items using the Integration Services endpoint.

Integrating inbound and outbound communications with the SAP Commerce Cloud and SAP S/4HANA Cloud integration requires knowledge of important practices.

Inbound Communication

You can generate OData v2 services by creating Integration Objects. Each service is generated through the Backoffice Integration UI Tool perspective or via ImpEx at runtime. The Integration Object definitions offer a business-world view of the types defined in the platform, which are better suited to real-world integration scenarios.

For example, there are many parts composing products, orders, and customers that the Integration Objects encapsulate into a cohesive unit of work.

Outbound Communication

You can dynamically define the payload of an Integration Object published to an external target. Developers leverage this ability to create skeletal business processes and interceptors (building blocks).

If you are less technical, you can dynamically modify the building blocks at runtime using Backoffice.

Save progress to your learning plan by logging in or creating an account