Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

importer

importer

Specifies the type of object to import. Dependencies of those objects are also imported (see below).

Parent elements

importstrategy

Attributes

Name

Number of occurrences

Description

type

1

Specifies the type of objects to be imported. Supported values are:

  • PRODUCT: Import products (and product bundles) and their associated categories and catalogs. The product data must be stored in the import package in a file named products.xml.
    Note: If importing product bundles, the system always performs a CLEAR_COLLECTION. RETAIN_COLLECTIONis not available for product bundles.
  • CATALOG: Import catalogs. The catalog data must be stored in the import package in a file named catalogs.xml.
  • CATEGORY: Import categories and their associated catalogs. The category data must be stored in the import package in a file named categories.xml.
  • PROMOTION: Import promotions and (optionally) their associated conditions and eligibilities. The promotion data must be stored in the import package in a file named promotions.xml. Condition and eligibility data, if included, must be stored in the import package in a file named condition_rules.xml.
  • SYSTEMCONFIGURATION: Import system configuration settings. The setting data must be stored in the import package in a file named system_configuration.xml.
  • PRICELISTDESCRIPTOR: Import price lists and (optionally) their base amounts. The price lists must be stored in the import package in a file named price_lists.xml. The base amounts, if included, must be stored in the import package in a file named base_amounts.xml.
  • PAYMENTGATEWAY: Import payment gateways and (optionally) payment gateway properties. The payment gateways must be stored in the import package in a file named payment_gateways.xml.
  • PRICELISTASSIGNMENT: Import price list assignments. The price list assignments must be stored in a file named price_list_assignments.xml.
  • WAREHOUSE: Import warehouses. The warehouses must be stored in a file named warehouses.xml.
  • TAXCODE: Import tax codes. The tax codes must be stored in a file named tax_codes.xml.
  • TAXJURISDICTION: Import tax jurisdictions. The tax jurisdictions must be stored in a file named tax_jurisdictions.xml.
  • STORE: Import stores. The stores must be stored in a file named stores.xml.
  • STORE_ASSOCIATION: Import store associations. The store associations must be stored in a file named store_associations.xml.
  • CUSTOMERPROFILE_ATTRIBUTE: Import customer profile attributes. The customer profile attributes must be stored in a file named customerprofile_attributes.xml.
  • CMUSER: Import CMusers and (optionally) the user roles, price lists, catalogs, stores, warehouses, and user password histories associated with the CMuser. The CMusers must be stored in a file named cmusers.xml.
  • USER_ROLE: Import user roles and (optionally) user permissions. User roles must be stored in a file named user_roles.xml.
  • CUSTOMER: Import customers. Customers must be stored in a file named customers.xml.
  • PROMOTION: Import promotions. Promotions must be stored in a file named promotions.xml.
  • COUPONSET: Import coupon sets and (optionally) the coupons in the coupon set. Coupon sets must be stored in a file named coupon_sets.xml.
  • GIFT_CERTIFICATE: Import gift certificates. Gift certificates must be stored in a file named gift_certificates.xml.
  • SHIPPING_SERVICE_LEVEL: Import shipping service level. Shipping service levels must be stored in a file named shipping_service_levels.xml.
  • SHIPPING_REGION: Import shipping regions. Shipping regions must be stored in a file named shipping_regions.xml.
  • SAVED_CONDITION: Import saved conditions. Saved conditions must be stored in a file named saved_conditions.xml.
  • CM_IMPORT_JOB: Import CM import jobs and (optionally) CM import mappings. CM import jobs must be stored in a file named cmimportjobs.xml
  • DATA_POLICY: Import data policies. You must store the data policies with the file name data_policies.xml. Only the items that do not exist in the system are imported.
  • CUSTOMER_CONSENT: Import customer consents. You must store the customer consents with the file name customer_consents.xml.Only the items that do not exist in the system are imported.

Child elements

Note:

Child elements are ordered.

Name

Number of occurrences

Description

importstrategy

0..1

Specifies how the Import-Export tool resolves conflicts between data in the import package and existing data in the destination.

dependentelements

0..1

Specifies how dependencies of each item type are handled.