Search
K
[dev] 🇫🇷 Classifieds Management V3

the currency used for all the prices.

string

the currency must be entered as ISO 4217 currency code.
Please refer to https://www.iso.org/iso-4217-currency-codes.html
Last checked: October 1st, 2021
Here are the alphabetic three-letter country codes:

  • AED: UAE Dirham
  • AFN: Afghani
  • ALL: Lek
  • AMD: Armenian Dram
  • ANG: Netherlands Antillean Guilder
  • AOA: Kwanza
  • ARS: Argentine Peso
  • AUD: Australian Dollar
  • AWG: Aruban Florin
  • AZN: Azerbaijan Manat
  • BAM: Convertible Mark
  • BBD: Barbados Dollar
  • BDT: Taka
  • BGN: Bulgarian Lev
  • BHD: Bahraini Dinar
  • BIF: Burundi Franc
  • BMD: Bermudian Dollar
  • BND: Brunei Dollar
  • BOB: Boliviano
  • BOV: Mvdol
  • BRL: Brazilian Real
  • BSD: Bahamian Dollar
  • BTN: Ngultrum
  • BWP: Pula
  • BYN: Belarusian Ruble
  • BZD: Belize Dollar
  • CAD: Canadian Dollar
  • CDF: Congolese Franc
  • CHE: WIR Euro
  • CHF: Swiss Franc
  • CHW: WIR Franc
  • CLF: Unidad de Fomento
  • CLP: Chilean Peso
  • CNY: Yuan Renminbi
  • COP: Colombian Peso
  • COU: Unidad de Valor Real
  • CRC: Costa Rican Colon
  • CUC: Peso Convertible
  • CUP: Cuban Peso
  • CVE: Cabo Verde Escudo
  • CZK: Czech Koruna
  • DJF: Djibouti Franc
  • DKK: Danish Krone
  • DOP: Dominican Peso
  • DZD: Algerian Dinar
  • EGP: Egyptian Pound
  • ERN: Nakfa
  • ETB: Ethiopian Birr
  • EUR: Euro
  • FJD: Fiji Dollar
  • FKP: Falkland Islands Pound
  • GBP: Pound Sterling
  • GEL: Lari
  • GHS: Ghana Cedi
  • GIP: Gibraltar Pound
  • GMD: Dalasi
  • GNF: Guinean Franc
  • GTQ: Quetzal
  • GYD: Guyana Dollar
  • HKD: Hong Kong Dollar
  • HNL: Lempira
  • HRK: Kuna
  • HTG: Gourde
  • HUF: Forint
  • IDR: Rupiah
  • ILS: New Israeli Sheqel
  • INR: Indian Rupee
  • IQD: Iraqi Dinar
  • IRR: Iranian Rial
  • ISK: Iceland Krona
  • JMD: Jamaican Dollar
  • JOD: Jordanian Dinar
  • JPY: Yen
  • KES: Kenyan Shilling
  • KGS: Som
  • KHR: Riel
  • KMF: Comorian Franc
  • KPW: North Korean Won
  • KRW: Won
  • KWD: Kuwaiti Dinar
  • KYD: Cayman Islands Dollar
  • KZT: Tenge
  • LAK: Lao Kip
  • LBP: Lebanese Pound
  • LKR: Sri Lanka Rupee
  • LRD: Liberian Dollar
  • LSL: Loti
  • LYD: Libyan Dinar
  • MAD: Moroccan Dirham
  • MDL: Moldovan Leu
  • MGA: Malagasy Ariary
  • MKD: Denar
  • MMK: Kyat
  • MNT: Tugrik
  • MOP: Pataca
  • MRU: Ouguiya
  • MUR: Mauritius Rupee
  • MVR: Rufiyaa
  • MWK: Malawi Kwacha
  • MXN: Mexican Peso
  • MXV: Mexican Unidad de Inversion (UDI)
  • MYR: Malaysian Ringgit
  • MZN: Mozambique Metical
  • NAD: Namibia Dollar
  • NGN: Naira
  • NIO: Cordoba Oro
  • NOK: Norwegian Krone
  • NPR: Nepalese Rupee
  • NZD: New Zealand Dollar
  • OMR: Rial Omani
  • PAB: Balboa
  • PEN: Sol
  • PGK: Kina
  • PHP: Philippine Peso
  • PKR: Pakistan Rupee
  • PLN: Zloty
  • PYG: Guarani
  • QAR: Qatari Rial
  • RON: Romanian Leu
  • RSD: Serbian Dinar
  • RUB: Russian Ruble
  • RWF: Rwanda Franc
  • SAR: Saudi Riyal
  • SBD: Solomon Islands Dollar
  • SCR: Seychelles Rupee
  • SDG: Sudanese Pound
  • SEK: Swedish Krona
  • SGD: Singapore Dollar
  • SHP: Saint Helena Pound
  • SLL: Leone
  • SOS: Somali Shilling
  • SRD: Surinam Dollar
  • SSP: South Sudanese Pound
  • STN: Dobra
  • SVC: El Salvador Colon
  • SYP: Syrian Pound
  • SZL: Lilangeni
  • THB: Baht
  • TJS: Somoni
  • TMT: Turkmenistan New Manat
  • TND: Tunisian Dinar
  • TOP: Pa’anga
  • TRY: Turkish Lira
  • TTD: Trinidad and Tobago Dollar
  • TWD: New Taiwan Dollar
  • TZS: Tanzanian Shilling
  • UAH: Hryvnia
  • UGX: Uganda Shilling
  • USD: US Dollar
  • USN: US Dollar (Next day)
  • UYI: Uruguay Peso en Unidades Indexadas (UI)
  • UYU: Peso Uruguayo
  • UYW: Unidad Previsional
  • UZS: Uzbekistan Sum
  • VED: Bolívar Soberano
  • VES: Bolívar Soberano
  • VND: Dong
  • VUV: Vatu
  • WST: Tala
  • XAF: CFA Franc BEAC
  • XAG: Silver
  • XAU: Gold
  • XBA: Bond Markets Unit European Composite Unit (EURCO)
  • XBB: Bond Markets Unit European Monetary Unit (E.M.U.-6)
  • XBC: Bond Markets Unit European Unit of Account 9 (E.U.A.-9)
  • XBD: Bond Markets Unit European Unit of Account 17 (E.U.A.-17)
  • XCD: East Caribbean Dollar
  • XDR: SDR (Special Drawing Right)
  • XOF: CFA Franc BCEAO
  • XPD: Palladium
  • XPF: CFP Franc
  • XPT: Platinum
  • XSU: Sucre
  • XTS: Codes specifically reserved for testing purposes
  • XUA: ADB Unit of Account
  • XXX: The codes assigned for transactions where no currency is involved
  • YER: Yemeni Rial
  • ZAR: Rand
  • ZMW: Zambian Kwacha
  • ZWL: Zimbabwe Dollar

Allowed values:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWL

Default:EUR

Example

PriceCommon

object

common fields for all prices

* Additional properties are NOT allowed.
amountnumber

amount of the select priceType

>= 0

Example:950

vatValuenumber

the vat value in currency

>= 0

Example:1000

vatPercentnumber

the vat value in percent

>= 0<= 100

Example:19.6

isVatIncludedboolean

vat is included in the price

Example

PriceInformation

object
priceInformationstring
  • PRICE_ON_DEMAND: specific flag for displaying this price on the
    portal/website. If PRICE_ON_DEMAND is chosen, the price MUST NOT
    be shown! It may only be used as search price!
  • BASIS_FOR_NEGOTIATION: the price is not fixed, it is negotiable.
    If the price is FIXED, priceInformation should not be sent.

Allowed values:PRICE_ON_DEMANDBASIS_FOR_NEGOTIATION

Example:PRICE_ON_DEMAND

Example

Orientation

string

cardinal and ordinal geographical directions

Allowed values:NORTHEASTSOUTHWESTNORTH_EASTSOUTH_EASTNORTH_WESTSOUTH_WESTEAST_WESTSOUTH_NORTH

Example

EstateType

string

the general type of the property.
To classify it in detail, please use the subtypes.
descriptions for the enums above:

  • HOUSE: a building where people live in
  • APARTMENT: a set of rooms for living in within a building; a flat
  • PLOT: a piece of land
  • OFFICE: a room, set of rooms, or building where the business of a
    commercial or industrial organization or of a professional
    person is conducted. also medical offices are included here.
  • TRADING: all kind of properties concerning trading, retail
    and whole sale
  • GASTRONOMY_HOTEL: all kind of properties concerning the hotel
    and catering industry
  • STORAGE_PRODUCTION: an industrial or production site, warehouse,
    storage unit or building
  • AGRICULTURE_FORESTRY: all kind of properties concerning
    agriculture and forestry in the broadest sense
  • PARKING: all parking relevant properties for any kind of vehicles
  • SENIOR: senior-oriented living properties
  • PROJECT: usually a project is made up of more single properties,
    like a multi family house and often it is not finished yet but
    planned or under construction
  • MISCELLANEOUS: every other kind of property that can not be
    classified into the other estateTypes

Allowed values:HOUSEAPARTMENTPLOTOFFICETRADINGGASTRONOMY_HOTELSTORAGE_PRODUCTIONAGRICULTURE_FORESTRYPARKINGSENIORPROJECTMISCELLANEOUS

Example