Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
Relay
- Shipping
Ecom Syncs
- Offers
Search Connection Health
Search, Filter and Sort Connection Health reports for all accessible merchants, paged
Request object for searching, sorting and filtering ConnectionHealth
A partial match query against either merchantId or merchantName
A list of platforms to filter by
Filter by ConnectionHealth Status
Property to sort by in camelCase
Direction to sort by
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 partial match query against either merchantId or merchantName
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 Filter by ConnectionHealth Status
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR Property to sort by in camelCase
merchantId, merchantName, status, platform Direction to sort by
asc, desc Response
The actual content of the response; A list of the result objects
The id of the merchant this connection health report pertains to
The name of the merchant this connection health report pertains to
The obfuscated email address 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 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 URL Of the Store
The distribution type this merchant is set to
PUBLIC, PRIVATE The status object for the merchant connection
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
The results of the merchant connection check
The status object for the merchant connection
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
The status object for the product sync
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
Shopify Product Sync Tracking & Status
Merchant ID
Status of Sync
NOT_STARTED, PENDING, IN_PROGRESS, COMPLETED, FAILED, ABORTED Should the sync be aborted
Total number of products in the store
Total number of products successfully synced
Does this merchant require a resync
Date of last sync
Has the taxonomy been synced
Have the webhooks been created
Date of last shipping data sync
The app, if any, that originated the sync request.
The status object for the merchant invalid products
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR 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
ID of product on external platform
Name of product on external platform
URL to product thumbnail
ID of merchant with broken product
Comma separated list of product invalidation reasons
Status of the invalidation
UNRESOLVED, RESOLVED Date created
Date of last update
The status object for offers published
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
The results object for offers published
The status object for the merchant payout account
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR 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.
Unique identifier for the object
Type of the account entity in Violet. This is either DEVELOPER or MERCHANT.
MERCHANT, DEVELOPER, DEVELOPER, MERCHANT Identifier of the account entity in Violet. This is either the Violet developer or merchant identifier.
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 Whether or not know-your-customer requirements have been fulfilled for the underlying payment provider payout account.
INCOMPLETE, COMPLETE, REQUIRES_UPDATES Whether or not transfers are being sent by Violet to the connected payment provider account for transactions.
Two-letter country code of the bank that this Payout Account is associated to.
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.
Verification status of the payout account connected to the payment provider.
Time at which the object was created. In ISO-8601 format.
Time at which the object was last modified. In ISO-8601 format.
EXPRESS, CUSTOM, STANDARD, PLATFORM STRIPE, NUVEI, CREDOVA, EXTERNAL Legal Entity Address City
Legal Entity Address State
Legal Entity Address Country
Legal Entity Address Postal/Zip Code
Legal Entity Date of Birth
Legal Entity Business Name
Account Holder Name
Legal Entity Business Tax ID
Legal Entity First Name
Legal Entity Last Name
Legal Entity SSN Last Four
Legal Entity Type
Has SSN Last 4 been provided
Have the TOS been accepted
Desired Currency of the Legal Entity
The merchants desired statement descriptor
The merchants website
The merchants email
The merchants phone number
Legal Entity Address Line One
Legal Entity Address Line Two
The status object for the merchant payout account migration
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR 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 object for the merchant commission rate
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
The default commission rate this merchant pays to a channel if it is not overridden
A list of commission rate overrides this merchant has configured
The status of the given property
COMPLETE, INCOMPLETE, NEEDS_ATTENTION, NOT_APPLICABLE, ERROR The error encountered while retrieving status
The app id overriding the merchant commission rate
The commission rate this merchant pays to the channel
Indicates if the commission rate is locked or not. Commission rates can only be locked or unlocked by a Channel.
Boolean indicating if this is the last page
The total count of pages available
The total count of objects available
Boolean indicating if this is the first page of the response
The total number of objects in this specific response
The page size selected at request time
The page number selected at request time
Boolean indicating if the response content is empty
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.
Violet wrapper for springframework pageable
The current page number (one based)
The number of elements per page
The offset
Boolean indicating if the result is paged
Boolean indicating if the result is unpaged
Was this page helpful?