24/7 Support: 800.608.6482

Navigation


OrderList_Archive

This function allows you to archive orders. Archiving orders in Miva Merchant consists of deleting all payment data and shipping labels from an order. This is a useful feature for merchants that no longer need that data, especially order payment information as it reduces their liability in case of a data breach.

Request Body Parameters

Order_IDs Type:
Array
Title:
Order ID
List of order numbers to archive
Delete_Payment_Data Type:
Boolean
Title:
Delete Payment Data
[optional] If set to false payment data will not be deleted. The default value is true.
Delete_Shipping_Labels Type:
Boolean
Title:
Delete Shipping Labels
[optional] If set to false shipping labels will not be deleted. The default value is true.

Response Parameters

processed Type:
String
Title:
Orders Processed
Total number of orders archived.

Example Requests

Example Response

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 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.