Commerce

8.6.x

Commerce Manager Related Object Types

CM Import Job

An import job updates objects from Comma Separated Values(CSV) file data, such as:

  • Categories
  • Products
  • Inventories
  • Prices
  • Customers

Each column in the CSV file maps to a data field in the Commerce Manager. The element <mappings>, as shown in the example below, defines these mappings.

note

When an export is performed, an empty pricing.xml is generated. This file is generated for legacy systems and should not be used.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cmimportjobs>
    <cmimportjob guid="IMPORT_JOB_FOR_COUPON_CODE_EMAIL">
        <name>Coupon Codes and Addresses Import</name>
        <csv_file_name>template.csv</csv_file_name>
        <col_delimeter>,</col_delimeter>
        <text_qualifier>&quot;</text_qualifier>
        <data_type_name>Coupon Code And Email</data_type_name>
        <dependent_price_list_guid>null</dependent_price_list_guid>
        <import_type_id>1</import_type_id>
        <max_allow_errors>0</max_allow_errors>
        <mappings>
            <mapping>
                <col_number>1</col_number>
                <import_field_name>couponCode</import_field_name>
            </mapping>
            <mapping>
                <col_number>2</col_number>
                <import_field_name>emailAddress</import_field_name>
            </mapping>
        </mappings>
    </cmimportjob>

    <cmimportjob guid="59072B87-43EE-BD05-8595-CD2A2BA25229">
        <name>01-SnapItUp</name>
        <csv_file_name>snapitup.csv</csv_file_name>
        <col_delimeter>|</col_delimeter>
        <text_qualifier>&quot;</text_qualifier>
        <data_type_name>Category - SnapItUp</data_type_name>
        <import_type_id>1</import_type_id>
        <max_allow_errors>0</max_allow_errors>
        <catalogue_guid>SNAPITUP</catalogue_guid>
        <mappings>
            <mapping>
                <col_number>5</col_number>
                <import_field_name>parentCategoryCode</import_field_name>
            </mapping>
            <mapping>
                <col_number>7</col_number>
                <import_field_name>storeVisible</import_field_name>
            </mapping>
            <mapping>
                <col_number>2</col_number>
                <import_field_name>displayName(en)</import_field_name>
            </mapping>
            <mapping>
                <col_number>1</col_number>
                <import_field_name>categoryCode</import_field_name>
            </mapping>
            <mapping>
                <col_number>6</col_number>
                <import_field_name>ordering</import_field_name>
            </mapping>
            <mapping>
                <col_number>3</col_number>
                <import_field_name>displayName(fr)</import_field_name>
            </mapping>
            <mapping>
                <col_number>11</col_number>
                <import_field_name>seoDescription(fr)</import_field_name>
            </mapping>
            <mapping>
                <col_number>8</col_number>
                <import_field_name>catDescription(en)</import_field_name>
            </mapping>
            <mapping>
                <col_number>10</col_number>
                <import_field_name>seoDescription(en)</import_field_name>
            </mapping>
            <mapping>
                <col_number>4</col_number>
                <import_field_name>catImage</import_field_name>
            </mapping>
            <mapping>
                <col_number>9</col_number>
                <import_field_name>catDescription(fr)</import_field_name>
            </mapping>
        </mappings>
    </cmimportjob>
</cmimportjobs>

CMUser

A CMUser is a Commerce Manager administrator account. Each account has access to certain features, as determined by the user roles assigned to the account. For more information on Commerce Manager administrator accounts, see the Commerce Manager User Manual.

Field definitions:

  • <user_name>: The username that the user specifies when logging into Commerce Manager.
  • <oidc_subject>: The subject identifier that connects this user to a user in your Identity Provider.
  • <enabled>: Shows a true/false value that sets the CMUser to be disabled or enabled in the Commerce Manager.
  • <user_password_history_items>: Provides a list of passwords the CMUser has used. Up to four passwords are stored.
  • <has_temporary_password>: Indicates the CM user has a temporary password. On log in, Commerce Manager requires the user to change their password.
  • <user_role_guids>: Lists the User Roles assigned to the CMUser.
  • <catalog_codes>: Lists the Catalogs the CMUser has access to.
  • <store_codes>: Lists the Stores the CMUser has access to.
  • <warehouse_codes>: Lists the Warehouses the CMUser has access to.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cmusers>
    <cmuser guid="03BAF4C3-0D92-093D-E9D6-B03CDDBAD3AC">
        <user_name>ViewProductPricing</user_name>
        <email>test21@pd.local</email>
        <oidc_subject>6bfdd1e3-4f02-42bc-ac9e-802b6f9be5fd</oidc_subject>
        <first_name>PricePermissionViewProductPricing</first_name>
        <last_name>PermissionTest</last_name>
        <password>e38ad214943daad1d64c102faec29de4afe9da3d</password>
        <creation_date>2012-01-30T16:06:48-08:00</creation_date>
        <last_login>2012-02-01T10:13:02-08:00</last_login>
        <last_password_change>2012-01-30T16:28:41-08:00</last_password_change>
        <last_modified>2012-02-01T10:13:02-08:00</last_modified>
        <total_failed_login_attempts>0</total_failed_login_attempts>
        <enabled>true</enabled>
        <has_temporary_password>false</has_temporary_password>
        <user_password_history_items/>
        <has_access_to_all_warehouses>true</has_access_to_all_warehouses>
        <has_access_to_all_catalogs>true</has_access_to_all_catalogs>
        <has_access_to_all_stores>true</has_access_to_all_stores>
        <has_access_to_all_price_lists>true</has_access_to_all_price_lists>
        <user_role_guids>
            <user_role_guids>202</user_role_guids>
            <user_role_guids>F64A4413-C442-980F-CF6B-C195A38CA4FD</user_role_guids>
        </user_role_guids>
        <price_list_guids/>
        <catalog_codes/>
        <store_codes/>
        <warehouse_codes/>
    </cmuser>
</cmusers>

User Roles

User rolea are a set of permissions. Each permission defines the various actions that an administrator (CMUser) can perform when logged into the Commerce Manager.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<user_roles>
    <user_role guid="ABCFCF0B-4CC1-4B01-A193-2DD35F12F8EF">
        <name>Catalog Management</name>
        <description>Catalog Management Role</description>
        <permissions>
            <permission>MANAGE_PRODUCT_SKU</permission>
            <permission>CATEGORY_MANAGE</permission>
            <permission>CATEGORY_INCLUDE_EXCLUDE</permission>
            <permission>CATALOG_IMPORTS_MANAGE</permission>
            <permission>CATALOG_MANAGE</permission>
            <permission>GLOBAL_ATTRIBUTE_EDIT</permission>
            <permission>INCLUDE_EXCLUDE_PRODUCT</permission>
            <permission>MANAGE_PRODUCT_MERCHANDISING</permission>
            <permission>PRICE_MANAGEMENT_MANAGE_PRODUCT_PRICING</permission>
            <permission>CATALOG_IMPORTS_EXECUTE</permission>
            <permission>MANAGE_VIRTUAL_CATALOG_LINK_CATEGORY</permission>
        </permissions>
    </user_role>
</user_roles>

System Configuration

The System Configuration object is set of Commerce Manager’s system configuration settings.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<system_configuration>
    <configuration_setting>
        <name_space>COMMERCE/STORE/theme</name_space>
        <description>The theme associated with the store. (The name of the subfolder under the themes directory that contains the theme's templates, CSS files, and other resources.)</description>
        <default_value type="String">electronics</default_value>
        <max_overrides>-1</max_overrides>
        <defined_values>
            <value context="SNAPITUP">electronics</value>
            <value context="SNAPITUPUK">electronics</value>
            <value context="SLRWORLD">electronics</value>
        </defined_values>
        <setting_metadata>
            <value key="environmentSpecific">false</value>
            <value key="tefreshStrategy">interval:timeout=COMMERCE/Cache/Cache_2</value>
        </setting_metadata>
    </configuration_setting>
</system_configuration>

Tag Groups

A tag group is a logical set of tag definitions used to organize tags. For more information, see the Tagging Framework section.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tag_groups>
    <tag_group code="CUSTOM_CONDITIONS">
        <displayName>
            <value language="es">Custom Conditions</value>
            <value language="ru">Специальные Условия</value>
        </displayName>
        <definitions>
            <tag code="CUSTOMER_ZIP_CODE">
                <name>CUSTOMER_ZIP_CODE</name>
                <type>text</type>
                <description>Customer's zip code</description>
                <displayName>
                    <value language="es">Customer ZIP</value>
                    <value language="ru">Почтовый Индекс Покупателя</value>
                </displayName>
                <dictionaries>
                    <dictionary>PLA_SHOPPER</dictionary>
                    <dictionary>PROMOTIONS_SHOPPER</dictionary>
                </dictionaries>
            </tag>
        </definitions>
    </tag_group>

    <tag_group code="CUSTOMER_SEGMENT">
        <displayName>
            <value language="es">Customer Segment</value>
            <value language="ru">Покупательский Сегмент</value>
        </displayName>
        <definitions>
            <tag code="CUSTOMER_COUNTRY_CODE">
                <name>CUSTOMER_COUNTRY_CODE</name>
                <type>country_code</type>
                <description>Customer's country code</description>
                <displayName>
                    <value language="es">Customer Country</value>
                    <value language="ru">Страна Покупателя</value>
                </displayName>
                <dictionaries>
                    <dictionary>PLA_SHOPPER</dictionary>
                </dictionaries>
            </tag>
        </definitions>
    </tag_group>
</tag_groups>
Last updated on 5/10/2024
← Import Export ConceptsCustomer →