cURL
Python
JavaScript
PHP
Go
Java
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.true
When this value is true the merchants product metadata will be included during catalog syncs.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 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.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.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 .
Request body for toggling the boolean value of a setting.
Response default - application/json
default response
A Container for Merchant Configuration info
Feature flags that apply to a merchant globally, regardless of their commerce platform.
global_feature_flags. {key}
Feature flags that apply to a merchant globally, regardless of their commerce platform.
Feature flags that apply to a merchant depending on their commerce platform.
platform_feature_flags. {key}
Feature flags that apply to a merchant depending on their commerce platform.
Configurations for the merchants store.
store_config. default_weight_unit
Default weight unit used by the merchant.
Available options:
INCHES,
FEET,
CENTIMETERS,
OUNCES,
POUNDS,
GRAMS,
KILOGRAMS,
CARATS,
YARDS,
MILLIMETERS,
TONNES,
MILLIGRAMS,
LITERS,
MILLILITERS,
QUARTS,
QUARTERS,
GALLONS,
PINTS,
METERS
store_config. default_size_unit
Default size unit used by the merchant.
Available options:
INCHES,
FEET,
CENTIMETERS,
OUNCES,
POUNDS,
GRAMS,
KILOGRAMS,
CARATS,
YARDS,
MILLIMETERS,
TONNES,
MILLIGRAMS,
LITERS,
MILLILITERS,
QUARTS,
QUARTERS,
GALLONS,
PINTS,
METERS
store_config. default_locale
Default locale used by the merchant.
store_config. default_currency
Default currency code used by the merchant.
Available options:
USD,
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
ISK,
JMD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
STD,
SVC,
SZL,
THB,
TJS,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
BTN
Base URL of the merchant's store.
store_config. base_media_url
Base Media URL of the media from a merchant's store.
Configurations for the merchants order behaviors.
orders_config. commerce_disabled
Is order creation, or cart submission, disabled for this merchant.
orders_config. custom_tags
Custom tags to be added to a merchants orders upon submission.
Custom tags to be added to a merchants orders upon submission.
orders_config. prohibit_order_cancellations
Does this merchants prohibit order cancellations.
orders_config. prohibit_order_refunds
Does this merchants prohibit order refunds.
orders_config. sync_policy
Policies for syncing this merchants catalog.
orders_config.sync_policy. syncType
Available options:
POLLING,
HYBRID,
NO_SYNC
orders_config.sync_policy. syncFrequencyMinutes
orders_config.sync_policy. consolidationFrequencyMinutes
Configurations for the merchants catalog behaviors.
Configurations for the merchants inventory behaviors.
catalog_config.inventory. safetyStockRules
Configured stock rules that can override the data from the external commerce platform.
catalog_config.inventory.safetyStockRules. tags
catalog_config.inventory.safetyStockRules.tags. {key}
Configured stock rules that can override the data from the external commerce platform.
catalog_config.inventory.safetyStockRules. categories
catalog_config.inventory.safetyStockRules.categories. {key}
Configured stock rules that can override the data from the external commerce platform.
catalog_config.inventory.safetyStockRules. collections
catalog_config.inventory.safetyStockRules.collections. {key}
Configured stock rules that can override the data from the external commerce platform.
catalog_config.inventory.safetyStockRules. vendors
catalog_config.inventory.safetyStockRules.vendors. {key}
Configured stock rules that can override the data from the external commerce platform.
catalog_config. availability
Configurations for the merchants availability behaviors.
catalog_config.availability. availabilityRules
catalog_config.availability.availabilityRules. tags
catalog_config.availability.availabilityRules.tags. {key}
Configurations for the merchants inventory behaviors.
catalog_config.availability.availabilityRules. categories
catalog_config.availability.availabilityRules.categories. {key}
Configurations for the merchants inventory behaviors.
catalog_config.availability.availabilityRules. collections
catalog_config.availability.availabilityRules.collections. {key}
Configurations for the merchants inventory behaviors.
catalog_config.availability.availabilityRules. vendors
catalog_config.availability.availabilityRules.vendors. {key}
Configurations for the merchants inventory behaviors.
catalog_config. syncPolicy
Policies for syncing this merchants catalog.
catalog_config.syncPolicy. syncType
Available options:
POLLING,
HYBRID,
NO_SYNC
catalog_config.syncPolicy. syncFrequencyMinutes
catalog_config.syncPolicy. consolidationFrequencyMinutes
Configurations for the merchants shipping behaviors.
shipping_config. fallback_methods
Fallback methods to be used when the merchant's system provides no shipping methods.
Fallback methods to be used when the merchant's system provides no shipping methods.
shipping_config.fallback_methods. label
shipping_config.fallback_methods. price
shipping_config.fallback_methods. calculationType
Available options:
PER_ORDER,
PER_ITEM
shipping_config. exclude_external_free_shipping
Should external free shipping methods be excluded.
shipping_config. exclude_external_methods
Should all external shipping methods be excluded.
