GET

/v1/merchants/{merchant_id}

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id

  • Params

HEADER PARAMETERS

X-Violet-App-Secretrequired
String
X-Violet-App-Idrequired
String
X-Violet-App-Tokenrequired
String
curl --request GET
  --url https://sandbox-api.violet.io/v1/merchants/10000
  --header 'X-Violet-App-Id: <Your App Id Here>'
  --header 'X-Violet-App-Secret: <Your App Secret Here>'
  --header 'X-Violet-Token: <Your Violet token here>'
  --header 'Accept: application/json'

{
    "id": 10000,
    "name": "Besties",
    "platform": "SHOPIFY",
    "store_url": "violet-besties.myshopify.com",
    "commission_rate": 15.0,
    "distribution_type": "PUBLIC",
    "category": "OTHER",
    "connection_status": "NOT_CONNECTED"
}

Headers

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

Path Parameters

merchant_idrequired
integer

Query Parameters

app_id
integer

Response

200 - application/json
annual_revenue
enum<string>

Annual Revenue

Available options:
L_E_100K,
G_100K_L_E_1M,
G_1M_L_E_100M,
G_100M
billing_configured
boolean

The billing status of the merchant

category
enum<string>

Merchant Category

Available options:
OTHER,
APPAREL_AND_ACCESSORIES,
ANIMALS_AND_PET_SUPPLIES,
ARTS_AND_ENTERTAINMENT,
BABY_AND_TODDLER,
BUSINESS_AND_INDUSTRIAL,
CAMERAS_AND_OPTICS,
ELECTRONICS,
FOOD_BEVERAGE_TOBACCO,
FURNITURE,
HARDWARE,
HEALTH_AND_BEAUTY,
HOME_AND_GARDEN,
LUGGAGE_AND_BAGS,
MATURE,
MEDIA,
OFFICE_SUPPLIES,
RELIGIOUS_AND_CEREMONIAL,
SOFTWARE,
SPORTING_GOODS,
TOYS_AND_GAMES,
VEHICLES_PARTS
commission_rate
number

The default commission rate of the merchant

connection_status
enum<string>

If a developers application has access to this merchant.

Available options:
NOT_CONNECTED,
CONNECTED,
REQUESTED,
DECLINED
custom_store_url
string

The custom URL of the Store

date_created
string

Date of creation

date_last_modified
string

Date of last update

default
boolean
default_country_code
string

The default country of origin of merchant

default_currency
string

The default currency used by merchant

default_language_code
string

The default language used by merchant

default_size_unit
enum<string>

Default Unit of Size in the Merchants Store

Available options:
INCHES,
FEET,
CENTIMETERS,
OUNCES,
POUNDS,
GRAMS,
KILOGRAMS,
CARATS,
YARDS,
MILLIMETERS,
TONNES,
MILLIGRAMS,
LITERS,
MILLILITERS,
QUARTS,
QUARTERS,
GALLONS,
PINTS,
METERS
default_state_code
string

The default state / province of origin of merchant

default_weight_unit
enum<string>

Default Unit of Weight in the Merchants Store

Available options:
INCHES,
FEET,
CENTIMETERS,
OUNCES,
POUNDS,
GRAMS,
KILOGRAMS,
CARATS,
YARDS,
MILLIMETERS,
TONNES,
MILLIGRAMS,
LITERS,
MILLILITERS,
QUARTS,
QUARTERS,
GALLONS,
PINTS,
METERS
distribution_type
enum<string>

ID of the Merchant on Ecommerce Platform

Available options:
PUBLIC,
PRIVATE
emailrequired
string

The Merchants unique email address

external_id
string

ID of the Merchant on Ecommerce Platform

featured
boolean

Featured Merchant

id
integer
logo
string

URL of the merchants logo

merchant_namerequired
string

The name of the merchants business

platformrequired
enum<string>

The eCommerce platform this merchant uses

Available options:
shopify,
magento,
magento_one,
woocommerce,
bigcommerce,
lightspeed,
ecwid,
yaas,
spreecommerce,
demandware,
volusion,
prestashop,
threedcart
referral_source
enum<string>

Source of the merchant referral

Available options:
VIOLET,
PLATFORM_MARKETPLACE,
AFFILIATE_PROGRAM,
OTHER
shipping_configured
boolean

The shipping status of the merchant

status
enum<string>

The status of the merchant

Available options:
inactive,
active,
disabled,
new
store_url
string

The URL of the Store

taxes_configured
boolean

The tax status of the merchant

user_idrequired
integer

The Id of the User who owns this Merchant Account

verified
boolean

If a user has verified their email address

Get MerchantsOverview