What’s new in version 1.12.2

Version 1.12.2 of the Shopify connector is now available. It includes a minor but important improvement to the way Shopify metafields are named and mapped in Sales Layer.

This version is especially recommended for customers who work with Shopify metafields whose namespace contains underscores, such as custom namespaces created directly in Shopify.

Main update in version 1.12.2:

• Keeps the standard metafield naming format: metafields_<namespace>_<key>.
• Allows namespaces that contain underscores by writing each namespace underscore as three underscores: ___.
• Keeps the same format for existing metafields that do not have underscores in the namespace.
• Makes it easier to map Shopify metafields that already exist with custom namespaces.

All the changes described in this article are available from Shopify connector version 1.12.2 onward.

New metafield naming format

From version 1.12.2 onward, Shopify metafields must be named in Sales Layer using this format:

metafields_<namespace>_<key>

For example, this field name in Sales Layer:

metafields_global_title_tag

is sent to Shopify as:

namespace: global
key: title_tag

Namespaces with underscores

If the Shopify namespace contains an underscore, each underscore in the namespace must be written as three underscores in the Sales Layer field name.

For example, this field name in Sales Layer:

metafields_custom___attributes_auftauen_tk

is sent to Shopify as:

namespace: custom_attributes
key: auftauen_tk

Existing metafields without underscores

Existing metafields whose namespace does not contain underscores keep the same format as before.

For example:

metafields_global_description_tag
metafields_custom_material

Before synchronizing metafields

The Sales Layer connector can send metafields to Shopify, but the metafield definition should be created in Shopify before sending any data. This helps Shopify apply the correct metafield type and validations.

If the metafield definition does not exist, the connector may create it automatically, but it will be incomplete. In that case, Shopify may treat the received value as plain text instead of applying the intended metafield type.

For more information about creating and mapping metafields, see the article Metafields.

Best practices

Before synchronizing metafields, create and define them in Shopify, then check that the namespace and key in Sales Layer match the Shopify configuration. If the namespace contains underscores, replace each namespace underscore with three underscores in the Sales Layer field name. When working with data that Shopify should recognize natively, use Shopify standard metafields whenever possible.

Useful Shopify links

• Metafields