Skip to content

`OrderList_Archive`#

Description#

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#

Parameter	Type	Description
`Order_IDs`	Array	List of order numbers to archive
`Delete_Payment_Data`	Boolean	If set to false, payment data will not be deleted. The default value is true.
`Delete_Shipping_Labels`	Boolean	If set to false, shipping labels will not be deleted. The default value is true.

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the request was successful
`processed`	String	Total number of orders archived.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderList_Archive",
    "Delete_Payment_Data": true,
    "Delete_Shipping_Labels": true,
    "Order_IDs": [200299, 200300]
}

Example Response#

{
    "success": 1,
    "processed": 1
}