Get Merchants by ID
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}
{
"id": 123,
"merchant_name": "<string>",
"email": "<string>",
"user_id": 123,
"platform": "shopify",
"store_url": "<string>",
"custom_store_url": "<string>",
"verified": true,
"status": "inactive",
"default_currency": "<string>",
"default_country_code": "<string>",
"default_state_code": "<string>",
"default_language_code": "<string>",
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"distribution_type": "PUBLIC",
"default_weight_unit": "INCHES",
"default_size_unit": "INCHES",
"referral_source": "VIOLET",
"logo": "<string>",
"category": "OTHER",
"featured": true,
"connection_status": "NOT_CONNECTED",
"annual_revenue": "L_E_100K",
"shipping_configured": true,
"taxes_configured": true,
"default": true,
"billing_configured": true
}
Headers
Path Parameters
Query Parameters
Response
The name of the merchants business
The Merchants unique email address
The Id of the User who owns this Merchant Account
The eCommerce platform this merchant uses
shopify
, magento
, magento_one
, woocommerce
, bigcommerce
, lightspeed
, ecwid
, yaas
, spreecommerce
, demandware
, volusion
, prestashop
, threedcart
The URL of the Store
The custom URL of the Store
If a user has verified their email address
The status of the merchant
inactive
, active
, disabled
, new
The default currency used by merchant
The default country of origin of merchant
The default state / province of origin of merchant
The default language used by merchant
The default commission rate of the merchant
Date of creation
Date of last update
ID of the Merchant on Ecommerce Platform
ID of the Merchant on Ecommerce Platform
PUBLIC
, PRIVATE
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
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
Source of the merchant referral
VIOLET
, PLATFORM_MARKETPLACE
, AFFILIATE_PROGRAM
, OTHER
URL of the merchants logo
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
Featured Merchant
If a developers application has access to this merchant.
NOT_CONNECTED
, CONNECTED
, REQUESTED
, DECLINED
Annual Revenue
L_E_100K
, G_100K_L_E_1M
, G_1M_L_E_100M
, G_100M
The shipping status of the merchant
The tax status of the merchant
The billing status of the merchant
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/{merchant_id}
{
"id": 123,
"merchant_name": "<string>",
"email": "<string>",
"user_id": 123,
"platform": "shopify",
"store_url": "<string>",
"custom_store_url": "<string>",
"verified": true,
"status": "inactive",
"default_currency": "<string>",
"default_country_code": "<string>",
"default_state_code": "<string>",
"default_language_code": "<string>",
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"distribution_type": "PUBLIC",
"default_weight_unit": "INCHES",
"default_size_unit": "INCHES",
"referral_source": "VIOLET",
"logo": "<string>",
"category": "OTHER",
"featured": true,
"connection_status": "NOT_CONNECTED",
"annual_revenue": "L_E_100K",
"shipping_configured": true,
"taxes_configured": true,
"default": true,
"billing_configured": true
}