ePages 6.11.0 - DE_EPAGES/Customer/API/CSV/CustomerExportImport.pm

Package DE_EPAGES::Customer::API::CSV::CustomerExportImport

This module implements the high level interface for import and export of customer data to CVS files.

Functions

csvExport
csvImport
new
warningCodes

csvExport

Exports all customer data of the shop to a CSV file.

Syntax
$Driver->csvExport($Shop, $PathFileName, $hFileFormat);
Example
my $Driver = DE_EPAGES::Content::API::CSV::ContentExportImport->new;
$Driver->csvExport( $Shop, 'Categories.csv', {
        'LanguageCode2s' => ['de', 'en'],
        'LocaleID' => 'de_DE',
} );
Input
$Path (string)
Path to shop object
$PathFileName (string)
CSV file name
$hFileFormat (ref.hash)
defines what to export
  • LanguageCode2s - list of ISO language codes. defines which
    languages are exported. If the list is empty, then all
    languages are exported. - array of strings
  • LocaleID - locale id - string
$aObjects (ref.array.integer)
list of objects, if undef all customers where exported

csvImport

Imports customer data from a CSV file into a shop.

Syntax
$Driver->csvImport($Shop, $PathFileName, $hFileFormat);
Example
my $Driver = DE_EPAGES::Content::API::CSV::ContentExportImport->new;
$Driver->csvImport( $Shop , 'Categories.csv', {
        'LanguageCode2s' => ['de', 'en'],
        'LocaleID' => 'de_DE',
} );
Input
$Path (string)
Path to shop object
$PathFileName (string)
CSV file name
$hFileFormat (ref.hash)
defines what to export
  • LanguageCode2s - list of ISO language codes. defines which
    languages are imported. If the list is empty, then all
    languages are imported. - array of strings
  • LocaleID - locale id - string

new

create a new csv export driver

Syntax
$Driver= DE_EPAGES::Customer::API::CSV::CustomerExportImport->new(%options);
Input
%options (hash)
exporter options
Return
$Exporter (object)
exporter

warningCodes

Returns the warning codes for csv export.

Syntax
$aWarningCodes = $Driver->warningCodes();
Return
$aWarningCodes (array.string)
warning codes