Search Connection Health
Search, Filter and Sort Connection Health reports for all accessible merchants, paged
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.
Query Parameters
Body
Request object for searching, sorting and filtering ConnectionHealth
A list of platforms to filter by
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 A partial match query against either merchantId or merchantName
Property to sort by in camelCase
merchantId, merchantName, status, platform Direction to sort by
asc, desc Filter by ConnectionHealth Status
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR Response
The actual content of the response; A list of the result objects
The status object for the merchant commission rate
The default commission rate this merchant pays to a channel if it is not overridden
The error encountered while retrieving status
A list of commission rate overrides this merchant has configured
The app id overriding the merchant commission rate
Indicates if the commission rate is locked or not. Commission rates can only be locked or unlocked by a Channel.
The error encountered while retrieving status
The commission rate this merchant pays to the channel
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The status object for the merchant connection
The error encountered while retrieving status
The results of the merchant connection check
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The distribution type this merchant is set to
PUBLIC, PRIVATE The status object for the merchant invalid products
The error encountered while retrieving status
The results object for invalid products
The number of invalid products the merchant has
Any products that could not be synced
Date created
Date of last update
ID of product on external platform
Comma separated list of product invalidation reasons
ID of merchant with broken product
Name of product on external platform
Status of the invalidation
UNRESOLVED, RESOLVED URL to product thumbnail
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The obfuscated email address of the merchant this connection health report pertains to
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 status object for the merchant payout account migration
The error encountered while retrieving status
The results of the merchant payout account migration check
MIGRATION_REQUIRED, MIGRATION_IN_PROGRESS, MIGRATED, NOT_APPLICABLE, ERROR The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The status object for offers published
The error encountered while retrieving status
The results object for offers published
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The status object for the merchant payout account
The error encountered while retrieving status
Violet Payout Account that stores underlying payment provider account information to be used for disbursing funds during Order processing.
Identifier of the account entity in Violet. This is either the Violet developer or merchant identifier.
Type of the account entity in Violet. This is either DEVELOPER or MERCHANT.
MERCHANT, DEVELOPER, DEVELOPER, MERCHANT Two-letter country code of the bank that this Payout Account is associated to.
Time at which the object was created. In ISO-8601 format.
Time at which the object was last modified. In ISO-8601 format.
Account Holder Name
The merchants email
Legal Entity Address City
Legal Entity Address Country
Legal Entity Address Line One
Legal Entity Address Line Two
Legal Entity Address Postal/Zip Code
Legal Entity Address State
Legal Entity Business Name
Legal Entity Business Tax ID
Desired Currency of the Legal Entity
Legal Entity Date of Birth
Legal Entity First Name
Legal Entity Last Name
Legal Entity SSN Last Four
Legal Entity Type
The merchants phone number
Has SSN Last 4 been provided
The merchants desired statement descriptor
Have the TOS been accepted
The merchants website
Unique identifier for the object
Whether or not know-your-customer requirements have been fulfilled for the underlying payment provider payout account.
INCOMPLETE, COMPLETE, REQUIRES_UPDATES Payment Provider that the underlying payout account was created in. This is the provider that handles payment and payout processing for this entity.
STRIPE, NUVEI, CREDOVA, EXTERNAL Identifier of the payout account in the payment provider system.
Type of account in the external payment provider. This field may not be present if the underlying payment provider does not have multiple account types.
EXPRESS, CUSTOM, STANDARD, PLATFORM Metadata from the payment provider associated to this payout account.
Metadata from the payment provider associated to this payout account.
STRIPE, NUVEI, CREDOVA, EXTERNAL EXPRESS, CUSTOM, STANDARD, PLATFORM Whether or not transfers are being sent by Violet to the connected payment provider account for transactions.
Current status of this payout account. This status reflects whether or not funds can be transferred to the connected payout account.
INCOMPLETE, COMPLETE, REQUIRES_UPDATES Verification status of the payout account connected to the payment provider.
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR 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, AMAZON, BIGCARTEL, CUSTOM The status object for the merchant connection
The error encountered while retrieving status
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The URL Of the Store
The status object for the product sync
The error encountered while retrieving status
Shopify Product Sync Tracking & Status
Merchant ID
Should the sync be aborted
The app, if any, that originated the sync request.
Date of last sync
Date of last shipping data sync
Does this merchant require a resync
Status of Sync
NOT_STARTED, PENDING, IN_PROGRESS, COMPLETED, FAILED, ABORTED Has the taxonomy been synced
Total number of products in the store
Total number of products successfully synced
Have the webhooks been created
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR Boolean indicating if the response content is empty
Boolean indicating if this is the first page of the response
Boolean indicating if this is the last page
Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.
The page number selected at request time
The total number of objects in this specific response
Violet wrapper for springframework pageable
The offset
The current page number (one based)
The number of elements per page
Boolean indicating if the result is paged
Boolean indicating if the result is unpaged
The page size selected at request time
The total count of objects available
The total count of pages available
Was this page helpful?