Update Orders
Update information for a specific order
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The name of the store to perform actions on via the API
Path Parameters
Uniqid of the resource
Body
The city the address is located in
The ISO country code country the address is located in
The address line of the the order
The zipcode for the address
The state the address is located
If null, the customer will be asked automatically to choose a gateway on the Sellix hosted /payment page. If product_id is specified, the gateway must be on in the product's gateways array
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
The name of the recipient for the order
If gateway is PAYPAL, a paypal_apm (PayPal Alternative Payment Method) can be specified. To retrieve the available PayPal APM for a specific customer session, please refer to the PayPal SDK using window.paypal.FUNDING and fundingSource to filter out available methods. You can also use our documentation on how to process white_label payments
bancontact
, eps
, trustly
, mercado
, paylater
, sepa
, venmo
, blik
, giropay
, ideal
, mybank
, sofort
, przelewy24
, credit
Stripe Alternative Payment Method name, such as iDEAL, used if gateway is STRIPE
afterpay_clearpay
, alipay
, bancontact
, au_becs_debit
, boleto
, eps
, fpx
, giropay
, grabpay
, ideal
, klarna
, oxxo
, p24
, sofort
, wechat_pay
The surname of the recipient for the order
Response
ID of the affiliate
Asset of the AML transaction
AML transaction asset list
Blockchain of the AML transaction
Actor ID
Entity category
Is after the sanction date
Is the primary entity
Is a VASP
Entity name
Timestamp for the AML transaction creation date
AML transaction error
AML transaction hash
AML transaction ID
Unique ID of the invoice this AML transaction is linked to
Origin of the AML transaction
AML transaction output address
AML transaction output type
AML transaction risk score
Shop ID linked to this AML transaction
Type of the AML transaction
The crypto address that was approved
The allowance of the approved address
The blockchain of the crypto currency
ERC20
, BEP20
, TRC20
, MATIC
, SOL
The coin of the approved address
Timestamp, available if the approved address has been created
Internal ID of the resource
The recurring billing ID of the approval
The transaction ID of the approval
Timestamp, available if the approved address has been updated
If invoice type is MONTHLY_BILL, contains a breakdown of the fees that need to be collected
Checkout URL for Binance invoice
ID for binance invoice
Full Binance QRCODE string
The blockchain of the crypto currency
ERC20
, BEP20
, TRC20
, MATIC
, SOL
The amount of the discount applied to the bundle
The type of discount applied to the bundle
PERCENTAGE
, FIXED
Internal ID of the resource
The product IDs of the products in the bundle
The shop ID to which this bundle belongs
The title of the bundle
Unique ID of the bundle, used as reference across the API
Timestamp, available if the bundle has been updated
CashApp cashtag used to create the QRCODE
Whether or not cashapp email is configured
Unique note for the customer to leave in the CashApp payment
Full CashApp QRCODE 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
Customer country
The country the shop is opperated in
Unique ID of the coupon, if used, for the discount
Timestamp for the creation of the invoice
Cryptocurrency address linked to this invoice
Cryptocurrency amount converted based on crypto_exchange_rate
Crypto confirmations needed to process the invoice
Exchange rate between the cryptocurrency chosen (if any) and USD
If true, an instant payout for this invoice's cryptocurrency address has been sent
Cryptocurrency amount received, paid by the customer
If true, a scheduled payout for this invoice's cryptocurrency address has been sent
Crypto transactions received to fulfill this invoice
Asset of the AML transaction
AML transaction asset list
Blockchain of the AML transaction
Timestamp for the AML transaction creation date
AML transaction error
AML transaction evaluation detail
AML transaction hash
AML transaction ID
Unique ID of the invoice this AML transaction is linked to
Origin of the AML transaction
AML transaction output address
AML transaction output type
AML transaction risk score
Shop ID linked to this AML transaction
Type of the AML transaction
Crypto transaction confirmations, not updated once the invoice status is COMPLETED or VOIDED
Timestamp for the crypto transaction reception date
Crypto amount sent in the transaction
Crypto transaction hash
Crypto transaction update date
URI used to create the QRCODE
Available currency
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 custom fields passed by the user at checkout. The type is map<string, string>
Email of the customer
ID of the customer
1 if darkmode is enabled, 0 if it is disabled
0
, 1
DEPRECATED: First three letters of the day name
DEPRECATED: Day value, number
If true, this invoice has been created through the Developers API
If present, the customer will be redirected to this URL after the invoice has been paid
If a product_id is not passed through the Developers API, a title must be specified
Additional webhook URL to which updates regarding this invoice will be sent
If a coupon or volume_discount is used, the discount value presents the total amount of discount over the total cost of the invoice
Representation of how discount was applied to invoice
Exchange rate between currency chosen and USD
If true, the Sellix fee_percentage has already been collected
The amount of the service fee
Available currency
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 amount of the service fee
Available currency
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 amount of the service fee
Available currency
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
What cut does Sellix take out of the total. To learn more about Sellix fees please refer to https://sellix.io/fees
Gateway chosen for this invoice. If null, the customer will be asked for a gateway in the Sellix hosted invoice page
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
gateways available for the update invoice Developers API
Internal ID of the resource
Customer IP
Additional info on the customer IP
IP abuse velocity
If true, the IP has an active TOR connection
If true, the IP has an active VPN connection
ISP ASN
If true, the IP has been recently detected as a BOT
Customer device browser
IP city
Customer connection type
IP country code
Customer device brand
Customer device model
IP Fraud Score details
987 < x < 100
ISP host
If true, the IP has been recently detected as a crawler
IP ISP
IP latitude
IP longitude
Any other details linked to this IP
If true, the customer used a mobile device
Customer device operating system
IP organization
If true, the IP has been recently detected using a proxy
If true, the IP has been recently detected in an online abuse
IP region
IP request ID used for internal reference
IP info retrieved successfully
Customer timezone
If true, the IP has been recently detected using TOR
If true, the IP has been recently detected using a VPN
If detected, customer ZIP code
If true, a VPN or Proxy has been detected
DEPRECATED
DEPRECATED
True if the product is of type LICENSE
Customer location
DEPRECATED: First three letters of the month name
Name of the merchant
How the invoice was created
STOREFRONT
, API
The original return url of the order
DEPRECATED
The ID for the payment link, if invoice was created by a payment link
DEPRECATED
PayPal Alternative Payment Method name, such as iDEAL, used if gateway is PAYPAL
Timestamp for the creation of the dispute
Unique ID of the resource, used as reference across the API
Unique ID of the invoice linked to this dispute
The stage in the dispute lifecycle
INQUIRY
, ARBITRATION
, CHARGEBACK
, PRE_ARBITRATION
The content of the dispute message
Timestamp for when the message was sent
Indicates whether the customer, merchant, or dispute arbiter posted the message
BUYER
, ARBITER
, SELLER
When a dispute it’s solved, its outcome is updated
RESOLVED_BUYER_FAVOUR
, CANCELED_BY_BUYER
, RESOLVED_SELLER_FAVOUR
, ACCEPTED
, RESOLVED_WITH_PAYOUT
, DENIED
, NONE
The dispute reason is why the customer has opened a dispute against your order
MERCHANDISE_OR_SERVICE_NOT_RECEIVED
, INCORRECT_AMOUNT
, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED
, PAYMENT_BY_OTHER_MEANS
, UNAUTHORISED
, CANCELED_RECURRING_BILLING
, CREDIT_NOT_PROCESSED
, PROBLEM_WITH_REMITTANCE
, DUPLICATE_TRANSACTION
, OTHER
Within which date the seller needs to respond
The shop ID to which this paypal dispute belongs
Each dispute is automatically updated when we receive an update from PayPal, the status indicates how it is going
OPEN
, UNDER_REVIEW
, WAITING_FOR_BUYER_RESPONSE
, RESOLVED
, WAITING_FOR_SELLER_RESPONSE
, OTHER
When the dispute was updated
Merchant PayPal email
If true and gateway is PAYPAL, the product will be shipped to the PayPal email on record instead of the customer email
This field is updated after the invoice is completed with the fee taken by PayPal over the invoice total
This field contains the PayPal order ID
This field is updated after the invoice is completed with the PayPal's email used for the purchase
ID of the paypal subscription
Link for the merchant to purchase the subscription from
PerfectMoney payment ID linked to the invoice
The percentage of revenue to give to affiliates. -1 for disabled, 0 for default (10%), other number for a custom percent
The average rating of the product
DEPRECATED
Block VPN and Proxy purchases if the gateway is PAYPAL or STRIPE
The ID of the image stored in cloudflare's CDN
The country ISO code that the business is located in
Timestamp for the creation of the product
Minimum number of confirmations for a crypto payment to be accepted
Available currency
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
Default value if the customer leaves the input empty
Custom field name displayed to the customer
Placeholder for the custom field input
Regex that the custom field value must match
Whether or not this custom field is required to proceed with the purchase
Type of the custom field
text
, hidden
, number
, largetextbox
, checkbox
Whether or not dark mode is enabled on the Sellix storefront
0
, 1
The text to be delivered to the customer after payment
The timestamp for when the invoice was delivered
Product description
Whether or not the discord integeration is enabled for this product
0
, 1
Whether or not the discord integration is optional
0
, 1
Whether to remove a role from the user when added to the discord server
0
, 1
The role to give users when added by the discord integration
The id of the discord server the bot will add users to
Whether to give users a role when added to the discord server
0
, 1
Count of negative feedback
Count of neutral feedback
Count of positive feedback
Count of all the feedback
Unique id of the file attachment for this product if the product type is FILE
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
Internal ID of the resource
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
Timestamp for the creation of the image
png
, webp
, jpg
, jpeg
, avif
, gif
Internal ID of the resource
The shop ID to which this resource belongs
PRODUCTS
IMAGE
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
Timestamp for the creation of the image
png
, webp
, jpg
, jpeg
, avif
, gif
Internal ID of the resource
The shop ID to which this resource belongs
PRODUCTS
IMAGE
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
Timestamp for the creation of the image
png
, webp
, jpg
, jpeg
, avif
, gif
Internal ID of the resource
The shop ID to which this resource belongs
PRODUCTS
IMAGE
DEPRECATED: The name of the product image with the file type
Where the image is stored in Sellix's self-hosted CDN
Amount in days that licenses will be valid for
Whether product licenses are generated on successful payments
0
, 1
The category ID the product is a part of
For PAYPAL and STRIPE, maximum risk level to accept payments in order to block fraud attempts
The name of the product
If on_hold is true, the product cannot be bought but is shown in the storefront
Whether or not pay-what-you-want pricing is enabled
0
, 1
DEPRECATED
PERCENT
, FIXED
Datetime for the creation of the resource
Available currency
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
Payment gateway this payment method is used for
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
Internal ID of the resource
The shop ID to which this resource belongs
When a product SUBSCRIPTION is created and the gateway PAYPAL chosen, a PayPal plan is automatically created on the connected account
When a product SUBSCRIPTION is created and the gateway PAYPAL chosen, a PayPal product is automatically created on the connected account
Product price
The price of the product variant in AUD
The price of the product variant in BGN
The price of the product variant in BRL
A list of the price of the product variant in various cryptocurrencies
The price of the product variant in ZAR
The discount price on the purchased goods
Product price in currency
Variants in pricing for the product
If private is true, the product is hidden on the storefront and cannot be bought with a direct link
Maximum quantity purchasable of this product
x > -1
Minimum quantity purchasable of this product
x > 1
At which product quantity should we send a webhook and email warning the merchant
Stringified array of the commands to be executed on the RCON server
The type of execution for the RCON commands. Only applies to RCON products
AUTOMATIC
, MANUAL
The time for when the RCON product should start
At which frequency the customer is billed for product type SUBSCRIPTION
DAY
, WEEK
, MONTH
, YEAR
How many recurring_interval before the customer is billed for product type SUBSCRIPTION
The url to redirect a customer to on successful payment
The text to be delivered to the customer after payment for a service
If the product is a subcription, this is the setup cost of the subscription
The shop ID to which this resource belongs
The slug used to navigate to the product page on a storefront
The amount of sales for the product
Sort order of this product
Stock of the current product, can be -1 for unlimited stock
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"
When a product SUBSCRIPTION is created and the gateway STRIPE chosen, a Stripe price is automatically created on the connected account
Product subtype, can be used only with type SUBSCRIPTION
SERVICE
, DYNAMIC
, FILE
, SERIALS
0
, 1
0
, 1
0
, 1
0
, 1
0
, 1
The Telegram group ID
Whether or not the Telegram integration is enabled
0
, 1
Whether or not the Telegram integration is optional
0
, 1
Text containing the product's terms of service
The current theme enabled on the Sellix storefront
Product title
Defines a trial period before billing the customer for product type SUBSCRIPTION. Will be null if product is not a subsription
0
, 1
Product type
INFO_CARD
, SERVICE
, DYNAMIC
, FILE
, SERIALS
, GAMING_RCON
, SUBSCRIPTION
, SUBSCRIPTION_V2
Whether or not the UI style configuration is enabled on the Sellix storefront
Unique ID of the resource, used as reference across the API
If unlisted is true, the product is not shown in the storefront but can be bought through a direct link
Date, available if the product has been edited
User ID of the user who updated the product
The VAR percentage set for the store
Array of volume discounts
How much of this product needs to be purchased in order to be eligible for this volume discount
Whether the discount value is a percentage or a fixed amount
PERCENTAGE
, FIXED
Value of a percentage or fixed discount
Time, in seconds, of how much the warranty for this product lasts
Clear explanation of what the warranty covers
Whether sellix should add a watermark to your product image
The watermark to add to the product image
The url for the YouTube video of the product
Available currency
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 description of the product addon
Internal ID of the resource
The price of the product addon
The product types for the product addon
The shop ID to which this addon belongs
The title of the product addon
Unique id of the resouce. The id for external usage through the API
Timestamp, available if the download has been created
The country of the customer that downloaded the product
The IP of the customer that downloaded the product
The ISP of the customer that downloaded the product
The timezone of the customer that downloaded the product
Internal ID of the resource
Unique ID of the invoice this download is linked to
Unique ID of the product linked to this invoice, if any
Product title
Product type
INFO_CARD
, SERVICE
, DYNAMIC
, FILE
, SERIALS
, GAMING_RCON
, SUBSCRIPTION
, SUBSCRIPTION_V2
The id of the product the plan belongs to
The description of the product variant
The price of the product variant
The title of the product variant
Qauntity of product purchased
Unique ID of the recurring bill
Available currency
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
Available currency
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
Creation date of the invoice
Timestamp for when resource was last updated
An internal Sellix secret used for completing tasks with our internal API
If product type is SERIALS, provide the serials linked to this invoice
If the product type is SERVICE, this field contains additional details on the type of service provided by the merchant
If true, the merchant has enabled invoice shipment to the PayPal customer email
The shop ID to which this invoice belongs
DEPRECATED: Unique id of the image attachment for this merchant with the image extension included
Where the image is stored in Sellix's self-hosted CDN
PRODUCTS
, SHOPS
The active type of the gateway fee
PERCENT
, FIXED
The price of the product variant in AUD
The price of the product variant in BGN
The price of the product variant in BRL
A list of the price of the product variant in various cryptocurrencies
The price of the product variant in ZAR
DateTime, available if the gateway fee has been created
The fixed amount of the gateway fee
Available currency
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 gateway of the gateway fee
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
Internal ID of the resource
The percent amount of the gateway fee
The shop ID to which this gateway fee belongs
DateTime, available if the gateway fee has been updated
If true, the merchant has enabled purchase with Credit Card through PayPal
Merchant Skrill email
Skrill link to redirect the customer to
Skrill unique ID linked to the invoice