Order_Delete
#
Description#
This function allows you to delete an order.
Warning
When an order is deleted, all resources attached to that order are also deleted. i.e custom order fields, customer assignment
Request Body Parameters#
Parameter |
Type | Description |
---|---|---|
Order_ID |
Number | Id of order to delete |
Response Parameters#
Parameter |
Type | Description |
---|---|---|
success |
boolean | boolean value for if the request was successful |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "Order_Delete",
"Order_ID": 20010
}
Example Response#
{
"success": 1
}
Error Responses#
Error Code | Error Message | Error Description |
---|---|---|
MER-JSN-ORD-00025 | Order number not found. | Order number not found. |
MER-JSN-ORD-00058 | Unable to load order: Order_ID must be specified | Order_id is a required parameter |