Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

SubscriptionAndOrderItem_Update

Previous Next

This function updates an item on a subscription and order.

Description#

This function updates an item on a subscription and order.

Request Parameters#

Parameter Type Required Description
order_id Number The id number of the order to be updated
line_id Number Yes The line id number of the order to be updated
subscription_id Number Yes Required. The id number of the subscription linked to the order item
paymentcard_id Number The id of the saved payment card linked to the subscription
product_id
Edit_Product
Product_Code
Product_SKU		 Number
String
String
String		 ID Number of product
Product code string
Product code string
Product SKU string
productsubscriptionterm_id Number Subscription term id for the product
address_id Number Address id for the subscription
ship_id Number Shipping id for the subscription
ship_data String The name of the shipping option for the subscription
quantity Number Product quantity for the subscription
nextdate Number Datetime string for the next subscription fulfillment date
template_codes String Template codes for product
attribute_codes String Attribute codes for product
values String Product values

Response Parameters#

Parameter Type Description
success Boolean Boolean value indicating if the api request was successful
total Number Subscription total price
formatted_total String Currency formatted subscription total price

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "SubscriptionAndOrderItem_Update",
    "Order_ID": 1013,
    "Line_ID": 91,
    "Subscription_ID": 6,
    "PaymentCard_ID": 0,
    "Product_ID": 9,
    "ProductSubscriptionTerm_ID": 1,
    "Address_ID": 2,
    "Ship_ID": 140,
    "Ship_Data": "overnight",
    "Quantity": 1,
    "NextDate": "2022-03-11T00:00:00-00:00",
    "Template_Codes": "",
    "Attribute_Codes": "",
    "Values": ""
}

Example Response#

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

Error Responses#

Error Code Error Message Error Description
MER-CUS-JSN-00001 Customer not found Customer not found
SubscriptionAndOrderItem_Add SubscriptionList_Delete