Get Connection Health

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_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

payout_account.status

enum<string>

The status of the given property

Available options:

COMPLETE,

INCOMPLETE,

NEEDS_ATTENTION,

NOT_APPLICABLE,

ERROR

payout_account.error

object

The error encountered while retrieving status

payout_account.results

object

Payout Account of the User. Maps to Stripe Connect Account.

payout_account.results.id

integer

payout_account.results.account_id

integer

Developer or Merchant ID

payout_account.results.account_type

enum<string>

Account Type

Available options:

MERCHANT,

DEVELOPER

payout_account.results.external_id

string

External ID. Stripe Account ID

payout_account.results.country_code

string

Country Code. Country Code for this Payout Account

payout_account.results.status

enum<string>

Status

Available options:

INCOMPLETE,

COMPLETE,

REQUIRES_UPDATES

payout_account.results.verified

boolean

Has the account been verified

payout_account.results.date_created

string

Date of account creation

payout_account.results.date_last_modified

string

Date of last account update

payout_account.results.payment_service_account_type

enum<string>

Type of account in the external payment service

Available options:

EXPRESS,

CUSTOM,

STANDARD

payout_account.results.payment_service

enum<string>

Payment Service used for this payout account

Available options:

STRIPE

payout_account.results.details

object

payout_account.results.details.legal_entity_address_city

string

Legal Entity Address City

payout_account.results.details.legal_entity_address_state

string

Legal Entity Address State

payout_account.results.details.legal_entity_address_country

string

Legal Entity Address Country

payout_account.results.details.legal_entity_address_postal_code

string

Legal Entity Address Postal/Zip Code

payout_account.results.details.legal_entity_date_of_birth

string

Legal Entity Date of Birth

payout_account.results.details.legal_entity_business_name

string

Legal Entity Business Name

payout_account.results.details.account_holder_name

string

Account Holder Name

payout_account.results.details.legal_entity_business_tax_id

string

Legal Entity Business Tax ID

payout_account.results.details.legal_entity_first_name

string

Legal Entity First Name

payout_account.results.details.legal_entity_last_name

string

Legal Entity Last Name

payout_account.results.details.legal_entity_ssn_last_four

string

Legal Entity SSN Last Four

payout_account.results.details.legal_entity_type

string

Legal Entity Type

payout_account.results.details.ssn_last_4_provided

boolean

Has SSN Last 4 been provided

payout_account.results.details.tosAccepted

boolean

Have the TOS been accepted

payout_account.results.details.legal_entity_currency

string

Desired Currency of the Legal Entity

payout_account.results.details.statement_descriptor

string

The merchants desired statement descriptor

payout_account.results.details.website_url

string

The merchants website

payout_account.results.details.email

string

The merchants email

payout_account.results.details.phone

string

The merchants phone number

payout_account.results.details.payoutsEnabled

boolean

payout_account.results.details.paymentsEnabled

boolean

payout_account.results.details.hasPayoutAccount

boolean

payout_account.results.details.disabledReason

string

payout_account.results.details.currentlyDue

string[]

payout_account.results.details.eventuallyDue

string[]

payout_account.results.details.pastDue

string[]

payout_account.results.details.pendingVerification

string[]

payout_account.results.details.legal_entity_address_line_1

string

Legal Entity Address Line One

payout_account.results.details.legal_entity_address_line_2

string

Legal Entity Address Line Two

migration

object

The status object for the merchant payout account migration

commission_rate

object

The status object for the merchant commission rate

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Headers

Query Parameters

Response