Get Custom Connection Health Report
Get a customized Connection Health Report for a specific merchant using merchant_id
. You can use ConnectionHealthRequest
to pass in the fields you want returned.
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.
A request object to allow to you to customize your connection health report
Set true to receive connection
Set true to receive scope_validation
Set true to receive sync_status
Set true to receive invalid_products
Set true to receive offers_published
Set true to receive payout_account
Set true to receive migration_account
Set true to receive commission_rate
Set true to receive terms_of_service. Available only for merchants requesting their own health
Set true to receive channel_connections. Available only for merchants requesting their own health
POST /v1/operations/connection_health/{merchant_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 311
{
"include_connection": true,
"include_scope_validation": true,
"include_sync_status": true,
"include_invalid_products": true,
"include_offers_published": true,
"include_payout_account": true,
"include_migration_account": true,
"include_commission_rate": true,
"include_terms_of_service": true,
"include_channel_connections": true
}
success
{
"merchantId": 12030,
"merchantName": "Space Drinks",
"merchantStatus": "ACTIVE",
"platform": "SHOPIFY",
"storeUrl": "ishan-guru-test-store.myshopify.com",
"payoutAccount": {
"status": "COMPLETE",
"results": {
"id": 13197,
"accountType": "MERCHANT",
"accountId": 12030,
"appId": 11026,
"isActive": true,
"status": "COMPLETE",
"kycStatus": "COMPLETE",
"payoutsEnabled": true,
"countryCode": "CA",
"paymentProvider": "STRIPE",
"paymentProviderAccountId": "acct_1Q33PsGaTELgZzqx",
"paymentProviderAccountType": "EXPRESS",
"paymentProviderMetadata": {
"stripeAccountId": "acct_1Q33PsGaTELgZzqx",
"stripeAccountType": "EXPRESS",
"stripeBankingCurrency": "cad"
},
"paymentProviderAccount": {
"accountId": "acct_1Q33PsGaTELgZzqx",
"accountType": "EXPRESS",
"bankingCountry": "CA",
"bankingCurrency": "cad",
"chargesEnabled": true,
"payoutsEnabled": true,
"requirements": {
"alternatives": [],
"currentlyDue": [],
"errors": [],
"eventuallyDue": [],
"pastDue": [],
"pendingVerification": []
},
"dateCreated": "2024-11-15T01:10:34+0000",
"dateLastModified": "2024-11-15T01:10:34+0000"
},
"errors": [],
"dateCreated": "2024-09-25T22:10:38+0000",
"dateLastModified": "2025-01-28T02:47:53+0000",
"paymentServiceAccountType": "EXPRESS",
"paymentService": "STRIPE",
"externalId": "acct_1Q33PsGaTELgZzqx",
"details": {
"tosAccepted": false,
"payoutsEnabled": true,
"paymentsEnabled": true,
"hasPayoutAccount": true,
"currentlyDue": [],
"eventuallyDue": [],
"pastDue": [],
"pendingVerification": []
}
}
}
}
Last updated
Was this helpful?