Metadata

Offer metadata allows for the custom data that merchants have applied to their products to be surfaced with the Violet Offer object. 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 on the metadata property of an Offer object.

{
  ...
  "metadata": [{
    "version": 1.0,
    "type": "STRING",
    "external_type": "single_line_text_field",
    "key": "region",
    "value": "US",
    "source": "EXTERNAL"
  }]
  ...
}

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 JASON string.

{
  ...
  "metadata": [{
    "version": 1.0,
    "type": "JSON",
    "external_type": "json",
    "key": "json_example",
    "value": "{\"key\":\"value\"}",
    "source": "EXTERNAL"
  }]
  ...
}

​

Including Metadata

By default, 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 of metadata.

This feature works with the following endpoints:

• Get All Merchant Offers
• Get Offer By Id

​

Supported Platforms

• Shopify

​

Syncing Metadata

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