> 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/configuration.md).

# Configuration

## Sales Channel Parameters

Sales channel parameters are key-value pairs scoped to a specific sales channel. They are stored within the app itself — not in the ERP. Your app is responsible for persisting and managing them. All configuration data must be **scoped by sales channel ID**, so that settings from one channel never affect another.

### Common Parameters

| Key                           | Description                    | Example                  |
| ----------------------------- | ------------------------------ | ------------------------ |
| `LAST_ORDER_IMPORT_TIMESTAMP` | When orders were last imported | `2026-01-15T10:30:00Z`   |
| `API_KEY`                     | Platform API key               | `sk_live_abc123`         |
| `API_SECRET`                  | Platform API secret            | `encrypted_secret`       |
| `SHOP_URL`                    | Platform store URL             | `mystore.myplatform.com` |
| `PLATFORM_VERSION`            | Platform API version           | `2024-01`                |
| `AUTO_ORDER_IMPORT`           | Whether to auto-import orders  | `true`                   |
| `QUEUE_BATCH_SIZE`            | Queue processing batch size    | `10`                     |
| `TRANSFER_TYPES`              | Enabled sync types (JSON)      | `{"product":true}`       |

Set sensible defaults when a new sales channel is created (in your `sales_channel.create` webhook handler).

### Caching

Reading parameters from storage on every request can be slow. Consider an in-memory cache with the sales channel ID as part of the cache key. Invalidate cached values when a parameter is updated and add a TTL for periodic refresh.

### Credential Storage

Never log credentials. Encrypt them at rest and support rotation without downtime.

## Transfer Toggles

Transfer toggles control which sync directions are active per sales channel. Stored as a JSON string in the `TRANSFER_TYPES` parameter.

| Toggle                      | Direction                 | Default |
| --------------------------- | ------------------------- | ------- |
| `UPLOAD_ARTICLE_MASTERDATA` | Product data → platform   | `false` |
| `UPLOAD_ARTICLE_PRICE`      | Prices → platform         | `false` |
| `UPLOAD_ARTICLE_STOCK`      | Stock levels → platform   | `false` |
| `UPLOAD_ARTICLE_IMAGE`      | Product images → platform | `false` |
| `UPLOAD_ORDER_STATUS`       | Order status → platform   | `true`  |
| `DOWNLOAD_ORDERS`           | Orders ← platform         | `true`  |

Outbound article sync is disabled by default — the user enables it after configuring the channel. Order-related flows are enabled by default.

Toggles are checked before creating queue entries, so webhook handlers don't need to check them.


---

# 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/configuration.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.