GET
/
merchants
/
{merchant_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": "OTHER",
  "platform_plan": "<string>",
  "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",
  "shipping_configured": true,
  "taxes_configured": true,
  "default": true,
  "merchantDisabled": true,
  "billing_configured": true
}

Retrieve merchant details based on a given merchant_id.

Merchant PII (name, email, etc.) is masked on this endpoint. If a merchant has forgotten what email they created their account under, you can view a masked version of their email on the Connection Health screen to help jog their memories. Ex. j*****e@example.com

Headers

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

Path Parameters

merchant_id
integer
required

Query Parameters

app_id
integer

Response

default - application/json
id
integer
merchant_name
string
required

The name of the merchants business

email
string
required

The Merchants unique email address

user_id
integer
required

The Id of the User who owns this Merchant Account

platform
enum<string>
required

The eCommerce platform this merchant uses

Available options:
OTHER,
SHOPIFY,
MAGENTO,
MAGENTO_ONE,
WOOCOMMERCE,
BIGCOMMERCE,
LIGHTSPEED,
ECWID,
YAAS,
SPREECOMMERCE,
DEMANDWARE,
VOLUSION,
PRESTASHOP,
THREEDCART,
SYLIUS,
WIX,
SWELL,
MIVA,
WEBSPHERE,
ORACLECC,
SAPCC,
SQUARESPACE,
SHOPWARE,
COMMERCETOOLS,
MEDUSA,
ABICART,
SPRYKER,
MYSTORE,
CENTRA,
XCART,
VTEX,
KIBO,
SALEOR,
VENDO,
CHORD,
DIGITALRIVER,
SQUARE,
AMAZON,
BIGCARTEL,
CUSTOM
platform_plan
string

The eCommerce platform plan of the store

store_url
string

The URL of the Store

custom_store_url
string

The custom URL of the Store

verified
boolean
deprecated

If a user has verified their email address. Deprecated (not used will always be false)

status
enum<string>

The status of the merchant

Available options:
INACTIVE,
ACTIVE,
DISABLED,
NEW,
DISABLED_INACTIVE,
FOR_DELETION,
APPLICATION_IN_PROGRESS,
APPLICATION_SUBMITTED,
APPLICATION_DENIED,
APPLICATION_ACCEPTED
default_currency
string

The default currency used by merchant

default_country_code
string

The default country of origin of merchant

default_state_code
string

The default state / province of origin of merchant

default_language_code
string

The default language used by merchant

commission_rate
number

The default commission rate of the merchant

date_created
string

Date of creation

date_last_modified
string

Date of last update

external_id
string

ID of the Merchant on Ecommerce Platform

distribution_type
enum<string>

ID of the Merchant on Ecommerce Platform

Available options:
PUBLIC,
PRIVATE
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
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
referral_source
enum<string>

Source of the merchant referral

Available options:
VIOLET,
PLATFORM_MARKETPLACE,
AFFILIATE_PROGRAM,
OTHER
logo
string

URL of the merchants logo

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
featured
boolean
deprecated

Featured Merchant. Deprecated (not used)

connection_status
enum<string>
deprecated

If a developers application has access to this merchant. Deprecated (not reliable) use connection health endpoint instead.

Available options:
NOT_CONNECTED,
CONNECTED,
REQUESTED,
DECLINED
shipping_configured
boolean
deprecated

The shipping status of the merchant. Deprecated (not reliable)

taxes_configured
boolean
deprecated

The tax status of the merchant. Deprecated (not reliable)

default
boolean

Is this a Users default merchant

merchantDisabled
boolean
billing_configured
boolean
deprecated

The billing status of the merchant. Deprecated (not reliable) use connection health endpoint instead.

Was this page helpful?

Get MerchantsSearch Merchants