> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Share a Private App
> Create a private listing and share your app with selected merchants using activation codes.
A private app isn't listed in the App Store. You share it with selected merchants using activation codes. This suits an app that isn't ready for general release, or one built for a few specific customers.
## Before You Start
Your app needs to be registered, provisioned, and tested, and you need to [Become a Seller](https://www.jtl-software.de/extension-store/Seller-werden) to list it.
Deploy your app to a public URL with HTTPS and update its URLs to production in the app manifest before you submit.
## Activation Codes
Merchants install a private app with an activation code you generate in [JTL Hub](https://hub.jtl-cloud.com/). Each code is single-use: one code activates the app for one merchant.
As a seller, you can generate as many codes as you need. Without a listing, you're limited to three.
## The Listing Manifest
You define your listing in a manifest. Set `distributionType` to `PRIVATE` to keep it out of the App Store.
```json theme={null}
{
"version": "1.0.0",
"defaultLocale": "de-DE",
"distributionType": "PRIVATE",
"name": {
"de-DE": {
"short": "My App",
"full": "My JTL Cloud App"
}
},
"description": {
"de-DE": {
"short": "A short teaser.",
"full": "The full description of the app."
}
},
"benefits": {
"de-DE": [
"Benefit 1",
"Benefit 2",
"Benefit 3"
]
},
"category": {
"main": "articles-product-data",
"sub": ["item-master-data-attributes"]
},
"media": {
"icons": {
"light": "https://example.com/icon-light.png",
"dark": "https://example.com/icon-dark.png"
},
"screenshots": [
{
"id": "screenshot-1",
"url": "https://example.com/screenshot-1.png",
"alt": "The app's dashboard"
}
]
},
"compatibility": {
"products": {
"de-DE": ["jtl-wawi"]
},
"productsNotes": "",
"minVersions": {
"jtl-wawi": "1.1.0"
}
},
"support": {
"url": {
"de-DE": "https://example.com/support"
},
"documentation": {
"de-DE": "https://example.com/docs"
}
},
"legal": {
"privacyPolicy": "https://example.com/privacy",
"termsOfUse": "https://example.com/terms",
"gdpr": {
"request": "https://example.com/gdpr/request",
"delete": "https://example.com/gdpr/delete"
}
}
}
```
Private listings don't go through App Store review.
You can configure your pricing tiers now, but merchant billing through them is not yet available. Defining your tiers now ensures your listing is ready when billing becomes available.
Before you submit, replace any development placeholders with production content:
* **Icons and screenshots**: Replace placeholder URLs with your production assets hosted at stable, publicly accessible URLs. Provide both light and dark icon variants.
* **Names and descriptions**: Finalize the copy for every locale you support (`name.{locale}.short`, `name.{locale}.full`, `description.{locale}.short`, `description.{locale}.full`).
* **Benefits**: Provide three to five localized benefits describing the value your app offers merchants.
* **Compatibility**: List the supported JTL products and specify a valid minVersions entry for each.
* **Support URLs**: Set `support.url.{locale}` and `support.documentation.{locale}` to publicly accessible support and documentation pages.
* **Legal URLs**: Ensure `legal.privacyPolicy`, `legal.termsOfUse`, `legal.gdpr.request`, and `legal.gdpr.delete` all point to published pages. These are required for JTL compliance.
Names, descriptions, benefits, supported products, and support URLs are localized by locale, allowing a single manifest to support multiple markets.
See the [Listing Manifest Reference](/guides/cloud-apps/listing-manifest) for more details.
## Create the Listing
Create your listing as a draft. All three paths produce the same listing.
If you're using one of the JTL Cloud App starter templates, update the `listing.json` file in your project root, then create the listing draft:
```bash theme={null}
npm run listing
```
If you're building your app from scratch:
1. Create a `listing.json` file in your project root
2. Generate the listing draft:
```bash theme={null}
npx -y @jtl-software/create-cloud-app@latest listing
```
The CLI reads your `listing.json` and creates a listing in the **DRAFT** state in the Partner Portal.
Once the listing is created, use the returned URL to open the listing in the [Partner Portal](https://partner.jtl-cloud.com/) to review and submit it.
In the [Partner Portal](https://partner.jtl-cloud.com/), navigate to **Publish apps** and select **Edit listing** for your app.
The Listing Wizard guides you through five steps:
1. Generally
2. Media
3. Compatibility
4. Prices
5. Legal
You can save your progress at any time. Your listing remains in the **DRAFT** state until you submit it for review.
#### 1. Generally
Configure the basic information for your app.
For the distribution type, choose **Private**. This makes your app eligible for publication in the App Store after it passes JTL's review.
Then fill in other required details and click **Further** to continue.
#### 2. Media
Choose your app category and upload your marketing assets.
Provide:
* A primary category and at least one subcategory
* Light and dark app icons (JPG, PNG, or SVG, 250 × 250 px)
* At least one screenshot or product image (up to 5 MB each)
* An optional YouTube product video
#### 3. Compatibility
Choose which JTL products your app supports.
You can select:
* JTL-Wawi
* JTL-Shop
* JTL-WMS
* JTL-POS
* JTL-FFN
Use Further information to describe additional supported products or third-party integrations.
JTL-WMS and JTL-POS require JTL-Wawi. Selecting either product automatically selects JTL-Wawi.
#### 4. Prices
Every public listing must include at least one package. You can create up to four packages, each marked as Free or Paid.
Although pricing can be configured now, merchant billing isn't fully available yet. Configure your packages so your listing is ready once billing becomes available.
For each package, provide the required details and note that a listing can have only one free package, and only one package marked **Most Popular**.
#### 5. Legal
Provide the required legal and support information. All URLs must be valid and publicly accessible.
After completing the final step, you can save as draft or submit the listing for review.
## Submit your Listing
Submit your listing when it's complete.
Because private apps skip App Store review, your listing is ready to share once submitted.
## Generate and Share Activation Code
Generate an activation code for your app in [Partner Portal](https://partner.jtl-cloud.com/) under **Manage apps**.
Send the code to your customer directly, for example by email, along with instructions for redeeming it. A private app you build under your own tenant isn't visible in another merchant's tenant, so the code is what gives them access to install it.
Go to [Partner Portal](https://partner.jtl-cloud.com/) and open **Manage apps**. In the app list, click the three-dot menu for your app and select **Activation codes**.
Generate an activation code by clicking on the **Create activation code** button.
A dialog will show where you can manually input your custom activation code or auto-generate one by clicking the dice icon.
The code is a plain-text string tied to your private app.
### How a Merchant Redeems a Code
Include these steps when you send the code:
In [JTL Hub](https://hub.jtl-cloud.com/), open **Manage apps**.
At the bottom of the page, click the **Activate now** button. A dialog opens.
Enter the activation code you received from your partner and follow the prompts to install the app.
Once the merchant redeems the code, the app installs in their tenant and runs through the same setup flow as any other app.
## What's Next?
Ready for a wider audience? Publish your app for all merchants to find and install.
Add panel views, custom tabs, and deeper ERP integration to your app.