Get Merchants
Retrieve all merchants that you are connected to.
Query parameters
pageinteger · int32OptionalDefault:
1
sizeinteger · int32OptionalDefault:
20
exclude_publicbooleanOptionalDefault:
Exclude public merchants from the result set
false
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
default
default response
application/json
get
GET /v1/merchants 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
{
"content": [
{
"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-07-10T00:15:07.569Z",
"date_last_modified": "2025-07-10T00:15:07.569Z",
"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
}
],
"last": true,
"total_pages": 1,
"total_elements": 1,
"first": true,
"number_of_elements": 1,
"size": 1,
"number": 1,
"empty": true,
"next_page_cursor": "text",
"pageable": {
"page_number": 1,
"page_size": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 1,
"paged": true,
"unpaged": true
},
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
}
Last updated
Was this helpful?