GuidesRequest an APPNewsletterContact UsChangelog
Guides

Changelog

2024-08-30

Introduced a change in part of the Authorization URL. More precisely: mercury/authorization has been changed to <LOCALE>/crm/authorization where <LOCALE> is a country code.

Authorization URL varies depending on the portal:

  • Imovirtual: https://imovirtual.com/pt/crm/authorization/?response_type=code&client_id=<YOUR CLIENT ID>&state=<A USER ID>
  • Otodom: https://otodom.pl/pl/crm/authorization/?response_type=code&client_id=<YOUR CLIENT ID>&state=<A USER ID>
  • Storia: https://storia.ro/ro/crm/authorization/?response_type=code&client_id=<YOUR CLIENT ID>&state=<A USER ID>

2024-08-29

  • Introduced a new field to the Taxonomy API: mandatory that indicates whether an attribute is required (true) or optional (false).

2024-07-09

  • Introduced a new (optional) attribute to the Taxonomy API: energy-certificate (for Otodom).

2024-07-04

  • Changed Taxonomy API - added warning that the Taxonomy API is outdated for Imovirtual.

2024-05-20

2024-05-07

2024-05-06

  • Removed all references to outdated_by_package - this status ceased to exist on Imovirtual on that date.

2024-04-26

  • Changed Primary market - "Agency account type can publish units for the primary market, but not the investments"
  • Changed Publishing isolated units : "Primary market units can be published without being part of an investment, and this type of advert can be published only by an Agency account type"
  • Changed Publishing an investments and units : added: "If you add the unit advert without the "parent_uuid" field (as a Developer), you will receive the following error message:" + webhook notification example
  • Changed Hidden price - removed "Separate advert" column (not possible to hide the price in the unit adverts)

2024-03-11

  • Changed Authorization Flow - Screenshots updates to Otodom branding
  • Changed Publishing isolated units - Screenshots updates to Otodom branding
  • Update Legacy integrations - Removed Imovirtual legacy feed info. To have access to the new Imovirtual Feed, please get in contact with us.
  • Deleted "Imovirtual legacy feed" reference doc, as this legacy import is not longer available
  • Deleted "Base64 Encode/Decode" from Tech Docs, as we implemented the encode/decode of the Base64 directly on the Application manager
  • Deleted "Profile API" reference doc, as Profile API was discontinued on 30 November 2023.

2024-03-22

2024-01-30

  • Added Hidden Price page that describes a way to hide the price on the advert.
  • Changed Migrate existing integrations :
    • added: "The final step is to perform an update of all adverts (PUT) to synchronise them. Executing this step will give you the assurance that the adverts exported to the portal match the adverts stored on your site."
    • changed: "We recommend that after finishing this process you remove the user's ads from your legacy integration and deactivate the legacy export. It is very important to send the adverts only via API (to avoid duplicates)."

2023-12-22

  • Changed Validations required for OLX Export - added: "following characters cannot be provided more than three times in a row: ! ? . , - = + # % & @ \* > \< : ( ) |" to OLX Validation both for title and description fields.

2023-12-07

  • Changed Applying a Promotion - added: "If you get an error while applying your OLX promotion, most of the times you don't need to apply it again! The ad will automatically export after you fix the payload." to "OLX Exports might have additional validations" header.
  • Changed Publish payload example - changed Postman Collection URL to API Reference URL.
  • Changed Publishing an investment - changed Postman Collection URL to API Reference URL.
  • Changed Advert payload and validation rules - changed Postman Collection URL to API Reference URL.

2023-11-14

Changed Profile API - Profile API will be discontinued on 30 November 2023.

2023-09-19

Changed Publishing errors - added a new examples to the troubleshooting section:

2023-09-15

Introduced a new field: "visible_in_profile" to Advert Notifications and Get Meta endpoints:

  • Changed Activate ads - added: "In addition "visible_in_profile"parameter returned by the Advert Notifications and Get Meta endpoints has to be set to true."
  • Changed Deactivate ads - added: "Please note that it is not possible to deactivate previously deleted advert. If you have received a webhook with field "visible_in_profile": false it means that the advert is not present in the user's profile and cannot be deactivated."
  • Changed Delete an advert - added: "Please note that it is not possible to delete previously deleted advert. If you have received a webhook with field "visible_in_profile": false it means that the advert is not present in the user's profile and cannot be deleted."
  • Changed Receiving Advert Notifications :
    • added: "visible_in_profile": "true" to the code example
    • added: description for "visible_in_profile" field
  • Changed Get advert metadata - added: "visible_in_profile": "true" to the code examples
  • Changed Publish Advert - added: "visible_in_profile": "true" to the code examples
  • Changed Advert Lifecycle - added: "visible_in_profile": "true" to the code examples

2023-09-01

Changed Validations required for OLX Export - update regarding number-of-rooms attribute.

2023-08-03

Changed Receiving Leads - update regarding limited access to the Leads functionality.

2023-07-28

Changed Applying Promotions - update regarding the new way for Applying Promotions for Otodom.pl and Storia.ro.

Changed VAS Lifecycle - update regarding the VAS Lifecycle notifications for Otodom.pl and Storia.ro.

2023-07-05

Changed Invalid access token - added "Invalid refresh token" description

2023-07-04

Changed Authorization and token handling - modified point 2.: "Refresh token can be used only one-time"

Changed Updating ads - added point 1.3: "Change the image in a published ad and update it"

Changed Step 1 - User authorization - added last paragraph: "Note that triggering the migration process is a one-time action. Once the adverts have been migrated, there is no need to reuse the &import=1 parameter during the next authorizations for the same user."

2023-06-27

Changed Advert payload and validation rules - the following parameters are now available for Storia.ro:

  • rent_price.value
  • rent_price.currency
  • deposit_price.value
  • deposit_price.currency

2023-05-31

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Removed:
    • Offices for Sale
    • Offices for Rent

Use Stores for Sale / Stores for Rent category along with urn:concept:use-types to determine the type of usage (for example: urn:concept:office)

2023-05-29

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Halls and Warehouses for Sale
  • Halls and Warehouses for Rent

2023-05-16

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Houses for Sale

2023-05-11

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Added:
    • Garages for Sale
    • Garages for Rent

2023-05-05

Fixed webhook tester in the Application Manager. Previously it was expecting only 200 as status code response and now it is between 200 and 299.

2023-05-04

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Houses for Rent

2023-03-21

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Terrains for Sale

2023-03-15

Changed Taxonomy API - updates to the Storia.ro category tree including new parameters and attributes for the following categories:

  • Rooms for Rent
  • Terrains for Rent

2022-11-17

Changed Editing and deleting adverts - adverts managed via API can be edited outside the integration now.

2022-09-08

Changed Profile API - This API will be discontinued soon.

2021-08-16

Changed Migrate existing integrations - migrations available for all marketplaces.

2021-06-25

Added Advert status codes for Investment Units lifecycle: removed_by_parent_ad
Added Advert Lifecycle status notification for Investment Units lifecycle: removed_by_parent_ad
Added removing unit adverts from the investment to the documentation

2021-06-07

Added Applying Promotions feature and documentation.
Added VAS errors page, those errors are related to the Applying Promotion feature.
Update Value-Added Services webhook notifications. These notifications are available when the VAS is applied through the RE Marketplace or OLX Group RE Partner API.

2021-01-20

Added Value Added Services and OLX Notifications .
VAS are commercial products available in our portals that typically allow customers to boost the visibility of their adverts by highlighting, or bumping them, for example. That also includes the OLX Exportation.

2020-12-17

Removed Statistics endpoint due to new developments on the target portals.

2020-11-26

Changed Taxonomy.
Changed Advert payload and validation rules , 3d_view removed.

2020-11-23

Blocked Authorization page to regular/private users accounts.

2020-11-20

Changed Terms & Conditions page to include Poland version.

2020-10-22

Added Testing your integration for Primary Market documentation.

2020-10-20

Scheduled Maintenance .

2020-09-30

Changed the Authorization page to add the client's email account. He hopes this way to prevent authentications with the wrong account. See the page at Authorization Flow .

2020-09-25

Changed Developer Hub to OLX Group Developer Hub. More info at our Newsletter .

2020-09-23

Scheduled Maintenance

2020-09-21

Changed Webhook section:
Receiving Advert Notifications
Advert status codes
Publishing adverts
Advert Lifecycle
Incoming Message

2020-09-08

Changed Authorization Flow and User authorization experience documentation.
Changed Adverts API documentation.

2020-08-31

Changed guides strutucture , to include new categories: Getting Started, Authorization & Authentication, Publishing Adverts, Package Info and Manage Lead. This structure will allow you to quickly find common information.

2020-07-28

Changed Terms & Conditions page to include T&C translated to Romanian, in .pdf file
Changed Testing your integration scenarios to improve demo sessions, before Go Live approval

2020-07-27

Changed Test Account page to improve details about the rules of using a test account.

2020-07-17

Changed Testing your integration page to include scenarios to validate when properties are sold, rented, or reserved on the CRM side. Those property adverts need to be removed or deactivated from our Marketplaces.

2020-07-15

Changed Terms & Conditions . Partner's (with active an non-active applications) informed thought Newsletter .

2020-07-09

Add Primary Market adverts
Changed Primary Market documentation.

2020-07-01

Changed Terms & Conditions to include EN pdf version.
Changed documentation for image validation, in Advert validation rules .

2020-06-22

Changed Terms & Conditions

2020-06-02

Added Service-level agreement documentation, as a compromise of our quality.

2020-03-30

Changed Advert payload and Advert validation rules documentation were was added new attributes:

  • 3d_view;
  • virtual_walk;
  • floor_plan.

2020-03-20

2020-01-02

  • Storia and Otodom:
    Added Primary Market export thought API
  • Imovirtual:
    Fixed Profile API notifications upon manual package increment via Imovirtual adminpanel

2019-12-06

2019-11-26

2019-05-10

2019-04-30

2019-02-18

2019-01-30

  • Added Postal Code to locations fields [only available to Imovirtual]. See the example in Publishing adverts for more details.

2018-12-03

  • Changed documentation, namely the Best Practices section. Make sure to check out the Before going live pages.

2018-10-25

  • Added process to detect duplicated ads based on API Key, access_token, custom_fields.id and category_urn
  • Changed process and custom_fields.id field can no longer be updated
  • Changed state machine rules and now any operation is allowed except those that target adverts in transient states (TO_POST, TO_PUT, TO_DELETE and TO_ACTIVATE)

2018-10-15

2018-08-27

  • Fixed encoding issue on Incoming messages (leads), namely the webhooks of type 'incoming_message_success'. Leads are sent using UTF8 encode.

2018-08-14

  • Added header "user-agent" with the value of "olx-group-api" to "identity" the webhook requests made by our API

2018-08-10

2018-08-06

  • Changed webhook notification signatures from the payload to a header named "x-signature" for all Webhooks . Additionally, the signature has been simplified to only use the object_id and transaction_id fields of the notification's payload.

2018-07-24

  • Added advert_activated_success and advert_activated_error on the publish_advert flow.

2018-07-16

  • Changed date time to include a timezone. Incoming message webhook "created_at" field has changed from "2018-07-16 11:04:50" to "2018-07-16T11:04:50.000+0100".
  • Changed Timestamp, meaning: it is now what the event describes (the state change, the message creation, etc.)
  • Added event timestamp for all Webhooks .

2018-07-11

2018-07-06

2018-07-05

  • Changed contact object of the advert payload. This information is now correctly reflected on the target site. If the contact object is omitted, the default account details will be used instead.

2018-06-18

2018-06-06

2018-05-21

  • Changed the site URN for Imovirtual to urn:site:imovirtualcom

Updated 4 months ago