Odoo Help


What is the use of @api.returns?

Karthik Arumugam
on 10/20/15, 7:11 AM 1,518 views

Please any one explain me about the use of @api.returns with simple example.


Hello Karthik,

@api.returns specify what needs to be return, either id, ids, False or recordset.



Hello Karthik,

@api.returns is the decorator, with the help of it you can return anything you want from specific function. So for example generally create method returns the record set of newly created record for particular model. Now for that specific model, if you want to return an dictionary instead of that record set, then you can define @api.returns like as follows,

@api.returns(self, lamda s: {s.id:s}) 
def create(self, vals)
res = super(xx, self).create(vals)
return res

Above method will return the dictionary of the record set ( { ID : Recordset } ), not just an record set of specific model.

Another good example to use @api.returns in a best way is :

Generally write method returns the Boolean value ( True or False ). That returned value becomes useless sometimes. So with usage of  @api.returns you can return the Recordset / List of ids which are successfully updated. ( With the magic of inheritance you can perform this thing into your specific model only. It's wonderful, No ?? )

I am not giving more lengthy specifications as other links are good for you to understand this concept into depth. Sometimes just concept clearance with a good example is necessary rather then read the detailed documentations first. And I hope i have been able to clear your confusion regarding @api.returns with proper example.

Hope this helps,

About This Community

This platform is for beginners and experts willing to share their Odoo knowledge. It's not a forum to discuss ideas, but a knowledge base of questions and their answers.


Odoo Training Center

Access to our E-learning platform and experience all Odoo Apps through learning videos, exercises and Quizz.

Test it now

Question tools

1 follower(s)


Asked: 10/20/15, 7:11 AM
Seen: 1518 times
Last updated: 7/13/16, 5:53 AM