Get Merchant

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*****[email protected]

Get Merchant

get

Path parameters

merchant_idinteger · int32Required

Query parameters

app_idinteger · int32Optional

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

default

default response

application/json

get

/merchants/{merchant_id}

HTTPcURLJavaScriptPython

GET /v1/merchants/{merchant_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

default

default response

{
  "id": 1,
  "merchant_name": "text",
  "email": "text",
  "user_id": 1,
  "platform": "OTHER",
  "platform_plan": "text",
  "store_url": "text",
  "custom_store_url": "text",
  "status": "INACTIVE",
  "default_currency": "text",
  "default_country_code": "text",
  "default_state_code": "text",
  "default_language_code": "text",
  "commission_rate": 1,
  "date_created": "2025-12-23T15:19:45.603Z",
  "date_last_modified": "2025-12-23T15:19:45.603Z",
  "external_id": "text",
  "distribution_type": "PUBLIC",
  "default_weight_unit": "INCHES",
  "default_size_unit": "INCHES",
  "referral_source": "VIOLET",
  "logo": "text",
  "category": "OTHER",
  "default": true,
  "merchantDisabled": true
}