Document Properties
Kbid
30003X
Last Modified
06-Apr-2023
Added to KB
02-Nov-2021
Public Access
Everyone
Status
Online
Doc Type
Guidelines
Product
  • IOM 4.0
  • IOM 4.1
  • IOM 4.2
  • IOM 4.3
  • IOM 4.4
  • IOM 4.5
  • IOM 4.6
  • IOM 4.7
Guide - IOM REST-Logging

Introduction

When integrating standard REST-API of IOM it might be helpful to see requests and responses. This may be useful if the desired information is not available otherwise, or it can be used additionally. This guide describes how to enable selected REST operations to see its request and response. The target audience of this guide is development, consulting, and operations.

References

Configure Logging

During the resource discovery phase all REST-operations will be scanned.

For REST-operations that are configured, three handlers will be registered which will log data during a REST-call: for request, response, and response-payload.

Configure a REST-Operation

To configure an operation, add its operationId into the values-files of Helm and execute an upgrade. Also see Guide - Operate Intershop Order Management 3.X.

The operationId can be found in the REST-API specification. Also see Overview - Intershop Order Management REST API.

Examples

OperationId createOrder

When configuring the operationId createOrder the following output is available:

  • by the request-handler



  • by the response-handler

OperationId updateTransmission

The response-payload when using operationId updateTransmissions may look like:

Limitations

For REST-API before IOM 2.13 check OrderMessageLogDO in the database.

Furthermore, since IOM 2.13, the following operationIds cannot be used currently:

  • cache-api
    • getCacheStatesgetCacheStatusdeleteCache
  • rma-api
    • getContactPersonsgetReturnRequestItems
  • schedule-api
    • scheduleUpdategetSchedulesgetSchedule

Also, gzip-compression is not supported yet.

Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.