Get Connection Health
Get Connection Health Reports for all merchants that you are connected to.
Reports for all accessible merchants.
Query parameters
app_idinteger · int32Required
exclude_publicbooleanOptionalDefault:
true
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
default
default response
application/json
get
GET /v1/operations/connection_health HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*
default
default response
[
{
"merchant_id": 1,
"merchant_name": "text",
"merchant_email": "text",
"merchant_status": "INACTIVE",
"platform": "OTHER",
"store_url": "text",
"distribution_type": "PUBLIC",
"connection": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"isConnected": true,
"hasActivePlatformPlan": true,
"hasShippingMethods": true,
"storeScopes": {
"hasValidScopes": true,
"requiredScopes": [
"text"
],
"missingScopes": [
"text"
]
},
"connected": true
}
},
"scope_validation": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"valid": true,
"missing_scopes": [
"text"
]
}
},
"sync_status": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"id": 1,
"merchant_id": 1,
"status": "NOT_STARTED",
"abort": true,
"total_products": 1,
"total_products_synced": 1,
"resync_required": true,
"date_last_synced": "2025-07-10T00:54:41.997Z",
"taxonomy_synced": true,
"webhooks_created": true,
"date_shipping_last_synced": "2025-07-10T00:54:41.997Z",
"app_id": 1
}
},
"invalid_products": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"count": 1,
"invalid_product": {
"id": 1,
"external_id": "text",
"name": "text",
"thumbnail_url": "text",
"merchant_id": 1,
"issues": "text",
"status": "UNRESOLVED",
"date_created": "2025-07-10T00:54:41.997Z",
"date_last_modified": "2025-07-10T00:54:41.997Z"
}
}
},
"offers_published": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"sync_complete": true,
"count": 1
}
},
"payout_account": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": {
"id": 1,
"account_type": "MERCHANT",
"account_id": 1,
"merchant_id": 1,
"app_id": 1,
"is_active": true,
"country_code": "text",
"payment_provider": "STRIPE",
"payment_provider_account_id": "text",
"payment_provider_account_type": "EXPRESS",
"payment_provider_metadata": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"payment_provider_account": {},
"date_deactivated": "2025-07-10T00:54:41.997Z",
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-10T00:54:41.997Z",
"date_created": "2025-07-10T00:54:41.997Z",
"payout_account_id": 1
}
],
"date_created": "2025-07-10T00:54:41.997Z",
"date_last_modified": "2025-07-10T00:54:41.997Z"
}
},
"migration": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"results": "MIGRATION_REQUIRED"
},
"commission_rate": {
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"default_rate": 1,
"overrides": [
{
"status": "COMPLETE",
"error": {
"message": "text",
"error": "text",
"code": 1,
"data": {
"cause": "ORDER_ERROR",
"skus": [
{
"message": "text",
"name": "text",
"skuId": 1,
"orderSkuId": 1,
"bagId": 1
}
]
},
"id": {},
"ids": [
{}
]
},
"app_id": 1,
"rate": 1,
"commission_locked": true
}
]
}
}
]
Last updated
Was this helpful?