In this blog post, I will share the basics of SAP Commerce Cloud integration.
Integration API Module:
It is a set of extensions used for data integration. It uses ODATA protocol. The data is passed as Integration Object.
An Integration Object describes the structure of a business-level entity. It is the foundation for an EDMX schema. It is composed of several commerce Items. The structure can be defined either at the backoffice or via Impex or using meta API.
The integrationKey property serves as a unique identifier for each EDMX entity.
Integration Object Modelling:
Go to SAP Commerce Portal -> BackOffice -> Integration UI tool
After creating the structure, view the EDMX structure using 'META' icon.
Supported credential type is Basic or OAuth (System –>API –> Credentials).
Outbound sync uses delta detection to identify new and modified Items in SAP Commerce Cloud.
Configure an outbound channel (Backoffice -> Integration UI Tool -> Outbound Sync -> Configuration -> Channels). Select an Integration Object, choose a Consumed Destination and then select 'Generate Related Configurations'. The 'Generate Related Configurations' option is used to autogenerate the container, stream(s), job, and cronjob for the configuration.
Use 'OutboundServiceFacade' to send Integration Object Items. Tutorial Link
To enable monitoring outbound requests in backoffice, set property 'outboundservices.monitoring.enabled' to true in HAC (Platform -> Configuration).
To monitor outbound requests, go to
Integration UI Tools -> Monitoring -> Outbound.
Outbound payload retention can be configured by setting the below properties in HAC.
It is used to execute business logic before or after a request to persist an item in SAP Commerce Cloud.
We can invoke the hook by specifying its name in the header of an HTTP POST request. There are 2 types of hooks:
There can be only one PrePersistHook and one PostPersistHook per request at most. If there is no value in a Pre- or PostPersistHook header, the header is ignored and the object is persisted as usual.
The following shows an example of an inbound persistence hook call from standard integration package.
This blog post serves as a foundational introduction to Commerce Cloud integration. Thank you for reading this. Please feel free to share your feedback or thoughts or ask questions in the Q&A tag below.