product.ribbon: fields, relations and API
The product.ribbon model ("Product ribbon") is a persistent model declared by the eCommerce module, then extended by 1 other module. It exposes 14 fields, 8 of them declared directly on the model; 2 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.ribbon- Label
- Product ribbon
- Type
- Persistent (models.Model)
- SQL table
product_ribbon- Origin module
- eCommerce (
website_sale) - Extended by
- website_sale_stock
- Default order (_order)
sequence ASC, 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 |
|---|---|---|---|
| assign | Assign Defines how this ribbon is assigned to products: - Manually: You assign the ribbon manually to products. - Sale: Applied when the product is visibly on sale. - New: Applied based on the New period you will define. - Out Of Stock: Applied when the product is out of stock. | selection | required Values: |
| bg_color | Background Color | char | required |
| name | Ribbon Name | char | requiredtranslatable |
| new_period | New Period | integer | |
| position | Position | selection | required Values: |
| sequence | Sequence | integer | |
| style | Style Defines the display style: - Ribbon: Shows a ribbon banner on the product image. - Badge: Shows a small badge label on the product image. | selection | required Values: |
| text_color | Text Color | char | required |
| 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
No own relational field.
Fields of other models pointing here
- product.product: variant_ribbon_id
- product.template: website_ribbon_id
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.ribbon/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","assign","bg_color","position","style"],"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.ribbon/search_read",
headers=headers,
json={"domain": [], "fields": ["name","assign","bg_color","position","style"], "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-ribbon">product.ribbon (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.