Authentication

Basic Authentication

Please configure your clients to use this authentication method to submit user name and password.

Bearer Token Authentication

To generate a valid JSON Web Token (JWT), just log into the OMT, inspect the browser cookies and use the value of the cookie called 'OMS_IDENTITY' as JWT. Within an UI-client (e.g., Postman) choose "Bearer Token" and just type in a valid JWT.

Authorization

The permission "View return requests" is required to use the GET endpoints and must be assigned at the requested shop_name organization. The permission "Manage return requests" is required to use the POST endpoints and must be assigned at the requested shop_name organization.

API Specification

Introduction

OpenAPI Version: 3.0.1

IOM RMA REST API Version: 2.11

The IOM RMA REST API supports programmatic access to objects related to the Return Merchandise Authorization (RMA) process.

Changelog

Version 2.11

A list of WriteContactPerson can be added to WriteReturnRequest.
Added undocumented refinements to ContactPerson. lastName and emailAddress are required. Optional language follows ISO-639-1.
Changed example of ReadReturnRequest and WriteReturnRequest. type was changed to PICKUP for a more consistent example.
Added undocumented constraint to WriteApproval. comment is required if status should be NOT_APPROVED.

Version 2.10
New endpoint returnables, which returns all positions that can still be returned back.
New endpoint return-reasons, which returns all return reasons that are allowed for the shop.

Open ReDoc-rendered Open API documentation in separate window.

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.