website logo
Channel Docs
Merchant Docs
Navigate through spaces
⌘K
👋Welcome to Violet's Docs
💡Concepts
🧭Guides
🚀Quick Start
🛍️Violet Sample App — The Ultra Store
🏃‍♂️Utilizing Quick Checkout
💻API Reference
✋Help
Docs powered by archbee 

Get Connection Health Report by MerchantId.

2min
GET

ConnectionHealth reports are cached once every 24 hours, if you need to request fresh data, pass ?refresh=true.

AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
merchant_id
integer
*
QUERY PARAMETERS
app_id
integer
refresh
boolean
HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
RESPONSES
200
successful operation
ConnectionHealth
The container for all status objects comprising merchant connection health
merchant_id
integer<int32>
The id of the merchant this connection health report pertains to
merchant_name
string
The name of the merchant this connection health report pertains to
platform
string<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 | DIGITALRIVER | CUSTOM>
The eCommerce platform this merchant uses
store_url
string
The URL Of the Store
distribution_type
string<PUBLIC | PRIVATE>
The distribution type this merchant is set to
connection
Connection
The status object for merchant connection check
scope_validation
ScopeValidation
The status object for merchant scope validation
sync_status
SyncStatus
The status object for product sync
invalid_products
InvalidProducts
The status object for invalid products
offers_published
OffersPublished
The status object for merchant offers published health
payout_account
Connection
The status object for the merchant payout account
migration
Migration
The status object for the merchant payout account migration
commission_rate
CommissionRate
The status object for merchant commission rate health
terms_of_service
TermsOfService
The status object for merchant terms of service health
channel_connection
ChannelConnections
The status object for merchant channel connection health




Updated 04 May 2023
Did this page help you?
Yes
No
PREVIOUS
Delete Webhook Header
NEXT
Get Connection Health Report by MerchantId
Docs powered by archbee