Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Get Merchant Config
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}/configuration
{
"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"
]
}
}
Retrieve the merchant configuration based on a given merchant_id
.
You must be connected to a merchant to retrieve their configuration.
Merchant Configuration is currently in beta.
Path Parameters
Response
A Container for Merchant Configuration info
Feature flags that apply to a merchant globally, regardless of their commerce platform.
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.
Feature flags that apply to a merchant depending on their commerce platform.
Configurations for the merchants store.
Default weight unit used by the merchant.
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
Default size unit used by the merchant.
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
Default locale used by the merchant.
Default currency code used by the merchant.
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.
Base Media URL of the media from a merchant's store.
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.
Does this merchants prohibit order cancellations.
Does this merchants prohibit order refunds.
Configurations for the merchants catalog behaviors.
Configurations for the merchants inventory behaviors.
Configured stock rules that can override the data from the external commerce platform.
Configured stock rules that can override the data from the external commerce platform.
Configured stock rules that can override the data from the external commerce platform.
Configured stock rules that can override the data from the external commerce platform.
Configurations for the merchants availability behaviors.
Configurations for the merchants inventory behaviors.
Configurations for the merchants inventory behaviors.
Configurations for the merchants inventory behaviors.
Configurations for the merchants shipping behaviors.
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.
Should external free shipping methods be excluded.
Should all external shipping methods be excluded.
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}/configuration
{
"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"
]
}
}