Skip to Content

Odoo Simple Rest API

by
Odoo

$ 53.15

v 18.0 Third Party
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 165468
Technical Name odoo_simple_rest_api
LicenseLGPL-3
Websitehttps://cnelindia.com
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 165468
Technical Name odoo_simple_rest_api
LicenseLGPL-3
Websitehttps://cnelindia.com
logo
logo

Rest APIFeatures

Search & Read
Search and Read any Record

Download
Download Binary Datal

Create & Duplicate & Drop
Manage your Databases

Create & Edit & Delete
Create, Edit or Delete any Record

Report
Create and Download any Report

Backup & Restore
Backup and Restore Databases

Support

Odoo Simple Rest API

You will The odoo Rest API module allow us to connect to database
with the help of GET , POST , PUT and DELETE request.

Connect with us on email

Chat with us on WhatsApp

Most

Odoo Simple Rest API integration app

Odoo Simple rest API

Are you ready to streamline your business operations?
Enhance it now!

info@cnelindia.com +91 9983345001

Documentation

The OpenAPI specification is a widely adopted standard for documenting APIs in a machine-readable format, typically in JSON or YAML. It provides a consistent and clear method for describing an API's endpoints, request/response structures, authentication methods, and more.

Each endpoint is defined with the HTTP methods it supports (GET, POST, PUT, DELETE, etc.), along with the necessary parameters (query, path, header, body) and expected responses. The use of schemas within the specification allows for clear definitions of data structures, ensuring that both the request and response bodies follow a consistent format.

One of the key advantages of OpenAPI is that the documentation can be automatically updated when new endpoints are added, whether they are created manually or through generated Python code. This ensures that the documentation remains synchronized with the API codebase, reducing the effort required to maintain it.

Additionally, tools like Swagger UI and Redoc can visualize and interact with the API documentation, making it easier for developers to understand and test endpoints. The OpenAPI specification also supports versioning, allowing APIs to evolve over time while maintaining backward compatibility for existing users.

Overall, OpenAPI enhances the consistency, usability, and automation of API documentation, ensuring that developers and consumers can easily work with and integrate APIs.

Documentation Section

Here you can add your documentation text or content. This section will be visible when you click on the Documentation tab. You can add HTML content, formatted text, images, or any other necessary information.

You can also use rich text, code snippets, or even embed videos. This is a customizable area for your documentation needs.

Screenshots

Configuration

  • First of all, we have to add a new parameter in odoo conf. file.
  • server_wide_modules = web, base, odoo_simple_rest_api
    - This will allow us to send request to server without selecting database first.
    - Incase if you have to uninstall the module , you have to remove this parameter.
    - Next we can install the module.
  • After installing the Rest api app we can see a new api key field in users.
    • - Next we have to generate the api-key for the current user.
  • You can import the postman collections provided in the app folder for authentication and interacting with database in various methods.

Postman collections

  • We have attached Postman collections through which you can authenticate rest api.
  • First, extract the zip file. Then, you will obtain the JSON-format file, which you can directly import into POSTMAN.
  • The url format will be like this - http://localhost:8018/odoo_connect Replace 'localhost:8018' with your localhost port number.
  • You have to provide database name, username and password through the headers while sending request.
  • If the authentication is successful , an api key will be generated for the current user.
  • This key will be used when sending api requests to database.
  • The response will be like this - {"Status": "auth successful", "User": "Mitchell Admin", "api-key": "66c2ebab-d4dc-42f0-87d0-d1646e887569"}.

API Authentication

  • After rest api authentication, we can create records in the rest api app.
  • Here we can choose the model, and also we can choose the http methods.
  • The api response will be based on these records.
Get Records
  • You can send GET request to retrieve data from the database.
  • The postman collection has been provided with app files for sending request from postman.
  • You have to provide username, password and api key through the header.
  • Model can be passed as argument as the technical name, and also if you want specific record you can provide the id as well.
  • The format for GET method will be like this http://localhost:8018/send_request?model=res.partner&Id=10.
  • We can specify the fields inside the JSON data, and it will be like this - {"fields": ["name", "email"]}.
  • This is the format of api response - {"records": [{"id": 10, "email": "deco.addict82@example.com", "name": "Deco Addict"}]}.
Create Records
  • Using POST method , you can create new records in the database.
  • Just make sure you enabled POST method for the model record in rest api app , otherwise you will get 'method not allowed' message.
  • For creating record you have to provide the JSON data along with the model.
  • You can make use of the postman collection that we have added with app files.
  • The format for sending POST request will be like this - http://localhost:8018/send_request?model=res.partner.
  • This is the format for JSON data - { "fields" :["name", "phone"] , "values": {"name": "abc", "phone":"55962441552" } }.
  • Make sure the data entered in correct format otherwise you will get 'Invalid JSON data' message.
  • Response will be in this format - {"New resource": [{"id": 51, "name": "abc", "phone": "55962441552"}]}.
Update Records
  • Updation of records in the database can be done with PUT method.
  • You have to provide the model and also the id or the record that you want to update.
  • You can use the Postman collection that we have provided and , you will be always have to send request with your login credentials. Otherwise, it will be showing access denied.
  • The format for sending PUT request will be like this - http://localhost:8018/send_request?model=res.partner&Id=46.
  • Here too you have to provide the JSON data through which the updates will be done.
  • The response format will be like this - {"Updated resource": [{"id": 46, "email": "abc@example.com", "name": "Toni"}]}.
Delete Records
  • Database records can be deleted by sending DELETE method request.
  • For the deletion we have to provide the Model and the record id that we want to delete.
    • Make sure you have permission to delete files for the selected model in the rest api record.
  • The delete request format will be like this - http://localhost:8018/send_request?model=res.partner&Id=46.
  • The response after successful deletion will be - {"Resource deleted": [{"id": 46, "email": "abc@example.com", "name": "Toni"}]}.

API Authentication

  • After rest api authentication, we can create records in the rest api app.
  • Here we can choose the model, and also we can choose the http methods.
  • The api response will be based on these records.

Odoo Simple Rest API

You will The odoo Rest API module allow us to connect to database
with the help of GET , POST , PUT and DELETE request.

Connect with us on email

Chat with us on WhatsApp

Shopify has recently updated its subscription plans, resulting in limitations on customer data access for Basic plan users. This change means that when attempting to import orders to Odoo, you might encounter the error message "Customer data not found." To resolve this issue and regain full data access, you will need to upgrade to a higher-tier Shopify plan such as Shopify, Advanced Shopify, or Shopify Plus.

Yes, the app works perfectly well with Odoo Enterprise (On-premise and Odoo.SH) as well as Community. Odoo Online (Cloud) does not allow installation of third-party apps and hence this app cannot be installed on Odoo Online.

If you purchase our app for Odoo Version 12 and prior, we will provide you access to all the versions up to 12 depending on their availability. Starting version 13, every version of the app will be sold separately. We offer free support for a duration of 90 days from the date of purchase. Kindly read our support policy to know the details.

You can contact us to request a customization in the app.

Yes, you can export Products from Odoo to Shopify as well as import Products from Shopify to Odoo. If the products are already present on Odoo as well as Shopify, you can establish a synchronization between them using the connector

The Shopify Odoo Connector lets connect as many Shopify stores as you want with a single Odoo Instance.

The connector synchronizes products by matching the Internal Reference field in Odoo with the SKU field in Shopify. It is mandatory to have a unique SKU or Internal Reference for a product.

The connector allows you to update price from Odoo to Shopify via a pricelist. You can set up a pricelist per Shopify instance in Odoo and update the price to Shopify via the pricelist. You also import the prices from Shopify to Odoo, however, the prices will get imported to the pricelist and not directly to the product.

The connector allows you to update stock from Odoo to Shopify either manually or automatically via a cron job. Stock levels get automatically adjusted in Odoo based on the imported orders. You can also import stock levels from Shopify to Odoo. The imported stock values will create an inventory adjustment entry in Odoo which upon validating will affect the actual stock levels. In the connector settings, you can choose one warehouse per Shopify Instance from which the stock is to be managed.

Any order on Shopify can be imported to Odoo if the connector has been configured correctly. The connector provides a configuration that lets you choose if you want to import only unfulfilled orders or fulfilled orders or both.

Yes. Your endpoint must be an HTTPS webhook address with a valid SSL certificate that can correctly process the event.

If you want to use Webhooks, you must enable the database filter. However, in the case of Odoo.sh, it is handled automatically.

No 

                        Odoo Proprietary License v1.0

                        This software and associated files (the "Software") may only be used (executed,
                        modified, executed after modifications) if you have purchased a valid license
                        from the authors, typically via Odoo Apps, or if you have received a written
                        agreement from the authors of the Software (see the COPYRIGHT file).

                        You may develop Odoo modules that use the Software as a library (typically
                        by depending on it, importing it and using its resources), but without copying
                        any source code or material from the Software. You may distribute those
                        modules under the license of your choice, provided that this license is
                        compatible with the terms of the Odoo Proprietary License (For example:
                        LGPL, MIT, or proprietary licenses similar to this one).

                        It is forbidden to publish, distribute, sublicense, or sell copies of the Software
                        or modified copies of the Software.

                        The above copyright notice and this permission notice must be included in all
                        copies or substantial portions of the Software.

                        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
                        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
                        DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
                        ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
                        DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.