Function /seller/listing/set
Function invocation
https://json.aftermarket.pl/seller/listing/set
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:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| 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 | |
| boolean | false | Only check for parameter correctness (deprecated and unused) | ||
| currency | string | PLN | Price currency | |
| string | "" | Domain language (deprecated and unused) | ||
| description | string | "" | Domain description | |
| 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 | |
| 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) | |
| float | 0 | Price reseller (deprecated and unused) | ||
| float | 0 | Commision in percentage of buy now price per month of domain lease (deprecated and unused) | ||
| 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 name | Type | Description |
|---|---|---|
| active | boolean | Domain is set for sale |
| integer | Allegro auction identifier (deprecated and unused) | |
| integer | Number of bids in an auction (deprecated and unused) | |
| integer | Auction Buy Now price (deprecated and unused) | |
| string | Auction currency (deprecated and unused) | |
| boolean | Auction is dutch (deprecated and unused) | |
| integer | Auction end time as an Unix timestamp (deprecated and unused) | |
| integer | Auction identifier (deprecated and unused) | |
| integer | Current price in an auction (deprecated and unused) | |
| boolean | Auction has reserve price (deprecated and unused) | |
| integer | Auction start time as an Unix timestamp (deprecated and unused) | |
| 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 |
| boolean | Category 1 editable (deprecated and unused) | |
| boolean | Category 2 editable (deprecated and unused) | |
| boolean | Category 3 editable (deprecated and unused) | |
| boolean | Category 4 editable (deprecated and unused) | |
| string | Categories editable (deprecated and unused) | |
| currency | string | Listing currency |
| earnings | float | Earnings |
| earningsCurrency | string | Earnings currency |
| featured | boolean | Listing is featured |
| integer | Group sale ID (deprecated and unused) | |
| homepage | boolean | Domain is promoted on homepage |
| boolean | Is domain registered with Aftermarket.pl (deprecated and unused) | |
| listingId | integer | Listing identifier |
| string | External Make Offer Url (deprecated and unused) | |
| integer | Domain transfer method (deprecated and unused) | |
| 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 |
| integer | The domain is currently being rented (deprecated and unused) | |
| string | Marketplace portal where the auction is visible (deprecated and unused) | |
| price | float | Current domain price |
| 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 |
| string | Listing status (deprecated and unused) | |
| time | integer | Listing date as an Unix timestamp |
| string | Domain typo detection (deprecated and unused) | |
| 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 |