Toggle Global Feature Flag

Toggle the global feature flags of a merchant based on a given merchant_id and feature_flag.

You must be connected to a merchant to modify their configuration.

Merchant Configuration is currently in beta.

Available Feature Flags

Sync Taxonomy - sync_taxonomy

When this value is true the merchants taxonomy data will be included during catalog syncs. Default: true

---

Sync Product Metadata - sync_metadata

When this value is true the merchants Product metadata will be included during catalog syncs. Note: this does not include Sku metadata, that must be enabled separately. Default: false

The inclusion of metadata often requires additional calls to the commerce platform API's and will increase the time it takes to sync a merchants products. It is recommended to only enable this feature if you know your merchant requires metadata.

---

Sync Sku Metadata - sync_sku_metadata

When this value is true the merchants Sku metadata will be included during catalog syncs. Default: false

The inclusion of sku metadata often requires additional calls to the commerce platform API's and will increase the time it takes to sync a merchants products. It is recommended to only enable this feature if you know your merchant requires sku metadata.

---

Sync Collections - sync_collections

When this value is true the merchants collection data will be synced. When collection syncs are enabled an initial sync will be performed immediately then additional re-syncs will occur every 24 hours. This feature is currently limited to SHOPIFY. Default: false

Enabling collections will result in additional calls to commerce platform API's. It is recommended that you only enable the syncing of collections if the collection data is being utilized. Learn more about interacting with collections here.

---

Sync Product Shipping Data - sync_offer_shipping\

When this value is true any per-product shipping data from the merchants system will be synced. Once this feature has been toggled on, the merchant will go into a queue for the syncing of their shipping data. This feature is currently limited to SHOPIFY. Default: false

Enabling the syncing of product shipping data will result in additional calls to commerce platform API's. It is recommended that you only enable the syncing of product shipping data if the shipping data is being utilized. Learn more about utilizing shipping data here.

---

Use Contextual Prices - use_contextual_prices

When this value is true any explicit, per-currency prices, that are provided by the merchant will be used instead of prices that are based on currency exchange rates. This feature is currently limited to SHOPIFY, BIGCOMMERCE, and COMMERCETOOLS. Contextual prices are only supported for apps using Estimate Order and Direct Order Submission. Default: false

Syncing contextual prices can be expensive in terms of external rate limits and sync performance so Violet will only sync the presentment currencies that match the currencies your app operates in. Please provide Violet with all currencies you currently operate in and notify Violet when support for additional currencies is added.

A complete sync of the merchants product catalog will be initialized when this value is set to true. Depending on the size of the merchant's catalog it may take some time for all Offers to be updated with a merchants contextual prices.

Toggle Merchant Config Global Feature Flag

put

Path parameters

merchant_idinteger · int32Required

feature_flagstringRequired

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

Request body for toggling the boolean value of a setting.

enabledbooleanOptional

Is the setting enabled.

Responses

default

default response

application/json

A Container for Merchant Configuration info

lockedbooleanOptional

When true, prevents any changes from being made to the merchant configuration.

put/merchants/{merchant_id}/configuration/global_feature_flags/{feature_flag}

PUT /v1/merchants/{merchant_id}/configuration/global_feature_flags/{feature_flag} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

default

default response

{
  "global_feature_flags": {
    "sync_metadata": false,
    "sync_collections": true,
    "sync_sku_metadata": true
  },
  "platform_feature_flags": {
    "filter_by_collections": false,
    "use_custom_shipping_rates": true
  },
  "orders_config": {
    "custom_tags": [
      "tag1",
      "tag2"
    ]
  }
}