Odoo REST API: Version 1.0 documentation

Our Odoo REST API Reference houses a lot of information but doesn’t always tell you how you should use it.

If you want to build apps and other integrations for Odoo, this tutorial will walk you through what is required to authenticate and make basic API calls.

Get the module

The module restapi is available on Odoo App Store, Here are links for:

• Version 17.0 (Community & Enterprise)

• Version 16.0 (Community & Enterprise)

• Version 15.0 (Community & Enterprise)

• Version 14.0 (Community & Enterprise)

• Version 13.0 (Community & Enterprise)

• Version 12.0 (Community & Enterprise)

• Version 11.0 (Community & Enterprise)

• Version 10.0 (Community & Enterprise)

• Version 9.0 (Community & Enterprise)

• Version 8.0 (Community & Enterprise)

Installation

Install restapi module by following the below steps:

1. Unzip restapi module to the custom addons directory

2. Restart Odoo server

3. Activate Developer Mode from the Settings menu

4. Navigate to the Apps menu

5. Click on Update Apps List menu in the left sidebar

6. Once apps list is updated, click on the Apps menu from left/top side bar

7. Search module restapi

8. Click on Install button.

Getting Started

• Connection

  • Configuration
  • Demo
  • Logging In

    • How you can do

      • Odoo Version Information
      • Oauth1 Authentication
      • OAuth2 Authentication
• Calling Methods

  • What you can do?
  • Check Access Rights
  • List Records

    • Pagination
  • Count Records
  • Read Records

    • Read Single Record
    • Read List Records
    • Read Filter Records
  • List Record Fields
  • Create Records
  • Update Records

    • Update Single Record
    • Update List Records
  • Delete Records

    • Delete Single Record
    • Delete List Records
• Report Printing

  • Print Single Report
  • Print List Reports
• Inspection and Introspection

  • ir.model
  • ir.model.fields