GET
/
merchants
Header
Query
curl --request GET \
  --url https://sandbox-api.violet.io/v1/merchants
{
  "total_pages": 123,
  "total_elements": 123,
  "pageable": {
    "unpaged": true,
    "page_size": 123,
    "page_number": 123,
    "paged": true,
    "sort": {},
    "offset": 123
  },
  "number_of_elements": 123,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 123,
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "shopify",
      "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",
      "annual_revenue": "L_E_100K",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "billing_configured": true
    }
  ],
  "number": 123,
  "empty": true
}

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

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

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

Was this page helpful?

OverviewGet Merchants by ID