POST
/
operations
/
connection_health
/
{merchant_id}
curl --request POST \
  --url https://sandbox-api.violet.io/v1/operations/connection_health/{merchant_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "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
}'
{
  "merchant_id": 123,
  "merchant_name": "<string>",
  "merchant_email": "<string>",
  "merchant_status": "INACTIVE",
  "platform": "OTHER",
  "store_url": "<string>",
  "distribution_type": "PUBLIC",
  "connection": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "isConnected": true,
      "hasActivePlatformPlan": true,
      "hasShippingMethods": true,
      "storeScopes": {
        "hasValidScopes": true,
        "requiredScopes": [
          "<string>"
        ],
        "missingScopes": [
          "<string>"
        ]
      },
      "connected": true
    }
  },
  "scope_validation": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "valid": true,
      "missing_scopes": [
        "<string>"
      ]
    }
  },
  "sync_status": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "id": 123,
      "merchant_id": 123,
      "status": "NOT_STARTED",
      "abort": true,
      "total_products": 123,
      "total_products_synced": 123,
      "resync_required": true,
      "date_last_synced": "2023-11-07T05:31:56Z",
      "taxonomy_synced": true,
      "webhooks_created": true
    }
  },
  "invalid_products": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "count": 123,
      "invalid_product": {
        "id": 123,
        "external_id": "<string>",
        "name": "<string>",
        "thumbnail_url": "<string>",
        "merchant_id": 123,
        "issues": "<string>",
        "status": "UNRESOLVED",
        "date_created": "2023-11-07T05:31:56Z",
        "date_last_modified": "2023-11-07T05:31:56Z"
      }
    }
  },
  "offers_published": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "sync_complete": true,
      "count": 123
    }
  },
  "payout_account": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": {
      "id": 123,
      "account_id": 123,
      "account_type": "MERCHANT",
      "external_id": "<string>",
      "country_code": "<string>",
      "status": "INCOMPLETE",
      "verified": true,
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "payment_service_account_type": "EXPRESS",
      "payment_service": "STRIPE",
      "details": {
        "legal_entity_address_city": "<string>",
        "legal_entity_address_state": "<string>",
        "legal_entity_address_country": "<string>",
        "legal_entity_address_postal_code": "<string>",
        "legal_entity_date_of_birth": "2023-11-07T05:31:56Z",
        "legal_entity_business_name": "<string>",
        "account_holder_name": "<string>",
        "legal_entity_business_tax_id": "<string>",
        "legal_entity_first_name": "<string>",
        "legal_entity_last_name": "<string>",
        "legal_entity_ssn_last_four": "<string>",
        "legal_entity_type": "<string>",
        "ssn_last_4_provided": true,
        "tosAccepted": true,
        "legal_entity_currency": "<string>",
        "statement_descriptor": "<string>",
        "website_url": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "payoutsEnabled": true,
        "paymentsEnabled": true,
        "hasPayoutAccount": true,
        "disabledReason": "<string>",
        "currentlyDue": [
          "<string>"
        ],
        "eventuallyDue": [
          "<string>"
        ],
        "pastDue": [
          "<string>"
        ],
        "pendingVerification": [
          "<string>"
        ],
        "legal_entity_address_line_1": "<string>",
        "legal_entity_address_line_2": "<string>"
      }
    }
  },
  "migration": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "results": "MIGRATION_REQUIRED"
  },
  "commission_rate": {
    "status": "COMPLETE",
    "error": {
      "id": {},
      "message": "<string>",
      "error": "<string>",
      "code": 123,
      "ids": [
        {}
      ]
    },
    "default_rate": 123,
    "overrides": [
      {
        "status": "COMPLETE",
        "error": {
          "id": {},
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "ids": [
            {}
          ]
        },
        "app_id": 123,
        "rate": 123,
        "commission_locked": true
      }
    ]
  }
}

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.

The normal GET endpoint is strongly encouraged for normal dashboard scenarios.

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.

Headers

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

Path Parameters

merchant_id
integer
required

Query Parameters

app_id
integer

Body

application/json
include_connection
boolean

Set true to receive connection

include_scope_validation
boolean

Set true to receive scope_validation

include_sync_status
boolean

Set true to receive sync_status

include_invalid_products
boolean

Set true to receive invalid_products

include_offers_published
boolean

Set true to receive offers_published

include_payout_account
boolean

Set true to receive payout_account

include_migration_account
boolean

Set true to receive migration_account

include_commission_rate
boolean

Set true to receive commission_rate

include_terms_of_service
boolean

Set true to receive terms_of_service. Available only for merchants requesting their own health

include_channel_connections
boolean

Set true to receive channel_connections. Available only for merchants requesting their own health

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_email
string

The obfuscated email address 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,
AMAZON,
BIGCARTEL,
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?

Get Connection Health ReportRelay - Get Shipping Zones