# Products

Add fixed-price products and currencies sold by quantity, with images, stock, limits and automatic delivery in the city.

Source: https://fivedash.fivex.gg/docs/en/store/products

Products are what your city sells: VIPs, cars, items, money, currencies like diamonds or coins. Each product lives inside a category, has a price and an image, and says what the player gets in the game once the payment is approved. This page is for whoever builds the store's catalogue.

[Video: how to do it in under 20 seconds](https://fivedash.fivex.gg/docs/videos/store-products-en.mp4)

## Before you start

* **Plan:** the Store is on the Plus, Pro and Ultra plans. The number of products per store depends on the plan:

| Plan  | Products per store |
| ----- | ------------------ |
| Plus  | up to 50           |
| Pro   | up to 500          |
| Ultra | unlimited          |

* **Permission:** page **Store → Products**.

| Action                                                  | Level                       |
| ------------------------------------------------------- | --------------------------- |
| Products and currencies                                 | **View**                    |
| Create, edit, reorder and delete                        | **Configure**               |
| Gift a product to a customer (in **Store → Customers**) | **Manage** on **Customers** |

* **Categories:** products live inside categories. If the store has none yet, the page shows **Create the categories first** and the **Create categories** button. See [Categories](https://fivedash.fivex.gg/docs/en/store/categories).
* **Delivery:** the store only sells with the FiveDash resource running on the server and delivery turned on in `loja.lua`. See [In-game delivery](https://fivedash.fivex.gg/docs/en/store/in-game-delivery).

## Product types

When you click **New product**, you pick the **Product type**:

| Type         | What it's for                      | How the price works                                                |
| ------------ | ---------------------------------- | ------------------------------------------------------------------ |
| **Product**  | VIP, car, item: one fixed price.   | One price per unit, with an optional sale.                         |
| **Currency** | Diamonds, coins: sold by quantity. | A base price, ready-made packs, quantity discounts and any amount. |

## How the page is organized

* **Store → Products** opens the list of categories, with how many products each has and how many are on sale (**all on sale**, **none on sale** or "N on sale"). Pick a category to view and edit.
* Inside the category, products show as cards, with search (**Search products**) and a filter (**Filter by status**): **All**, **On sale**, **Drafts**, **Sold out**.
* Each card shows the price (or **from**, for currencies), how many in-game deliveries it has (or **No delivery set up**) and, with limited stock, **N left**.
* **Uncategorized** holds products from categories that were deleted (**From deleted categories**). They don't show in the store until you move each one to a category.

## Add a product

### Open the category

Go to **Store → Products** and pick the category. If it's empty, click **Add product**. If it already has products, click **New product** and pick **Product**.

### Fill in the details

In **Details**, enter the **Name** (e.g. Gold VIP) and, if you want, the **Description**: what the player gets, for how long, and any rule worth knowing. The description supports formatting.

### Set the price

In **Price**, enter the amount. To show a sale, fill in the **Previous price** (it shows struck through next to the price) or switch to **Enter the discount as a percentage**.

### Set up the in-game delivery

In **In-game delivery**, click **Add delivery** and pick what the city delivers. Deliveries run in list order.

### Pick status, image, category and limits

In the right column: **Status** (**On sale** or **Draft**), **Featured**, **Image**, **Category** and **Stock and limits**.

### Save

Click **Save**. Saved as **On sale**, the product shows in the store right away.

> Without a delivery, the payment is approved but the player gets nothing in the city.

## Product fields

### Details and price

| Field                               | What it does                                                                                                                                    | Default          |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| **Name**                            | The product's name in the store. Up to 60 characters.                                                                                           | Empty (required) |
| **Description**                     | Formatted text on the product page. Up to 1,000 characters.                                                                                     | Empty (optional) |
| **Price**                           | Amount charged per unit, from R$ 0.50 to R$ 50,000.00.                                                                                          | Empty (required) |
| **Previous price**                  | The "was" price, higher than **Price**, shown struck through. In the store it reads "was X, now Y".                                             | **No sale**      |
| **How to enter the previous price** | **Enter the previous price** (in reais) or **Enter the discount as a percentage** (1% to 90%; the previous price is worked out from the price). | Previous price   |

### Status and featured

| Field                | What it does                                                                              | Default     |
| -------------------- | ----------------------------------------------------------------------------------------- | ----------- |
| **Status → On sale** | Players see it and can buy it. If the category is hidden, nobody sees it until it's back. | **On sale** |
| **Status → Draft**   | Only the team sees it. Good for preparing before launch.                                  | —           |
| **Featured**         | Shows first in the store, with the badge.                                                 | Off         |

A product with limited stock that reaches zero shows as **Sold out** and stops selling by itself.

### Image

| Field     | What it does                                                                                                                      | Default        |
| --------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| **Image** | The product's picture. Use a PNG, JPG or WebP up to 10 MB; you crop it before saving.                                             | No image       |
| Shape     | Landscape (4:3, 800 × 600) or portrait (3:4, 900 × 1200), following the store's website. Change the shape in **Store → Website**. | Landscape, 4:3 |

Click or drag the image to upload. To replace it, use **Change image**; to take it off, **Remove**.

### Category

| Field        | What it does                                                                                                             | Default                  |
| ------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
| **Category** | Which category the product is in. Hidden categories show a crossed-out eye icon. Each category holds up to 200 products. | The category you clicked |

### Stock and limits

| Field                | What it does                                                                                                                | Default                           |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| **Limited stock**    | On, the product sells out when it reaches zero. Off, it sells without a limit. Goes from 0 to 100,000 units.                | Off (starts at 10 when turned on) |
| **Limit per player** | On, counts each player's purchases, in total. Off, each player buys as many times as they want. Goes from 1 to 1,000 times. | Off (starts at 1 when turned on)  |

For currencies this panel is called **Limits** and only has **Limit per player**: currencies have no stock.

## In-game deliveries

Each product can have up to 10 deliveries. They become actions the FiveDash resource runs on the server once the order is paid. After an order is placed, editing the product doesn't change what that order delivers.

| Type                | What it does                                        | Fields                                                                                                                               |
| ------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **VIP or role**     | Puts the player in a framework group.               | **Framework group** (no spaces, e.g. `vip_gold`) and **Duration** in days (1 to 3,650) or **Permanent**. Default: 30 days.           |
| **Vehicle**         | A car, bike or boat in the garage.                  | **Spawn name**: the same as in `/car`, no spaces (e.g. `zentorno`).                                                                  |
| **Money**           | An amount in the bank or wallet.                    | **Amount** (1 to 1,000,000,000; default 100,000) and **Goes to**: **Bank** or **Wallet**. Default: **Bank**.                         |
| **Item**            | Something in the inventory, with a quantity.        | **Inventory item** (e.g. `water`) and **Quantity** (1 to 100,000; default 1).                                                        |
| **Command**         | A command in the server console.                    | **Console command**, up to 200 characters. **Variables:** `{id}`, `{discord}` and `{pedido}` (in-game ID, Discord and order number). |
| **Player's choice** | A list, like several cars: they choose at checkout. | See the table below.                                                                                                                 |

When the player buys more than one unit, VIP days and money and item amounts add up (days up to 3,650), and a command runs once per unit.

### Player's choice

| Field                       | What it does                                                                                                                                                                                   | Default                                                          |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| **Question at checkout**    | What the checkout asks. Up to 60 characters.                                                                                                                                                   | "Escolha seu veículo", "Escolha seu item" or "Escolha seu plano" |
| **What the player chooses** | **Vehicles**, **Items** or **Groups**.                                                                                                                                                         | **Vehicles**                                                     |
| **How many they choose**    | How many options the player picks: 1 up to 5, and always fewer than the number of options.                                                                                                     | 1                                                                |
| **Quantity of each**        | Items only: how many units of each chosen item.                                                                                                                                                | 1                                                                |
| **Duration**                | Groups only: days (1 to 3,650) or **Permanent**.                                                                                                                                               | 30 days                                                          |
| Options                     | Each option has a **Name in the store** (up to 40 characters) and the value the city gets (**Spawn name**, **Inventory item** or **Framework group**, no spaces, no repeats). 2 to 40 options. | 2 empty options                                                  |

> To add several options at once, paste a list, one per line, as `Name; value` (e.g. `Pegassi Zentorno; zentorno`).

To see how each type is delivered on each framework, with the player online or offline, see [In-game delivery](https://fivedash.fivex.gg/docs/en/store/in-game-delivery).

## Currencies

A currency is sold by quantity: diamonds, coins, gems. To create one, click **New product** and pick **Currency**, or **Add currency** in an empty category. The currency editor has the same **Details**, **Status**, **Featured**, **Image**, **Category** and **Limits** as a product, plus the panels below.

### Currency

| Field              | What it does                                                                                          | Default               |
| ------------------ | ----------------------------------------------------------------------------------------------------- | --------------------- |
| **Currency name**  | What the currency is called in the city, in the plural. 2 to 24 characters.                           | Diamantes             |
| **Currency icon**  | One of the 10 built-in icons, or your own with **Upload icon** (SVG, PNG, WebP or JPG, up to 512 KB). | Diamond               |
| **Currency color** | **Gold**, **Blue**, **Purple**, **Green**, **Pink** or **Pick another color**.                        | **Blue**              |
| **Base price**     | What it costs **for every** 1, 10, 100 or 1,000 units, before discounts. R$ 0.01 to R$ 10,000.00.     | R$ 5.00 for every 100 |

### Packs

Ready-made quantities in the store. The bonus is free, on top of what the player pays. Up to 8 packs.

| Field              | What it does                                                                                | Default          |
| ------------------ | ------------------------------------------------------------------------------------------- | ---------------- |
| **Pack quantity**  | How many units the player pays for. Can't repeat.                                           | —                |
| **Pack bonus**     | Free units, from 0 up to the quantity itself.                                               | 0                |
| **Pack highlight** | **No highlight**, **Most popular** or **Best value**. Each highlight goes on one pack only. | **No highlight** |

Packs a new currency comes with: 100; 500 (+25); 1,000 (+100, **Most popular**); 2,500 (+300); 5,000 (+750, **Best value**). The **Suggest packs** button builds a list from the base price. Each pack must cost at least R$ 0.50.

### Quantity discount

The more the player takes, the less they pay per unit. Applies to packs and to any amount. Up to 5 tiers.

| Field     | What it does                                                                      | Default |
| --------- | --------------------------------------------------------------------------------- | ------- |
| **From**  | From how many units the tier applies (2 or more).                                 | —       |
| **% off** | The tier's discount, 1% to 80%. Each tier must give more off than the one before. | —       |

Tiers on a new currency: 1,000+ at 5% off and 5,000+ at 10% off.

### Any amount

| Field                                | What it does                                                                                                                     | Default |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ------- |
| **Let the player choose the amount** | Besides the packs, the player types how much they want. Shows as **Other amount** in the store. Off, only the packs are on sale. | On      |
| **Minimum**                          | The smallest amount accepted. Must cost at least R$ 0.50.                                                                        | 100     |
| **Maximum**                          | The largest amount, up to 10,000,000.                                                                                            | 50,000  |
| **In steps of**                      | The amount's step.                                                                                                               | 50      |

The currency needs at least one pack or any amount turned on.

### In-game delivery (currency)

How the city gives the currency: what was bought plus the bonus. The editor shows a sample of what the city will run.

| **How to deliver** option | What it does                                                                                                                                                             | Default                       |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- |
| **Command**               | Runs the **Delivery command** in the console. It must contain `{quantidade}`, which becomes the total bought. It also takes `{id}` and `{pedido}`. Up to 200 characters. | `darmoedas {id} {quantidade}` |
| **Item**                  | Puts the total in **Inventory item** (no spaces, e.g. `diamond`).                                                                                                        | —                             |
| **Money**                 | Deposits the total **In the bank** or **In the wallet** (**Where the money goes**).                                                                                      | **In the bank**               |

## Organize and edit

### Change the order

Inside the category, drag the card by its handle. The order here is the order in the store.

### Put on sale or pause

In the card's actions menu, use **Put on sale** or **Move to draft**.

### Duplicate

In the card's menu, or in **More product options** in the editor, click **Duplicate**. The copy is created as a draft, with "(copy)" in the name and its own copy of the image. Save your changes before duplicating.

### Delete

In the menu, click **Delete** and confirm with **Delete product**. The product leaves the store right away.

> To take a product off sale without losing anything, keep it as a **Draft** instead of deleting it.

## Gift a product

The team can give a product to a customer without charging. It becomes a gift order: the city delivers it like a purchase, but it doesn't count as a sale.

### Open the customer

Go to **Store → Customers** and open the customer.

### Pick the product

Click **Give product** and pick the product. If it has a **Player's choice**, tick the options. For currencies, pick a pack or an **Other** amount.

### Say who gets it

In **ID in the city**, type the character's ID. Empty, it goes to the character linked to the customer's Discord. The city checks the ID and shows the character's name.

### Send it

Optionally write the **Reason (only the team sees it)** and click **Give as a gift**.

| Field                              | What it does                                                  | Limit            |
| ---------------------------------- | ------------------------------------------------------------- | ---------------- |
| Quantity                           | How many units of the product.                                | 1 to 20          |
| **How much to give**               | For currencies: a pack or another amount.                     | Up to 10,000,000 |
| **ID in the city**                 | Who it goes to. Empty: the character linked to their Discord. | —                |
| **Reason (only the team sees it)** | The order's internal note.                                    | 200 characters   |

Only products that deliver something in the city can be gifted.

## Best sellers at checkout

On **Store → Offers** you turn on **Best sellers at checkout**, which suggests the products that sold most in the last 30 days. See [Offers](https://fivedash.fivex.gg/docs/en/store/offers).

## FAQ

**I changed the product. Do paid orders change too?**
No. Each order keeps the deliveries from the moment of purchase.

**The product is On sale but doesn't show in the store. Why?**
Its category may be hidden, or it sold out. The editor warns you when the category is hidden.

**I hit my plan's product limit. Now what?**
New products and copies are refused until you delete one or change plans. See [Plans and billing](https://fivedash.fivex.gg/docs/en/getting-started/plans-and-billing).

**Can I sell without a delivery set up?**
Yes, but the player pays and gets nothing in the city. Use it for something the team hands over by hand, and mark the order as delivered in **Store → Orders**.

## Next steps

[In-game delivery](https://fivedash.fivex.gg/docs/en/store/in-game-delivery)How each delivery type reaches the character.
[Categories](https://fivedash.fivex.gg/docs/en/store/categories)Organize the store's sections.
[Coupons](https://fivedash.fivex.gg/docs/en/store/coupons)Discounts for giveaways and partnerships.
[Orders](https://fivedash.fivex.gg/docs/en/store/orders)Follow payments and deliveries.
