Migration Guide V3 to V4

Migration Guide - V3 to V4

The only breaking change in V4 is in the catalog module. If you are not using the catalog module, you can upgrade to V4 without any changes to your code.

Function Changes

Removed functions

• addItem
• addItemsBatch
• addOrUpdateItem
• getItem
• modifyItem
• removeItem

Replaced functions

• addOrUpdateItemsBatch ➜ createOrReplaceItems
• getItems ➜ retrieveItems
• removeItemsBatch ➜ deleteItems

Added functions

• updateItems
• createOrReplaceVariations
• updateVariations
• retrieveVariations
• deleteVariations

The rest of the functions do not have any changes.

Items and Variations

One of the important changes is the separation of “Items” and “Variations”. Previously, variations lived under an “item” as an attribute. However, they now have their own functions for create, update, and remove operations. This change provides users more flexibility when making changes to variations.

Data Schema for Items

The attributes of an “Item” did not change, however, the structure of the schema has changed. Detailed explanation of the attributes and an example can be found here.

Data Schema for Variations

The attributes of an “Variation” did not change, however, the structure of the schema has changed. Detailed explanation of the attributes and an example can be found here.

Use Cases

Creating a new catalog or doing a full sync over an existing catalog

• createOrReplaceItems
• createOrReplaceVariations

Updating existing items or variations without overriding existing attributes

• updateItems
• updateVariations

Remove items or variations

• deleteItems
• deleteVariations

Extended documentation about the functions in this SDK can be found here and REST API documentation can be found here.