Get Merchant
/v1/merchants/{merchant_id}
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}
{
"annual_revenue": "L_E_100K",
"billing_configured": "boolean",
"category": "OTHER",
"commission_rate": "number",
"connection_status": "NOT_CONNECTED",
"custom_store_url": "string",
"date_created": "string",
"date_last_modified": "string",
"default": "boolean",
"default_country_code": "string",
"default_currency": "string",
"default_language_code": "string",
"default_size_unit": "INCHES",
"default_state_code": "string",
"default_weight_unit": "INCHES",
"distribution_type": "PUBLIC",
"email": "string",
"external_id": "string",
"featured": "boolean",
"id": "integer",
"logo": "string",
"merchant_name": "string",
"platform": "shopify",
"referral_source": "VIOLET",
"shipping_configured": "boolean",
"status": "inactive",
"store_url": "string",
"taxes_configured": "boolean",
"user_id": "integer",
"verified": "boolean"
}
Retrieve merchant details based on a given merchant_id
.
Headers
Path Parameters
Query Parameters
Response
Annual Revenue
L_E_100K
, G_100K_L_E_1M
, G_1M_L_E_100M
, G_100M
The billing status of the merchant
Merchant Category
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
The default commission rate of the merchant
If a developers application has access to this merchant.
NOT_CONNECTED
, CONNECTED
, REQUESTED
, DECLINED
The custom URL of the Store
Date of creation
Date of last update
The default country of origin of merchant
The default currency used by merchant
The default language used by merchant
Default Unit of Size in the Merchants Store
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
The default state / province of origin of merchant
Default Unit of Weight in the Merchants Store
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
ID of the Merchant on Ecommerce Platform
PUBLIC
, PRIVATE
The Merchants unique email address
ID of the Merchant on Ecommerce Platform
Featured Merchant
URL of the merchants logo
The name of the merchants business
The eCommerce platform this merchant uses
shopify
, magento
, magento_one
, woocommerce
, bigcommerce
, lightspeed
, ecwid
, yaas
, spreecommerce
, demandware
, volusion
, prestashop
, threedcart
Source of the merchant referral
VIOLET
, PLATFORM_MARKETPLACE
, AFFILIATE_PROGRAM
, OTHER
The shipping status of the merchant
The status of the merchant
inactive
, active
, disabled
, new
The URL of the Store
The tax status of the merchant
The Id of the User who owns this Merchant Account
If a user has verified their email address
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}
{
"annual_revenue": "L_E_100K",
"billing_configured": "boolean",
"category": "OTHER",
"commission_rate": "number",
"connection_status": "NOT_CONNECTED",
"custom_store_url": "string",
"date_created": "string",
"date_last_modified": "string",
"default": "boolean",
"default_country_code": "string",
"default_currency": "string",
"default_language_code": "string",
"default_size_unit": "INCHES",
"default_state_code": "string",
"default_weight_unit": "INCHES",
"distribution_type": "PUBLIC",
"email": "string",
"external_id": "string",
"featured": "boolean",
"id": "integer",
"logo": "string",
"merchant_name": "string",
"platform": "shopify",
"referral_source": "VIOLET",
"shipping_configured": "boolean",
"status": "inactive",
"store_url": "string",
"taxes_configured": "boolean",
"user_id": "integer",
"verified": "boolean"
}