Create New RMA

Overview

In order to create new RMA, you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed to the service call.

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Rma​​

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Rma

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from token authentication)
  • Header info: Content-Type: application/json
  • Request Body:

ParameterData TypeDescriptionIs Required
OrderIDintegerID of existing ordertrue
OrderItemsListList of order items for which to create RMAtrue
OrderItem.OrderItemIDintegerID of order itemtrue
OrderItem.QtyToReturnintQty of this order item to return. If the OrderItem is a kit this propertry has to be ommited and BundleItems have to be provided.

RMA cannot be created for kit parent. Exception is the independent kit for which RMA can be created either for the order item or its kit items meaning that either OrderItem.QtyToReturn or OrderItem.BundleItems can be provided.

false
OrderItem.ReasonIDintegerID of return reason.

List of possible return reasons can be obtained from service “Get RMA Items Return Reasons List”.

false
OrderItem.DescriptionstringDescription for why the item is returnedfalse
OrderItem.BundleItemsListList of kit items in case the order item is a kit or if RMA for independent kit items needs to be created.

This property is required for non independent kits.

false
OrderItem.BundleItem.ProductIDstringProduct ID of the bundle itemtrue
OrderItem.BundleItem.QtyToReturnintegerQuantity to returntrue
OrderItem.BundleItem.ReasonIDintegerID of return reason.

List of possible return reasons can be obtained from service “Get RMA Items Return Reasons List”.

true
OrderItem.BundleItem.DescriptionstringDescription for why the item is returnedfalse

Response

  • If user is authenticated and create RMA is successful, then response will be Status Code 200 => OK and ID of the created RMA is returned.
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • In case of error, response will be Status Code 500 => Internal Server Error

Was this article helpful?

Next
Get All RMAs