GET

/v1/merchants

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id

You can get a list of all the merchants that your app has access to by using the following enpoint.

  • Params

HEADER PARAMETERS

X-Violet-App-Secretrequired
String
X-Violet-App-Idrequired
String
X-Violet-App-Tokenrequired
String
curl --request GET
  --url https://sandbox-api.violet.io/v1/merchants
  --header 'Accept: application/json'
  --header 'X-Violet-Token': 'TOKEN',
  --header 'X-Violet-App-Id': 'APPID',
  --header 'X-Violet-App-Secret': 'APPSECRET'

{
    "content": [
        {
            "id": 10000,
            "name": "Besties",
            "platform": "SHOPIFY",
            "store_url": "violet-besties.myshopify.com",
            "commission_rate": 15.0,
            "distribution_type": "PUBLIC",
            "category": "OTHER",
            "connection_status": "NOT_CONNECTED"
        },
        {
            "id": 10001,
            "name": "Vio",
            "platform": "ECWID",
            "store_url": "",
            "commission_rate": 0.0,
            "distribution_type": "PUBLIC",
            "category": "OTHER",
            "connection_status": "NOT_CONNECTED"
        },
        {
            "id": 10003,
            "name": "Nordies Store",
            "platform": "ECWID",
            "store_url": "violetio.ecwid.com",
            "default_country_code": "US",
            "commission_rate": 10.0,
            "distribution_type": "PUBLIC",
            "referral_source": "VIOLET",
            "category": "OTHER",
            "connection_status": "NOT_CONNECTED"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "page_number": 0,
        "page_size": 20,
        "offset": 0,
        "unpaged": false,
        "paged": true
    },
    "total_pages": 1,
    "last": true,
    "total_elements": 3,
    "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
    },
    "first": true,
    "number_of_elements": 3,
    "size": 20,
    "number": 0,
    "empty": false
}

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

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
OverviewGet Merchants by ID