OrderItem_Update

Updates an item (product) in an order, such as its code, name, quantity, price or attributes. All fields except Order_ID and Line_ID are optional. The response has the new order total.

Before you begin#

• The API token needs OrderItem_Update, 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 item’s line_id. OrderList_Load_Query returns both.

Example requests#

Update an item#

Changes line 154 of order 200101 to 3 small red shirts at a new price, with size and color attributes.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderItem_Update",
    "line_id": 154,
    "Order_ID": 200101,
    "Code": "shirt",
    "Name": "Custom T-Shrt",
    "SKU": "shirt-red-small",
    "Quantity": 3,
    "Price": 10.58,
    "Weight": 1,
    "Taxable": true,
    "Attributes": [
        {
            "attr_code": "size",
            "opt_code_or_data": "small",
            "price": 0,
            "weight": 0
        },
        {
            "attr_code": "color",
            "opt_code_or_data": "red",
            "price": 0,
            "weight": 0
        }
    ]
}

Request parameters#

attributes object#

Example response#

{
    "success": 1,
    "data": {
        "total": 63.48,
        "formatted_total": "$63.48"
    }
}

Response parameters#

Error responses#

Related functions#

Try in Postman#

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