Merchants - Merchant
Search Merchants
POST
/v1/merchants/search
X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request POST \
--url https://sandbox-api.violet.io/v1/merchants/search \
--header 'Content-Type: application/json'
{
"content": [
{
"annual_revenue": "L_E_100K",
"billing_configured": "boolean",
"category": "OTHER",
"commission_rate": "number",
"connection_status": "NOT_CONNECTED",
"custom_store_url": "string",
"date_created": "string",
"date_last_modified": "string",
"default": "boolean",
"default_country_code": "string",
"default_currency": "string",
"default_language_code": "string",
"default_size_unit": "INCHES",
"default_state_code": "string",
"default_weight_unit": "INCHES",
"distribution_type": "PUBLIC",
"email": "string",
"external_id": "string",
"featured": "boolean",
"id": "integer",
"logo": "string",
"merchant_name": "string",
"platform": "shopify",
"referral_source": "VIOLET",
"shipping_configured": "boolean",
"status": "inactive",
"store_url": "string",
"taxes_configured": "boolean",
"user_id": "integer",
"verified": "boolean"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"number_of_elements": "integer",
"pageable": {
"offset": "integer",
"page_number": "integer",
"page_size": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
},
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"total_elements": "integer",
"total_pages": "integer"
}
Search for merchants you are connected to given certain filter criteria.
Headers
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
Query Parameters
page
Default: "1"integer
size
Default: "20"integer
Body
application/json
commission_rate_max
number
The maximum commission rate of the Merchant
commission_rate_min
number
The minimum commission rate of the Merchant
id
integer
The ID of the Merchant
name
string
The name of the Merchant
sort_by
string
Property to sort by in camelCase
sort_direction
string
Direction to sort by
status
enum<string>
The connection status of the Merchant
Available options:
ANY
, CONNECTED
, PRIVATE
, PUBLIC
Response
200 - application/json
content
object[]
empty
boolean
first
boolean
last
boolean
number
integer
number_of_elements
integer
pageable
object
size
integer
sort
object
total_elements
integer
total_pages
integer
curl --request POST \
--url https://sandbox-api.violet.io/v1/merchants/search \
--header 'Content-Type: application/json'
{
"content": [
{
"annual_revenue": "L_E_100K",
"billing_configured": "boolean",
"category": "OTHER",
"commission_rate": "number",
"connection_status": "NOT_CONNECTED",
"custom_store_url": "string",
"date_created": "string",
"date_last_modified": "string",
"default": "boolean",
"default_country_code": "string",
"default_currency": "string",
"default_language_code": "string",
"default_size_unit": "INCHES",
"default_state_code": "string",
"default_weight_unit": "INCHES",
"distribution_type": "PUBLIC",
"email": "string",
"external_id": "string",
"featured": "boolean",
"id": "integer",
"logo": "string",
"merchant_name": "string",
"platform": "shopify",
"referral_source": "VIOLET",
"shipping_configured": "boolean",
"status": "inactive",
"store_url": "string",
"taxes_configured": "boolean",
"user_id": "integer",
"verified": "boolean"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"number_of_elements": "integer",
"pageable": {
"offset": "integer",
"page_number": "integer",
"page_size": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
},
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"total_elements": "integer",
"total_pages": "integer"
}