Guide to Query Params For the GET /orders endpoint, there are a few unique query parameters available for you to use. Here is a detailed example of how to use the query parameters to get the most out of our API.
The page and limit query parameters need to be positive integers.
The sort query parameter needs to be a comma separated list of key-value pairs such as created_at:ASC,type:ASC, where the key is a field described below, and the value is either ASC or DESC.
The filter query parameter needs to be a comma separated list of key-value pairs such as status:COMPLETED,type:PRODUCT, where the key is a field described below, and the value is a possible value for the respective field.
The search query parameter needs to be an email to search for all the invoices from.
Here are all the possible fields for the search and filter parameters: uniqid, recurring_billing_id, type, origin, shop_id, customer_id, product_id, affiliate_revenue_customer_id, gateway, blockchain, paypal_apm, stripe_apm, total, total_display, coupon_id, customer_email, paypal_payer_email, paypal_capture_id, paypal_subscription_id, stripe_id, stripe_invoice_id, binance_invoice_id, cashapp_note, crypto_address, status, void_details, created_at, updated_at
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The name of the store to perform actions on via the API
If pagination is desired, the page to fetch of the response
The number of resources to include in a page
How to sort the resources in the response
Which requirements to apply to returned resources
A specific value to search the response for
The status of the response
The total number of invoices returned
The total number of invoices on the store
data. total_invoices_filtered
The total number of invoices that matched the specified fitler
The current page if pagination was specified
The total amount of invoices to display per page
The filter to use against the invoices
The fields to sort the invoices by
The fields to search for in invoices
The total amount of fields returned
THe amount of time, in milliseconds, it took to retrieve the orders
Internal ID of the resource
Unique ID of the resource, used as reference across the API
Invoice total, unit_price*quantity where quantity is applicable
data.orders. total_display
Invoice total in the currency chosen
data.orders. exchange_rate
Exchange rate between currency chosen and USD
data.orders. crypto_exchange_rate
Exchange rate between the cryptocurrency chosen (if any) and USD
data.orders. product_variants
data.orders.product_variants. {product_id}
The id of the product the plan belongs to
data.orders.product_variants.{product_id}. price
The price of the product variant
data.orders.product_variants.{product_id}. title
The title of the product variant
data.orders.product_variants.{product_id}. description
The description of the product variant
data.orders.product_variants.{product_id}. price_conversions
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
The shop ID to which this invoice belongs
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
data.orders. customer_email
data.orders. paypal_email_delivery
If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email
Unique ID of the product linked to this invoice, if any
data.orders. product_title
Available options:
INFO_CARD,
SERVICE,
DYNAMIC,
FILE,
SERIALS,
GAMING_RCON,
SUBSCRIPTION,
SUBSCRIPTION_V2
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
DEPRECATED: Merchant PayPal email
data.orders. paypal_order_id
This field contains the PayPal order ID
This field is updated after the invoice is completed with the fee taken by PayPal over the invoice total
data.orders. paypal_payer_email
This field is updated after the invoice is completed with the PayPal's email used for the purchase
Skrill unique ID linked to the invoice
Skrill link to redirect the customer to
data.orders. perfectmoney_id
PerfectMoney payment ID linked to the invoice
data.orders. crypto_address
Cryptocurrency address linked to this invoice
data.orders. crypto_amount
Cryptocurrency amount converted based on crypto_exchange_rate
data.orders. crypto_received
Cryptocurrency amount received, paid by the customer
URI used to create the QRCODE
data.orders. crypto_confirmations_needed
Crypto confirmations needed to process the invoice
data.orders. cashapp_cashtag
CashApp cashtag used to create the QRCODE
Unique note for the customer to leave in the CashApp payment
data.orders. is_vpn_or_proxy
If true, a VPN or Proxy has been detected
Qauntity of product purchased
Unique ID of the coupon, if used, for the discount
If coupon_id is specified, coupon_code contains the code used during the checkout
data.orders. custom_fields
The custom fields passed by the user at checkout. The type is map<string, string>
data.orders. developer_invoice
If true, this invoice has been created through the Developers API
data.orders. developer_title
If a product_id is not passed through the Developers API, a title must be specified
data.orders. developer_webhook
Additional webhook URL to which updates regarding this invoice will be sent
data.orders. developer_return_url
If present, the customer will be redirected to this URL after the invoice has been paid
Available options:
PENDING,
COMPLETED,
VOIDED,
WAITING_FOR_CONFIRMATIONS,
PARTIAL,
CUSTOMER_DISPUTE_ONGOING,
REVERSED,
REFUNDED,
WAITING_SHOP_ACTION,
PROCESSING
data.orders. status_details
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
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
If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice
data.orders. fee_percentage
What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees
data.orders. fee_breakdown
data.orders.fee_breakdown. service_fee
data.orders.fee_breakdown.service_fee. amount
The amount of the service fee
data.orders.fee_breakdown.service_fee. 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.orders.fee_breakdown.service_fee. breakdown
data.orders.fee_breakdown. aml_analysis
data.orders.fee_breakdown.aml_analysis. amount
The amount of the service fee
data.orders.fee_breakdown.aml_analysis. 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.orders.fee_breakdown.aml_analysis. breakdown
data.orders.fee_breakdown. platform_fee
data.orders.fee_breakdown.platform_fee. amount
The amount of the service fee
data.orders.fee_breakdown.platform_fee. 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.orders.fee_breakdown.platform_fee. breakdown
DEPRECATED: Day value, number
DEPRECATED: First three letters of the day name
DEPRECATED: First three letters of the month name
Timestamp for the creation of the invoice
Date, available if the blacklist has been edited
User ID of the user who updated the invoice
data.orders. is_evm_approved
Whether or not the EVM transaction is approved
Whether or not a fee was billed to the customer
data.orders. crypto_scheduled_payout
If the payout for this invoice is SCHEDULED and not INSTANT and a cryptocurrency gateway is used, once the payout has been sent this field will contain additional info on it
data.orders.crypto_scheduled_payout. amount
Cryptocurrency amount sent in the payout transaction
data.orders.crypto_scheduled_payout. transaction_output
Total output of the transaction, equals to amount-transaction_fee-service_fee
data.orders.crypto_scheduled_payout. shop_cut
Equal to transaction_output
data.orders.crypto_scheduled_payout. transaction_fee
data.orders.crypto_scheduled_payout. service_fee
data.orders.crypto_scheduled_payout. tx
data.orders.crypto_scheduled_payout. created_at
Timestamp for when the transaction was broadcast
data.orders. shop_paypal_credit_card
Whether or not to support credit cards on PayPal
data.orders. shop_force_paypal_email_delivery
Whether or not to deliver the product to the PayPal email address
