POST
/
operations
/
connection_health
/
search
curl --request POST \
  --url https://sandbox-api.violet.io/v1/operations/connection_health/search \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "platforms": [
    "OTHER"
  ],
  "status": "COMPLETE",
  "sort_by": "merchantId, merchantName, status, platform",
  "sort_direction": "asc, desc"
}'
{
  "content": [
    {
      "merchant_id": 123,
      "merchant_name": "<string>",
      "merchant_email": "<string>",
      "merchant_status": "INACTIVE",
      "platform": "OTHER",
      "store_url": "<string>",
      "distribution_type": "PUBLIC",
      "connection": {
        "status": "COMPLETE",
        "error": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "ids": [
            {}
          ]
        },
        "results": {
          "isConnected": true,
          "hasActivePlatformPlan": true,
          "hasShippingMethods": true,
          "storeScopes": {
            "hasValidScopes": true,
            "requiredScopes": [
              "<string>"
            ],
            "missingScopes": [
              "<string>"
            ]
          },
          "connected": true
        }
      },
      "scope_validation": {
        "status": "COMPLETE",
        "error": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "ids": [
            {}
          ]
        },
        "results": {
          "valid": true,
          "missing_scopes": [
            "<string>"
          ]
        }
      },
      "sync_status": {
        "status": "COMPLETE",
        "error": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "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": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "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": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "ids": [
            {}
          ]
        },
        "results": {
          "sync_complete": true,
          "count": 123
        }
      },
      "payout_account": {
        "status": "COMPLETE",
        "error": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "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": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "ids": [
            {}
          ]
        },
        "results": "MIGRATION_REQUIRED"
      },
      "commission_rate": {
        "status": "COMPLETE",
        "error": {
          "message": "<string>",
          "error": "<string>",
          "code": 123,
          "id": {},
          "ids": [
            {}
          ]
        },
        "default_rate": 123,
        "overrides": [
          {
            "status": "COMPLETE",
            "error": {
              "message": "<string>",
              "error": "<string>",
              "code": 123,
              "id": {},
              "ids": [
                {}
              ]
            },
            "app_id": 123,
            "rate": 123,
            "commission_locked": true
          }
        ]
      }
    }
  ],
  "last": true,
  "total_pages": 123,
  "total_elements": 123,
  "first": true,
  "number_of_elements": 123,
  "size": 123,
  "number": 123,
  "empty": true,
  "next_page_cursor": "<string>",
  "pageable": {
    "page_number": 123,
    "page_size": 123,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}

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

page
integer
default: 1
size
integer
default: 20
app_id
integer
required
exclude_public
boolean
default: true

Body

application/json
query
string

A partial match query against either merchantId or merchantName

platforms
enum<string>[]

A list of platforms to filter by

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
status
enum<string>

Filter by ConnectionHealth Status

Available options:
COMPLETE,
INCOMPLETE,
NEEDS_ATTENTION,
NOT_APPLICABLE,
ERROR
sort_by
enum<string>

Property to sort by in camelCase

Available options:
merchantId, merchantName, status, platform
sort_direction
enum<string>

Direction to sort by

Available options:
asc, desc

Response

default - application/json
content
object[]

The actual content of the response; A list of the result objects

last
boolean

Boolean indicating if this is the last page

total_pages
integer

The total count of pages available

total_elements
integer

The total count of objects available

first
boolean

Boolean indicating if this is the first page of the response

number_of_elements
integer

The total number of objects in this specific response

size
integer

The page size selected at request time

number
integer

The page number selected at request time

empty
boolean

Boolean indicating if the response content is empty

next_page_cursor
string

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.

pageable
object

Violet wrapper for springframework pageable

sort
object

Violet Wrapper for springframework sort

Was this page helpful?

Get Connection HealthGet Connection Health Report