| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1331 |
| Technical Name |
api_payload_editor |
| License | See License tab |
| Versions | 16.0 17.0 18.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1331 |
| Technical Name |
api_payload_editor |
| License | See License tab |
| Versions | 16.0 17.0 18.0 |
Create your requests by yourself and keep third party apps updated with Odoo datas easily
In case you have third party apps (with available APIs) which need to keep data updated with Odoo database's,
Payload Editor, with a user-friendly design, will allow users to edit easily their own payload based on Odoo datas and send update requests to third party apps.
Once all settings ready, you can send the datas directly to the third party apps.
Settings
Choose model and edit filter rules
First thing to do is to create our payload editor, choose a name and a model (the document you want to sync).
Then we can edit our domain to filter the records to be synced. You can watch an example of how to configure it here at 1:57.
Edit your own template
Based on what is expected in the third party app API, you can edit your own template, by adding the keys one by one and point the equivalent field in Odoo models.
The field selector is actually from the standard Odoo libraries, the same used in the domain selector.
For relational field, we can emb his own structure, which means we can edit a new entity of his own. We can then navigate through our template with the breadcrumb.
Once your template is done, do not forget to save your work. You can now display a sample to see what will your payload looks like.
Edit the destination URL
Insert the URL with the corresponding endpoint of the third party app API and choose the method. POST, PUT and PATCH are available
POST, PUT and PATCH are available but POST is the common used method. For PUT and PATCH with url parameter,
You can insert parameters on the URL but the value must refer to an existing value and field in Odoo,
like the reference for orders or internal reference for products. (ex: http://dummyjson.com/order/{name}
Set up authentication
For request to be able to reach third party app, API usually required authentication.
Basic authentication, API key authentication, and Bearer token are available by default in authorization type.
Basic authentication: username and password are required
API key authentication: Key and Value are required. Also we can add the authentication information in request header or directly in the URL.
Bearer token: Commonly used, if the token is obtained elsewhere, we can add it in the authentication page.
User interface
For easier use, you can create an action on the chosen template,
after which the action will be available on the forms and lists of the model which will perform the query for the chosen records.
You can also start manually the request from your payload editor which will send the records filtered by your domain.
From the logs box button, track all your query status whether they passed or whether they encountered issues.
Copyright © 2025 CoolDev Solutions This software is a proprietary product of CoolDev Solutions. It may not be redistributed or resold without express written permission. This module is licensed for use only by the purchaser, and may not be copied, modified, or reverse-engineered, except where permitted by law. All rights reserved.
Please log in to comment on this module