Name: Introducing Integration API Module in SAP Commerce Cloud
Uploaded: 2026-3-24
Duration: 424 s

Share feedback

<p>We are aware of intermittent issues in accessing the learning content</p>

We are aware of intermittent issues in accessing the learning content

Personalize your learning.

Why create an SAP account?

Enhance your learning experience

SAP Learning

Choose your subscription

Manage your subscription

Live Sessions

Hands-on Practice

Certification

My Learning

Ready to start learning?

This browser is not supported

Please try again later

Sorry, we encountered an error

Try again or reset results to continue browsing

We didn’t find what you’re looking for

To continue, please log in

Your session has timed out

Validate your skills and learning by completing the certification exam and gain a highly recognised accreditation.

Book your certification exam

Complete the assessment to validate your SAP PartnerEdge competency qualifications.

Ready to take your assessment?

Learn about the key features and essentials in the latest release to help you prepare for the Stay Certified assessment.

Prepare for assessment

Learn new skills you need at your own pace with our bite-sized lessons.

Prepare for certification

In your My Learning account you can view your certification and learn how to take your Stay Certified assessment.

Ready to take your Stay Certified assessment?

Explore {title} at SAP Learning. Find out more!

Assessment

Course Completion

Knowledge Badge

Overview

Support Resource

Certification Exam

Theoretical Exam

Schedule

External Course

Practical Exercise

Practical Test

External Hands-On

External Resource

Learning Journey

Learning Journey Assessment

Lesson

Live Session

Practice System

Quiz

Scenario Based Assessment

Course Assessment

Course

Stay Certified

Subscription

System Based Assessment

Test Out

Unit

Video

Video Playlist

Week

Want to remove this from your Learning List?

Your exclusive access to the SAP Learning Hub, event edition is ready. <link>Start learning now.</link>

Access activated

You can now register for free Live Sessions.

<div><div><div><div>Discover SAP Commerce Cloud’s Integration API module in a fast, hands-on tour. Learn how to model data with Type and Class Integration Objects, expose runtime-configurable OData endpoints, and use Backoffice to build inbound/outbound APIs, manage payloads and destinations, secure with Basic or OAuth 2, enable CRUD, automate publication via Outbound Sync or Webhooks, monitor/audit activity, and export Postman-ready configs.<br><br>If you need additional information please refer to the product documentation: <a target="_blank" rel="nofollow noopener noreferrer" href="https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/a369beb4497b44d08eb7f548147cae1d.html">Integration API Module</a>.</div></div></div></div>

Introducing Integration API Module in SAP Commerce Cloud

In this video, we'll explore the Integration API module in SAP Commerce Cloud and how it enables seamless data integration with external systems. SAP Commerce Cloud's Integration API module, also known as Integration APIs, is a set of runtime configurable interfaces used for data integration with SAP Commerce Cloud. It is based on OData RESTful Web Services. Therefore, it is aligned with the vision for integrating SAP applications in general, either in cloud or hybrid environments. The major features are supported by inbound OData services, outbound OData services, and backoffice for modeling the services and monitoring the communication. Let's talk about them one by one in a bit more detail. First of all, the inbound OData services support the generation of OData RESTful web services, which can be used to connect with any OData-enabled application, such as SAP BTP Integration Suite. The web service endpoints are easily managed with the intuitive user interface in backoffice. These changes can be done dynamically at runtime without restarting or recompiling SAP Commerce Cloud server. Furthermore, the service endpoints are secured with either basic authentication for easy testing or OAuth 2 for live systems with higher security requirements. Last but not least, the exposed web services support all essential request types such as GET, POST, PATCH, DELETE, so that you can access, create, update, or delete SAP Commerce Cloud data respectively. Second of all, the outbound OData services can publish SAP Commerce Cloud data to HTTP or OData version 2 endpoints, such as SAP BTP Integration Suite. Just as the inbound services, the request payload can be dynamically managed within backoffice. As well as the destination, where the data is published to, can also be defined at runtime. Furthermore, automatic data publication mechanism is also provided to support data communication with external systems based on either outbound sync services or webhooks that are bound to change detection of SAP Commerce Cloud data. Now, let's talk about integration object. Integration object represents the basic building block within SAP Commerce Cloud's Integration API module. It creates specific API service endpoints that accept one or more objects and define the object's payload. There are two kinds of integration object: Type Modelling Integration Objects and Class Modelling Integration Objects. Type Modelling Integration Objects are based on the SAP Commerce Cloud type system and can be used with both inbound and outbound OData services. Class Modelling Integration Objects are based on standard Java classes that extend AbstractEvent and can be used with outbound OData services. Finally, there is a dedicated backoffice perspective or cockpit named Integration UI Tool that is used to model and monitor the data integration process. Let's take a quick look at this perspective in backoffice. Under Integration Object Modeling, you can create new integration objects for inbound or outbound OData services or manage the existing integration objects. You can enable or disable any attribute to expose or hide it on the related OData endpoint. Observe its data type and status. Make it the unique key for the integration object or allow deep persistence if needed. You can view the further details or rename the attribute to any other ID value to be exposed. You can also see the meta information of the integration object. For example, the Impex statement for import and export of your configuration. The EDMX format for easy mapping in other systems, for example SCPI. The JSON view for a sample JSON format to be used in your OData request for for this integration object. Or visualize the related underlying SAP Commerce Cloud types. You can clone the selected integration object. Download the audit report about it to track the management history of the integration object. Add any classification attributes if the integration object is related to product type. Define under which criteria the SAP Commerce Cloud data is searched and create virtual attributes in the integration object for your specific project needs. Under Authentication, you can create a new security configuration and connect it to any inbound OData endpoint. Or manage the existing one, setting the authentication type to Basic Authentication or OAuth2. Under Authorization, you can manage the list of principles, also known as User Accounts, that can access the related types of the selected integration object and see what access rights are granted. Under Monitoring, you can observe the inbound or outbound data connection. You can find all the connection history for a specific integration object endpoint, see whether they were successful or contained any error. Under Outbound Sync, you configure automatic data publication from the SAP Commerce Cloud data to external systems. You can configure what should be published within a certain job by relating streams to channels within containers. You can then schedule a cron job to execute the configured job. Similarly, you can also create Webhook to trigger data publication by specifying the Integration Object related to SAP Commerce Cloud data, the Consumed Destination for publication target, or any optional filter to filter the data. You can export specific or all instances of three configuration types, Inbound Channel Configuration, Webhook Configuration, and Outbound Channel Configuration. The selected items are packaged into a single Postman Collection JSON file, which contains the meta-API requests and payload needed to import the configurations into another system. If you want to know more, there is a dedicated page where you can find detailed documentation of the Integration API module. You can find the link in the description below. This concludes our exploration of the Integration API module in SAP Commerce Cloud and its powerful capabilities for seamless data integration.