Document Properties
Last Modified01-Oct-2020
Added to KB13-Aug-2019
Public AccessEveryone
Doc TypeReferences
  • IOM 2.15
  • IOM 2.16
  • IOM 2.17
  • IOM 3.0

IOM Return Status Model


Statuses of a return.


For services using this model the statuses must be used prefixed with STATE_.

This means for the status INITIAL the following will be returned: STATE_INITIAL.

Product Version


Product To Version




The following table lists all states of Return State Model with IDs and short descriptions.

INITIAL0Return initially stored in the database.
NOT_CHECKED999Validation of return failed. The return has to be checked manually.
CHECKED1000Return was checked.
DO_ANNOUNCE4001Announcement of return information has to be done.
ANNOUNCED4100Finished announcement of return information.
DO_PROCESS3001Return is ready to process.
PROCESSED6000Return processed.
DO_COMPOSE_RESPONSE4701Response to shop has to be created from return.
COMPOSED_RESPONSE4800Created response to the shop from return.
DO_CLOSE7901Return process can be closed.
DO_CHECK500Modified manually and ready to process.
IN_EXTERNAL_PROCESSING8900Return is in external processing.
NOT_CHECKED_DO_APPROVE995Validation of return failed. The return has to be checked manually by the shop.
DO_APPROVE2001Validation failed. Return has to be approved.
APPROVE_MANUAL2099Return has to be approved manually.
APPROVED2500Return approved.
DO_PREPARE_DOCUMENT7001Required objects to create documents will be created.
PREPARED_DOCUMENT7100Finished creation of documents.
WAIT_MERGE10000Return was stopped because of order merge. Status to wait without status transitions.
COPIED_FOR_MANUAL_EDIT9999Created copy of the message to be edited manually.
WAIT_PENDING11000Return was stopped after creation of new return by interface. Status to wait without status transitions.
FAILED9000Processing of return failed.
CLOSED8000Closed return processing.
APPROVAL_REJECTED8500Rejected approval.


The following model shows the different states and the possible transitions between the states.


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.

Customer Support
Knowledge Base
Product Resources