GET
/
operations
/
connection_health
Header
Query
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

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Query Parameters

app_id
integer
required
exclude_public
boolean
default: true

Response

default - application/json
merchant_id
integer

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

merchant_status
enum<string>

The status/state of the merchant this connection health report pertains to

Available options:
INACTIVE,
ACTIVE,
DISABLED,
NEW,
DISABLED_INACTIVE,
FOR_DELETION,
APPLICATION_IN_PROGRESS,
APPLICATION_SUBMITTED,
APPLICATION_DENIED,
APPLICATION_ACCEPTED
platform
enum<string>

The eCommerce platform this merchant uses

Available options:
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
store_url
string

The URL Of the Store

distribution_type
enum<string>

The distribution type this merchant is set to

Available options:
PUBLIC,
PRIVATE
connection
object

The status object for the merchant connection

scope_validation
object

The status object for the merchant connection

sync_status
object

The status object for the product sync

invalid_products
object

The status object for the merchant invalid products

offers_published
object

The status object for offers published

payout_account
object

The status object for the merchant payout account

migration
object

The status object for the merchant payout account migration

commission_rate
object

The status object for the merchant commission rate

Was this page helpful?

Delete Webhook HeaderSearch Connection Health