- Get API Keys
- Welcome
Access
Offers
SKUs
Categories
Collections
Currencies
Cart
Payment
Customer
Completion
Shipping
Discounts
Items
Refunds
Orders
Webhooks
Webhook Events
Wekbhook Headers
Merchant/App Installs
Connection
Shipping
Overview
Login
Catalog
Orders & Checkout
Events
Apps
Operations
Relay
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
}
}
Retrieve all merchants that you are connected to.
Headers
Query Parameters
Response
The actual content of the response; A list of the result objects
The name of the merchants business
The Merchants unique email address
The Id of the User who owns this Merchant Account
The eCommerce platform this merchant uses
OTHER
, SHOPIFY
, MAGENTO
, MAGENTO_ONE
, WOOCOMMERCE
, BIGCOMMERCE
, LIGHTSPEED
, ECWID
, YAAS
, SPREECOMMERCE
, DEMANDWARE
, VOLUSION
, PRESTASHOP
, THREEDCART
, SYLIUS
, WIX
, SWELL
, MIVA
, WEBSPHERE
, ORACLECC
, SAPCC
, SQUARESPACE
, SHOPWARE
, COMMERCETOOLS
, MEDUSA
, ABICART
, SPRYKER
, MYSTORE
, CENTRA
, XCART
, VTEX
, KIBO
, SALEOR
, VENDO
, CHORD
, DIGITALRIVER
, SQUARE
, AMAZON
, BIGCARTEL
, CUSTOM
The eCommerce platform plan of the store
The URL of the Store
The custom URL of the Store
If a user has verified their email address. Deprecated (not used will always be false)
The status of the merchant
INACTIVE
, ACTIVE
, DISABLED
, NEW
, DISABLED_INACTIVE
, FOR_DELETION
, APPLICATION_IN_PROGRESS
, APPLICATION_SUBMITTED
, APPLICATION_DENIED
, APPLICATION_ACCEPTED
The default currency used by merchant
The default country of origin of merchant
The default state / province of origin of merchant
The default language used by merchant
The default commission rate of the merchant
Date of creation
Date of last update
ID of the Merchant on Ecommerce Platform
ID of the Merchant on Ecommerce Platform
PUBLIC
, PRIVATE
Default Unit of Weight in the Merchants Store
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
Default Unit of Size in the Merchants Store
INCHES
, FEET
, CENTIMETERS
, OUNCES
, POUNDS
, GRAMS
, KILOGRAMS
, CARATS
, YARDS
, MILLIMETERS
, TONNES
, MILLIGRAMS
, LITERS
, MILLILITERS
, QUARTS
, QUARTERS
, GALLONS
, PINTS
, METERS
Source of the merchant referral
VIOLET
, PLATFORM_MARKETPLACE
, AFFILIATE_PROGRAM
, OTHER
URL of the merchants logo
Merchant Category
OTHER
, APPAREL_AND_ACCESSORIES
, ANIMALS_AND_PET_SUPPLIES
, ARTS_AND_ENTERTAINMENT
, BABY_AND_TODDLER
, BUSINESS_AND_INDUSTRIAL
, CAMERAS_AND_OPTICS
, ELECTRONICS
, FOOD_BEVERAGE_TOBACCO
, FURNITURE
, HARDWARE
, HEALTH_AND_BEAUTY
, HOME_AND_GARDEN
, LUGGAGE_AND_BAGS
, MATURE
, MEDIA
, OFFICE_SUPPLIES
, RELIGIOUS_AND_CEREMONIAL
, SOFTWARE
, SPORTING_GOODS
, TOYS_AND_GAMES
, VEHICLES_PARTS
Featured Merchant. Deprecated (not used)
If a developers application has access to this merchant. Deprecated (not reliable) use connection health endpoint instead.
NOT_CONNECTED
, CONNECTED
, REQUESTED
, DECLINED
The shipping status of the merchant. Deprecated (not reliable)
The tax status of the merchant. Deprecated (not reliable)
Is this a Users default merchant
The billing status of the merchant. Deprecated (not reliable) use connection health endpoint instead.
Boolean indicating if this is the last page
The total count of pages available
The total count of objects available
Boolean indicating if this is the first page of the response
The total number of objects in this specific response
The page size selected at request time
The page number selected at request time
Boolean indicating if the response content is empty
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.
Violet wrapper for springframework pageable
The current page number (one based)
The number of elements per page
Violet Wrapper for springframework sort
Boolean indicating if the result set is unsorted
Boolean indicating if the result set is sorted
Boolean indicating if the result set is empty
The offset
Boolean indicating if the result is paged
Boolean indicating if the result is unpaged
Violet Wrapper for springframework sort
Boolean indicating if the result set is unsorted
Boolean indicating if the result set is sorted
Boolean indicating if the result set is empty
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
}
}