Merchants Explore
Explore Merchants in the Violet network outside of those you're currently connected with. You can directly work with Violet to add these merchants to your network.
Query parameters
pageinteger · int32OptionalDefault:
1
sizeinteger · int32OptionalDefault:
20
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
Merchant Explore Request
namestringOptional
Name of 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/explore 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: 56
{
"name": "text",
"sort_by": "text",
"sort_direction": "text"
}
default
default response
{
"content": [
{
"id": 1,
"name": "text",
"store_url": "text"
}
],
"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?