> For the complete documentation index, see [llms.txt](https://developer.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.vario-software.de/cookbook/onlineshops-and-marketplaces-app/project-structure.md).

# Getting Started

This page highlights the **shop-specific** directories and files in a VARIO Cloud app. For the general app structure, see the [VARIO App Framework](https://github.com/vario-software/vario-app-framework) and [VARIO App Demo](https://github.com/vario-software/vario-app-demo).

## Shop-Specific Layout

```
my-shop-app/
├── api/
│   ├── routes/
│   │   ├── article.js                # Article lookup endpoints
│   │   ├── webhooks.js               # ERP webhook handlers
│   │   └── cronWebhooks.js           # Cron/scheduled webhook handlers
│   └── services/
│       ├── inbound/
│       │   ├── order/                # Order import (fetch → transform → import)
│       │   │   ├── index.js
│       │   │   ├── fetch.js
│       │   │   ├── transform.js
│       │   │   └── import.js
│       │   ├── product/              # Product import (optional)
│       │   └── multiPartImporter.js
│       ├── outbound/
│       │   ├── article/              # Product sync (fetch → transform → import)
│       │   │   ├── index.js
│       │   │   ├── fetch.js
│       │   │   ├── transform.js
│       │   │   └── import.js
│       │   ├── article-stock/        # Stock sync
│       │   ├── article-price/        # Price sync
│       │   ├── article-media/        # Image sync
│       │   ├── order-status/         # Order status sync
│       │   └── outbound.js           # Queue processor
│       ├── maintenance/
│       │   ├── install/
│       │   │   └── migrations/
│       │   │       └── 1/
│       │   │           ├── index.js            # Migration logic
│       │   │           └── static/
│       │   │               └── erp/
│       │   │                   └── eav-groups/  # EAV group JSON files
│       │   ├── queue.js              # Queue read/write helpers
│       │   ├── salesChannelParameter.js  # Per-channel config helpers
│       │   └── context.js            # setSalesChannel helper
│       └── platform/                 # Platform API client
│           └── client.js
├── ui/                               # Frontend (channel config UI)
└── manifest.json
```

## Key Conventions

**Inbound services** follow a `fetch → transform → import` pattern:

* `index.js` — orchestrates the flow and creates the MultiPart Import
* `fetch.js` — retrieves data from the external platform API
* `transform.js` — maps platform data to the VARIO import format
* `import.js` — sends the transformed data to the ERP via MultiPart Import

**Outbound services** follow a `fetch → transform → import` pattern:

* `index.js` — orchestrates the flow
* `fetch.js` — retrieves article/stock/price data from the ERP via VQL
* `transform.js` — maps ERP data to the platform's API format
* `import.js` — sends the transformed data to the platform API

**Migrations** in `maintenance/install/migrations/<version>/` run during app installation. They set up sales channels, EAV groups, webhooks, and default parameters. See [Core Concepts](/cookbook/onlineshops-and-marketplaces-app/core-concepts.md).

**EAV group definitions** are stored as JSON files under `static/erp/eav-groups/` and loaded by the migration script.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.vario-software.de/cookbook/onlineshops-and-marketplaces-app/project-structure.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
