API Changelog

Find all API Functions, examples and documentation in this Postman Collection & Environment.

26.03.00#

Image_Add #

New function. Adds an image to the store from a file on the server or from base64 data in Image_Data, and returns the image’s record.

Runtime_Load_Product_Reviews #

New function. Loads a page of approved reviews for a product, with its rating breakdown and average, using the same sort, rating filter, offset and count rules as the Load_Product_Reviews template function.

Runtime_Product_Review_Insert #

New function. Submits a product review from the storefront without a page reload, with the same validation and prelogic rules as the TGRADD form action.

Runtime_ProductList_Load_Query #

Runtime_CategoryProductList_Load_Query #

Runtime_RelatedProductList_Load_Query #

Added a new productvariant_possible filter which outputs a productvariant_possible object matching amPossible/Runtime_AttributeList_Load_ProductVariant_Possible, indicating which attribute options are in-stock/selectable for a product’s variants. Takes select_one (Boolean) and dependency_resolution (first/cascade/last) parameters. The existing attributes ondemandcolumn is unchanged.

PageList_Load_Query #

Documented existing Branch_ID/Edit_Branch/Branch_Name request parameters, which let you target a branch other than the store’s primary/current branch.

reCAPTCHA v3#

Runtime JSON functions can now be protected by reCAPTCHA v3. Requests to a protected function that fail verification return an error. See reCAPTCHA v3 and the JSON CAPTCHA feature.

26.01.01#

ProductImage_Add #

Added optional Image_Data parameter to support uploading a base64 encoded image directly, without requiring the file to pre-exist on the server.

Product_Insert #

Added Product_ExcludeFromSearchResults boolean request parameter to exclude a product from on-site search results.
Response now includes exsearch boolean field reflecting the product’s exclude-from-search state.

Product_Update #

Added Product_ExcludeFromSearchResults boolean request parameter to exclude a product from on-site search results.

10.08.03 (2/13/2024)#

ProductVariantPricing_Update #

10.07.02 (8/02/2023)#

10.07.00 (6/13/2023)#

10.06.00 (2/28/2023)#

JavaScriptResourceList_Load_Query #

CopyPageRulesList_Load_Query #

CopyProductRulesList_Load_Query #

CopyProductRulesModuleList_Load_Query #

CopyProductRulesModule_Update_Assigned #

CopyProductRulesCustomFieldList_Load_Query #

CopyProductRulesCustomField_Update_Assigned #

CopyPageRulesSettingsList_Load_Query #

CopyPageRulesSettings_Update_Assigned #

ProductList_Load_Query #

Now supports ondemandcolumns for subscriptionsettings and subscriptionterms

10.05.00 (12/19/2022)#

New Runtime APIs for accessing product and category data across any page in Miva. These functions include features such as:

Dynamically generating and returning images at any dimensions
Loading Sale Price & Inventory data, public custom fields and attributes
Support for Redis Caching for faster responses

Runtime_productlist_load_query #

Runtime_CategoryProductList_Load_Query #

Runtime_RelatedProductList_Load_Query #

Runtime_CategoryList_Load_Query #

OrderItem_Split - Now returns the id of the newly created line item#

Cost and Weight are now included in the Parts object of OrderList_Load_Query and QuoteList_Load_Query

All JSON functions now output the disp_order (display order) field if available. This allows external systems to read/view the display order of a product assigned to a category for example. This impacts the following public JSON API functions:

ProductList_Load_Query
ProductImage_Add
CategoryProductList_Load_Query

New API Functions:

SubscriptionList_Load_Query#

AllOrderPaymentList_Load_Query#

CSSResource_Insert#

CSSResource_Update#

CSSResource_Delete#

JavaScriptResource_Update#

JavaScriptResource_Delete#

Page_Insert#

Page_Copy#

Page_Update#

Page_Delete#

ProductVariant_Insert - Standardized to match update function#

ProductVariant_Update - Standardized to match insert function#

CustomerPriceGroupList_Load_Query #

PriceGroupList_Load_Query #

Now returns an object containing the time for the dt_start and dt_end response

10.03.00 (3/29/2022)#

New JSON API Functions

Runtime_BasketItem_Delete #

Runtime_BasketItem_Update #

Runtime_CalculateCharges #

Runtime_ShippingMethodList_Load #

CustomerSubscriptionList_Load_Query #

ProductAndSubscriptionTermList_Load_Query #

ProductSubscriptionTermList_Load_Query #

SubscriptionShippingMethodList_Load_Query #

Subscription_Update #

Subscription_Insert #

SubscriptionList_Delete #

SubscriptionAndOrderItem_Add #

SubscriptionAndOrderItem_Update #

Updates to Existing Functions

OrderList_Load_Query -#

CustomerList_Load_Query -#

Response now contains a dt_Updated unix timestamp. Full URL path, including domain name is now included as an ondemandcolumn when requesting product data via the ProductList_Load_Query. This is added by adding "url" as an ondemandcolumn in the request.

10.01.00 (6/30/2021)#

New API Functions Added

Attribute_Delete #

Attribute_Insert #

Attribute_Load_Code#

Attribute_Update #

AttributeAndOptionList_Load_Product #

OptionList_Load_Attribute#

Option_Delete #

Option_Insert #

Option_Update #

Option_Load_Code#

Option_Set_Default #

ProductVariantList_Load_Query#

ProductVariant_Insert#

ProductVariant_Update#

ProductVariant_Generate#

ProductVariant_Generate_Delimiter#

ProductKitList_Load_Query#

ProductKit_Generate_Variants#

ProductKit_Update_Parts#

ProductKit_Variant_Count#

InventoryProductSettings_Update#

ProductURIList_Load_Query#

ProductVariantList_Delete#

RelatedProductList_Load_Query#

OrderItem_Split #

OrderitemList_RemoveFromShipment #

OrderShipmentList_Load_Query #

CustomerAddress_Insert #

CustomerAddress_Update #

CustomerAddress_Delete #

CustomerAddressList_Delete #

CustomerAddress_Update_Residential#

CategoryList_DisplayOrder_Update#

CategoryProductList_DisplayOrder_Update#

ChildCategoryList_DisplayOrder_Update#

ChildCategoryList_Load_Query #

URIList_Load_Query #

URI_Insert#

URI_Update#

URI_Delete#

URIList_Delete#

ProductURI_Insert#

ProductURI_Update#

ProductURIList_Load_Query#

ProductURIList_Delete#

ProductURI_Redirect#

CategoryURI_Insert#

CategoryURI_Update#

CategoryURIList_Load_Query#

CategoryURIList_Delete#

CategoryURI_Redirect#

PageURI_Insert#

PageURI_Update#

PageURIList_Load_Query#

PageURIList_Delete#

PageURI_Redirect#

FeedURI_Insert#

FeedURI_Update#

FeedURIList_Load_Query#

FeedURIList_Delete#

AvailabilityGroupCustomerList_Load_Query#

AvailabilityGroupProductList_Load_Query#

AvailabilityGroup_Delete #

AvailabilityGroup_Insert #

AvailabilityGroup_Update #

AvailabilityGroupCategoryList_Load_Query#

AvailabilityGroupCategory_Update_Assigned #

AvailabilityGroupBusinessAccountList_Load_Query#

AvailabilityGroupShippingMethodList_Load_Query#

PriceGroupBusinessAccountList_Load_Query#

PriceGroupBusinessAccount_Update_Assigned #

PriceGroupCategoryList_Load_Query#

PriceGroupCategory_Update_Assigned#

PriceGroupExcludedCategoryList_Load_Query#

PriceGroupExcludedProductListLoadQuery#

PriceGroupExcludedCategory_Update_Assigned#

PriceGroupExcludedProduct_Update_Assigned#

PriceGroupQualifyingProductList_Load_Query#

PriceGroupQualifyingProduct_Update_Assigned #

PriceGroup_Delete #

PriceGroup_Insert#

PriceGroup_Update#

CouponCustomerList_Load_Query #

CouponCustomer_Update_Assigned #

OrderCoupon_Update_Assigned#

BusinessAccountList_Load_Query #

BusinessAccount_Insert #

BusinessAccount_Update #

BusinessAccountList_Delete #

BusinessAccountCustomerList_Load_Query #

BusinessAccountCustomer_Update_Assigned #

ImageTypeList_Load_All#

ImageTypelist_Load_Query #

AttributeTemplateAttributeList_DisplayOrder_Update#

AttributeTemplateAttributeList_Load_Query #

AttributeTemplateAttribute_Delete #

AttributeTemplateAttribute_Insert #

AttributeTemplateAttribute_Update #

AttributeTemplateList_Load_Query #

AttributeTemplateOption_Delete #

AttributeTemplateOption_Insert #

AttributeTemplateOption_Set_Default #

AttributeTemplateOption_Update #

AttributeTemplate_Delete #

AttributeTemplate_Update #

AttributeTemplateProductList_Load_Query#

AttributeTemplateProduct_Update_Assigned#

Attribute_CopyTemplate#

Attribute_CopyLinkedTemplate#

MivaMerchantVersion#

Module#

Store_Load#

Updated JSON API Functions

OrderList_Load_Query #

Items object now contains “tax” and “formatted_tax” fields for line item sales tax

10.00.05 (2/09/2021)#

New JSON API Functions

Quote_Convert #

Quote_Copy #

Quote_Delete #

Quote_Update_Customer_Id #

QuoteIndex_Load_Id #

QuoteItem_Add #

QuoteItem_Update #

QuoteItemList_Delete #

QuoteItemList_Load #

QuoteList_Load_Query #

QuoteNote_Insert #

QuoteNote_Update #

QuoteNote_Update_Public #

QuoteNoteList_Delete #

QuoteNoteList_Load_Query #

Quote_Create_Empty #

Quote_Load_Id #

Quote_Send #

Quote_Update_Expiry #

Quote_Update_Requester_Information #

QuoteCustomFieldandValueList_Load_Quote #

QuoteCustomFieldValues_Update_Quote #

10.00.00 (9/22/2020)#

New JSON API Functions

BranchJavaScriptResourceVersionList_Load_Query #

BranchCSSResourceVersionList_Load_Query #

BranchTemplateVersionList_Load_Query #

BranchPropertyVersionList_Load_Query #

BranchTemplateVersionList_Load_Query #

BranchList_Load_Query #

Branch_Create #

Branch_Delete #

Branch_Update #

Branch_SetPrimary #

Branch_Copy #

ChangesetList_Load_Query #

Changeset_Create #

ResourceGroupList_Load_Query #

ChangesetList_Merge#

ChangesetChangeList_Load_Query#

ChangesetTemplateVersionList_Load_Query#

ChangesetJavaScriptResourceVersionList_Load_Query#

ChangesetPropertyVersionList_Load_Query#

Branch_Merge#

BranchList_Delete#

SetPricing #

ClearPricing #

Product_CustomerPriceList_Load_Query #

Customer_ProductPriceList_Load_Query #

CustomerCreditHistoryList_Load_Query #

CustomerCreditHistory_Delete #

CustomerCreditHistory_Insert #

OrderItemList_CreateReturn #

OrderReturnList_Received #

Misc Updates

CategoryList_Load_Query #

now supports URI column

OrderItem_Add #

Now returns the full order item record

9.14.00 (8/7/2019)#

New Functions

PriceGroupCustomer_List_Load_Query #

9.13.02 (6/25/2019)#

Updated Functions

OrderList_Load_Query #

A new object exists for the payment module object within the payments object. This allows any external system to identify to payment module which processed the payment (authorize.net, vs PayPal vs AmazonPay, etc.). This object is included in the payments object for each payment record in the OrderList_Load_Query API call. This addition allows an external system to identify which payment module processed the payment.

"module": {
   "id": 120,
   "code": "cybersource",
   "name": "CyberSource",
   "provider": "Miva",
   "api_ver": "9.06",
   "version": "9.0005",
   "module": "modules\/payment\/cybersource.mvc",
   "refcount": 1,
   "active": true
 }

9.13 (4/17/2019)#

Updated Functions

OrderList_Load_Query #

A new object exists for item parts within the Items Object. This allows for items setup as a kit to also show the part products of that item. This object will only be present if an item has parts and if you pass "parts" as an ondemandcolumn in the request.

parts:
[
    {
        code:           "Part Product Code",
        sku:            "Part Product SKU",
        name:           "Part Product Name",
        quantity:       <x>,
        total_quantity: <x * item.quantity>
        price:          <part product price>
    }
]

9.12 - Initial Release#

10/30/2018 - Initial JSON API Release

API Clients Runtime.js

On This Page