Function   /seller/listing/set

Function invocation

Function description

Sets domain for sale. NOTE! This function may adjust the domain prices if they are too high. Therefore you must always check the returned object to see what prices have been set..

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
active boolean YES Set the domain for sale
cat1 string "" First category identifier
cat2 string "" Second category identifier
cat3 string "" Third category identifier
cat4 string "" Fourth category identifier
check boolean false Only check for parameter correctness (deprecated and unused)
currency string PLN Price currency
language string "" Domain language (deprecated and unused)
description string "" Domain description
minPrice float 0 Minimum price (deprecated, please use 'priceMinimum' parameter)
name string YES Domain name. If a few domains will be typed, then they will be grouped. Domains need to be separated by commas
portal string "" Portal where the auction will be visible (deprecated and unused)
price float 0 Buy It Now price (if 0 then Buy it Now price will be disabled)
priceReseller float 0 Price reseller (deprecated and unused)
rental_percentage float 0 Commision in percentage of buy now price per month of domain lease (deprecated and unused)
rental_rule_id integer 0 Rental rule id (deprecated and unused)
priceMinimum float 0 Minimum price, offers below it will be automatically rejected (if 0 then minimum price will be disabled)
priceRental float 0 Monthly rental cost
hirePlanId integer 0 Hire plan identifier
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)

Return value

Listing data (list of structures with the following fields):

Field nameTypeDescription
active boolean Domain is set for sale
allegroId integer Allegro auction identifier (deprecated and unused)
auctionBids integer Number of bids in an auction (deprecated and unused)
auctionBinPrice integer Auction Buy Now price (deprecated and unused)
auctionCurrency string Auction currency (deprecated and unused)
auctionDutch boolean Auction is dutch (deprecated and unused)
auctionEndTime integer Auction end time as an Unix timestamp (deprecated and unused)
auctionId integer Auction identifier (deprecated and unused)
auctionPrice integer Current price in an auction (deprecated and unused)
auctionReserve boolean Auction has reserve price (deprecated and unused)
auctionStartTime integer Auction start time as an Unix timestamp (deprecated and unused)
buyNowURL string External Buy It Now URL (deprecated and unused)
cat1 string Category 1
cat2 string Category 2
cat3 string Category 3
cat4 string Category 4
cat5 string Category 5
cat6 string Category 6
cat7 string Category 7
cat8 string Category 8
cat9 string Category 9
cat1Editable boolean Category 1 editable (deprecated and unused)
cat2Editable boolean Category 2 editable (deprecated and unused)
cat3Editable boolean Category 3 editable (deprecated and unused)
cat4Editable boolean Category 4 editable (deprecated and unused)
categoriesEditable string Categories editable (deprecated and unused)
currency string Listing currency
earnings float Earnings
earningsCurrency string Earnings currency
featured boolean Listing is featured
groupSaleId integer Group sale ID (deprecated and unused)
homepage boolean Domain is promoted on homepage
internal boolean Is domain registered with (deprecated and unused)
listingId integer Listing identifier
makeOfferURL string External Make Offer Url (deprecated and unused)
method integer Domain transfer method (deprecated and unused)
minprice float Minimum price (deprecated, offer minimum price is now given in 'priceMinimum' field)
priceMinimum float Minimum price (only for listings)
name string Domain name
nameIDN string Domain name (internationalized)
note string Domain description
offers integer Number of received offers
pendingRental integer The domain is currently being rented (deprecated and unused)
portal string Marketplace portal where the auction is visible (deprecated and unused)
price float Current domain price
priceReseller integer Domain price on reseller sites (deprecated and unused)
priceRental float Monthly rental cost
hirePlanId integer Hire plan identifier
saleType boolean Sale document type (vat - invoice with VAT only, novat - invoice with VAT or invoice without VAT, person - invoice with VAT or sale without document)
sellerId string Seller identifier
status string Listing status (deprecated and unused)
time integer Listing date as an Unix timestamp
typo string Domain typo detection (deprecated and unused)
utfname string Domain name (internationalized) (deprecated, this value is given in 'nameIDN' field)
views integer Number of listing views in past 30 days
visits integer Number of domain visits in past 30 days