GET

/v1/operations/connection_health/{merchant_id}

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request GET \
  --url https://sandbox-api.violet.io/v1/operations/connection_health/{merchant_id}
{
  "channel_connection": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "status": "complete",
    "total_connected": "integer"
  },
  "commission_rate": {
    "default_rate": "number",
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "overrides": [
      {
        "app_id": "integer",
        "error": {
          "code": "integer",
          "error": "string",
          "id": "object",
          "ids": [
            "object"
          ],
          "message": "string"
        },
        "rate": "number",
        "status": "complete"
      }
    ],
    "status": "complete"
  },
  "connection": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "account_id": "integer",
      "account_type": "merchant",
      "country_code": "string",
      "date_created": "string",
      "date_last_modified": "string",
      "details": {
        "account_holder_name": "string",
        "currentlyDue": [
          "string"
        ],
        "disabledReason": "string",
        "email": "string",
        "eventuallyDue": [
          "string"
        ],
        "hasPayoutAccount": "boolean",
        "legal_entity_address_city": "string",
        "legal_entity_address_country": "string",
        "legal_entity_address_line_1": "string",
        "legal_entity_address_line_2": "string",
        "legal_entity_address_postal_code": "string",
        "legal_entity_address_state": "string",
        "legal_entity_business_name": "string",
        "legal_entity_business_tax_id": "string",
        "legal_entity_currency": "string",
        "legal_entity_date_of_birth": "string",
        "legal_entity_first_name": "string",
        "legal_entity_last_name": "string",
        "legal_entity_ssn_last_four": "string",
        "legal_entity_type": "string",
        "pastDue": [
          "string"
        ],
        "paymentsEnabled": "boolean",
        "payoutsEnabled": "boolean",
        "pendingVerification": [
          "string"
        ],
        "phone": "string",
        "ssn_last_4_provided": "boolean",
        "statement_descriptor": "string",
        "tosAccepted": "boolean",
        "website_url": "string"
      },
      "external_id": "string",
      "id": "integer",
      "payment_service": "stripe",
      "payment_service_account_type": "express",
      "status": "INCOMPLETE",
      "verified": "boolean"
    },
    "status": "complete"
  },
  "distribution_type": "PUBLIC",
  "invalid_products": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "count": "integer",
      "invalid_product": {
        "date_created": "string",
        "date_last_modified": "string",
        "external_id": "string",
        "id": "integer",
        "issues": "string",
        "merchant_id": "integer",
        "name": "string",
        "status": "UNRESOLVED",
        "thumbnail_url": "string"
      }
    },
    "status": "complete"
  },
  "merchant_id": "integer",
  "merchant_name": "string",
  "merchant_status": "INACTIVE",
  "migration": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": "MIGRATION_REQUIRED",
    "status": "complete"
  },
  "offers_published": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "count": "integer",
      "sync_complete": "boolean"
    },
    "status": "complete"
  },
  "payout_account": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "account_id": "integer",
      "account_type": "merchant",
      "country_code": "string",
      "date_created": "string",
      "date_last_modified": "string",
      "details": {
        "account_holder_name": "string",
        "currentlyDue": [
          "string"
        ],
        "disabledReason": "string",
        "email": "string",
        "eventuallyDue": [
          "string"
        ],
        "hasPayoutAccount": "boolean",
        "legal_entity_address_city": "string",
        "legal_entity_address_country": "string",
        "legal_entity_address_line_1": "string",
        "legal_entity_address_line_2": "string",
        "legal_entity_address_postal_code": "string",
        "legal_entity_address_state": "string",
        "legal_entity_business_name": "string",
        "legal_entity_business_tax_id": "string",
        "legal_entity_currency": "string",
        "legal_entity_date_of_birth": "string",
        "legal_entity_first_name": "string",
        "legal_entity_last_name": "string",
        "legal_entity_ssn_last_four": "string",
        "legal_entity_type": "string",
        "pastDue": [
          "string"
        ],
        "paymentsEnabled": "boolean",
        "payoutsEnabled": "boolean",
        "pendingVerification": [
          "string"
        ],
        "phone": "string",
        "ssn_last_4_provided": "boolean",
        "statement_descriptor": "string",
        "tosAccepted": "boolean",
        "website_url": "string"
      },
      "external_id": "string",
      "id": "integer",
      "payment_service": "stripe",
      "payment_service_account_type": "express",
      "status": "INCOMPLETE",
      "verified": "boolean"
    },
    "status": "complete"
  },
  "platform": "OTHER",
  "scope_validation": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "missing_scopes": [
        "string"
      ],
      "valid": "boolean"
    },
    "status": "complete"
  },
  "store_url": "string",
  "sync_status": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": {
      "abort": "boolean",
      "date_last_synced": "string",
      "id": "integer",
      "merchant_id": "integer",
      "resync_required": "boolean",
      "status": "NOT_STARTED",
      "taxonomy_synced": "boolean",
      "total_products": "integer",
      "total_products_synced": "integer",
      "webhooks_created": "boolean"
    },
    "status": "complete"
  },
  "terms_of_service": {
    "error": {
      "code": "integer",
      "error": "string",
      "id": "object",
      "ids": [
        "object"
      ],
      "message": "string"
    },
    "results": [
      {
        "date_accepted": "string",
        "ip_address": "string",
        "policy_type": "TERMS_OF_SERVICE",
        "user_email_address": "string",
        "user_id": "integer",
        "version": "string"
      }
    ],
    "status": "complete"
  }
}

Retrieve the connection health for a specific Merchant given their merchant_id. You can use this endpoint to understand whether or not merchants are ready for transactions through your app.

This endpoint cached once every 24 hours. The data you see may be stale. 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

Path Parameters

merchant_idrequired
integer

Query Parameters

app_id
integer
refresh
Default: false
boolean

Response

200 - application/json
channel_connection
object

The status object for merchant channels connected

commission_rate
object

The status object for the merchant commission rate

connection
object

The status object for the merchant connection

distribution_type
enum<string>

The distribution type this merchant is set to

Available options:
PUBLIC,
PRIVATE
invalid_products
object

The status object for the merchant invalid products

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
migration
object

The status object for the merchant payout account migration

offers_published
object

The status object for offers published

payout_account
object

The status object for the merchant connection

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,
DIGITALRIVER,
CUSTOM
scope_validation
object

The status object for the merchant connection

store_url
string

The URL Of the Store

sync_status
object

The status object for the product sync

terms_of_service
object

The status object for the merchant terms of service acceptance

Delete Webhook HeaderGet Custom Connection Health Report