POST

/v1/merchants/explore

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request POST \
  --url https://sandbox-api.violet.io/v1/merchants/explore \
  --header 'Content-Type: application/json'
{
  "content": [
    {
      "id": "integer",
      "name": "string",
      "store_url": "string"
    }
  ],
  "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"
}

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
Default: "1"
integer
size
Default: "20"
integer

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
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
Search MerchantsGet All Webhooks