Download OpenAPI specification:Download
The IOM RMA REST API supports programmatic access to objects related to the Return Merchandise Authorization process.
Returns a list of return reasons configured for a given shop.
shopName required | string The shop name |
type | Array of strings Example: type=RET Filter the return reasons by name of 1..n return types |
OK
Bad Request
Authentication information is missing or invalid
Forbidden
Not Found
[- {
- "name": "RET010",
- "description": "return of goods / general",
- "type": "RET"
}
]
Creates a new approval
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
status required | string Enum: "APPROVED" "NOT_APPROVED" The status of the approval. |
comment | string The comment for the approval. |
Created
Bad Request
Authentication information is missing or invalid
Forbidden
Unsupported Media Type
An unexpected error occured
{- "status": "APPROVED",
- "comment": "The return request reasons are not convincing."
}
{- "status": 400,
- "errors": [
- {
- "code": "VALIDATION_EXCEPTION",
- "message": "Attribute XYZ is mandatory",
- "value": { }
}
]
}
Returns a list of return request contact persons for a given returnRequestId, shopName and shopOrderNumber.
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "id": 10000,
- "company": "Intershop Communication AG",
- "firstName": "John",
- "lastName": "Doe",
- "phoneNumber": "0176 12345677",
- "emailAddress": "john.doe@intershop.com",
- "language": "english"
}
]
Returns a return request for a given shopName, shopOrderNumber and returnRequestId.
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
{- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "type": "RETURN",
- "rmaNumber": "10901095",
- "comment": "The battery is draining quickly",
- "id": 10000,
- "creationDate": "2020-04-16T16:12:23Z",
- "shopOrderNumber": 20180303123,
- "shopName": "Test Shop US DE",
- "supplierOrderNumber": 20180303321,
- "supplierName": "Test Supplier US DE",
- "status": "CLOSED",
- "businessStatus": "ACCEPTED"
}
Returns a list of returnable order positions. Get the necessary data to enable a client a prepare the creation of a return request.
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
{- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "positions": [
- {
- "positionNumber": 3,
- "quantity": 1,
- "items": [
- {
- "productSerialNumber": "667002"
}
], - "product": {
- "number": "100-0001",
- "name": "Demo Product"
}
}
]
}
Returns a list of return requests for a given shopName and shopOrderNumber.
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "type": "RETURN",
- "rmaNumber": "10901095",
- "comment": "The battery is draining quickly",
- "id": 10000,
- "creationDate": "2020-04-16T16:12:23Z",
- "shopOrderNumber": 20180303123,
- "shopName": "Test Shop US DE",
- "supplierOrderNumber": 20180303321,
- "supplierName": "Test Supplier US DE",
- "status": "CLOSED",
- "businessStatus": "ACCEPTED"
}
]
Creates a new return request
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
type required | string Enum: "RETURN" "PICKUP" The type that specifies the return request. |
rmaNumber | string [ 1 .. 50 ] characters The actual number of the return request. |
comment | string [ 0 .. 255 ] characters The comment of the return request. |
positions required | Array of objects (WriteReturnRequestPosition) [ 1 .. 2147483647 ] items |
pickupAddress | object (WritePickupAddress) Represents a pickup address related to the return request from an order of a shop. |
customAttributes | Array of objects (WriteCustomAttribute) |
Created
Bad Request
Authentication information is missing or invalid
Forbidden
Unsupported Media Type
An unexpected error occured
{- "type": "RETURN",
- "rmaNumber": "10901095",
- "comment": "The battery is draining quickly",
- "positions": [
- {
- "positionNumber": 1,
- "productNumber": 20180303123,
- "reason": "RET100",
- "quantity": 1,
- "items": [
- {
- "productSerialNumber": "W88401231AX"
}
]
}
], - "pickupAddress": {
- "company": "Intershop Communication AG",
- "firstName": "John",
- "lastName": "Doe",
- "streetName": "Alexstraße",
- "houseNumber": "28",
- "postCode": "12053",
- "city": "Berlin",
- "countryCode": "DEU",
- "district": "Berlin",
- "additionFirstLine": "Finanz",
- "additionSecondLine": "3.Floor"
}, - "customAttributes": [
- {
- "key": "Example Key",
- "value": "Example Value"
}
]
}
{- "status": 400,
- "errors": [
- {
- "code": "VALIDATION_EXCEPTION",
- "message": "Attribute XYZ is mandatory",
- "value": { }
}
]
}
Returns a list of return request pickup addresses for a given returnRequestId, shopName and shopOrderNumber.
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "company": "Intershop Communication AG",
- "firstName": "John",
- "lastName": "Doe",
- "streetName": "Alexstraße",
- "houseNumber": "28",
- "postCode": "12053",
- "city": "Berlin",
- "countryCode": "DEU",
- "district": "Berlin",
- "additionFirstLine": "Finanz",
- "additionSecondLine": "3.Floor",
- "id": 10000
}
]
Returns a list of return request custom attributes for a given returnRequestId, shopName and shopOrderNumber.
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "key": "Example Key",
- "value": "Example Value",
- "id": 10000
}
]
Returns a list of return request position items for a given returnRequestId, shopName and shopOrderNumber.
returnRequestPositionId required | integer <int64> The return request position id of the related return request |
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "productSerialNumber": "W88401231AX",
- "id": 10000
}
]
Returns a return request position for a given returnRequestId, shopName, shopOrderNumber and a returnRequestPositionId.
returnRequestPositionId required | integer <int64> The return request position id of the related return request |
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
{- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "positionNumber": 1,
- "productNumber": 20180303123,
- "reason": "RET100",
- "quantity": 1,
- "id": 10000,
- "productName": "test_product_1",
- "supplierProductNumber": 20180303123
}
Returns a list of return request positions for a given returnRequestId, shopName and shopOrderNumber.
returnRequestId required | integer <int64> The return request id of the related order |
shopOrderNumber required | string The order number of the shop |
shopName required | string The shop name |
OK
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
[- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "positionNumber": 1,
- "productNumber": 20180303123,
- "reason": "RET100",
- "quantity": 1,
- "id": 10000,
- "productName": "test_product_1",
- "supplierProductNumber": 20180303123
}
]