RMA API Calls

Updated 6 months ago ​by Dimitar Ivanov

GetRMA

In order to create an RMA for an order, the OrderCreationSourceApplication on the order has to be PointOfSale

There are two ways to request RMAs, by OrderID or RMAID:

  • RMA_GetRMAByOrderID
  • RMA_GetRMAByID

Associate Replacement order with RMA

This can be linked on the RMA Item Level:  RMAItem_Update

Changing the status of RMA

  • Create RMA (Currently only possible for POS Orders)  
  • public int Create_RMA(int OrderID)
            {
                return OCS_sellerCloud.RMA_CreateNew(OCS_authHeader, OrderID);
            }

            public int Create_RMA_Item(int OrderID, int OrderItemID, int RMAID, int QtyToReturn, int RMAReason, string RMADescription, string KitProductID)
            {
                return OCS_sellerCloud.RMAItem_CreateNew(OCS_authHeader, OrderID, OrderItemID, RMAID, KitProductID, QtyToReturn, RMAReason, RMADescription);
            }

    Example:

    Dim sc_AuthHeader As New SC.AuthHeader

    With sc_AuthHeader

    .UserName = "gail@sellercloud.com"

    .Password = "sellercloud"

    End With

    Dim orderID As Integer = 5022046

    Dim orderItemID As Integer = 136968

    Dim rmaID As Integer = sellerCloud.RMA_CreateNew(sc_AuthHeader, orderID) MessageBox.Show("ORderID: " & orderID & ", RMA ID: " & rmaID)

    Dim rmaItemID As Integer = sellerCloud.RMAItem_CreateNew(sc_AuthHeader, orderID, orderItemID, rmaID, "", 1, 1, "Item did not fit my expectations.")

    MessageBox.Show("OrderID: " & orderID & ", RMA ID: " & rmaID & ", RMA Item ID: " & rmaItemID)


    RMA Reasons Enumerator

    • Damaged = 0
    • Defective = 1
    • Not_As_Requested = 2
    • Exchange = 4
    • Shipping_Error = 5
    • Didnt_Fit = 6
    • Vendor_Error = 7
    • Customer_Error = 8
    • Didnt_Like = 9
    • Processing_Error = 10
    • Denied_RMA = 11
    • Duplicate = 12
    • Fraud = 13
    • Missing_Pieces = 14
    • No_Refund_Due = 15
    • Return_To_Shipper = 16
    • Unauthorized_Return = 17
    • Undeliverable = 18
    • Warranty = 19
    • Warehouse_Mixup = 20
    • Listing_Mixup = 21
    • Other = 3

How did we do?