Get Merchants

GET

merchants

Header

Query

curl --request GET \
  --url https://sandbox-api.violet.io/v1/merchants

{
  "total_pages": 123,
  "total_elements": 123,
  "pageable": {
    "unpaged": true,
    "page_size": 123,
    "page_number": 123,
    "paged": true,
    "sort": {},
    "offset": 123
  },
  "number_of_elements": 123,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 123,
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "shopify",
      "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",
      "annual_revenue": "L_E_100K",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "billing_configured": true
    }
  ],
  "number": 123,
  "empty": true
}

Retrieve all merchants that you are connected to.

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

Response

200 - application/json

total_pages

integer

total_elements

integer

pageable

object

number_of_elements

integer

last

boolean

first

boolean

sort

object

size

integer

content

object[]

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:

shopify,

magento,

magento_one,

woocommerce,

bigcommerce,

lightspeed,

ecwid,

yaas,

spreecommerce,

demandware,

volusion,

prestashop,

threedcart

content.store_url

string

The URL of the Store

content.custom_store_url

string

The custom URL of the Store

content.verified

boolean

If a user has verified their email address

content.status

enum<string>

The status of the merchant

Available options:

inactive,

active,

disabled,

new

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

Featured Merchant

content.connection_status

enum<string>

If a developers application has access to this merchant.

Available options:

NOT_CONNECTED,

CONNECTED,

REQUESTED,

DECLINED

content.annual_revenue

enum<string>

Annual Revenue

Available options:

L_E_100K,

G_100K_L_E_1M,

G_1M_L_E_100M,

G_100M

content.shipping_configured

boolean

The shipping status of the merchant

content.taxes_configured

boolean

The tax status of the merchant

content.default

boolean

content.billing_configured

boolean

The billing status of the merchant

number

integer

empty

boolean

Was this page helpful?

Get Orders Get Merchant

curl --request GET \
  --url https://sandbox-api.violet.io/v1/merchants

{
  "total_pages": 123,
  "total_elements": 123,
  "pageable": {
    "unpaged": true,
    "page_size": 123,
    "page_number": 123,
    "paged": true,
    "sort": {},
    "offset": 123
  },
  "number_of_elements": 123,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 123,
  "content": [
    {
      "id": 123,
      "merchant_name": "<string>",
      "email": "<string>",
      "user_id": 123,
      "platform": "shopify",
      "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",
      "annual_revenue": "L_E_100K",
      "shipping_configured": true,
      "taxes_configured": true,
      "default": true,
      "billing_configured": true
    }
  ],
  "number": 123,
  "empty": true
}

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Operations

Headers

Query Parameters

Response