PUT
/
merchants
/
{merchant_id}
/
configuration
/
global_feature_flags
/
{feature_flag}
curl --request PUT \
  --url https://sandbox-api.violet.io/v1/merchants/{merchant_id}/configuration/global_feature_flags/{feature_flag} \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true
}'
{
  "global_feature_flags": {
    "sync_metadata": false,
    "sync_collections": true
  },
  "platform_feature_flags": {
    "filter_by_collections": false,
    "use_custom_shipping_rates": true
  },
  "orders_config": {
    "custom_tags": [
      "tag1",
      "tag2"
    ]
  }
}

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 Metadata - sync_metadata

When this value is true the merchants product metadata will be included during catalog syncs.
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 Collections - sync_collections

When this value is true the merchants collection data will by 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 collections here.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

merchant_id
integer
required
feature_flag
string
required

Body

application/json
enabled
boolean

Is the setting enabled.

Response

default - application/json
global_feature_flags
object

Feature flags that apply to a merchant globally, regardless of their commerce platform.

platform_feature_flags
object

Feature flags that apply to a merchant depending on their commerce platform.

orders_config
object

Configurations for the merchants order behaviors.

Was this page helpful?

Get Merchant ConfigModify Merchant Order Config