Search Merchants

POST

merchants

curl --request POST \
  --url https://sandbox-api.violet.io/v1/merchants/search \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "name": "<string>",
  "commission_rate_min": 123,
  "commission_rate_max": 123,
  "status": "ANY",
  "sort_by": "<string>",
  "sort_direction": "<string>"
}'

{
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "OTHER",
      "platform_plan": "<string>",
      "store_url": "<string>",
      "custom_store_url": "<string>",
      "verified": true,
      "status": "INACTIVE",
      "default_currency": "<string>",
      "default_country_code": "<string>",
      "default_state_code": "<string>",
      "default_language_code": "<string>",
      "commission_rate": 123,
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "distribution_type": "PUBLIC",
      "default_weight_unit": "INCHES",
      "default_size_unit": "INCHES",
      "referral_source": "VIOLET",
      "logo": "<string>",
      "category": "OTHER",
      "featured": true,
      "connection_status": "NOT_CONNECTED",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "merchantDisabled": true,
      "billing_configured": 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
  }
}

Search for merchants you are connected to given certain filter criteria.

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

Body

application/json

integer

The ID of the Merchant

name

string

The name of the Merchant

commission_rate_min

number

The minimum commission rate of the Merchant

commission_rate_max

number

The maximum commission rate of the Merchant

status

enum<string>

The connection status of the Merchant

Available options:

ANY,

CONNECTED,

PRIVATE,

PUBLIC

sort_by

string

Property to sort by in camelCase

sort_direction

string

Direction to sort by

Response

default - application/json

content

object[]

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

content.id

integer

content.merchant_name

string

required

The name of the merchants business

content.email

string

required

The Merchants unique email address

content.user_id

integer

required

The Id of the User who owns this Merchant Account

content.platform

enum<string>

required

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

content.platform_plan

string

The eCommerce platform plan of the store

content.store_url

string

The URL of the Store

content.custom_store_url

string

The custom URL of the Store

content.verified

boolean

deprecated

If a user has verified their email address. Deprecated (not used will always be false)

content.status

enum<string>

The status of the merchant

Available options:

INACTIVE,

ACTIVE,

DISABLED,

NEW,

DISABLED_INACTIVE,

FOR_DELETION,

APPLICATION_IN_PROGRESS,

APPLICATION_SUBMITTED,

APPLICATION_DENIED,

APPLICATION_ACCEPTED

content.default_currency

string

The default currency used by merchant

content.default_country_code

string

The default country of origin of merchant

content.default_state_code

string

The default state / province of origin of merchant

content.default_language_code

string

The default language used by merchant

content.commission_rate

number

The default commission rate of the merchant

content.date_created

string

Date of creation

content.date_last_modified

string

Date of last update

content.external_id

string

ID of the Merchant on Ecommerce Platform

content.distribution_type

enum<string>

ID of the Merchant on Ecommerce Platform

Available options:

PUBLIC,

PRIVATE

content.default_weight_unit

enum<string>

Default Unit of Weight in the Merchants Store

Available options:

INCHES,

FEET,

CENTIMETERS,

OUNCES,

POUNDS,

GRAMS,

KILOGRAMS,

CARATS,

YARDS,

MILLIMETERS,

TONNES,

MILLIGRAMS,

LITERS,

MILLILITERS,

QUARTS,

QUARTERS,

GALLONS,

PINTS,

METERS

content.default_size_unit

enum<string>

Default Unit of Size in the Merchants Store

Available options:

INCHES,

FEET,

CENTIMETERS,

OUNCES,

POUNDS,

GRAMS,

KILOGRAMS,

CARATS,

YARDS,

MILLIMETERS,

TONNES,

MILLIGRAMS,

LITERS,

MILLILITERS,

QUARTS,

QUARTERS,

GALLONS,

PINTS,

METERS

content.referral_source

enum<string>

Source of the merchant referral

Available options:

VIOLET,

PLATFORM_MARKETPLACE,

AFFILIATE_PROGRAM,

OTHER

content.logo

string

URL of the merchants logo

content.category

enum<string>

Merchant Category

Available options:

OTHER,

APPAREL_AND_ACCESSORIES,

ANIMALS_AND_PET_SUPPLIES,

ARTS_AND_ENTERTAINMENT,

BABY_AND_TODDLER,

BUSINESS_AND_INDUSTRIAL,

CAMERAS_AND_OPTICS,

ELECTRONICS,

FOOD_BEVERAGE_TOBACCO,

FURNITURE,

HARDWARE,

HEALTH_AND_BEAUTY,

HOME_AND_GARDEN,

LUGGAGE_AND_BAGS,

MATURE,

MEDIA,

OFFICE_SUPPLIES,

RELIGIOUS_AND_CEREMONIAL,

SOFTWARE,

SPORTING_GOODS,

TOYS_AND_GAMES,

VEHICLES_PARTS

content.featured

boolean

deprecated

Featured Merchant. Deprecated (not used)

content.connection_status

enum<string>

deprecated

If a developers application has access to this merchant. Deprecated (not reliable) use connection health endpoint instead.

Available options:

NOT_CONNECTED,

CONNECTED,

REQUESTED,

DECLINED

content.shipping_configured

boolean

deprecated

The shipping status of the merchant. Deprecated (not reliable)

content.taxes_configured

boolean

deprecated

The tax status of the merchant. Deprecated (not reliable)

content.default

boolean

Is this a Users default merchant

content.merchantDisabled

boolean

content.billing_configured

boolean

deprecated

The billing status of the merchant. Deprecated (not reliable) use connection health endpoint instead.

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 Merchant Get Merchant Config

curl --request POST \
  --url https://sandbox-api.violet.io/v1/merchants/search \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "name": "<string>",
  "commission_rate_min": 123,
  "commission_rate_max": 123,
  "status": "ANY",
  "sort_by": "<string>",
  "sort_direction": "<string>"
}'

{
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "OTHER",
      "platform_plan": "<string>",
      "store_url": "<string>",
      "custom_store_url": "<string>",
      "verified": true,
      "status": "INACTIVE",
      "default_currency": "<string>",
      "default_country_code": "<string>",
      "default_state_code": "<string>",
      "default_language_code": "<string>",
      "commission_rate": 123,
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "distribution_type": "PUBLIC",
      "default_weight_unit": "INCHES",
      "default_size_unit": "INCHES",
      "referral_source": "VIOLET",
      "logo": "<string>",
      "category": "OTHER",
      "featured": true,
      "connection_status": "NOT_CONNECTED",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "merchantDisabled": true,
      "billing_configured": 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
  }
}

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Apps

Operations

Relay

Headers

Query Parameters

Body

Response