Skip to Content
Author's profile photo NithinKumar B

Overview and Execution of Web Service in SAP Business ByDesign & SAP Hybris Cloud for Customer

Overview and Execution of Web Service


  • A way for two applications or electronic devices to communicate over a network.
  • Act like a black-box that may require input and deliver a result
  • Are modular, self-contained and self-describing
  • Work on top of any communication technology stack i.e. applicable to any platform, database, and programming language
  • Can be published, discovered and invoked based on open technology standards
  • Work in synchronous and asynchronous scenarios
  • Facilitate integration within an enterprise as well as cross enterprises

Web Service Jargon:

  • Extensible Markup Language (XML) is a way to label data so we can structure our information in meaningful ways.
  • Web Services Description Language (WSDL) works as a help desk, describing the details of the web service.
  • Universal Description, Discovery, and Integration (UDDI), also much like a help desk, is a means of publishing and finding information about web services.
  • Simple Object Access Protocol (SOAP) is like a courier or communicator during the transfer of data. It is platform independent and extensible.

Web Service.PNG

Web Service Types:

A2X (Application To X users):   A2X service is for UI consumption, synchronous accesses and normally user get error message right away if something wrong, and you should be able to consume these service directly if you want.

A2A (Application To Application): Communication pattern for data exchange between two applications in one business process platform within the same enterprise, which will include forward error handling etc and need involve EAI/ESB middleware, in this case, most likely SAP PI.

B2B(Business To Business): Communication pattern for data exchange between two business process platforms across enterprise boundaries, which will include forward error handling etc and need involve EAI/ESB middleware, in this case, most likely SAP PI.


Communication Systems and Communication Arrangements:

  • A Communication System represents an external system which is used for application integration. Communication systems can be, for example, external time recording or master data systems. Before you can use a communication system in an application integration scenario, you need to create a communication arrangement.
  • Communication Arrangements help you to configure the electronic data exchange between the solution(ByD/C4x) and a communication partner.

The solution provides communication scenarios for inbound and outbound communication that you can use to create communication arrangements.

Inbound communication – Business documents are received from a communication partner,

Outbound communication – Business documents are sent to a communication partner.

For more information about communication arrangements, see Communications Arrangements Quick Guide in SAP Business Bydesign help center.

List of Operations:

1) Query Services:

Query operations are mass-enabled stateless synchronous Web service operations that allows transferring or requesting  amounts of data (Read Operation)

2) Maintain Services: Check Maintain Bundle & Maintain Bundle

Check Maintain Bundle vs. Maintain Bundle


Maintain Bundle operations enable external applications to create and change business document data


Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data. In    particular, Check Maintain Bundle operations have the following functions:

  Return system messages similar to corresponding Maintain Bundle operations

  Provide the same message type as the corresponding operation Maintain Bundle

  Do not assign internal numbers from a productive number range interval (number range statuses are not increased)

  Do not change business documents.

Action Codes:

Action codes represent an instruction to the recipient of the Web service request to process transmitted message node elements.

Action Codes.PNG

How To Check Web Service Error Logs:

Frontend UI Logs:

Go To Application and User Management  Work Center >  Input and Output Management > Business Communication Monitoring > Select the Rejected Web Service Calls  from the menu Show

Web Service Logs.PNG

Extending Web Service Interfaces :

Extending Interfaces:

It is now possible to use the extended fields in the service interfaces. Navigate to the screen on which the extension field is available, and select Enter Adaptation Mode from the Adapt menu. In adaptation mode, select Edit Screen from the Adapt menu.  In the Adaptation panel, under Extension Fields, select the extension field from the list and under Field Properties, click Further Usage. On the  Services tab, you can add the extension field to the interface. In the Message column, you can check if the extensibility is supported in the request message and/or message structure.


Reference Documents:

List of Web Service APIs in SAP Business ByDesign –

List of Web Service APIs  SAP Hybris Cloud for Customer –

Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Ivan Bondarenko
      Ivan Bondarenko

      Thanks a lot, very good and well structured overview!

      Do you plan to describe particular cases, like pricing, accounts relationships etc.?



      Author's profile photo NithinKumar B
      NithinKumar B
      Blog Post Author


      Thanks. This blog is targeted to get an overview of web service & it's execution. Since, we have many business scenarios which are created through web service, we have generalized it. But, we can surely assist if there is an issue with particular case/scenario. You can report an incident to SAP in such case.



      Author's profile photo Former Member
      Former Member

      Very well written document Nithin, really helpful.