App Manifest Shop

The app manifest defines your app's metadata, required permissions, and UI integration points. Shop and marketplace apps need specific permissions and integrations beyond what a basic VARIO app requires.

Complete Example

Here is a full manifest for a shop integration:

{
  "appVersion": "1.0.0",
  "label": "My Shop Integration",
  "description": "Connects My Shop Platform with VARIO Cloud ERP for product, stock, price, and order synchronization.",
  "shortName": "my-shop",
  "rootUrl": "https://app.example.com/",
  "pcInstallationUrl": "https://app.example.com/ui/install.html",
  "pcInstallationDeletionUrl": "https://app.example.com/ui/uninstall.html",
  "pcManifestUrl": "https://app.example.com/manifest",
  "requirements": {
    "permissions": [
      { "resource": "article", "verb": "read" },
      { "resource": "article", "verb": "update" },
      { "resource": "stock", "verb": "read" },
      { "resource": "price", "verb": "read" },
      { "resource": "document", "verb": "readSalesDocuments" },
      { "resource": "sales-channel", "verb": "create" },
      { "resource": "sales-channel", "verb": "read" },
      { "resource": "sales-channel", "verb": "update" },
      { "resource": "sales-channel", "verb": "delete" },
      { "resource": "dataImport", "verb": "create" },
      { "resource": "dataImport", "verb": "read" },
      { "resource": "eav", "verb": "create" },
      { "resource": "eav", "verb": "read" },
      { "resource": "eav", "verb": "update" },
      { "resource": "eav", "verb": "delete" }
    ]
  },
  "authorization": {
    "verbs": [
      {
        "name": "use-app",
        "description": "Can access the shop integration"
      },
      {
        "name": "manage-settings",
        "description": "Can configure shop settings and mappings"
      },
      {
        "name": "process-queue",
        "description": "Can trigger queue processing"
      },
      {
        "name": "import-orders",
        "description": "Can trigger order imports"
      }
    ]
  },
  "uiIntegrations": {
    "integrations": [
      {
        "id": "navigation",
        "pointOfIntegration": "navigation.root",
        "url": "/ui/index.html",
        "iconClass": "fas fa-store",
        "msgKey": "My Shop",
        "permissionKey": "use-app"
      }
    ]
  }
}

Required Permissions

Minimum Permissions

Every shop app needs at least these permissions:

Resource	Verb	Why
sales-channel	create	Create sales channel backend and channels during installation
sales-channel	read	Query sales channel configuration
eav	create	Create custom fields for external IDs and sync data
eav	read	Read custom field values

Product Sync Permissions

Resource	Verb	Why
article	read	Fetch article data for outbound sync
article	update	Write back external IDs to custom fields
stock	read	Fetch stock levels for inventory sync
price	read	Fetch prices for price sync

Order Import Permissions

Resource	Verb	Why
dataImport	create	Run MultiPart Import for orders
dataImport	read	Check import status
document	readSalesDocuments	Read order/document data for status sync

Extended Permissions

Depending on your integration, you may also need:

Resource	Verb	Why
sales-channel	update	Modify sales channel settings
sales-channel	delete	Remove sales channels
eav	update	Update custom field values
eav	delete	Clean up EAV data on uninstall

Authorization Verbs

Define custom verbs to control who can do what within your app:

{
  "authorization": {
    "verbs": [
      {
        "name": "use-app",
        "description": "Can access the shop integration UI"
      },
      {
        "name": "manage-settings",
        "description": "Can configure settings, mappings, and transfer toggles"
      },
      {
        "name": "process-queue",
        "description": "Can manually trigger queue processing"
      },
      {
        "name": "import-orders",
        "description": "Can trigger manual order imports"
      }
    ]
  }
}

Check these permissions in your backend:

const { checkPermission } = require('@vario-software/vario-app-framework-backend/utils/permission');

app.apiServer.post('/queue/process', async (req, res) =>
{
  await checkPermission('process-queue'); // Throws 403 if not allowed
  // ... process queue
});

And in your frontend:

import { hasPermission } from '../node_modules/@vario-software/vario-app-framework-frontend/script/permission.js';

if (await hasPermission('manage-settings'))
{
  // Show settings UI
}

UI Integrations

Navigation Entry

Add your app to the VARIO Cloud sidebar:

{
  "id": "navigation",
  "pointOfIntegration": "navigation.root",
  "url": "/ui/index.html",
  "iconClass": "fas fa-store",
  "msgKey": "My Shop",
  "permissionKey": "use-app"
}

Settings Tabs

Add tabs to the sales channel settings area:

{
  "id": "settings.connection",
  "pointOfIntegration": "settings.sales-channels.my-shop.tabs.connection",
  "url": "/ui/settings/connection.html",
  "iconClass": "fal fa-plug",
  "msgKey": "Connection"
},
{
  "id": "settings.mappings",
  "pointOfIntegration": "settings.sales-channels.my-shop.tabs.mappings",
  "url": "/ui/settings/mappings.html",
  "iconClass": "fal fa-exchange-alt",
  "msgKey": "Mappings"
},
{
  "id": "settings.order-import",
  "pointOfIntegration": "settings.sales-channels.my-shop.tabs.order-import",
  "url": "/ui/settings/order-import.html",
  "iconClass": "fal fa-shopping-cart",
  "msgKey": "Order Import"
}

Product Detail Tabs

Add a tab to the product detail view showing platform-specific information:

{
  "id": "products.listings.detail",
  "pointOfIntegration": "products.articles.detail.tabs.listings.detail.my-shop",
  "url": "/ui/products/listing-detail.html",
  "msgKey": "My Shop"
}

Order Detail Tabs

Add a tab to the order detail view showing platform order data:

{
  "id": "documents.sales-channels.detail",
  "pointOfIntegration": "documents-sales.detail.tabs.salesChannels.detail.my-shop",
  "url": "/ui/documents/order-detail.html",
  "msgKey": "My Shop Order"
}

Manifest Properties Reference

Property	Required	Description
appVersion	Yes	Semantic version of your app
label	Yes	Human-readable app name
description	Yes	Brief description of the app
shortName	Yes	Unique identifier (EN letters, underscores, hyphens only)
rootUrl	Yes	Base URL of your backend
pcInstallationUrl	Yes	URL loaded during installation
pcInstallationDeletionUrl	Yes	URL loaded during uninstallation
pcManifestUrl	Yes	URL where VARIO fetches runtime metadata
requirements.permissions	Yes	Required resource permissions
authorization.verbs	No	Custom permission verbs
uiIntegrations.integrations	No	UI integration points

For the full manifest specification, see the general App Manifest documentation.