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
POST

Get Connection Health Report by MerchantId using the provided ConnectionHealthRequest to customize the returned report. This endpoint is not cached and is only recommended for cases where the state of a merchant is changing rapidly (e.g. during onboarding) and you don't need the entire report or can't wait for the entire report to be regenerated. The normal GET endpoint is strongly encouraged for normal dashboard scenarios.

AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
merchant_id
integer
*
QUERY PARAMETERS
app_id
integer
HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
BODY PARAMETERS
body
ConnectionHealthRequest
A request object to allow to you to customize your connection health report
include_connection
boolean
Set true to receive connection
include_scope_validation
boolean
Set true to receive scope_validation
include_sync_status
boolean
Set true to receive sync_status
include_invalid_products
boolean
Set true to receive invalid_products
include_offers_published
boolean
Set true to receive offers_published
include_payout_account
boolean
Set true to receive payout_account
include_migration_account
boolean
Set true to receive migration_account
include_commission_rate
boolean
Set true to receive commission_rate
include_terms_of_service
boolean
Set true to receive terms_of_service. Available only for merchants requesting their own health
include_channel_connections
boolean
Set true to receive channel_connections. Available only for merchants requesting their own health
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
Get Connection Health Report by MerchantId.
NEXT
Get Connection Health
Docs powered by archbee