This guide is intended for customers with custom-built third-party API integrations. It provides an additional method for updating orders, rather than the standard approach.
Adding items to a return
Once a return has been created, Warehouse or 3PL Client Users can add an item to a return using the following API call: /api/Return/{id}/AddItem.
Note: Only one product can be added per API request, but you can specify a quantity greater than one for that product.
Required Information
To successfully make the call, you will need:
The Return ID.
The Product ID you want to add.
The Return Reason ID.
The Action (see options below).
(Optional) Comments.
(Optional) Photos.
Example body
{"Quantity": 1,"ReturnReasonId": 123,"ProductId": 456,"Action": "REFUND","Comments":"Item was damaged","ReturnPhotos":[ "https://example.com/photo1.jpg"]}Additional Details
ReturnReasonId: Go to the Return Reasons section in Mintsoft, click Edit on a reason, and use the number that appears in the URL.
ProductId: Go to the product in Mintsoft, click Edit, and copy the number in the URL.
Action must be one of the following:
NONE
REFUND
RESEND
ReturnPhotos is optional. If not needed, you can remove that line from the request body.