Search Merchants
Search for merchants you are connected to given certain filter criteria.
Query parameters
pageinteger · int32OptionalDefault:
1
sizeinteger · int32OptionalDefault:
20
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
idinteger · int32Optional
The ID of the Merchant
namestringOptional
The name of the Merchant
commission_rate_minnumber · doubleOptional
The minimum commission rate of the Merchant
commission_rate_maxnumber · doubleOptional
The maximum commission rate of the Merchant
statusstring · enumOptionalPossible values:
The connection status of the Merchant
sort_bystringOptional
Property to sort by in camelCase
sort_directionstringOptional
Direction to sort by
Responses
default
default response
application/json
post
POST /v1/merchants/search HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"id": 1,
"name": "text",
"commission_rate_min": 1,
"commission_rate_max": 1,
"status": "ANY",
"sort_by": "text",
"sort_direction": "text"
}
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-10T05:57:15.564Z",
"date_last_modified": "2025-07-10T05:57:15.564Z",
"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?