OrderItemList_Cancel

Cancels one or more items (products) in an order and returns the new order total. You can record a reason for the cancellation.

Before you begin#

• The API token needs OrderItemList_Cancel, 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 ID and the line_id of each item. OrderList_Load_Query returns both.

Example requests#

Cancel items#

Cancels lines 153 and 165 of order 200100 and records why.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderItemList_Cancel",
    "Order_Id": "200100",
    "Reason": "Customer called to remove items",
    "line_ids": [153, 165]
}

Request parameters#

Example response#

{
    "success": 1,
    "data": {
        "total": 0.0,
        "formatted_total": "$0.00"
    }
}

Response parameters#

Error responses#

Related functions#

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Orders > OrderItemList_Cancel. See Set Up Postman.