Get Merchant Config

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.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

merchant_id

integer

required

Response

default - application/json

A Container for Merchant Configuration info

global_feature_flags

object

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

global_feature_flags.{key}

boolean

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.

platform_feature_flags.{key}

boolean

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

store_config

object

Configurations for the merchants store.

store_config.default_weight_unit

enum<string>

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

enum<string>

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

string

Default locale used by the merchant.

store_config.default_currency

enum<string>

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

store_config.base_url

string

Base URL of the merchant's store.

store_config.base_media_url

string

Base Media URL of the media from a merchant's store.

orders_config

object

Configurations for the merchants order behaviors.

orders_config.custom_tags

string[]

Custom tags to be added to a merchants orders upon submission.

catalog_config

object

Configurations for the merchants catalog behaviors.

catalog_config.inventory

object

Configurations for the merchants inventory behaviors.

catalog_config.inventory.safetyStockRules

object