IntershopIOM - 2.10 - RMA

IOM RMA REST API (2.10)

Download OpenAPI specification:Download

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

Authentication

basicAuth

Basic Authentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

bearerAuth

JWT Bearer token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

shop

API endpoints, that could be used by the shop.

List the configured return reasons for a given shop

Returns a list of return reasons configured for a given shop.

Authorizations:
path Parameters
shopName
required
string

The shop name

query Parameters
type
Array of strings
Example: type=RET

Filter the return reasons by name of 1..n return types

Responses

200

OK

400

Bad Request

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

get /shops/{shopName}/return-reasons
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/return-reasons

Response samples

Content type
application/vnd.intershop.return-request.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

Create an approval

Creates a new approval

Authorizations:
path Parameters
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

Request Body schema: application/vnd.intershop.approval.v1+json
status
required
string
Enum: "APPROVED" "NOT_APPROVED"

The status of the approval.

comment
string

The comment for the approval.

Responses

201

Created

400

Bad Request

401

Authentication information is missing or invalid

403

Forbidden

415

Unsupported Media Type

500

An unexpected error occured

post /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/approvals
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/approvals

Request samples

Content type
application/vnd.intershop.approval.v1+json
Copy
Expand all Collapse all
{
  • "status": "APPROVED",
  • "comment": "The return request reasons are not convincing."
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "errors":
    [
    ]
}

List the return request contact persons

Returns a list of return request contact persons for a given returnRequestId, shopName and shopOrderNumber.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/contact-persons
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/contact-persons

Response samples

Content type
application/vnd.intershop.contact-person.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

Get a return request

Returns a return request for a given shopName, shopOrderNumber and returnRequestId.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}

Response samples

Content type
application/vnd.intershop.return-request.v1+json
Copy
Expand all Collapse all
{
  • "links":
    [
    ],
  • "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"
}

List the returnable order positions to prepare the creation of a return request

Returns a list of returnable order positions. Get the necessary data to enable a client a prepare the creation of a return request.

Authorizations:
path Parameters
shopOrderNumber
required
string

The order number of the shop

shopName
required
string

The shop name

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/returnables
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/returnables

Response samples

Content type
application/vnd.intershop.return-request.v1+json
Copy
Expand all Collapse all
{
  • "links":
    [
    ],
  • "positions":
    [
    ]
}

List the return requests

Returns a list of return requests for a given shopName and shopOrderNumber.

Authorizations:
path Parameters
shopOrderNumber
required
string

The order number of the shop

shopName
required
string

The shop name

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests

Response samples

Content type
application/vnd.intershop.return-request.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a return request

Creates a new return request

Authorizations:
path Parameters
shopOrderNumber
required
string

The order number of the shop

shopName
required
string

The shop name

Request Body schema: application/vnd.intershop.return-request.v1+json
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)

Responses

201

Created

400

Bad Request

401

Authentication information is missing or invalid

403

Forbidden

415

Unsupported Media Type

500

An unexpected error occured

post /shops/{shopName}/orders/{shopOrderNumber}/return-requests
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests

Request samples

Content type
application/vnd.intershop.return-request.v1+json
Copy
Expand all Collapse all
{
  • "type": "RETURN",
  • "rmaNumber": "10901095",
  • "comment": "The battery is draining quickly",
  • "positions":
    [
    ],
  • "pickupAddress":
    {
    },
  • "customAttributes":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "errors":
    [
    ]
}

List the return request pickup addresses

Returns a list of return request pickup addresses for a given returnRequestId, shopName and shopOrderNumber.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/pickup-addresses
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/pickup-addresses

Response samples

Content type
application/vnd.intershop.pickup-address.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

List the return request custom attributes

Returns a list of return request custom attributes for a given returnRequestId, shopName and shopOrderNumber.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/custom-attributes
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/custom-attributes

Response samples

Content type
application/vnd.intershop.custom-attribute.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

List the return request position items

Returns a list of return request position items for a given returnRequestId, shopName and shopOrderNumber.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}/items
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}/items

Response samples

Content type
application/vnd.intershop.return-request-item.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

Get a return request position

Returns a return request position for a given returnRequestId, shopName, shopOrderNumber and a returnRequestPositionId.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}

Response samples

Content type
application/vnd.intershop.return-request-position.v1+json
Copy
Expand all Collapse all
{
  • "links":
    [
    ],
  • "positionNumber": 1,
  • "productNumber": 20180303123,
  • "reason": "RET100",
  • "quantity": 1,
  • "id": 10000,
  • "productName": "test_product_1",
  • "supplierProductNumber": 20180303123
}

List the return request positions

Returns a list of return request positions for a given returnRequestId, shopName and shopOrderNumber.

Authorizations:
path Parameters
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

Responses

200

OK

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get /shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions
{protocol}://{domain}:{port}/rest/rma/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions

Response samples

Content type
application/vnd.intershop.return-request-position.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]