eCommerce

• website_id Many2one → website
  compute='_compute_website_id' help='Website through which this invoice was created for eCommerce orders.' readonly=True store=True string='Website' tracking=True args: 'website'

• preview_invoice(self)

• abandoned_carts_amount Integer
  compute='_compute_abandoned_carts' string='Amount of Abandoned Carts'
• abandoned_carts_count Integer
  compute='_compute_abandoned_carts' string='Number of Abandoned Carts'
• website_ids One2many → website
  comodel_name='website' inverse_name='salesteam_id' string='Websites'

• get_abandoned_carts(self)

• website_description Text
  readonly=False related='product_id.description_sale' string='Description for Online Quotations'

No public methods.

• kpi_website_sale_total Boolean
  string='eCommerce Sales'
• kpi_website_sale_total_value Monetary
  compute='_compute_kpi_website_sale_total_value'

No public methods.

No new fields.

• get_frontend_session_info(self)
  @api.model

No new fields.

No public methods.

No new fields.

No public methods.

• is_thumbnail_visible Boolean
  help='Use product variant images instead of the attribute values displays.' string='Show Thumbnails'
• preview_variants Selection
  default='hidden' help='Instantly created variants are available for selection from your\xa0/shop page.' selection=[('visible', 'Visible'), ('hidden', 'Hidden'), ('hover', 'Hover')] string='On Product Cards'
• visibility Selection
  default='visible' selection=[('visible', 'Visible'), ('hidden', 'Hidden')]

No public methods.

• shown_on_product_page Boolean
  string='Publish on website'

No public methods.

• access_token Char
  copy=False default=<expr> readonly=True required=True
• cache_expiry Datetime
  default=fields.Datetime.now readonly=True required=True
• feed_cache Binary
  compute='_compute_feed_cache' readonly=True store=True
• lang_id Many2one → res.lang
  compute='_compute_lang_id' domain="[('id', 'in', website_lang_ids)]" help='Select the language to translate product names, descriptions, and other text in the feed.' precompute=True readonly=False required=True store=True string='Language' args: 'res.lang'
• last_notification_date Date
• name Char
  required=True
• pricelist_id Many2one → product.pricelist
  domain="[('website_id', 'in', (False, website_id)), ('selectable', '=', True)]" help='Specify a pricelist to localize the feed with a specific currency. If not set, the default website pricelist will be used.\nNote that the pricelist must be selectable on the website.' args: 'product.pricelist'
• product_category_ids Many2many → product.public.category
  string='Categories' args: 'product.public.category'
• target Selection
  default='gmc' required=True selection=[('gmc', 'Google Merchant Center')]
• url Char
  compute='_compute_url'
• website_id Many2one → website
  required=True args: 'website'
• website_lang_ids Many2many
  related='website_id.language_ids'

• action_invalidate_cache(self)

• can_image_1024_be_zoomed Boolean
  compute='_compute_can_image_1024_be_zoomed' store=True string='Can Image 1024 be zoomed'
• embed_code Html
  compute='_compute_embed_code' sanitize=False
• image_1920 Image
• name Char
  required=True string='Name'
• product_tmpl_id Many2one → product.template
  comodel_name='product.template' index=True ondelete='cascade' string='Product Template'
• product_variant_id Many2one → product.product
  comodel_name='product.product' index=True ondelete='cascade' string='Product Variant'
• sequence Integer
  default=10
• video_url Char
  help='URL of a video for showcasing your product.' string='Video URL'

• create(self, vals_list)
  @api.model_create_multi
  We don't want the default_product_tmpl_id from the context to be applied if we have a product_variant_id set to avoid having the variant images to show also as template images. But we want it if we don't have a product_variant_id set.

• code Char
  groups='base.group_user' string='E-commerce Promotional Code'
• selectable Boolean
  help='Allow the end user to choose this price list'
• website_id Many2one → website
  comodel_name='website' default=_default_website domain="[('company_id', '=?', company_id)]" help='If you want a pricelist to be available on a website,you must fill in this field or make it selectable.Otherwise, the pricelist will not apply to any website.' ondelete='restrict' string='Website' tracking=20

• create(self, vals_list)
  @api.model_create_multi
• unlink(self)
• write(self, vals)

No new fields.

No public methods.

• base_unit_count Float
  default=1 digits=0 help='Display base unit price on your eCommerce pages. Set to 0 to hide it for this product.' required=True string='Base Unit Count'
• base_unit_id Many2one → website.base.unit
  comodel_name='website.base.unit' help='Define a custom unit to display in the price per unit of measure field.' string='Custom Unit of Measure'
• base_unit_name Char
  compute='_compute_base_unit_name' help='Displays the custom unit for the products if defined or the selected unit of measure otherwise.'
• base_unit_price Monetary
  compute='_compute_base_unit_price' string='Price Per Unit'
• product_variant_image_ids One2many → product.image
  comodel_name='product.image' inverse_name='product_variant_id' string='Extra Variant Images'
• variant_ribbon_id Many2one → product.ribbon
  comodel_name='product.ribbon' string='Variant Ribbon'
• website_id Many2one
  readonly=False related='product_tmpl_id.website_id'
• website_url Char
  compute='_compute_product_website_url' help='The full URL to access the document through the website.' string='Website URL'

• open_website_url(self)
• website_publish_button(self)
• write(self, vals)

• align_category_content Boolean
  default=False help="Align the category content on the shop page. Corresponds to the 'Center Content' editor option." string='Align Category Content'
• child_id One2many → product.public.category
  comodel_name='product.public.category' inverse_name='parent_id' string='Children Categories'
• cover_image Image
  help='Displayed only in the Category List Snippet.' string='Cover Image'
• has_published_products Boolean
  compute='_compute_has_published_products' compute_sudo=True search='_search_has_published_products'
• name Char
  required=True translate=True
• parent_id Many2one → product.public.category
  comodel_name='product.public.category' index=True ondelete='cascade' string='Parent'
• parent_path Char
  index=True
• parents_and_self Many2many → product.public.category
  comodel_name='product.public.category' compute='_compute_parents_and_self'
• product_tmpl_ids Many2many → product.template
  comodel_name='product.template' relation='product_public_category_product_template_rel'
• sequence Integer
  default=_default_sequence index=True
• show_category_description Boolean
  default=True help="Display the category description on the shop page. Corresponds to the 'Show Description' editor option." string='Show Category Description'
• show_category_title Boolean
  default=False help="Display the category title on the shop page. Corresponds to the 'Show Title' editor option." string='Show Category Title'
• website_description Html
  sanitize_attributes=False sanitize_form=False sanitize_overridable=True string='Description' translate=html_translate
• website_footer Html
  sanitize_attributes=False sanitize_form=False string='Category Footer' translate=html_translate

• check_parent_id(self)
  @api.constrains('parent_id')
• get_available_snippet_categories(self, website_id)
  @api.model
  Return parent categories available for selection in the dynamic category snippet. :param int website_id: ID of the current website :return: Available parent categories :rtype: list[dict]

• assign Selection
  default='manual' help='Defines how this ribbon is assigned to products:\n- Manually: You assign the ribbon manually to products.\n- Sale: Applied when the product is visibly on sale.\n- New: Applied based on the New period you will define.\n' required=True selection=[('manual', 'Manually'), ('sale', 'On Sale'), ('new', 'When New')] string='Assign'
• bg_color Char
  default='#000000' required=True string='Background Color'
• name Char
  required=True size=20 string='Ribbon Name' translate=True
• new_period Integer
  default=30
• position Selection
  default='left' required=True selection=[('left', 'Left'), ('right', 'Right')] string='Position'
• sequence Integer
  default=10
• style Selection
  default='ribbon' help='Defines the display style:\n- Ribbon: Shows a ribbon banner on the product image.\n- Badge: Shows a small badge label on the product image.' required=True selection=[('ribbon', 'Ribbon'), ('tag', 'Badge')] string='Style'
• text_color Char
  default='#FFFFFF' required=True string='Text Color'

No public methods.

No new fields.

No public methods.

• accessory_product_ids Many2many → product.product
  check_company=True column1='src_id' column2='dest_id' comodel_name='product.product' help='Accessories show up when the customer reviews the cart before payment (cross-sell strategy).' relation='product_accessory_rel' string='Accessory Products'
• alternative_product_ids Many2many → product.template
  check_company=True column1='src_id' column2='dest_id' comodel_name='product.template' help='Suggest alternatives to your customer (upsell strategy). Those products show up on the product page.' relation='product_alternative_rel' string='Alternative Products'
• base_unit_count Float
  compute='_compute_base_unit_count' default=0 digits=0 help='Display base unit price on your eCommerce pages. Set to 0 to hide it for this product.' inverse='_set_base_unit_count' required=True store=True string='Base Unit Count'
• base_unit_id Many2one → website.base.unit
  comodel_name='website.base.unit' compute='_compute_base_unit_id' help='Define a custom unit to display in the price per unit of measure field.' inverse='_set_base_unit_id' store=True string='Custom Unit of Measure'
• base_unit_name Char
  compute='_compute_base_unit_name' help='Displays the custom unit for the products if defined or the selected unit of measure otherwise.'
• base_unit_price Monetary
  compute='_compute_base_unit_price' string='Price Per Unit'
• compare_list_price Monetary
  help='Add a strikethrough price to your /shop and product pages for comparison purposes.It will not be displayed if pricelists apply.' string='Compare to Price'
• description Html
  index='trigram'
• description_ecommerce Html
  sanitize_attributes=False sanitize_form=False sanitize_overridable=True string='eCommerce Description' translate=html_translate
• description_sale Text
  index='trigram'
• product_template_image_ids One2many → product.image
  comodel_name='product.image' copy=True inverse_name='product_tmpl_id' string='Extra Product Media'
• public_categ_ids Many2many → product.public.category
  comodel_name='product.public.category' help="The product will be available in each mentioned eCommerce category. Go to Shop > Edit Click on the page and enable 'Categories' to view all eCommerce categories." relation='product_public_category_product_template_rel' string='Website Product Category'
• publish_date Datetime
  compute='_compute_publish_date' default=fields.Datetime.now required=True store=True string='Publish Date'
• variants_default_code Char
  compute='_compute_variants_default_code' help='Technical field to enhance performance when looking up default code of productvariants (LIKE/ILIKE)' index='trigram' store=True
• website_description Html
  index='trigram' sanitize_attributes=False sanitize_form=False sanitize_overridable=True string='Description for the website' translate=html_translate
• website_ribbon_id Many2one → product.ribbon
  comodel_name='product.ribbon' string='Ribbon'
• website_sequence Integer
  copy=False default=_default_website_sequence help='Determine the display order in the Website E-commerce' index=True string='Website Sequence'
• website_size_x Integer
  default=1 string='Size X'
• website_size_y Integer
  default=1 string='Size Y'

• create_product_variant(self, product_template_attribute_value_ids)
  Create if necessary and possible and return the id of the product variant matching the given combination for this template. Note AWA: Known "exploit" issues with this method: - This method could be used by an unauthenticated user to generate a lot of useless variants. Unfortunately, after discussing the matter with ODO, there's no easy and user-friendly way to block that behavior. We would have to use captcha/server actions to clean/... that are all not user-friendly/overkill mechanisms. - This method could be used to try to guess what product variant ids are created in the system and what product template ids are configured as "dynamic", but that does not seem like a big deal. The error messages are identical on purpose to avoid giving too much information to a potential attacker: - returning 0 when failing - returning the variant id whether it already existed or not :param product_template_attribute_value_ids: the combination for which to get or create variant :type product_template_attribute_value_ids: list of id of `product.template.attribute.value` :return: id of the product variant matching the combination or 0 :rtype: int
• set_sequence_bottom(self)
• set_sequence_down(self)
• set_sequence_top(self)
• set_sequence_up(self)
• write(self, vals)

No new fields.

No public methods.

No new fields.

No public methods.

No new fields.

No public methods.

• account_on_checkout Selection
  compute='_compute_account_on_checkout' inverse='_inverse_account_on_checkout' readonly=False required=True selection=[('optional', 'Optional'), ('disabled', 'Disabled'), ('mandatory', 'Mandatory')] string='Customer Accounts'
• add_to_cart_action Selection
  readonly=False related='website_id.add_to_cart_action'
• cart_abandoned_delay Float
  readonly=False related='website_id.cart_abandoned_delay'
• cart_recovery_mail_template Many2one
  readonly=False related='website_id.cart_recovery_mail_template_id'
• confirmation_email_template_id Many2one
  readonly=False related='website_id.confirmation_email_template_id'
• ecommerce_access Selection
  readonly=False related='website_id.ecommerce_access'
• group_gmc_feed Boolean
  group='base.group_user' implied_group='website_sale.group_product_feed' readonly=False related='website_id.enabled_gmc_src' string='Google Merchant Center'
• group_product_price_comparison Boolean
  group='base.group_user' help='Add a strikethrough price to your /shop and product pages for comparison purposes.It will not be displayed if pricelists apply.' implied_group='website_sale.group_product_price_comparison' string='Comparison Price'
• group_show_uom_price Boolean
  default=False group='base.group_user' implied_group='website_sale.group_show_uom_price' string='Base Unit Price'
• module_website_sale_autocomplete Boolean
  args: 'Address Autocomplete'
• module_website_sale_collect Boolean
  args: 'Click & Collect'
• salesperson_id Many2one
  readonly=False related='website_id.salesperson_id'
• salesteam_id Many2one
  readonly=False related='website_id.salesteam_id'
• send_abandoned_cart_email Boolean
  readonly=False related='website_id.send_abandoned_cart_email' string='Abandoned Email'
• show_line_subtotals_tax_selection Selection
  readonly=False related='website_id.show_line_subtotals_tax_selection'
• website_sale_contact_us_button_url Char
  readonly=False related='website_id.contact_us_button_url' string='Button Url'
• website_sale_prevent_zero_price_sale Boolean
  readonly=False related='website_id.prevent_zero_price_sale' string='Prevent Sale of Zero Priced Product'

• action_open_abandoned_cart_mail_template(self)
  @api.readonly
• action_open_extra_info(self)
• action_open_product_feeds(self)
  @api.readonly
  Open the list view to manage the feed specific to the current website.
• action_open_sale_mail_templates(self)
  @api.readonly
• action_view_delivery_provider_modules(self)
• set_values(self)

No new fields.

• write(self, vals)

• amount_delivery Monetary
  compute='_compute_amount_delivery' help='Tax included or excluded depending on the website configuration.' string='Delivery Amount'
• cart_quantity Integer
  compute='_compute_cart_info' string='Cart Quantity'
• cart_recovery_email_sent Boolean
  string='Cart recovery email already sent'
• is_abandoned_cart Boolean
  compute='_compute_abandoned_cart' search='_search_abandoned_cart' string='Abandoned Cart'
• only_services Boolean
  compute='_compute_cart_info' string='Only Services'
• shop_warning Char
  string='Warning'
• website_id Many2one → website
  comodel_name='website' help='Website through which this order was placed for eCommerce orders.' readonly=True
• website_order_line One2many → sale.order.line
  comodel_name='sale.order.line' compute='_compute_website_order_line' string='Order Lines displayed on Website'

• action_confirm(self)
• action_preview_sale_order(self)
• action_recovery_email_send(self)
• create(self, vals_list)
  @api.model_create_multi

• name_short Char
  compute='_compute_name_short'
• shop_warning Char
  string='Warning'

• get_description_following_lines(self)

• is_abandoned_cart Boolean
  readonly=True string='Abandoned Cart'
• public_categ_ids Many2many
  related='product_tmpl_id.public_categ_ids' string='eCommerce Categories'
• website_id Many2one → website
  readonly=True args: 'website'

No public methods.

No new fields.

• enable_view(self, xml_id)
  @api.model
  Override of `theme.utils` to disable all category style templates when enabling one.

• account_on_checkout Selection
  default='optional' selection=[('optional', 'Optional'), ('disabled', 'Disabled (buy as guest)'), ('mandatory', 'Mandatory (no guest checkout)')] string='Customer Accounts'
• add_to_cart_action Selection
  default='stay' selection=[('stay', 'Stay on Product Page'), ('go_to_cart', 'Go to cart')]
• auth_signup_uninvited Selection
  default='b2c'
• cart_abandoned_delay Float
  default=10.0 string='Abandoned Delay'
• cart_recovery_mail_template_id Many2one → mail.template
  comodel_name='mail.template' default=_default_recovery_mail_template domain=[('model', '=', 'sale.order')] string='Cart Recovery Email'
• confirmation_email_template_id Many2one → mail.template
  comodel_name='mail.template' default=_default_confirmation_email_template domain=[('model', '=', 'sale.order')]
• contact_us_button_url Char
  default='/contactus' string='Contact Us Button URL' translate=True
• currency_id Many2one → res.currency
  comodel_name='res.currency' compute='_compute_currency_id' string='Default Currency'
• ecommerce_access Selection
  default='everyone' required=True selection=[('everyone', 'All users'), ('logged_in', 'Logged in users')]
• enabled_gmc_src Boolean
  default=<expr> string='Google Merchant Center'
• prevent_zero_price_sale Boolean
  string="Hide 'Add To Cart' when price = 0"
• pricelist_ids One2many → product.pricelist
  comodel_name='product.pricelist' compute='_compute_pricelist_ids' string='Price list available for this Ecommerce/Website'
• product_page_cols_order Selection
  default='regular' selection=[('regular', 'Regular order'), ('inverse', 'Inverse order')] string='Product Page main columns order'
• product_page_container Selection
  default='unset' selection=[('unset', 'Unset'), ('regular', 'Regular'), ('fluid', 'Full-width')]
• product_page_grid_columns Integer
  default=2
• product_page_image_layout Selection
  default='carousel' required=True selection=[('carousel', 'Carousel'), ('grid', 'Grid')]
• product_page_image_ratio Selection
  default='1_1' required=True selection=[('auto', 'Auto'), ('21_9', 'Wider (21/9)'), ('16_9', 'Wide (16/9)'), ('4_3', 'Landscape (4/3)'), ('6_5', 'Horizontal (6/5)'), ('1_1', 'Default (1/1)'), ('4_5', 'Portrait (4/5)'), ('2_3', 'Vertical (2/3)')]
• product_page_image_ratio_mobile Selection
  default='auto' required=True selection=[('auto', 'Auto'), ('21_9', 'Wider (21/9)'), ('16_9', 'Wide (16/9)'), ('4_3', 'Landscape (4/3)'), ('6_5', 'Horizontal (6/5)'), ('1_1', 'Default (1/1)'), ('4_5', 'Portrait (4/5)'), ('2_3', 'Vertical (2/3)')]
• product_page_image_roundness Selection
  default='none' required=True selection=[('none', 'None'), ('small', 'Small'), ('medium', 'Medium'), ('big', 'Big')]
• product_page_image_spacing Selection
  default='none' required=True selection=[('none', 'None'), ('small', 'Small'), ('medium', 'Medium'), ('big', 'Big')]
• product_page_image_width Selection
  default='50_pc' required=True selection=[('none', 'Hidden'), ('33_pc', '33 %'), ('50_pc', '50 %'), ('66_pc', '66 %'), ('100_pc', '100 %')]
• salesperson_id Many2one → res.users
  comodel_name='res.users' domain=[('share', '=', False)] string='Salesperson'
• salesteam_id Many2one → crm.team
  comodel_name='crm.team' default=_default_salesteam_id index='btree_not_null' ondelete='set null' string='Sales Team'
• send_abandoned_cart_email Boolean
  string='Send email to customers who abandoned their cart.'
• send_abandoned_cart_email_activation_time Datetime
  compute='_compute_send_abandoned_cart_email_activation_time' store=True string="Time when the 'Send abandoned cart email' feature was activated."
• shop_default_sort Selection
  default='website_sequence asc' required=True selection='_get_product_sort_mapping'
• shop_extra_field_ids One2many → website.sale.extra.field
  comodel_name='website.sale.extra.field' inverse_name='website_id' string='E-Commerce Extra Fields'
• shop_gap Char
  default='16px' required=False string='Grid-gap on the shop'
• shop_opt_products_design_classes Char
  default='o_wsale_products_opt_layout_catalog o_wsale_products_opt_design_thumbs o_wsale_products_opt_name_color_regular o_wsale_products_opt_rounded_2 o_wsale_products_opt_thumb_cover o_wsale_products_opt_img_secondary_show o_wsale_products_opt_img_hover_zoom_out_light o_wsale_products_opt_has_cta o_wsale_products_opt_actions_onhover o_wsale_products_opt_has_wishlist o_wsale_products_opt_wishlist_fixed o_wsale_products_opt_has_description o_wsale_products_opt_actions_subtle o_wsale_products_opt_cc1' help='CSS class for shop products design' string='Shop Design Class'
• shop_page_container Selection
  default='regular' selection=[('regular', 'Regular'), ('fluid', 'Full-width')]
• shop_ppg Integer
  default=21 string='Number of products in the grid on the shop'
• shop_ppr Integer
  default=3 string='Number of grid columns on the shop'
• show_line_subtotals_tax_selection Selection
  compute='_compute_show_line_subtotals_tax_selection' readonly=False selection=[('tax_excluded', 'Tax Excluded'), ('tax_included', 'Tax Included')] store=True string='Line Subtotals Tax Display'

• action_dashboard_redirect(self)
  @api.model
• configurator_addons_apply(self, industry_name=None, **kwargs)
  Override of `website` to generate eCommerce categories for a given industry using AI.
• configurator_apply(self, *, shop_page_style_option=None, product_page_style_option=None, **kwargs)
  @api.model
  Override of `website` to apply eCommerce page style configurations. :param str shop_page_style_option: The key of the selected shop page style option. See `const.SHOP_PAGE_STYLE_MAPPING`. :param str product_page_style_option: The key of the selected product page style option. See `const.PRODUCT_PAGE_STYLE_MAPPING`.
• create(self, vals_list)
  @api.model_create_multi
• get_configurator_product_page_styles(self)
  @api.model
  Format and return ids and images of each product page style for website onboarding. :return: The product page style information. :rtype: list[dict]
• get_configurator_shop_page_styles(self)
  @api.model
  Format and return the ids and images of each shop page style for website onboarding. :return: The shop page style information. :rtype: list[dict]
• get_pricelist_available(self, show_visible=False)
  Return the list of pricelists that can be used on website for the current user. Country restrictions will be detected with GeoIP (if installed). :param bool show_visible: if True, we don't display pricelist where selectable is False (Eg: Code promo) :returns: pricelist recordset
• get_suggested_controllers(self)
• has_ecommerce_access(self)
  Return whether the current user is allowed to access eCommerce-related content.
• is_pricelist_available(self, pl_id)
  Return a boolean to specify if a specific pricelist can be manually set on the website. Warning: It check only if pricelist is in the 'selectable' pricelists or the current pricelist. :param int pl_id: The pricelist id to check :returns: Boolean, True if valid / available
• sale_product_domain(self)
• sale_reset(self)

• name Char
  help='Define a custom unit to display in the price per unit of measure field.' required=True translate=True

No public methods.

• back_button_label Char
  translate=True
• main_button_label Char
  translate=True
• name Char
  required=True translate=True
• sequence Integer
• step_href Char
  required=True string='Href'
• website_id Many2one → website
  ondelete='cascade' args: 'website'

No public methods.

No new fields.

No public methods.

No new fields.

No public methods.

• field_id Many2one → ir.model.fields
  comodel_name='ir.model.fields' domain=[('model_id.model', '=', 'product.template'), ('ttype', 'in', ['char', 'binary'])] ondelete='cascade' required=True
• label Char
  related='field_id.field_description'
• name Char
  related='field_id.name'
• sequence Integer
  default=10
• website_id Many2one → website
  comodel_name='website' index='btree_not_null'

No public methods.

• product_cross_selling Boolean
  help='True only for product filters that require a product_id because they relate to cross selling' string='About cross selling products'

• default_get(self, fields)
  @api.model

• product_id Many2one → product.product
  comodel_name='product.product' index='btree_not_null' ondelete='cascade' readonly=True

No public methods.

• product_count Integer
  compute='_compute_product_statistics' help='Total number of product viewed' string='Products Views'
• product_ids Many2many → product.product
  comodel_name='product.product' compute='_compute_product_statistics' string='Visited Products'
• visitor_product_count Integer
  compute='_compute_product_statistics' help='Total number of views on products' string='Product Views'

No public methods.