Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.17 KB

UPGRADING.md

File metadata and controls

55 lines (33 loc) · 2.17 KB

Upgrade Guide from 2.1.0 to 2.2.0

Issue MMAPI-62 added the inserted object into the response. ProductVariantInsertResponse has had its original response data moved and all calling code should be updated to reflect this change.

Example usage from 2.1.x

response.getProductId();
response.getVariantId();

Should be updated to for 2.2.x

response.getProductVariant().getProductId()
response.getProductVariant().getVariantId()

Issue MMAPI-67 renamed some model getter functions and all calling code should be updated. Use the following list to rename all usage in your applications:

CustomerSubscription.getAddressDescrip() 		-> CustomerSubscription.getAddressDescription()
CustomerSubscription.getAddressAdress() 		-> CustomerSubscription.getAddressAddress()
CustomerSubscription.getAddressAddress_1()		-> CustomerSubscription.getAddressAddress1()
CustomerSubscription.getAddressAddress_2()		-> CustomerSubscription.getAddressAddress2()
ProductAndSubscriptionTerm.getTermDescrip()		-> ProductAndSubscriptionTerm.getTermDescription()

Upgrade Guide from 2.0.X to 2.1.0+

The class TemplateVersionSettings has been renamed to VersionSettings.

If you are utilizing this class within your code then you will need to be renamed in their type declarations. Usage has stayed the same.

Upgrade Guide from 1.x to 2.x

Usage of OrderItemOption

Usage of OrderItemOption will need to be updated to support the change to the member attribute to attributeCode.

Replace all usage of OrderItemOption models that call either getAttribute() or setAttribute(str) with getAttributeCode() and setAttributeCode(str).

Example usage from 1.x:

var itemOption = new merchantapi.models.OrderItemOption();
itemOption.setAttribute("code");

Should be updated for 2.x:

itemOption = new merchantapi.models.OrderItemOption();
itemOption.setAttributeCode('code');

Example usage from 1.x:

var itemOption; // A OrderItemOption model loaded from an OrderListLoadQuery, for example
itemOption.getAttribute();

Should be updated for 2.x:

var itemOption; // A OrderItemOption model loaded from an OrderListLoadQuery, for example
itemOption.getAttributeCode();