Transfer Toggles

Transfer toggles let users enable or disable specific sync types per sales channel. Not every channel needs every sync direction — for example, a channel might only need product sync but not stock or price sync.

Concept

Each sync direction is represented by a toggle that can be turned on or off:

Toggle	Description
Product sync (outbound)	Push article master data to the platform
Stock sync (outbound)	Push inventory levels to the platform
Price sync (outbound)	Push price updates to the platform
Order status sync (outbound)	Push fulfillment data to the platform
Order import (inbound)	Pull orders from the platform
Media sync (outbound)	Push product images to the platform

Storing Transfer Toggles

Store the toggles as a JSON object in your sales channel parameters:

const defaultTransferTypes = {
  UPLOAD_ARTICLE_MASTERDATA: true,
  UPLOAD_ARTICLE_PRICE: true,
  UPLOAD_ARTICLE_STOCK: true,
  UPLOAD_ARTICLE_MEDIA: true,
  UPLOAD_ORDER_STATUS: true,
  DOWNLOAD_ORDERS: true
};

// Store during channel initialization
await setChannelParameter(salesChannelId, 'TRANSFER_TYPES', JSON.stringify(defaultTransferTypes));

Checking Toggles Before Processing

Before processing a queue item, check whether the corresponding transfer type is enabled:

async function isTransferEnabled(salesChannelId, topic)
{
  const topicToToggle = {
    'article.sync': 'UPLOAD_ARTICLE_MASTERDATA',
    'price.sync': 'UPLOAD_ARTICLE_PRICE',
    'stock.sync': 'UPLOAD_ARTICLE_STOCK',
    'media.sync': 'UPLOAD_ARTICLE_MEDIA',
    'order-status.sync': 'UPLOAD_ORDER_STATUS',
    'order.import': 'DOWNLOAD_ORDERS'
  };

  const toggleKey = topicToToggle[topic];
  if (!toggleKey)
  {
    return true; // Unknown topics are allowed by default
  }

  const transferTypes = JSON.parse(
    await getChannelParameter(salesChannelId, 'TRANSFER_TYPES') || '{}'
  );

  return transferTypes[toggleKey] === true;
}

// In your queue processor
async function processQueueItem(item)
{
  const enabled = await isTransferEnabled(item.salesChannelId, item.topic);

  if (!enabled)
  {
    // Skip — this transfer type is disabled for this channel
    return;
  }

  // Process normally...
}

Building a Settings UI

Provide a settings page where users can toggle sync types on and off for each sales channel. This is typically a list of checkboxes or switches:

Product Sync          [✓]
Stock Sync            [✓]
Price Sync            [ ]  ← disabled
Order Status Sync     [✓]
Order Import          [✓]
Media Sync            [ ]  ← disabled

Saving Toggle Changes

app.apiServer.post('/settings/transfer-types', async (req, res) =>
{
  const salesChannelId = req.headers['x-sales-channel'];
  const transferTypes = req.body;

  await setChannelParameter(salesChannelId, 'TRANSFER_TYPES', JSON.stringify(transferTypes));

  res.json({ success: true });
});

Webhook Handler Optimization

You can also check transfer toggles in your webhook handlers to avoid queuing items that won't be processed:

app.apiServer.post('/webhooks/stock-update', async (req, res) =>
{
  res.status(200).send({ success: true });

  const salesChannelId = getSalesChannelFromWebhook(req);
  const enabled = await isTransferEnabled(salesChannelId, 'stock.sync');

  if (enabled)
  {
    await addToQueue('stock.sync', req.body.entityId, salesChannelId);
  }
});

This prevents unnecessary queue entries when a transfer type is disabled.