{"id":472,"date":"2023-12-11T12:46:46","date_gmt":"2023-12-11T12:46:46","guid":{"rendered":"https:\/\/olxdoc.wpenginepowered.com\/?p=472"},"modified":"2023-12-11T12:46:46","modified_gmt":"2023-12-11T12:46:46","slug":"advert-payload-and-validation-rules","status":"publish","type":"post","link":"https:\/\/doc.olxgroup.com\/api\/?p=472","title":{"rendered":"Advert payload and validation rules"},"content":{"rendered":"\n\n\t
\n

Advert payload and validation rules<\/h1>\n<\/header>\n
\n

Below you can check the structure of an advert payload, a description of each field, and each field validation rules.<\/p>\n

 <\/p>\n<\/section>\n

Advert additional information<\/h2>\n

This table describes only the main structure of the advert. In addition to this, an advert can also contain a number of attributes and\/or characteristics.
Which can be consulted in the\u00a0Taxonomy API<\/a>.<\/p>\n\tFor a complete example of what an advert looks like, check out our\u00a0Postman Collection<\/a>.
\nAlso, you can check out the example under\u00a0Publishing Adverts<\/a>.\n

Advert Payload and Validation Rules<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nDescription<\/th>\nRequired<\/th>\nValidation<\/th>\n<\/tr>\n<\/thead>\n
title<\/td>\nTitle of the advert.<\/td>\nRequired<\/td>\nstring
\n70 chars max (Imovirtual.pt, Storia.ro)
\n50 chars max (Otodom.pl)
\n5 chars min
\n(publication fails if limits are exceeded, title is not truncated). Title should not contain uppercase string.<\/td>\n<\/tr>\n
description<\/td>\nDescription of the advert.<\/td>\nRequired<\/td>\nstring
\n65535 chars max
\n50 chars min<\/td>\n<\/tr>\n
category_urn<\/td>\nURN of the advert category.<\/td>\nRequired<\/td>\nUnique category identifier (see\u00a0Taxonomy API<\/a>)<\/td>\n<\/tr>\n
contact.name<\/td>\nName of the contact person for advert customization<\/td>\nRequired<\/td>\nstring<\/td>\n<\/tr>\n
contact.phone<\/td>\nPhone number of contact person for advert customization.<\/td>\nRequired<\/td>\nstring
\n7 digits min
\n14 digits max<\/td>\n<\/tr>\n
contact.email<\/td>\nE-mail number of the contact person for advert customization.<\/td>\nRequired<\/td>\nstring with a valid e-mail address<\/td>\n<\/tr>\n
contact.photo<\/td>\nPhoto of the contact person for advert customization.<\/td>\nOptional<\/td>\nstring with a valid url of an image
\nmax: 1MB
\nmin width: 100px
\nmin height: 100px<\/td>\n<\/tr>\n
price<\/td>\nPrice value of the advert.<\/td>\nRequired<\/td>\nint or float
\n0 (zero) to hide price and display it as “on demand”, except for investments category.<\/td>\n<\/tr>\n
price.currency<\/td>\nPrice currency.<\/td>\nRequired<\/td>\nAccepted values are:
\nOtodom: PLN,\u00a0EUR,\u00a0GBP<\/strong>
\nImovirtual: EUR<\/strong>
\nStoria: EUR,\u00a0RON<\/strong><\/td>\n<\/tr>\n
rent_price.value<\/td>\nSets the optional rent price for “for sale” categories.<\/td>\nOptional<\/td>\nOtodom\/Storia only<\/em><\/strong>
\nint or float<\/td>\n<\/tr>\n
rent_price.currency<\/td>\nSets the currency for the optional rent price.<\/td>\nOptional<\/td>\nOtodom\/Storia only<\/em><\/strong>
\nAccepted values are PLN,\u00a0EUR,\u00a0GBP.<\/strong><\/td>\n<\/tr>\n
deposit_price.value<\/td>\nSets the optional deposit value for “for rent” categories.<\/td>\nOptional<\/td>\nOtodom\/Storia only<\/em><\/strong>
\nint or float<\/td>\n<\/tr>\n
deposit_price.currency<\/td>\nSets the currency for the optional deposit value.<\/td>\nOptional<\/td>\nOtodom\/Storia only<\/em><\/strong>
\nAccepted values are PLN,\u00a0EUR,\u00a0GBP.<\/strong><\/td>\n<\/tr>\n
market<\/td>\nDefines the type of market for the advert.<\/td>\nOptional<\/td>\nAccepted values are secondary<\/strong> (default if omitted) or primary.<\/strong><\/td>\n<\/tr>\n
parent_uuid<\/td>\nUUID of the parent advert. Only valid for primary market adverts.<\/td>\nOptional<\/td>\nRefer to\u00a0Primary Market<\/a>\u00a0for more information.<\/td>\n<\/tr>\n
location.lat
\nlocation.lon<\/td>\n		Latitude and Longitude of advert location.<\/td>\nRequired<\/td>\ndecimal degrees (e.g. 38.66287, -9.075342)
\nmust be the country site coordinate<\/td>\n<\/tr>\n
location.postal_code<\/td>\nPostal code of advert location.<\/td>\nOptional
\n(Only required if coordinates are not in the request.)<\/td>\n		Imovirtual only<\/em><\/strong>
\nNote: when lat\/lon are provided, postal code is ignored.
\nCheck available Portuguese CP on\u00a0CTT<\/a>\u00a0site.<\/td>\n<\/tr>\n
location.exact<\/td>\nDetermines if the exact location of the advert will be shown on a map.<\/td>\nOptional<\/td>\nboolean
\nAccepted values are false<\/strong> (default if omitted) or true.<\/strong>\u00a0Only available if coordinates are in the request.<\/td>\n<\/tr>\n
images.url<\/td>\nURL of an advert image.<\/td>\nRequired<\/td>\nArray, at least one must be sent.
\nSmallest side must have at least 300px.
\nHTTP response status code need to be 200.<\/td>\n<\/tr>\n
movie_url<\/td>\nThe URL for a Youtube or Vimeo movie to be displayed on the advert detail page.<\/td>\nOptional<\/td>\nMust be a valid Youtube or Vimeo URL (shortlinks are not accepted)<\/td>\n<\/tr>\n
virtual_walk<\/td>\nThe URL for a Youtube, Vimeo or a Matterport movie to be displayed on the advert detail page.<\/td>\nOptional<\/td>\nMust be a valid URL from Youtube, Vimeo, Cupix](https:\/\/www.cupix.com\/<\/a>),\u00a0Matterport<\/a>\u00a0or\u00a0Kuula<\/a>
\n(shortlinks are not accepted)<\/td>\n<\/tr>\n
floor_plan<\/td>\nURL of an image.<\/td>\nOptional<\/td>\nMust be a valid image URL.
\n(shortlinks are not accepted)<\/td>\n<\/tr>\n
attributes.urn<\/td>\nURN of an attribute.<\/td>\nOptional<\/td>\nRefer to the\u00a0Taxonomy API<\/a>\u00a0for more information.<\/td>\n<\/tr>\n
attributes.value<\/td>\nThe value of the attribute.<\/td>\nOptional<\/td>\nRefer to the\u00a0Taxonomy API<\/a>\u00a0for more information.<\/td>\n<\/tr>\n
attributes.urn > urn:concept:net-area-m2
\nand
\nurn:concept:gross-area-m2
\nand
\nurn:concept:terrain-area-m2
\nand
\nurn:concept:usable-area-m2<\/td>\n		URN for an area attribute.<\/td>\nRequired for some category_urn<\/td>\nint
\nRefer to the\u00a0Taxonomy API<\/a>\u00a0for more information.
\nAlso, check\u00a0here<\/a>
\nwhich are the areas available for each category.<\/td>\n<\/tr>\n
attributes.urn > urn:concept:register-number<\/td>\nRegistration number for local accommodation<\/td>\nRequired for category_urn urn:concept:realestate-for-vacation<\/strong><\/td>\nImovirtual only<\/em><\/strong>
\nint
\nmust contain only the value of register number itself, we will add “\/AL” automatically.<\/td>\n<\/tr>\n
site_urn<\/td>\nThe site where the advert will be published to.<\/td>\nRequired<\/td>\nRefer to\u00a0Supported Sites<\/a>\u00a0for more information.<\/td>\n<\/tr>\n
custom_fields.id<\/td>\nInternal advert ID generated from your own application.<\/td>\nRequired<\/td>\nstring<\/td>\n<\/tr>\n
custom_fields.reference_id<\/td>\nAn optional reference for the advert.<\/td>\nOptional<\/td>\nstring<\/td>\n<\/tr>\n
dates related attributes
\ne.g
\nurn:concept:free-from
\nurn:concept:start-date<\/td>\n		Attributes related to dates<\/td>\nOptional<\/td>\nstring format [YYYY-MM-DD]<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Some extra validations are required to successfully publish adverts in the\u00a0OLX platform<\/strong>. Check\u00a0here<\/a>\u00a0which are.<\/p>\n\n","protected":false},"excerpt":{"rendered":"

Advert payload and validation rules Below you can check the structure of an advert payload, a description of each field, and each field validation rules.   Advert additional information This table describes only the main structure of the advert. In addition to this, an advert can also contain a number of attributes and\/or characteristics.Which can… Read more »<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=\/wp\/v2\/posts\/472"}],"collection":[{"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=472"}],"version-history":[{"count":0,"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=\/wp\/v2\/posts\/472\/revisions"}],"wp:attachment":[{"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=472"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=472"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/doc.olxgroup.com\/api\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=472"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}