View Merchants
Get Merchants
Introduction
Getting Started
- Apps
- Pagination
- Authentication
- Environments
- Definitions
Checkout
- Overview
- Getting Started
- Getting Started
- Create a Violet Application
- POSTPostman + Login
- View Merchants
- Interact with Catalogs
- Place an Order
- Merchants
- Catalog
- Carts and Bags
- Discounts
- Webhooks
- Guides
- FAQs
- Resources
- Current Platforms
Payments
- Overview
- Payment Integrations
- Payment Settings
- Setup
- Payments during Checkout
- Payouts
- Webhooks
Violet Connect
- Overview
- Setup
- Payouts
- Commissions
- Guides
- Testing
- FAQs
Relay
Product Info
View Merchants
Get Merchants
What Merchants am I connected to?
GET
/
merchants
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants
{
"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,
"merchantDisabled": 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
}
}
You can get a list of all the merchants that your app has access to by using the following endpoint.
Query Parameters
Exclude public merchants from the result set
Response
default - application/json
default response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants
{
"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,
"merchantDisabled": 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
}
}