Unopim Export/Import Workflow

1. exporters.php

Every select filter field needs: async, track_by, label_by, list_route. Optional: dependent (array of field names this field depends on).

<?php
// Config/exporters.php

return [

    // ---- Product Export ----
    '{ModuleName}Products' => [
        'title'     => '{module-name}::app.data-transfer.exports.type.product',
        'exporter'  => \Webkul\{ModuleName}\Helpers\Exporters\Product\Exporter::class,
        'validator' => \Webkul\{ModuleName}\Validators\JobInstances\Export\ProductsValidator::class,
        'source'    => \Webkul\Product\Repositories\ProductRepository::class,
        'filters'   => [
            'fields' => [
                [
                    'name'       => 'credential',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.credential',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,          // REQUIRED for select fields
                    'track_by'   => 'id',          // REQUIRED — key used to track value
                    'label_by'   => 'label',       // REQUIRED — key used for display
                    'list_route' => '{module-slug}.credentials.get', // REQUIRED — API route
                ],
                [
                    'name'       => 'channel',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.channel',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.channel.get',
                    'dependent'  => ['locale'],    // optional: fields this depends on
                ],
                [
                    'name'       => 'locale',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.locale',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.locale.get',
                ],
                [
                    'name'       => 'currency',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.currency',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.currency.get',
                ],
                [
                    'name'       => 'with_media',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.with-media',
                    'type'       => 'boolean',      // boolean fields have no async/track_by
                ],
            ],
        ],
    ],

    // ---- Category Export ----
    '{ModuleName}Categories' => [
        'title'     => '{module-name}::app.data-transfer.exports.type.category',
        'exporter'  => \Webkul\{ModuleName}\Helpers\Exporters\Category\Exporter::class,
        'validator' => \Webkul\{ModuleName}\Validators\JobInstances\Export\CategoryAndAttributesValidator::class,
        'source'    => \Webkul\Category\Repositories\CategoryRepository::class,
        'filters'   => [
            'fields' => [
                [
                    'name'       => 'credential',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.credential',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.credentials.get',
                ],
                [
                    'name'       => 'channel',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.channel',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.channel.get',
                    'dependent'  => ['locale'],
                ],
                [
                    'name'       => 'locale',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.locale',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.locale.get',
                ],
            ],
        ],
    ],

    // ---- Attribute Export ----
    '{ModuleName}Attributes' => [
        'title'     => '{module-name}::app.data-transfer.exports.type.attribute',
        'exporter'  => \Webkul\{ModuleName}\Helpers\Exporters\Attribute\Exporter::class,
        'validator' => \Webkul\{ModuleName}\Validators\JobInstances\Export\CategoryAndAttributesValidator::class,
        'source'    => \Webkul\Attribute\Repositories\AttributeRepository::class,
        'filters'   => [
            'fields' => [
                [
                    'name'       => 'credential',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.credential',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.credentials.get',
                ],
                [
                    'name'       => 'channel',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.channel',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.channel.get',
                    'dependent'  => ['locale'],
                ],
                [
                    'name'       => 'locale',
                    'title'      => '{module-name}::app.data-transfer.exports.filters.locale',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.locale.get',
                ],
            ],
        ],
    ],
];

2. quick_exporters.php

One-click export jobs that appear in the Unopim product listing toolbar. Keys: title, route, exporter, source. No filters key.

<?php
// Config/quick_exporters.php

return [
    '{ModuleName}QuickExport' => [
        'title'    => '{Module Name} Quick Export Product',
        'route'    => '{module-slug}.quick_export',
        'exporter' => \Webkul\{ModuleName}\Helpers\Exporters\Product\Exporter::class,
        'source'   => \Webkul\Product\Repositories\ProductRepository::class,
    ],
];

3. importers.php

Same filter structure as exporters.php — async/track_by/label_by/list_route required.

<?php
// Config/importers.php

return [

    // ---- Category Import ----
    '{ModuleName}CategoriesImport' => [
        'title'     => '{module-name}::app.data-transfer.imports.type.category',
        'importer'  => \Webkul\{ModuleName}\Helpers\Importers\Category\Importer::class,
        'validator' => \Webkul\{ModuleName}\Validators\JobInstances\Import\CategoryAndAttributesValidator::class,
        'source'    => \Webkul\Category\Repositories\CategoryRepository::class,
        'filters'   => [
            'fields' => [
                [
                    'name'       => 'credential',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.credential',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.credentials.get',
                ],
                [
                    'name'       => 'locale',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.locale',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.locale.get',
                ],
            ],
        ],
    ],

    // ---- Product Import ----
    '{ModuleName}ProductImport' => [
        'title'     => '{module-name}::app.data-transfer.imports.type.product',
        'importer'  => \Webkul\{ModuleName}\Helpers\Importers\Product\Importer::class,
        'validator' => \Webkul\{ModuleName}\Validators\JobInstances\Import\ProductsValidator::class,
        'source'    => \Webkul\Product\Repositories\ProductRepository::class,
        'filters'   => [
            'fields' => [
                [
                    'name'       => 'credential',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.credential',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.credentials.get',
                ],
                [
                    'name'       => 'channel',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.channel',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.channel.get',
                    'dependent'  => ['locale'],
                ],
                [
                    'name'       => 'locale',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.locale',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.locale.get',
                ],
                [
                    'name'       => 'currency',
                    'title'      => '{module-name}::app.data-transfer.imports.filters.currency',
                    'required'   => true,
                    'validation' => 'required',
                    'type'       => 'select',
                    'async'      => true,
                    'track_by'   => 'id',
                    'label_by'   => 'label',
                    'list_route' => '{module-slug}.currency.get',
                ],
            ],
        ],
    ],
];

4. Credentials GET Route (Required for list_route)

The list_route values in filter fields reference named routes that return {id, label} JSON for each selectable item.

// In routes file — inside the admin middleware group
Route::get('credentials/get', [CredentialController::class, 'getCredentials'])
     ->name('{module-slug}.credentials.get');

// In CredentialController
public function getCredentials(): JsonResponse
{
    $credentials = $this->credentialRepository->all(['id', 'label']);

    return new JsonResponse($credentials);
}

5. Exporter Class (AbstractExporter)

<?php
// src/Helpers/Exporters/Product/Exporter.php

namespace Webkul\{ModuleName}\Helpers\Exporters\Product;

use Webkul\DataTransfer\Contracts\JobTrackBatch as JobTrackBatchContract;
use Webkul\DataTransfer\Helpers\Export as ExportHelper;
use Webkul\DataTransfer\Helpers\Exporters\AbstractExporter;
use Webkul\DataTransfer\Jobs\Export\File\FlatItemBuffer as FileExportFileBuffer;
use Webkul\DataTransfer\Repositories\JobTrackBatchRepository;
use Webkul\{ModuleName}\Repositories\CredentialRepository;
use Webkul\{ModuleName}\Services\{ModuleName}Service;

class Exporter extends AbstractExporter
{
    /**
     * Batch size for chunked processing.
     */
    public const BATCH_SIZE = 100;

    /**
     * Entity tag used in error reporting.
     */
    public const UNOPIM_ENTITY_NAME = 'product';

    /**
     * Action for creating a new record.
     */
    public const ACTION_ADD = 'createProduct';

    /**
     * Action for updating an existing record.
     */
    public const ACTION_UPDATE = 'updateProduct';

    /**
     * Error code when item already exists.
     */
    public const CODE_ALREADY_EXIST = 'product_invalid_sku';

    /**
     * Error code when item does not exist.
     */
    public const CODE_NOT_EXIST = 'rest_term_invalid';

    public function __construct(
        protected JobTrackBatchRepository $importBatchRepository,
        protected FileExportFileBuffer $exportFileBuffer,
        protected CredentialRepository $credentialRepository,
        protected {ModuleName}Service $service,
    ) {
        parent::__construct($importBatchRepository, $exportFileBuffer);
    }

    /**
     * Initialize: called once before batch processing.
     *
     * @return void
     */
    public function initializeExport(): void
    {
        $credentialId = $this->getFilterValue('credential');
        $credential   = $this->credentialRepository->findOrFail($credentialId);
        $this->service->useCredential($credential);
    }

    /**
     * Export a batch of items.
     *
     * @return bool
     */
    public function exportBatch(JobTrackBatchContract $batch, $filePath): bool
    {
        $this->initializeBatch($batch);

        foreach ($batch->data as $rowData) {
            $this->processItem($rowData);
        }

        $this->saveBatchSummary($batch, $filePath);

        return true;
    }

    /**
     * Process a single item.
     *
     * @param  array<mixed>  $rowData
     */
    protected function processItem(array $rowData): void
    {
        try {
            $existingId = $this->findExternalId($rowData['sku'] ?? null);

            if ($existingId) {
                $this->service->updateProduct($existingId, $rowData);
                $this->createdItemsCount++;
            } else {
                $this->service->createProduct($rowData);
                $this->updatedItemsCount++;
            }
        } catch (\Throwable $e) {
            $this->jobLogger?->warning($e->getMessage());
            $this->skippedItemsCount++;
        }
    }

    /**
     * Look up whether this SKU already exists externally.
     */
    protected function findExternalId(?string $sku): ?int
    {
        if (! $sku) {
            return null;
        }

        $results = $this->service->searchProducts(['sku' => $sku]);

        return $results[0]['id'] ?? null;
    }
}

6. Validator Class

<?php
// src/Validators/JobInstances/Export/ProductsValidator.php

namespace Webkul\{ModuleName}\Validators\JobInstances\Export;

use Webkul\DataTransfer\Validators\JobInstances\AbstractValidator;

class ProductsValidator extends AbstractValidator
{
    /**
     * Validate the job filter inputs.
     *
     * @param  array<string, mixed>  $filters
     * @return array<string>  error messages, empty if valid
     */
    public function validate(array $filters): array
    {
        $errors = [];

        if (empty($filters['credential'])) {
            $errors[] = trans('{module-name}::app.validation.credential-required');
        }

        if (empty($filters['channel'])) {
            $errors[] = trans('{module-name}::app.validation.channel-required');
        }

        if (empty($filters['locale'])) {
            $errors[] = trans('{module-name}::app.validation.locale-required');
        }

        return $errors;
    }
}

7. Importer Class

<?php
// src/Helpers/Importers/Product/Importer.php

namespace Webkul\{ModuleName}\Helpers\Importers\Product;

use Webkul\DataTransfer\Helpers\Importers\AbstractImporter;
use Webkul\{ModuleName}\Repositories\CredentialRepository;
use Webkul\{ModuleName}\Services\{ModuleName}Service;

class Importer extends AbstractImporter
{
    public const BATCH_SIZE = 100;

    public const UNOPIM_ENTITY_NAME = 'product';

    public function __construct(
        protected CredentialRepository $credentialRepository,
        protected {ModuleName}Service $service,
    ) {}

    /**
     * Import a batch of external products into Unopim.
     *
     * @param  array<mixed>  $items   Raw items from external API
     * @return void
     */
    public function importBatch(array $items): void
    {
        foreach ($items as $item) {
            $this->processImportItem($item);
        }
    }

    /**
     * @param  array<mixed>  $item
     */
    protected function processImportItem(array $item): void
    {
        // Transform external item to Unopim product format
        // and upsert via product repository
    }
}

8. Checklist

• exporters.php has async, track_by, label_by, list_route on every select field
• quick_exporters.php created with title/route/exporter/source (no filters)
• importers.php created using same filter field structure as exporters
• {module-slug}.credentials.get route registered returning [{id, label}]
• Exporter classes in Helpers/Exporters/{Entity}/ (not Services/)
• Importer classes in Helpers/Importers/{Entity}/
• Both extend AbstractExporter / AbstractImporter from Webkul\DataTransfer
• BATCH_SIZE constant defined in each exporter/importer
• UNOPIM_ENTITY_NAME constant defined
• Validator classes in Validators/JobInstances/Export/ and .../Import/
• All 3 config files registered in ServiceProvider's registerConfig()
• dependent used in fields where one selection changes another's options