Magento Models

class openerp.addons.magentoerpconnect.magento_model.MagentoBackend(pool, cr)

Bases: openerp.models.Model

account_analytic_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

admin_location

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

auth_basic_password

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

auth_basic_username

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

check_magento_structure(*args, **kwargs)

Used in each data import.

Verify if a website exists for each backend before starting the import.

company_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

default_category_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

default_lang_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

fiscal_position_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

import_categories_from_date

import_customer_groups(*args, **kwargs)

import_partners(*args, **kwargs)

Import partners from all websites

import_product_categories(*args, **kwargs)

import_product_product(*args, **kwargs)

import_products_from_date

import_sale_orders(*args, **kwargs)

Import sale orders from all store views

location

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

output_recorder(*args, **kwargs)

Utility method to output a file containing all the recorded requests / responses with Magento. Used to generate test data. Should be called with erppeek for instance.

password

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

product_binding_ids

One2many field; the value of such a field is the recordset of all the records in comodel_name such that the field inverse_name is equal to the current record.

Parameters:

• comodel_name – name of the target model (string)
• inverse_name – name of the inverse Many2one field in comodel_name (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• limit – optional limit to use upon read (integer)

The attributes comodel_name and inverse_name are mandatory except in the case of related fields or field extensions.

product_stock_field_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

sale_prefix

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

select_versions(*args, **kwargs)

Available versions in the backend.

Can be inherited to add custom versions. Using this method to add a version from an _inherit does not constrain to redefine the version field in the _inherit model.

synchronize_metadata(*args, **kwargs)

update_product_stock_qty(*args, **kwargs)

use_auth_basic

use_custom_api_path

username

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

version

Parameters:

• selection – specifies the possible values for this field. It is given as either a list of pairs (value, string), or a model method, or a method name.
• selection_add – provides an extension of the selection in the case of an overridden field. It is a list of pairs (value, string).

The attribute selection is mandatory except in the case of related fields or field extensions.

warehouse_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

website_ids

One2many field; the value of such a field is the recordset of all the records in comodel_name such that the field inverse_name is equal to the current record.

Parameters:

• comodel_name – name of the target model (string)
• inverse_name – name of the inverse Many2one field in comodel_name (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• limit – optional limit to use upon read (integer)

The attributes comodel_name and inverse_name are mandatory except in the case of related fields or field extensions.

class openerp.addons.magentoerpconnect.magento_model.MagentoConfigSpecializer(pool, cr)

Bases: openerp.models.AbstractModel

account_analytic_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

fiscal_position_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

specific_account_analytic_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

specific_fiscal_position_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

class openerp.addons.magentoerpconnect.magento_model.MagentoStore(pool, cr)

Bases: openerp.models.Model

backend_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

create_invoice_on

Parameters:

• selection – specifies the possible values for this field. It is given as either a list of pairs (value, string), or a model method, or a method name.
• selection_add – provides an extension of the selection in the case of an overridden field. It is a list of pairs (value, string).

The attribute selection is mandatory except in the case of related fields or field extensions.

name

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

send_invoice_paid_mail

send_picking_done_mail

storeview_ids

One2many field; the value of such a field is the recordset of all the records in comodel_name such that the field inverse_name is equal to the current record.

Parameters:

• comodel_name – name of the target model (string)
• inverse_name – name of the inverse Many2one field in comodel_name (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• limit – optional limit to use upon read (integer)

The attributes comodel_name and inverse_name are mandatory except in the case of related fields or field extensions.

website_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

class openerp.addons.magentoerpconnect.magento_model.MagentoStoreview(pool, cr)

Bases: openerp.models.Model

backend_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

catalog_price_tax_included

code

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

enabled

import_orders_from_date

import_sale_orders(*args, **kwargs)

lang_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

name

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

no_sales_order_sync

section_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

sort_order

store_id

The value of such a field is a recordset of size 0 (no record) or 1 (a single record).

Parameters:

• comodel_name – name of the target model (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• ondelete – what to do when the referred record is deleted; possible values are: 'set null', 'restrict', 'cascade'
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• delegate – set it to True to make fields of the target model accessible from the current model (corresponds to _inherits)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

class openerp.addons.magentoerpconnect.magento_model.MagentoWebsite(pool, cr)

Bases: openerp.models.Model

code

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

import_partners(*args, **kwargs)

import_partners_from_date

name

Basic string field, can be length-limited, usually displayed as a single-line string in clients

Parameters:

• size (int) – the maximum size of values stored for that field
• translate (bool) – whether the values of this field can be translated

product_binding_ids

Many2many field; the value of such a field is the recordset.

Parameters:comodel_name – name of the target model (string)

The attribute comodel_name is mandatory except in the case of related fields or field extensions.

Parameters:

• relation – optional name of the table that stores the relation in the database (string)
• column1 – optional name of the column referring to “these” records in the table relation (string)
• column2 – optional name of the column referring to “those” records in the table relation (string)

The attributes relation, column1 and column2 are optional. If not given, names are automatically generated from model names, provided model_name and comodel_name are different!

Parameters:

• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• limit – optional limit to use upon read (integer)

sort_order

store_ids

One2many field; the value of such a field is the recordset of all the records in comodel_name such that the field inverse_name is equal to the current record.

Parameters:

• comodel_name – name of the target model (string)
• inverse_name – name of the inverse Many2one field in comodel_name (string)
• domain – an optional domain to set on candidate values on the client side (domain or string)
• context – an optional context to use on the client side when handling that field (dictionary)
• auto_join – whether JOINs are generated upon search through that field (boolean, by default False)
• limit – optional limit to use upon read (integer)

The attributes comodel_name and inverse_name are mandatory except in the case of related fields or field extensions.

openerp.addons.magentoerpconnect.magento_model.MetadataBatchImport

alias of openerp.addons.magentoerpconnect.magento_model.MetadataBatchImporter

class openerp.addons.magentoerpconnect.magento_model.MetadataBatchImporter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.import_synchronizer.DirectBatchImporter

Import the records directly, without delaying the jobs.

Import the Magento Websites, Stores, Storeviews

They are imported directly because this is a rare and fast operation, and we don’t really bother if it blocks the UI during this time. (that’s also a mean to rapidly check the connectivity with Magento).

class openerp.addons.magentoerpconnect.magento_model.StoreAdapter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.backend_adapter.GenericAdapter

class openerp.addons.magentoerpconnect.magento_model.StoreAddCheckpoint(connector_env)

Bases: openerp.addons.connector.connector.ConnectorUnit

Add a connector.checkpoint on the magento.storeview or magento.store record

run(binding_id)

openerp.addons.magentoerpconnect.magento_model.StoreImport

alias of openerp.addons.magentoerpconnect.magento_model.StoreImporter

class openerp.addons.magentoerpconnect.magento_model.StoreImportMapper(connector_env)

Bases: openerp.addons.connector.unit.mapper.ImportMapper

direct = [('name', 'name')]

website_id(record)

class openerp.addons.magentoerpconnect.magento_model.StoreImporter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.import_synchronizer.MagentoImporter

Import one Magento Store (create a sale.shop via _inherits)

openerp.addons.magentoerpconnect.magento_model.StoreViewAddCheckpoint

alias of openerp.addons.magentoerpconnect.magento_model.StoreAddCheckpoint

class openerp.addons.magentoerpconnect.magento_model.StoreviewAdapter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.backend_adapter.GenericAdapter

openerp.addons.magentoerpconnect.magento_model.StoreviewImport

alias of openerp.addons.magentoerpconnect.magento_model.StoreviewImporter

class openerp.addons.magentoerpconnect.magento_model.StoreviewImportMapper(connector_env)

Bases: openerp.addons.connector.unit.mapper.ImportMapper

direct = [('name', 'name'), ('code', 'code'), ('is_active', 'enabled'), ('sort_order', 'sort_order')]

store_id(record)

class openerp.addons.magentoerpconnect.magento_model.StoreviewImporter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.import_synchronizer.MagentoImporter

Import one Magento Storeview

class openerp.addons.magentoerpconnect.magento_model.WebsiteAdapter(connector_env)

Bases: openerp.addons.magentoerpconnect.unit.backend_adapter.GenericAdapter

class openerp.addons.magentoerpconnect.magento_model.WebsiteImportMapper(connector_env)

Bases: openerp.addons.connector.unit.mapper.ImportMapper

backend_id(record)

direct = [('code', 'code'), ('sort_order', 'sort_order')]

name(record)