Get Connection Health
curl --request GET \
--url https://sandbox-api.violet.io/v1/operations/connection_health
[
{
"merchant_id": 123,
"merchant_name": "<string>",
"merchant_status": "INACTIVE",
"platform": "OTHER",
"store_url": "<string>",
"distribution_type": "PUBLIC",
"connection": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"scope_validation": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"sync_status": {
"status": "COMPLETE",
"error": {},
"results": {
"merchant_id": 123
}
},
"invalid_products": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"offers_published": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"payout_account": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"migration": {
"status": "COMPLETE",
"error": {},
"results": "MIGRATION_REQUIRED"
},
"commission_rate": {
"status": "COMPLETE",
"error": {},
"default_rate": 123,
"overrides": []
}
}
]
Get Connection Health Reports for all merchants that you are connected to.
This endpoint cached once every 24 hours. The data you see may be stale, although if you refresh a specific merchant, those updates will be reflected here. We highly recommend subscribing to our Webhooks to get accurate information about when a merchant needs attention.
Headers
Query Parameters
Response
The id of the merchant this connection health report pertains to
The name of the merchant this connection health report pertains to
The status/state of the merchant this connection health report pertains to
INACTIVE
, ACTIVE
, DISABLED
, NEW
, DISABLED_INACTIVE
, FOR_DELETION
, APPLICATION_IN_PROGRESS
, APPLICATION_SUBMITTED
, APPLICATION_DENIED
, APPLICATION_ACCEPTED
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
, CUSTOM
The URL Of the Store
The distribution type this merchant is set to
PUBLIC
, PRIVATE
The status object for the merchant connection
The status object for the merchant connection
The status object for the product sync
The status object for the merchant invalid products
The status object for offers published
The status object for the merchant payout account
The status object for the merchant payout account migration
The status object for the merchant commission rate
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/operations/connection_health
[
{
"merchant_id": 123,
"merchant_name": "<string>",
"merchant_status": "INACTIVE",
"platform": "OTHER",
"store_url": "<string>",
"distribution_type": "PUBLIC",
"connection": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"scope_validation": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"sync_status": {
"status": "COMPLETE",
"error": {},
"results": {
"merchant_id": 123
}
},
"invalid_products": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"offers_published": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"payout_account": {
"status": "COMPLETE",
"error": {},
"results": {}
},
"migration": {
"status": "COMPLETE",
"error": {},
"results": "MIGRATION_REQUIRED"
},
"commission_rate": {
"status": "COMPLETE",
"error": {},
"default_rate": 123,
"overrides": []
}
}
]