Function   /seller/auction/option/add

Function invocation

Function description

Inserts a new future auction into the system. A new future auction is created in the system with specified parameters.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
bin integer 0 Buy It Now price (deprecated, please use priceBuyNow parameter)
priceBuyNow float 0 Buy It Now price
check boolean false Only check for parameter correctness (deprecated and unused)
currency string "PLN" Auction currency
days integer YES Auction length in days
dutch boolean false Dutch auction (deprecated and unused)
hour integer YES Auction ending hour
name string YES Name of the domain to be listed in auction
price integer 0 Auction start price (deprecated, please use priceStart parameter)
priceStart float YES Auction start price
private boolean false Private auction
reserve integer 0 Minimum price (deprecated, please use priceMinimum parameter)
priceMinimum float 0 Minimum price
saleType string "vat" Possible sales document (vat - invoice with VAT only, novat - invoice with VAT or invoice without VAT, person - invoice with VAT or sale without document)
text string "" Auction description
useCode boolean false Use bonus code

Return value

Created auction id (integer value).