curl --request PUT \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}/configuration/orders_config \
--header 'Content-Type: application/json' \
--data '{
"custom_tags": [
"tag1",
"tag2"
]
}'
{
"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"
]
}
}
Modifies the merchants order configuration based on a given merchant_id.
You must be connected to a merchant to modify their configuration.
Merchant Configuration is currently in beta.
Available Order Configurations
Custom Tags - custom_tags
This configuration allows you to provide a set of tags that will be included with any orders submitted for this merchant.
Configurations for the merchants order behaviors.
Is order creation, or cart submission, disabled for this merchant.
Custom tags to be added to a merchants orders upon submission.
Custom tags to be added to a merchants orders upon submission.
prohibit_order_cancellations
Does this merchants prohibit order cancellations.
Does this merchants prohibit order refunds.
Policies for syncing this merchants catalog.
Available options:
POLLING,
HYBRID,
NO_SYNC
sync_policy.syncFrequencyMinutes
sync_policy.consolidationFrequencyMinutes
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
The name of the shipping method.
shipping_config.fallback_methods.price
The price of the shipping method in cents.
shipping_config.fallback_methods.currency
The currency of the shipping method.
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
shipping_config.fallback_methods.calculation_type
Whether the price is calculated per the entire order or per item.
Available options:
PER_ORDER,
PER_ITEM
shipping_config.fallback_methods.conditions
Any conditions that determine if a shipping method is applicable to the order.
shipping_config.fallback_methods.conditions.applicable_countries
A set of Alpha-2 country codes where the shipping method can be applied.
A set of Alpha-2 country codes where the shipping method can be applied.
shipping_config.fallback_methods.conditions.inapplicable_countries
A set of Alpha-2 country codes where the shipping method cannot be applied.
A set of Alpha-2 country codes where the shipping method cannot be applied.
shipping_config.fallback_methods.conditions.min_order_amount
The inclusive minimum order amount, if any, required for this shipping method to be applicable.
shipping_config.fallback_methods.conditions.max_order_amount
The inclusive maximum order amount, if any, that if reached will make this shipping method inapplicable.
shipping_config.fallback_methods.conditions.min_weight
The inclusive maximum weight of the order, if any, that if reached will make this shipping method inapplicable.
shipping_config.fallback_methods.conditions.min_weight.value
shipping_config.fallback_methods.conditions.min_weight.unit
Available options:
KG,
LB,
OZ
shipping_config.fallback_methods.conditions.max_weight
The inclusive maximum weight of the order, if any, that if reached will make this shipping method inapplicable.
shipping_config.fallback_methods.conditions.max_weight.value
shipping_config.fallback_methods.conditions.max_weight.unit
Available options:
KG,
LB,
OZ
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.
