product.document: fields, relations and API
The product.document model ("Product Document") is a persistent model declared by the Products & Pricelists module, then extended by 6 other modules. It exposes 14 fields, 8 of them declared directly on the model; 3 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.
Model identity
- Technical name
product.document- Label
- Product Document
- Type
- Persistent (models.Model)
- SQL table
product_document- Origin module
- Products & Pricelists (
product) - Extended by
- sale, mrp, sale_gelato, sale_pdf_quote_builder, website_sale, website_sale_gelato
- Default order (_order)
sequence, name- Delegation (_inherits)
- ir.attachment: fields of this model are also available, through
ir_attachment_id
Model fields
8 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
14 of 14 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| active | Active | boolean | |
| attached_on_mrp | MRP : Visible at Leave hidden if document only accessible on product form. Select Bill of Materials to visualise this document as a product attachment when this product is in a bill of material. | selection | required Values: added by Manufacturing ( |
| attached_on_sale | Sale : Visible at Allows you to share the document with your customers within a sale. Leave it empty if you don't want to share this document with sales customer. On quote: the document will be sent to and accessible by customers at any time. e.g. this option can be useful to share Product description files. On order confirmation: the document will be sent to and accessible by customers. e.g. this option can be useful to share User Manual or digital content bought on ecommerce. Inside quote: The document will be included in the pdf of the quotation and sale order between the header pages and the quote table. | selection | required Values: added by Sales ( |
| form_field_ids | Form Fields Included | many2many | computed, stored added by Sales PDF Quotation Builder ( |
| ir_attachment_id | Related attachment | many2one | required |
| is_gelato | Is Gelato | boolean | read-only added by Gelato ( |
| sequence | Sequence | integer | |
| shown_on_product_page | Publish on website | boolean | added by eCommerce ( |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- ir.attachment: ir_attachment_id
- sale.pdf.form.field: form_field_ids
Fields of other models pointing here
- sale.order.line: available_product_document_ids, product_document_ids
- sale.pdf.form.field: product_document_ids
Reading this model through the API
Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/product.document/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["attached_on_mrp","attached_on_sale","ir_attachment_id","active","is_gelato"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/product.document/search_read",
headers=headers,
json={"domain": [], "fields": ["attached_on_mrp","attached_on_sale","ir_attachment_id","active","is_gelato"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/product-document">product.document (Odoo 19.0)</a>Sources
Data verified on September 23, 2026 · Odoo 19.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.