Document Properties
Kbid281U96
Last Modified22-Jun-2020
Added to KB08-Mar-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductIOM 2.1

IOM Connector 4.0 - REST API - Order Return Reasons

URI

/orders/<order-id>/return

Http Method

GET

Short Description

Provides an information about return reasons for given order

Query Parameters

none

Example Requests

/orders/y.UKDACPMIQAAAFYFlQGqAA1/return

HTTP Status Codes

  • 200 OK
  • 400 Unauthorized
  • 401 Bad Request
  • 404 Not found

Description

Provides an information about return reasons for given order. This information include:

  • Type

  • Reason ID

  • Reason description

Cartridge

ac_iomconnector_orderhistory

Application

B2C Web Shop, SMB Web Shop

Product Version

4.0

Product To Version

 
Status

final

JSON

Request data format

Request related java object

n/a

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.adapter.iomconnector.rest.capi.resource.order.returnreason.OrderReturnReasonsResource
com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.returnreason.ReasonRO
com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.returnreason.ReasonCollectionRO

Response data example

 {
  "elements": [
    {
      "type": "ReasonRO",
      "id": "RET010",
      "description": "return of goods / general"
    },
    {
      "type": "ReasonRO",
      "id": "RET100",
      "description": "transport damage"
    },
    {
      "type": "ReasonRO",
      "id": "RET990",
      "description": "other reasons"
    },
    {
      "type": "ReasonRO",
      "id": "RET190",
      "description": "return of goods because product does not meet customer's expectations"
    }
  ],
  "type": "ResourceCollection"
}

XML

Request data format

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.adapter.iomconnector.rest.capi.resource.order.returnreason.OrderReturnReasonsResource
com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.returnreason.ReasonRO
com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.returnreason.ReasonCollectionRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReasonCollectionRO type="ResourceCollection">
    <elements>
        <ReasonRO type="ReasonRO">
            <description>return of goods / general</description>
            <id>RET010</id>
        </ReasonRO>
        <ReasonRO type="ReasonRO">
            <description>transport damage</description>
            <id>RET100</id>
        </ReasonRO>
        <ReasonRO type="ReasonRO">
            <description>other reasons</description>
            <id>RET990</id>
        </ReasonRO>
        <ReasonRO type="ReasonRO">
            <description>return of goods because product does not meet customer's expectations</description>
            <id>RET190</id>
        </ReasonRO>
    </elements>
</ReasonCollectionRO>

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets