Get Current Shop

GET

self

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Sellix-Merchant

string

The name of the store to perform actions on via the API

Response

200 - application/json

status

integer

data

object

data.id

integer

Internal ID of the resource

data.user_id

integer

The ID of the user who requested the shop info

data.type

enum<string>

The type of the shop

Available options:

DEFAULT

data.name

string

The name of the shop

data.avatar

string

The hash for the avatar

data.currency

enum<string>

Available currency

Available options:

CAD,

HKD,

ISK,

PHP,

DKK,

HUF,

CZK,

GBP,

RON,

SEK,

IDR,

INR,

BRL,

RUB,

HRK,

JPY,

THB,

CHF,

EUR,

MYR,

BGN,

TRY,

CNY,

NOK,

NZD,

ZAR,

USD,

MXN,

SGD,

AUD,

ILS,

KRW,

PLN

data.default_currency

enum<string>

Available currency

Available options:

CAD,

HKD,

ISK,

PHP,

DKK,

HUF,

CZK,

GBP,

RON,

SEK,

IDR,

INR,

BRL,

RUB,

HRK,

JPY,

THB,

CHF,

EUR,

MYR,

BGN,

TRY,

CNY,

NOK,

NZD,

ZAR,

USD,

MXN,

SGD,

AUD,

ILS,

KRW,

PLN

data.available_currency

enum<string>

Available currency

Available options:

CAD,

HKD,

ISK,

PHP,

DKK,

HUF,

CZK,

GBP,

RON,

SEK,

IDR,

INR,

BRL,

RUB,

HRK,

JPY,

THB,

CHF,

EUR,

MYR,

BGN,

TRY,

CNY,

NOK,

NZD,

ZAR,

USD,

MXN,

SGD,

AUD,

ILS,

KRW,

PLN

data.vat_percentage

string

The VAT percentage setup for the store

data.tax_configuration

string

The tax configuration for the shop

data.dashboard_feature

enum<string>

The organization mode set for the dashboard

Available options:

API_CUSTOM,

EMBED,

PAYMENT_LINKS,

STORE,

POS,

PLUGINS,

UNSURE

data.display_tax_on_storefront

enum<integer>

The tax percentage will be shown on the product cards of your storefront, and not on the checkout page and invoice PDF only

Available options:

0,

1

data.display_tax_custom_fields

enum<integer>

Whether the tax is displayed in custom fields

Available options:

0,

1

data.validation_only_for_companies

enum<integer>

Wheter or not VAT validation is only done for companies

Available options:

0,

1

data.validate_vat_number

enum<integer>

If enabled, we will validate the Company VAT number to be sure it’s correct

Available options:

0,

1

data.prices_tax_inclusive

enum<integer>

Whether or not product pricing incldues the VAT

Available options:

0,

1

data.notify_trial_ending

enum<integer>

Send an email to your customers when the trial period is ending

Available options:

0,

1

data.notify_upcoming_renewal

enum<integer>

Send an email to your customers days before an upcoming renewal

Available options:

0,

1

data.notify_subscription_renewal_failure

enum<integer>

Send an email to your customers if a subscription renewal fails

Available options:

0,

1

data.order_emails

enum<integer>

Whether or not the shop owner receives emails for orders

Available options:

0,

1

data.subscription_grace_period

integer

In days, how much time should we wait before cancelling a subscription if no payment is completed

data.paypal_credit_card

enum<integer>

Whether or not the shop accepts credit cards via PayPal

Available options:

0,

1

data.force_paypal_email_delivery

enum<integer>

Whether or not the shop delivers products to the PayPal email when the gateway is PAYPAL

Available options:

0,

1

data.paypal_merchant_id

string

The PayPal merchant ID of the PayPal account linked to the shop

data.binance_id

string

The Binance ID of the Binance account linked to the shop

data.walletconnect_id

string

The WalletConnect ID of the WalletConnect account linked to the shop

data.non_custodial_wallet

enum<integer>

Whether or not the shop uses the Sellix non-custodial crypto wallet

Available options:

0,

1

data.dark_mode

enum<integer>

Whether or not the shop has dark mode enabled

Available options:

0,

1

data.discord_link

string

The Discord server invite link for the shop

data.twitter_link

string

The link to the shop's Twitter account

data.instagram_link

string

The link to the shop's Instagram account

data.facebook_link

string

The link to the shop's Facebook account

data.telegram_link

string

The invite link to the shop's Telegram community

data.youtube_link

string

The link to the shop's YouTube channel

data.reddit_link

string

The link to the shop's SubReddit

data.tiktok_link

string

The link to the shop's TikTok account

data.search_enabled

enum<integer>

Whether or not the shop has dark mode enabled

Available options:

0,

1

data.sort_enabled

enum<integer>

Whether or not the shop has product sorting enabled

Available options:

0,

1

data.cart_enabled

enum<integer>

Whether or not the shop has the cart system enabled

Available options:

0,

1

data.cart_maximum_checkout

string

Set the maximum amount, in your currency, for an order made through the Shopping Cart

data.hide_out_of_stock

enum<integer>

Automatically hide your products when out of stock

Available options:

0,

1

data.google_analytics_tracking_id

string

The google analyticd tracking id the shop uses for analytics

data.crisp_website_id

string

The crisp website id the shop uses for analytics

data.center_product_titles

enum<integer>

Whether or not the shop's theme centers product titles

Available options:

0,

1

data.center_group_titles

enum<integer>

Whether or not the shop's theme centers group titles

Available options:

0,

1

This message will be shown to anyone who visits your site. Do not include your Terms of Service here

data.verified

enum<integer>

Whether or not the shop is verified by Sellix

Available options:

0,

1

data.on_hold

enum<integer>

Whether or not the shop is on hold

Available options:

0,

1

data.terms_of_service

string

The terms of service for the shop in MDX

data.primary_color_custom_theme

string

The primary color of the shop's custom theme. Value is null if no custom theme is used

data.secondary_color_custom_theme

string

The secondary color of the shop's custom theme. Value is null if no custom theme is used

data.primary_font_color_custom_theme

string

The primary font color of the shop's custom theme. Value is null if no custom theme is used

data.secondary_font_color_custom_theme

string

The secondary font color of the shop's custom theme. Value is null if no custom theme is used

data.custom_embed

enum<integer>

Whether or not the shop uses a custom embed theme. Value is null if no custom theme is used

Available options:

0,

1

data.custom_theme

enum<integer>

Whether or not the shop uses a custom storefront theme. Value is null if no custom theme is used

Available options:

0,

1

data.font_custom_theme

string

The font of the shop's custom storefront theme. Value is null if no custom theme is used

data.style_custom_theme

string

The style of the shop's custom storefront theme. Value is null if no custom theme is used

data.embed_style_custom_theme

string

The style of the shop's custom embed theme. Value is null if no custom theme is used

data.index_custom_theme

string

The index of the shop's active custom storefront theme. Value is null if no custom theme is used

data.product_card_custom_theme

string

The product_card of the shop's active custom storefront theme. Value is null if no custom theme is used

data.banner_custom_theme

object

The storefront banner of the shop's custom theme. Value is null if no custom theme is used

data.footer_custom_theme

object

The storefront footer of the shop's custom theme. Value is null if no custom theme is used

data.background_image_custom_theme

object

The storefront background image of the shop's custom theme. Value is null if no custom theme is used

data.logo_custom_theme

object

The storefront logo of the shop's custom theme. Value is null if no custom theme is used

data.header_custom_theme

object

The storefront header of the shop's custom theme. Value is null if no custom theme is used

data.cards_in_row_custom_theme

integer

The amount of cards to display in a row on the storefront

data.cards_align_custom_theme

object

Value is null if no custom theme is used

data.group_card_custom_theme

object

Value is null if no custom theme is used

data.card_animation_custom_theme

object

Value is null if no custom theme is used

data.light_font_color_custom_theme

string

The light mode font color of the shop's custom theme. Value is null if no custom theme is used

data.dark_font_color_custom_theme

string

The dark mode font color of the shop's custom theme. Value is null if no custom theme is used

data.light_color_custom_theme

string

The light mode accent color of the shop's custom theme. Value is null if no custom theme is used

data.dark_color_custom_theme

string

The dark mode accent color of the shop's custom theme. Value is null if no custom theme is used

data.border_color_custom_theme

string

The border color of the shop's custom theme. Value is null if no custom theme is used

data.button_color_custom_theme

string

The button color of the shop's custom theme. Value is null if no custom theme is used

data.thin_color_custom_theme

string

The thin font color of the shop's custom theme. Value is null if no custom theme is used

data.sort_custom_theme

enum<string>

The default sorting method for the storefront's custom theme

Available options:

DEFAULT,

PRICE,

STOCK,

NAME,

TYPE

data.helpspace_client_id

string

The helpspace client id of the helpspace account linked to the shop

data.helpspace_token

string

The helpspace token of the helpspace account linked to the shop

data.description_youtube_only

enum<integer>

Show only youtube video for invoice/product description

Available options:

0,

1

data.description_skip_default_image

enum<integer>

Skip Default Image for Product Description

Available options:

0,

1

data.hide_stock_counter

enum<integer>

If enabled, the number of how many products are in stock will be removed, we will only show 'In Stock' or 'Out of Stock'

Available options:

0,

1

data.image_width

integer

The width of the storefront image

data.image_height

integer

The height of the storefront image

data.default_sort

enum<string>

The default sorting method for the storefront

Available options:

DEFAULT,

PRICE,

STOCK,

NAME,

TYPE

data.description_image

enum<integer>

Whether or not the shop has a description image

Available options:

0,

1

data.hide_products_sold

enum<integer>

Hide the products sold counter on your storefront, only your average feedback will be displayed

Available options:

0,

1

data.service_date_from

enum<string>

Choose whether to display your business starting date from the day of your first sale or the day you have signed up to Sellix

Available options:

REGISTRATION_DATE,

FIRST_SALE

data.cards_type

string

DEPRECATED: The name of the product image with the file type

data.setup_wizard

enum<integer>

Whether or not the shop has completed the setup wizzard

Available options:

0,

1

data.setup_cryptocurrencies

enum<integer>

Whether or not the shop has setup cryptocurrencies

Available options:

0,

1

data.notices_banner

string

The notices for the shop

data.affiliate_revenue_percent

integer

The percentage of each payment given to affiliates

data.created_at

integer

Timestamp for the creation of the subscription

data.image_name

string

DEPRECATED: The name of the product image with the file type

data.image_storage

string

Where the image is stored in Sellix's self-hosted CDN

data.cloudflare_image_id

string

The cloudflare image ID of this product, replaces image_attachment and image_name. Format https://imagedelivery.net/95QNzrEeP7RU5l5WdbyrKw/<cloudflare_image_id>/<variant_name> where variant_name can be shopItem, avatar, icon, imageAvatarFeedback, public, productImageCart

data.marketplace_verified

enum<integer>

Whether or not the shop is a verified marketplace

Available options:

0,

1

error

string

message

string

env

string

Was this page helpful?

Sandbox Environment Create Payment

API Documentation

Information

Payments

Orders

Customers

Subscriptions 2.0

Subscriptions (legacy)

Licenses

Blacklists

Whitelists

Products

Categories

Groups

Coupons

Feedback

Queries

Authorizations

Headers

Response