POST
/
merchants
/
search
curl --request POST \
  --url https://sandbox-api.violet.io/v1/merchants/search \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "name": "<string>",
  "commission_rate_min": 123,
  "commission_rate_max": 123,
  "status": "ANY",
  "sort_by": "<string>",
  "sort_direction": "<string>"
}'
{
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "OTHER",
      "platform_plan": "<string>",
      "store_url": "<string>",
      "custom_store_url": "<string>",
      "verified": true,
      "status": "INACTIVE",
      "default_currency": "<string>",
      "default_country_code": "<string>",
      "default_state_code": "<string>",
      "default_language_code": "<string>",
      "commission_rate": 123,
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "distribution_type": "PUBLIC",
      "default_weight_unit": "INCHES",
      "default_size_unit": "INCHES",
      "referral_source": "VIOLET",
      "logo": "<string>",
      "category": "OTHER",
      "featured": true,
      "connection_status": "NOT_CONNECTED",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "billing_configured": true
    }
  ],
  "last": true,
  "total_pages": 123,
  "total_elements": 123,
  "first": true,
  "number_of_elements": 123,
  "size": 123,
  "number": 123,
  "empty": true,
  "next_page_cursor": "<string>",
  "pageable": {
    "page_number": 123,
    "page_size": 123,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}

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

Body

application/json
id
integer

The ID of the Merchant

name
string

The name of the Merchant

commission_rate_min
number

The minimum commission rate of the Merchant

commission_rate_max
number

The maximum commission rate of the Merchant

status
enum<string>

The connection status of the Merchant

Available options:
ANY,
CONNECTED,
PRIVATE,
PUBLIC
sort_by
string

Property to sort by in camelCase

sort_direction
string

Direction to sort by

Response

default - application/json
content
object[]

The actual content of the response; A list of the result objects

last
boolean

Boolean indicating if this is the last page

total_pages
integer

The total count of pages available

total_elements
integer

The total count of objects available

first
boolean

Boolean indicating if this is the first page of the response

number_of_elements
integer

The total number of objects in this specific response

size
integer

The page size selected at request time

number
integer

The page number selected at request time

empty
boolean

Boolean indicating if the response content is empty

next_page_cursor
string

Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.

pageable
object

Violet wrapper for springframework pageable

sort
object

Violet Wrapper for springframework sort