Archives orders. Archiving orders in Miva consists of deleting all payment data and shipping labels from an order. Use it when a merchant no longer needs that data. Removing old payment information reduces their liability in case of a data breach.
Before you begin#
- The API token needs
OrderList_Archive, 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.
- You need the order numbers to archive.
Example requests#
Archive orders#
Deletes the payment data and shipping labels from orders 200299 and 200300.
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "OrderList_Archive",
"Delete_Payment_Data": true,
"Delete_Shipping_Labels": true,
"Order_IDs": [200299, 200300]
}
Request parameters#
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Order_IDs |
Array | Yes | List of order numbers to archive | |
Delete_Payment_Data |
Boolean | No | true |
If set to false, payment data will not be deleted. The default value is true. |
Delete_Shipping_Labels |
Boolean | No | true |
If set to false, shipping labels will not be deleted. The default value is true. |
Example response#
{
"success": 1,
"processed": 1
}
Response parameters#
| Parameter | Type | Description |
|---|---|---|
success |
Boolean | Boolean value indicating if the request was successful |
processed |
Number | Total number of orders archived. |
Related functions#
| Function | Use it to |
|---|---|
OrderList_Load_Query |
Find the orders to archive |
Order_Delete |
Delete an order completely |
AllOrderPaymentList_Load_Query |
Review order payments before archiving |
Try in Postman#
In the Miva: JSON API: Authenticated collection, open Orders > OrderList_Archive. See Set Up Postman.