The Order Object

id

integer

Internal ID of the resource

uniqid

string

Unique ID of the resource, used as reference across the API

recurring_billing_id

string

Unique ID of the recurring bill

payout_configuration

string

DEPRECATED

secret

string

An internal Sellix secret used for completing tasks with our internal API

type

enum<string>

Invoice type. For subscriptions, the invoice type is PRODUCT_SUBSCRIPTION as SUBSCRIPTION is reserved for Sellix-own plans

Available options:

PRODUCT,

SUBSCRIPTION,

PUBLIC_REST_API,

MONTHLY_BILL,

SHOPPING_CART,

PRODUCT_SUBSCRIPTION,

PRODUCT_SUBSCRIPTION_V2

subtype

enum<string>

Product type

Available options:

INFO_CARD,

SERVICE,

DYNAMIC,

FILE,

SERIALS,

GAMING_RCON,

SUBSCRIPTION,

SUBSCRIPTION_V2

origin

enum<string>

How the invoice was created

Available options:

STOREFRONT,

API

total

number

Invoice total, unit_price*quantity where quantity is applicable

total_display

number

Invoice total in the currency chosen

product_variants

object

exchange_rate

number

Exchange rate between currency chosen and USD

crypto_exchange_rate

number

Exchange rate between the cryptocurrency chosen (if any) and USD

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

shop_id

integer

The shop ID to which this invoice belongs

shop_image_name

string

DEPRECATED: Unique id of the image attachment for this merchant with the image extension included

shop_image_storage

enum<string>

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

Available options:

PRODUCTS,

SHOPS

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

name

string

Name of the merchant

customer_email

string

Email of the customer

customer_id

string

ID of the customer

affliate_revenue_customer_id

string

ID of the affiliate

paypal_email_delivery

boolean

If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email

product_id

string

Unique ID of the product linked to this invoice, if any

product_title

string

Product title

product_type

enum<string>

Product type

Available options:

INFO_CARD,

SERVICE,

DYNAMIC,

FILE,

SERIALS,

GAMING_RCON,

SUBSCRIPTION,

SUBSCRIPTION_V2

subscription_id

integer

Field reserved for Sellix-own plans. Unique ID of the subscription purchased

subscription_time

integer

Field reserved for Sellix-own plans. Time, in seconds, of the subscription purchased

gateway

enum<string>

Gateway chosen for this invoice. If null, the customer will be asked for a gateway in the Sellix hosted invoice page

Available options:

PAYPAL,

STRIPE,

SKRILL,

PERFECT_MONEY,

CASH_APP,

BINANCE,

BITCOIN,

LITECOIN,

ETHEREUM,

BITCOIN_CASH,

NANO,

MONERO,

SOLANA,

RIPPLE,

BINANCE_COIN,

USDC,

USDT,

TRON,

BITCOIN_LN,

CONCORDIUM,

POLYGON,

PEPE,

DAI,

WETH,

APE,

SHIB,

USDC_NATIVE,

DOGECOIN,

PYTH,

BONK,

JUP,

JITO,

WEN,

RENDER,

MOBILE,

HNT

blockchain

enum<string>

The blockchain of the crypto currency

Available options:

ERC20,

BEP20,

TRC20,

MATIC,

SOL

paypal_apm

string

PayPal Alternative Payment Method name, such as iDEAL, used if gateway is PAYPAL

stripe_apm

enum<string>

Stripe Alternative Payment Method name, such as iDEAL, used if gateway is STRIPE

Available options:

afterpay_clearpay,

alipay,

bancontact,

au_becs_debit,

boleto,

eps,

fpx,

giropay,

grabpay,

ideal,

klarna,

oxxo,

p24,

sofort,

wechat_pay

paypal_email

string

Merchant PayPal email

paypal_order_id

string

This field contains the PayPal order ID

paypal_payer_email

string

This field is updated after the invoice is completed with the PayPal's email used for the purchase

paypal_fee

string

This field is updated after the invoice is completed with the fee taken by PayPal over the invoice total

paypal_subscription_id

integer

ID of the paypal subscription

paypal_subscription_link

integer

Link for the merchant to purchase the subscription from

lex_order_id

string

DEPRECATED

lex_payment_method

string

DEPRECATED

paydash_paymentID

string

DEPRECATED

virtual_payments_id

string

DEPRECATED

stripe_client_secret

string

Client secret used to create the STRIPE paymentIntent

stripe_price_id

string

If the invoice type is PRODUCT_SUBSCRIPTION or SUBSCRIPTION, refers to the STRIPE price ID

skrill_email

string

Merchant Skrill email

skrill_sid

string

Skrill unique ID linked to the invoice

skrill_link

string

Skrill link to redirect the customer to

perfectmoney_id

string

PerfectMoney payment ID linked to the invoice

binance_invoice_id

string

ID for binance invoice

binance_qrcode

string

Full Binance QRCODE string

binance_checkout_url

string

Checkout URL for Binance invoice

crypto_address

string

Cryptocurrency address linked to this invoice

crypto_amount

number

Cryptocurrency amount converted based on crypto_exchange_rate

crypto_received

number

Cryptocurrency amount received, paid by the customer

crypto_uri

string

URI used to create the QRCODE

crypto_confirmations_needed

integer

Crypto confirmations needed to process the invoice

crypto_scheduled_payout

boolean

If true, a scheduled payout for this invoice's cryptocurrency address has been sent

crypto_payout

boolean

If true, an instant payout for this invoice's cryptocurrency address has been sent

fee_billed

boolean

If true, the Sellix fee_percentage has already been collected

bill_info

object

If invoice type is MONTHLY_BILL, contains a breakdown of the fees that need to be collected

cashapp_qrcode

string

Full CashApp QRCODE string

cashapp_note

string

Unique note for the customer to leave in the CashApp payment

cashapp_cashtag

string

CashApp cashtag used to create the QRCODE

country

string

Customer country

location

string

Customer location

ip

string

Customer IP

is_vpn_or_proxy

boolean

If true, a VPN or Proxy has been detected

user_agent

string

Customer User Agent

quantity

integer

Qauntity of product purchased

coupon_id

string

Unique ID of the coupon, if used, for the discount

custom_fields

The custom fields passed by the user at checkout. The type is map<string, string>

developer_invoice

boolean

If true, this invoice has been created through the Developers API

developer_title

string

If a product_id is not passed through the Developers API, a title must be specified

developer_webhook

string

Additional webhook URL to which updates regarding this invoice will be sent

developer_return_url

string

If present, the customer will be redirected to this URL after the invoice has been paid

status

enum<string>

Status of the invoice

Available options:

PENDING,

COMPLETED,

VOIDED,

WAITING_FOR_CONFIRMATIONS,

PARTIAL,

CUSTOMER_DISPUTE_ONGOING,

REVERSED,

REFUNDED,

WAITING_SHOP_ACTION,

PROCESSING

status_details

enum<string>

If CART_PARTIAL_OUT_OF_STOCK, the invoice has been completed but some products in the cart were out of stock

Available options:

PAYMENT_FAILED,

CART_PARTIAL_OUT_OF_STOCK

void_details

enum<string>

If the invoice is VOIDED and the product (or all the products in the cart) were out of stock, this additional status is set

Available options:

PRODUCT_SOLD_OUT,

CART_PRODUCTS_SOLD_OUT

discount

number

If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice

fee_percentage

integer

What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees

fee_breakdown

object

fee_breakdown.service_fee

object

fee_breakdown.aml_analysis

object

fee_breakdown.platform_fee

object

discount_breakdown

object

Representation of how discount was applied to invoice

day_value

integer

deprecated

DEPRECATED: Day value, number

day

string

deprecated

DEPRECATED: First three letters of the day name

month

string

deprecated

DEPRECATED: First three letters of the month name

year

integer

deprecated

DEPRECATED: Year number

product_addons

object[]

bundle_config

object[]

created_at

integer

Timestamp for the creation of the invoice

updated_at

integer

Date, available if the blacklist has been edited

updated_by

integer

User ID of the user who updated the invoice

approved_address

object

service_text

string

If the product type is SERVICE, this field contains additional details on the type of service provided by the merchant

ip_info

object

Additional info on the customer IP

webhooks

object[]

Webhook responses for this invoice

rewards_data

object[]

paypal_dispute

object

product_downloads

object[]

payment_link_id

string

The ID for the payment link, if invoice was created by a payment link

cashapp_email_configured

boolean

Whether or not cashapp email is configured

license

boolean

True if the product is of type LICENSE

status_history

object[]

Additional details on the invoice status change

aml_wallets

object[]

aml_wallets.id

integer

AML transaction ID

aml_wallets.shop_id

integer

Shop ID linked to this AML transaction

aml_wallets.invoice_id

string

Unique ID of the invoice this AML transaction is linked to

aml_wallets.origin

string

Origin of the AML transaction

aml_wallets.type

string

Type of the AML transaction

aml_wallets.asset

string

Asset of the AML transaction

aml_wallets.blockchain

string

Blockchain of the AML transaction

aml_wallets.hash

string

AML transaction hash

aml_wallets.output_type

string

AML transaction output type

aml_wallets.output_address

string

AML transaction output address

aml_wallets.risk_score

string

AML transaction risk score

aml_wallets.asset_list

string[]

AML transaction asset list

aml_wallets.error

string

AML transaction error

aml_wallets.evaluation_detail

object[]

aml_wallets.contributions

object

aml_wallets.blockchain_info

object

aml_wallets.cluster_entities

object[]

aml_wallets.risk_score_detail

object

aml_wallets.created_at

integer

Timestamp for the AML transaction creation date

crypto_transactions

object[]

Crypto transactions received to fulfill this invoice

crypto_transactions.crypto_amount

number

Crypto amount sent in the transaction

crypto_transactions.hash

string

Crypto transaction hash

crypto_transactions.confirmations

integer

Crypto transaction confirmations, not updated once the invoice status is COMPLETED or VOIDED

crypto_transactions.created_at

integer

Timestamp for the crypto transaction reception date

crypto_transactions.updated_at

integer

Crypto transaction update date

crypto_transactions.aml_tx

object

crypto_transactions.aml_tx.id

integer

AML transaction ID

crypto_transactions.aml_tx.shop_id

integer

Shop ID linked to this AML transaction

crypto_transactions.aml_tx.invoice_id

string

Unique ID of the invoice this AML transaction is linked to

crypto_transactions.aml_tx.origin

string

Origin of the AML transaction

crypto_transactions.aml_tx.type

string

Type of the AML transaction

crypto_transactions.aml_tx.asset

string

Asset of the AML transaction

crypto_transactions.aml_tx.blockchain

string

Blockchain of the AML transaction

crypto_transactions.aml_tx.hash

string

AML transaction hash

crypto_transactions.aml_tx.output_type

string

AML transaction output type

crypto_transactions.aml_tx.output_address

string

AML transaction output address

crypto_transactions.aml_tx.risk_score

string

AML transaction risk score

crypto_transactions.aml_tx.asset_list

string[]

AML transaction asset list

crypto_transactions.aml_tx.error

string

AML transaction error

crypto_transactions.aml_tx.evaluation_detail

string[]

AML transaction evaluation detail

crypto_transactions.aml_tx.contributions

object[]

crypto_transactions.aml_tx.blockchain_info

object

crypto_transactions.aml_tx.cluster_entities

object[]

crypto_transactions.aml_tx.risk_score_detail

object

crypto_transactions.aml_tx.created_at

integer

Timestamp for the AML transaction creation date

product

object

product.id

integer

Internal ID of the resource

product.uniqid

string

Unique ID of the resource, used as reference across the API

product.slug

string

The slug used to navigate to the product page on a storefront

product.shop_id

number

The shop ID to which this resource belongs

product.type

enum<string>

Product type

Available options:

INFO_CARD,

SERVICE,

DYNAMIC,

FILE,

SERIALS,

GAMING_RCON,

SUBSCRIPTION,

SUBSCRIPTION_V2

product.subtype

enum<string>

Product subtype, can be used only with type SUBSCRIPTION

Available options:

SERVICE,

DYNAMIC,

FILE,

SERIALS

product.title

string

Product title

product.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

product.pay_what_you_want

enum<integer>

Whether or not pay-what-you-want pricing is enabled

Available options:

0,

1

product.price

number

Product price

product.price_display

number

Product price in currency

product.price_discount

number

The discount price on the purchased goods

product.affiliate_revenue_percent

number

The percentage of revenue to give to affiliates. -1 for disabled, 0 for default (10%), other number for a custom percent

product.price_variants

object

Variants in pricing for the product

product.description

string

Product description

product.licensing_enabled

enum<integer>

Whether product licenses are generated on successful payments

Available options:

0,

1

product.license_period

integer

Amount in days that licenses will be valid for

product.image_attachment

object

product.file_attachment

string

Unique id of the file attachment for this product if the product type is FILE

product.youtube_link

string

The url for the YouTube video of the product

product.volume_discounts

object[]

Array of volume discounts

product.recurring_interval

enum<string>

At which frequency the customer is billed for product type SUBSCRIPTION

Available options:

DAY,

WEEK,

MONTH,

YEAR

product.recurring_interval_count

integer

How many recurring_interval before the customer is billed for product type SUBSCRIPTION

product.trial_period

enum<integer>

Defines a trial period before billing the customer for product type SUBSCRIPTION. Will be null if product is not a subsription

Available options:

0,

1

product.setup_cost

string

If the product is a subcription, this is the setup cost of the subscription

product.paypal_product_id

string

When a product SUBSCRIPTION is created and the gateway PAYPAL chosen, a PayPal product is automatically created on the connected account

product.paypal_plan_id

string

When a product SUBSCRIPTION is created and the gateway PAYPAL chosen, a PayPal plan is automatically created on the connected account

product.stripe_price_id

string

When a product SUBSCRIPTION is created and the gateway STRIPE chosen, a Stripe price is automatically created on the connected account

product.discord_integration

enum<integer>

Whether or not the discord integeration is enabled for this product

Available options:

0,

1

product.discord_optional

enum<integer>

Whether or not the discord integration is optional

Available options:

0,

1

product.discord_set_role

enum<integer>

Whether to give users a role when added to the discord server

Available options:

0,

1

product.discord_server_id

string

The id of the discord server the bot will add users to

product.discord_role_id

number

The role to give users when added by the discord integration

product.discord_remove_role

enum<integer>

Whether to remove a role from the user when added to the discord server

Available options:

0,

1

product.quantity_min

integer

Minimum quantity purchasable of this product

Required range: x > 1

product.quantity_max

integer

Maximum quantity purchasable of this product

Required range: x > -1

product.quantity_warning

integer

At which product quantity should we send a webhook and email warning the merchant

product.gateways

enum<string>[]

Available options:

PAYPAL,

STRIPE,

SKRILL,

PERFECT_MONEY,

CASH_APP,

BINANCE,

BITCOIN,

LITECOIN,

ETHEREUM,

BITCOIN_CASH,

NANO,

MONERO,

SOLANA,

RIPPLE,

BINANCE_COIN,

USDC,

USDT,

TRON,

BITCOIN_LN,

CONCORDIUM,

POLYGON,

PEPE,

DAI,

WETH,

APE,

SHIB,

USDC_NATIVE,

DOGECOIN,

PYTH,

BONK,

JUP,

JITO,

WEN,

RENDER,

MOBILE,

HNT

product.custom_fields

object[]

product.rcon_commands

string

Stringified array of the commands to be executed on the RCON server

product.rcon_execution_type

enum<string>

The type of execution for the RCON commands. Only applies to RCON products

Available options:

AUTOMATIC,

MANUAL

product.rcon_start_time

string

The time for when the RCON product should start

product.crypto_confirmations_needed

integer

Minimum number of confirmations for a crypto payment to be accepted

product.max_risk_level

integer

For PAYPAL and STRIPE, maximum risk level to accept payments in order to block fraud attempts

product.block_vpn_proxies

boolean

Block VPN and Proxy purchases if the gateway is PAYPAL or STRIPE

product.delivery_text

string

The text to be delivered to the customer after payment

product.delivery_time

integer

The timestamp for when the invoice was delivered

product.service_text

string

The text to be delivered to the customer after payment for a service

product.stock_delimiter

string

How to delimit the stock if product type is SERIALS, for example with stock_delimiter "," and serials value first,second; the stock would have two different serials "first" and "second"

product.stock

integer

Stock of the current product, can be -1 for unlimited stock

product.dynamic_webhook

object

product.bestseller

number

DEPRECATED

product.sort_priority

integer

Sort order of this product

product.unlisted

boolean

If unlisted is true, the product is not shown in the storefront but can be bought through a direct link

product.on_hold

boolean

If on_hold is true, the product cannot be bought but is shown in the storefront

product.terms_of_service

string

Text containing the product's terms of service

product.warranty

integer

Time, in seconds, of how much the warranty for this product lasts

product.warranty_text

string

Clear explanation of what the warranty covers

product.watermark_enabled

number

Whether sellix should add a watermark to your product image

product.watermark_text

string

The watermark to add to the product image

product.redirect_link

string

The url to redirect a customer to on successful payment

product.label_singular

string

product.label_plural

string

product.private

boolean

If private is true, the product is hidden on the storefront and cannot be bought with a direct link

product.created_at

integer

Timestamp for the creation of the product

product.updated_at

integer

Date, available if the product has been edited

product.updated_by

integer

User ID of the user who updated the product

product.marketplace_category_id

string

The category ID the product is a part of

product.telegram_group_id

string

The Telegram group ID

product.telegram_integration

enum<integer>

Whether or not the Telegram integration is enabled

Available options:

0,

1

product.telegram_optional

enum<integer>

Whether or not the Telegram integration is optional

Available options:

0,

1

product.name

string

The name of the product

product.image_name

string

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

product.image_storage

string

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

product.cloudflare_image_id

string

The ID of the image stored in cloudflare's CDN

product.image_attachments

object[]

product.feedback

object

product.categories

object[]

product.payment_gateways_fees

object[]

product.price_conversions

object

product.addons

array

product.country_regulations

string

The country ISO code that the business is located in

product.available_stripe_apm

object

product.serials

string[]

product.webhooks

string[]

product.theme

string

The current theme enabled on the Sellix storefront

product.dark_mode

enum<integer>

Whether or not dark mode is enabled on the Sellix storefront

Available options:

0,

1

product.ui_style_configuration

boolean

Whether or not the UI style configuration is enabled on the Sellix storefront

product.vat_percentage

string

The VAR percentage set for the store

product.tax_details

object

product.image_attachment_info

object

product.average_score

string

The average rating of the product

product.sold_count

number

The amount of sales for the product

total_conversions

any

theme

string

What Sellix theme the shop is set to

dark_mode

enum<integer>

1 if darkmode is enabled, 0 if it is disabled

Available options:

0,

1

crypto_mode

any

gateways_available

string[]

gateways available for the update invoice Developers API

country_regulations

string

The country the shop is opperated in

available_stripe_apm

object

serials

string[]

If product type is SERIALS, provide the serials linked to this invoice

shop_payment_gateways_fees

object[]

shop_payment_gateways_fees.id

integer

Internal ID of the resource

shop_payment_gateways_fees.shop_id

integer

The shop ID to which this gateway fee belongs

shop_payment_gateways_fees.gateway

enum<string>

The gateway of the gateway fee

Available options:

PAYPAL,

STRIPE,

SKRILL,

PERFECT_MONEY,

CASH_APP,

BINANCE,

BITCOIN,

LITECOIN,

ETHEREUM,

BITCOIN_CASH,

NANO,

MONERO,

SOLANA,

RIPPLE,

BINANCE_COIN,

USDC,

USDT,

TRON,

BITCOIN_LN,

CONCORDIUM,

POLYGON,

PEPE,

DAI,

WETH,

APE,

SHIB,

USDC_NATIVE,

DOGECOIN,

PYTH,

BONK,

JUP,

JITO,

WEN,

RENDER,

MOBILE,

HNT

shop_payment_gateways_fees.percent_amount

number

The percent amount of the gateway fee

shop_payment_gateways_fees.fixed_amount

number

The fixed amount of the gateway fee

shop_payment_gateways_fees.fixed_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

shop_payment_gateways_fees.active_type

enum<string>

The active type of the gateway fee

Available options:

PERCENT,

FIXED

shop_payment_gateways_fees.updated_at

string

DateTime, available if the gateway fee has been updated

shop_payment_gateways_fees.created_at

string

DateTime, available if the gateway fee has been created

shop_payment_gateways_fees.conversions

object

shop_paypal_credit_card

boolean

If true, the merchant has enabled purchase with Credit Card through PayPal

shop_force_paypal_email_delivery

boolean

If true, the merchant has enabled invoice shipment to the PayPal customer email

shop_walletconnect_id

any

original_developer_return_url

string

The original return url of the order

rates_snapshot

object

void_times

object[]

API Documentation

Information

Payments

Orders

Customers

Subscriptions 2.0

Subscriptions (legacy)

Licenses

Blacklists

Whitelists

Products

Categories

Groups

Coupons

Feedback

Queries