Table of Contents

IntegrationData

Integration data property set is used to add metadata to product parts and / or materials.

PROPERTY_SET: IntegrationData

Property Name Type Localized Description
Name Text field Y The name of the integration data property. It can be referred to in scripting from elsewhere
Value Scripting N Value or scripting logic that the property has

Example of how this might look in the SalesData json:

     "properties": {
        "Material": "Fabric Petrol"
     },

Originally our product summary / Bill of Materials(BOM) has listed and counted items(parts of the composition) based on SKU's. When using integration data, the list takes the provided metadata into account while summarizing items.

This change means that parts with identical SKU's but different integration data (colors or materials specified) are treated as separate items in the summary / BOM.

Example of usage

Some e-commerce platforms have product variant limits, which hinders stores that have a vast variety of colors and materials. Using integration data property set in manager (management.vividworks.com), material and color options can be put to product parts metadata.

IntegrationDataExample

This removes the need for putting SKU's for materials, thus also removing the issue of product variant limit.

How above example would work and look in Shopify

In Shopify, the visibility of data can be configured with two options:

  1. The data can be displayed to both the shop owner and to the customer. It would be visible in cart and checkout (and for shop owner only, in 'orders' tab in Shopify admin view.) This can be implemented using Shopify's cart line item properties.

    CartView
    Red arrow in above image shows the result of configuring integrationdata in the way of the example.

    CheckoutView
    Red arrow in above image shows the result of configuring integrationdata in the way of the example.

    AdminOrdersView
    Red arrow in above image shows the result of configuring integrationdata in the way of the example.

  2. The data can be set to display only to the shop owner, in 'orders' tab in Shopify admin view. This can be implemented using Shopify's cart line item hidden properties. This way, the end customer will not see the metadata at all.

HiddenVisibleInAdminOrdersView
Red arrow in above image shows the result of configuring integrationdata in the way of the example.