POST
/
merchants
/
explore
curl --request POST \
  --url https://sandbox-api.violet.io/v1/merchants/explore \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "sort_by": "<string>",
  "sort_direction": "<string>"
}'
{
  "total_pages": 123,
  "total_elements": 123,
  "pageable": {
    "unpaged": true,
    "page_size": 123,
    "page_number": 123,
    "paged": true,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123
  },
  "number_of_elements": 123,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 123,
  "content": [
    {
      "id": 123,
      "name": "<string>",
      "store_url": "<string>"
    }
  ],
  "number": 123,
  "empty": true
}

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.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Query Parameters

page
integer
default: 1
size
integer
default: 20

Body

application/json
name
string

Name of Merchant

sort_by
string

Property to sort by in camelCase

sort_direction
string

Direction to sort by

Response

200 - application/json
total_pages
integer
total_elements
integer
pageable
object
number_of_elements
integer
last
boolean
first
boolean
sort
object
size
integer
content
object[]
number
integer
empty
boolean