Marks one or more returns as received and can put the inventory back in stock.
Marks one or more returns as received. Set Inventory_Adjustments to put the returned items back in stock. Returns are created with OrderItemList_CreateReturn.
Before you begin#
- The API token needs
OrderReturnList_Received, either assigned directly under Functions or through a group. See Create an API token. - Requests must be signed if the token requires it. See Make a signed request with HMAC.
- Miva version 10.00.00 or later.
- You need the return IDs.
OrderItemList_CreateReturnreturns them.
Example requests#
Mark returns as received#
Marks returns 6 and 7 as received and puts the inventory back in stock.
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "OrderReturnList_Received",
"Return_Ids": [6, 7],
"Inventory_Adjustments": [1, 1]
}
Request parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
Return_Ids |
Array | Array or Pipe separated list of Returns to mark as received. The Id is returned in the OrderItemList_CreateReturn call. | |
Inventory_Adjustments |
Array | Array or pipe separated list of 0 or 1 values, one per return in the same order as Return_Ids. 1 returns that return’s inventory to stock. |
Example response#
{
"success": 1,
"data": {
"id": 5,
"order_id": 200292,
"code": "200292-20200713-00005",
"status": 500,
"dt_issued": 1594666197,
"dt_recvd": 0
}
}
Response parameters#
| Name | Description |
|---|---|
success |
boolean value for if the request was successful |
Related functions#
| Function | Use it to |
|---|---|
OrderItemList_CreateReturn |
Create the return (RMA) |
OrderList_Load_Query |
Find the order |
OrderPayment_Refund |
Refund the payment for returned items |
Try in Postman#
In the Miva: JSON API: Authenticated collection, open Orders > OrderReturnList_Received. See Set Up Postman.