OrderItemList_CreateReturn

Creates an RMA (return) for one or more items (products) in an order. The response has the new return’s ID, which you pass to OrderReturnList_Received when the items come back.

Before you begin#

• The API token needs OrderItemList_CreateReturn, 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 order ID and the line_id of each item. OrderList_Load_Query returns both.

Example requests#

Create a return#

Creates a return for lines 141 and 142 of order 200292.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderItemList_CreateReturn",
    "Order_Id": "200292",
    "line_ids": [141, 142]
}

Request parameters#

Example response#

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

Response parameters#

Error responses#

Related functions#

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Orders > OrderItemList_CreateReturn. See Set Up Postman.