Enabling Metadata Syncing

The syncing of Product metadata and Sku metadata can be enabled on a per-merchant basis using the Toggle Global Feature Flag endpoint in the Merchant Configuration API. Offer metadata and Sku metadata must be enabled separately.

Offer and Sku metadata allows for the custom data that merchants have applied to their products to be surfaced with the Violet Offer and Sku objects. It is currently only enabled on a per-merchant basis as most commerce platforms (including Shopify) require additional API calls to be made in order to access metadata. By enabling metadata on a per-merchant basis we can ensure that the sync performance is not degraded for merchants who don’t utilize metadata.

Schema

When present, metadata will be available in the metadata property of an Offer or Sku object.

version - the schema version for the metadata (all will be 1.0 at this time)

type - STRING | JSON | INTEGER | LONG | DECIMAL | BOOLEAN

external_type - raw value type from the external commerce platform

key - the key or name that represents the data

value - the value of the data

source - INTERNAL | EXTERNAL (all metadata is EXTERNAL at this time)

When the type property has a value of JSON the value property will consist of a serialized JSON string.

Including Offer Metadata

By default, Offer metadata is not included in the Offer data returned by the Violet API. To include metadata, you must add an include query parameter with a value that contains metadata.

Example - ?include=metadata

This feature works with the following endpoints:

Including Sku Metadata

By default, Sku metadata is not included in the Sku data returned by the Violet API. To include metadata, you must add an include query parameter with a value that contains sku_metadata.

Example - ?include=sku_metadata

This feature works with the following endpoints:

Supported Platforms

At this time metadata is limited to merchants on the SHOPIFY platform. Support for additional platforms is currently in development.

Metadata Parity

Once a store is connected and metadata sync is enabled, Violet will sync with the Merchant’s metadata regularly.