JSON API Changelog#

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

OrderListLoad_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 Merchant",
   "api_ver": "9.06",
   "version": "9.0005",
   "module": "modules\/payment\/cybersource.mvc",
   "refcount": 1,
   "active": true
 }

9.13 (4/17/2019)#

Updated Functions

OrderListLoad_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