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 informationThis 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 Taxonomy API.
For a complete example of what an advert looks like, check out our API Reference.
Also, you can check out the example under Publishing Adverts.
Advert Payload and Validation Rules
Field | Description | Required | Validation |
---|---|---|---|
title | Title of the advert. | Required | string |
description | Description of the advert. | Required | string |
category_urn | URN of the advert category. | Required | Unique category identifier (see Taxonomy API) |
contact.name | Name of the contact person for advert customization | Required* | string
|
contact.email | E-mail number of the contact person for advert customization. | Required* | string with a valid e-mail address
|
contact.phone | Phone number of contact person for advert customization. | Optional | string |
contact.photo | Photo of the contact person for advert customization. | Optional | string with a valid url of an image |
price | Price value of the advert. | Required | int or float |
price.currency | Price currency. | Required | Accepted values are: |
rent_price.value | Sets the optional rent price for "for sale" categories. | Optional | Otodom/Storia only |
rent_price.currency | Sets the currency for the optional rent price. | Optional | Otodom/Storia only |
deposit_price.value | Sets the optional deposit value for "for rent" categories. | Optional | Otodom/Storia only |
deposit_price.currency | Sets the currency for the optional deposit value. | Optional | Otodom/Storia only |
market | Defines the type of market for the advert. | Optional | Accepted values are |
parent_uuid | UUID of the parent advert. Only valid for primary market adverts. | Optional | Refer to Primary Market for more information. |
location.lat | Latitude and Longitude of advert location. | Required | decimal degrees (e.g. 38.66287, -9.075342) |
location.exact | Determines if the exact location of the advert will be shown on a map. | Optional | boolean |
images.url | URL of an advert image. | Required | Array, at least one must be sent. |
movie_url | The URL for a Youtube or Vimeo movie to be displayed on the advert detail page. | Optional | Must be a valid Youtube or Vimeo URL (shortlinks are not accepted) |
virtual_walk | The URL for a Youtube, Vimeo or a Matterport movie to be displayed on the advert detail page. | Optional | Must be a valid URL from Youtube, Vimeo, Cupix](https://www.cupix.com/), Matterport or Kuula |
floor_plan | URL of an image. | Optional | Must be a valid image URL. |
attributes.urn | URN of an attribute. | Optional | Refer to the Taxonomy API for more information. |
attributes.value | The value of the attribute. | Optional | Refer to the Taxonomy API for more information. |
attributes.urn > urn:concept:net-area-m2 | URN for an area attribute. | Required for some category_urn | string |
attributes.urn > urn:concept:register-number | Registration number for local accommodation | Required for category_urn | Imovirtual only |
site_urn | The site where the advert will be published to. | Required | Refer to Supported Sites for more information. |
custom_fields.id | Internal advert ID generated from your own application. | Required | string |
custom_fields.reference_id | An optional reference for the advert. | Optional | string |
dates related attributes | Attributes related to dates | Optional | string format [YYYY-MM-DD] |
auto_extend | Determines whether advert has to be automatically extended or not | Optional | boolean |
Some extra validations are required to successfully publish adverts in the OLX platform. Check here which are.
Updated 16 days ago