Skip to content

OrderReturnList_Received#


Description#

This function allows you to mark one or more returns as received and optionally return the inventory back to stock.

Requirements#

Miva version 10.00.00 or later.

Request Body Parameters#

Parameter
Type 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_adjustment Boolean 0 or 1 value whether inventory should be returned to stock

Response Parameters#

Name Description
success boolean value for if the request was successful

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderReturnList_Received",
    "Return_Ids": [6, 7],
    "Inventory_Adjustment": "1"
}

Example Response#

{
    "success": 1,
    "data": {
        "id": 5,
        "order_id": 200292,
        "code": "200292-20200713-00005",
        "status": 500,
        "dt_issued": 1594666197,
        "dt_recvd": 0
    }
}