Function /seller/listing/list
Function invocation
https://json.aftermarket.pl/seller/listing/list
Function description
Returns the list of domains for sale listed on user account.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| active | integer | 0 | Group filter: 0 - all, 1 - active only, 2 - inactive only | |
| group | integer | 0 | Group filter: 0 - all, 1 - groups only, 2 - without groups | |
| idn | integer | 0 | IDN filter: 0 - all, 1 - IDN domain only, 2 - non-IDN domain only | |
| name | string | "" | String to search within domain names | |
| order | string | "name" | List sorting (can be sorted by name, time, price, offers, visits) | |
| string | "" | Text to be searched within domain names (deprecated and unused, please use 'name' parameter) | ||
| size | integer | 5000 | Page size | |
| start | integer | 0 | List start (for paging) | |
| integer | 0 | Sort type (deprecated and unused, please use 'order' parameter) | ||
| integer | 0 | Type of domains for search (deprecated and unused, please use 'active' parameter) | ||
| integer | 0 | Scope of search (deprecated and unused, please use 'group' paramater) |
Return value
The list of domains for sale (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 |