24/7 Support: 800.608.6482

Navigation


OrderItemList_CreateReturn

Requirements: Miva verion 10.00.00 or later.
This function allows you to create an RMA (return) for one or more items (products) in an order

Request Body Parameters

Order_ID Type:
Number
Title:
Order Id
Order Id
line_ids Type:
Array
Title:
Line IDs
Array of line ids to Return. This can either be a JSON array or a pipe delimited list

Response Parameters

id Type:
Number
Title:
Id
Id of newely created RMA
order_id Type:
Number
Title:
Order Id
Order ID
code Type:
String
Title:
RMA Code
Auto generated by Miva, the RMA Code is in the following format order_id-date-unique_int
status Type:
Number
Title:
RMA Status
One of two possisible status: 500 - RMA issued or 600 - Returned
dt_issued Type:
Timestamp
Title:
Date Time Issued
Unix Timestamp for when the RMA was created
dt_recvd Type:
Timestamp
Title:
Date Time Recieved
Unix Timestamp for when the Item was marked as returned. 0 means the item has not been returned.

Example Request

Example Response

Error Responses

error code
MER-JSN-ORD-00025
error message
Order number not found.
  Order number not found.
error code
MER-JSN-ORD-00059
error message
No valid order items specified
  The line_ids passed don't match up to any line_ids on the order
error code
MER-JSN-00023
error message
One or more parameters are invalid
  description
Missing line_ids parameter

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.