# đź›’Products Here is an example of 2 product configs: ```yaml items: A: price-mode: CLASSIC_ALL product-mode: CLASSIC_ALL sell-all: true shared-use-times: daily_bundle products: 1: material: STRING amount: 1 give-actions: 1: type: message message: 'You get a string!' buy-prices: 1: match-placeholder: '%player_health%' amount: '1.65' placeholder: '{amount}$' start-apply: 0 sell-prices: 1: match-placeholder: '%player_health%' amount: '1.65' placeholder: '{amount}$' start-apply: 0 give-actions: 1: type: console_command command: 'eco give {player} {amount}' B: price-mode: CLASSIC_ALL product-mode: CLASSIC_ALL products: 1: material: FEATHER amount: 1 buy-prices: 1: economy-plugin: Vault amount: '0.55' placeholder: '{amount}$' start-apply: 0 sell-prices: 1: economy-plugin: Vault amount: '0.52' placeholder: '{amount}$' start-apply: 0 ``` ## General Options {% hint style="info" %} Click [here](/shops/shops.md) to see the detalied example of those general options. {% endhint %} * display-item: Product display item in shop menu, it can be different from the real item player will obtain after purchase. For virtual products, you must set `display-item` here, otherwise they can not be displayed in GUI. For real item products, you must enable `auto-set-first-product` option under `display-item` section in `config.yml` file to allow you remove this section, after enable, if `display-item` is not set, the first real item product will be used as display item. This section use [Item format](/format/itemformat-tm.md). **Optional (if not set, will use first products)** * display-item.modify-lore: Whether we will modify display item lore to add info about price, limits and so on. You can set add lore info at `config.yml` file or `add-lore` option in product config, for more info about it, please view [Display Item Add Lore](/menus/display-item-add-lore.md) page. **Optional (default to true)** * display-name: Set product display name in `{product}` placeholder and buy more menu display item. **Optional. (if not set, we will use the display item's name as product display name)** * add-lore: Set special [display item add lore](/menus/display-item-add-lore.md) for this product, if not set, we will use default value set in `config.yml`. **Optional.** * click-event: Set special click event for this product, if not set, we will use default value set in `config.yml`. Don't forgot also modify `add-lore` option to correspond to the modified click event. **Optional.** ```yaml add-lore: - '@a&ePurchase: {buy-price}' - '@b&eSell: {sell-price}' - '&eDrop to buy, right to sell' # Modified add lore to to correspond to the modified click event click-event: buy: 'DROP' sell: 'RIGHT' ``` * bedrock: View [this page](/menus/bedrock-menus-premium.md). * buy-more: Set whether this product can open buy more menu. **Optional. (default to true)** * buy-more-menu: Set up separate buy more menu settings for the product. **Optional. Require 2.2.10+ version. (if not set, will use default value set in `config.yml` file)** ```yaml buy-more: true sell-all: true hide-message: false buy-more-menu: menu: buy-more-2 max-amount: 16 ``` * sell-all: Set whether this product can use sell all feature. **Optional, default to true. (Added in 3.9.3)** * shared-use-times: Please view [this page](/shops/shared-product-data-premium.md). * hide-message: Whether we hide the messages that will send after player buy or sell this product. **Optional, default to false. (Added in 4.2.11)**

By default, only hide success buy or sell message, for fail message like limit reached or not enough money, you have 2 methods to hide them:

* buy-prices/sell-prices/products: Please view [this page](/shops/products-config-single-thing.md). * price-mode: Support `ANY, ALL, CLASSIC_ANY, CLASSIC_ALL`. **Required.** * product-mode: Same as above. **Required if you have products section.** {% hint style="info" %} **ANY** and **ALL** mode should only be used when you are using dynamic value in products or prices configs. If your configuration uses static values, we will automatically switch your mode to **CLASSIC** mode to avoid unnecessary performance waste. {% endhint %}
ModeANYALLCLASSIC_ANYCLASSIC_ALL
Product GiveGive random products that meet conditions.Give all products.Same as ANY.Same as ALL.
Product /Price TakeFirst product/price that we found player meet condition and have enough amount.Players must have all products/prices that meet conditions to sell.Same as ANY.Same as ALL.
Price Give (means sell)First prices meet the condition requirements.All prices will be given.Same as ANY.Same as ALL.
Price SupportSupport dynamic price & apply option.Same as ALL.Price must be same at everytime.Same as CLASSIC_ALL.
Support Sell All if you are using dynamic value in products amount option.No
Due to the dynamic nature of price values, plugins have no way of knowing the maximum number of times you can sell a product if you use dynamic product amount.		No
Due to the dynamic nature of price values, plugins have no way of knowing the maximum number of times you can sell a product if you use dynamic product amount.		YesYes
Server PerformancesMaybe high when you have much buy/sell requests.Same as ALL.Low, just like other shop plugins doing!Same as CLASSIC_ANY.
* buy-actions: The action will run after buy this product, use [Action Forma](/format/action-format.md)[t](/format/action-format.md) here. **Optional.** * sell-actions: The action will run after sell this product, use [Action Format](/format/action-format.md) here. **Optional.** * fail-actions: The action will run if we fail to buy or sell this product, use [Action Format](/format/action-format.md) here. **Optional. In example above we put this on general-configs and set it as a fail sound.** * buy-conditions: The condition player need to meet to buy this product, use [Condition Format](/format/condition-format.md) here. **Optional**. * sell-conditions: The condition player need to meet to sell this product, use [Condition Format](/format/condition-format.md) here. **Optional**. * buy-limits: Set the maximum times of buy/sell times. **Optional. If not set, product can be purchased with unlimited times.** * buy-limits.global: Global limit. **Optional.** * buy-limits.default: If player don't meet any condition set below, they will use this limit. **Required if you have set buy-limits.** * buy-limits.\: Players who meet this condition will use this limit. Condition format can be found at [Conditions](/format/condition-format.md). For example: ```yaml buy-limits: default: 10 vip: 20 buy-limits-conditions: vip: 1: type: permission permission: 'test.permission' ``` * sell-limits: Same as buy-limits, but use for sell. {% hint style="info" %} For how to reset limits, please view [this page](/shops/product-config-buy-sell-times-reset.md). {% endhint %} ## Single Thing Options This section of the configuration includes the following options: * buy-prices * sell-prices * products The introduction of these options is on a separate page, please [click here](/shops/products-config-single-thing.md) to view. ## Buy/Sell Times Reset Options This section of the configuration includes the following options: * buy-times-reset-mode * buy-times-reset-time * buy-times-reset-time-format * buy-times-reset-value * buy-times-max-value * sell-times-reset-mode * sell-times-reset-time * sell-times-reset-time-format * sell-times-reset-value * sell-times-max-value The introduction of these options is on a separate page, please [click here](/shops/product-config-buy-sell-times-reset.md) to view. ## Dynamic Value You can set placeholders (including PlaceholderAPI) and [Math Calculate Format](/format/math-calculate-format.md) in `buy-prices`, `sell-prices` section's `amount` option and `buy-limits`, `sell-limits` section's value in product configs. By default, dynamic values are calculated in real-time and are not refreshed periodically. However, players will not see real-time values in the GUI. We will only refresh the dynamic values displayed in the GUI after the player opens the UI or clicks the item each time. For example, if you set a dynamic value in the purchase price and the dynamic value is changed when the player opens the GUI, although the player will not notice this change in the GUI display item, the plugin will calculate the price based on the updated dynamic value at the final purchase. This is a decision made to balance server performance and save costs. If you don't want this and want to dynamic value display refresh immediately, please [click here](/menus/general-menus.md#all-buttons-update). Available built-in placeholder list as below, for more info about them, please view [Built-In Placeholders](/placeholders/built-in-placeholders.md) page. * {buy-times-player} * {buy-times-server} * {buy-total-player} **- PREMIUM, 3.9.0+** * {buy-total-server} **- PREMIUM, 3.9.0+** {% hint style="info" %} Difference between **times** placeholder and **total** placeholder: * **times** placeholder will be reset to the value you set after each reset. * **total** placeholder will keep data after reset, and will accumulate previous times. Use command to set buy/sell times or other way will still effect total placeholder. This placeholder will auto reset when reaching the upper limit of int type data. {% endhint %} * {sell-times-player} * {sell-times-server} * {sell-total-player} **- PREMIUM, 3.9.0+** * {sell-total-server} **- PREMIUM, 3.9.0+** * {last-buy-player} **- PREMIUM** Display the time interval between the last purchase of this item by a single player, in seconds. If the player has not purchased this item or the buy time has been reset, it will return `0`. * {last-buy-server} **- PREMIUM** Display the time interval between the last purchase of this item by global server, in seconds. If no one has not purchased this item before or the buy time has been reset, it will return `0`. * {last-sell-player} **- PREMIUM** Display the time interval between the last sell of this item by a single player, in seconds. If the player has not sold this item or the sell time has been reset, it will return `0`. * {last-sell-server} **- PREMIUM**\ Display the time interval between the last sell of this item by global server, in seconds. If no one sold this item before or the sell time has been reset, it will return `0`. * {last-buy-reset-player} **- PREMIUM, 3.9.0+** Display the time interval between the last buy reset or first buy time after reset (depends on the reset mode you selected, for more info, please view [this page](https://ultimateshop.superiormc.cn/shops/product-config-buy-sell-times-reset)) of this item by a single player, in seconds. If the player has not purchased this item or the buy time has been reset, it will return last buy time. * {last-buy-reset-server} **- PREMIUM, 3.9.0+** Display the time interval between the last buy reset or first buy time after reset (depends on the reset mode you selected, for more info, please view [this page](https://ultimateshop.superiormc.cn/shops/product-config-buy-sell-times-reset)) of this item by global server, in seconds. If the player has not purchased this item or the buy time has been reset, it will return last buy time. * {last-sell-reset-player} **- PREMIUM, 3.9.0+** Display the time interval between the last sell reset or first sell time after reset (depends on the reset mode you selected, for more info, please view [this page](https://ultimateshop.superiormc.cn/shops/product-config-buy-sell-times-reset)) of this item by a single player, in seconds. If the player has not sold this item or the sell time has been reset, it will return last sell time. * {last-sell-reset-server} **- PREMIUM, 3.9.0+** Display the time interval between the last sell reset or first sell time after reset (depends on the reset mode you selected, for more info, please view [this page](https://ultimateshop.superiormc.cn/shops/product-config-buy-sell-times-reset)) of this item by global server, in seconds. If the player has not sold this item or the sell time has been reset, it will return last sell time. Also in `buy-prices` and `sell-prices` section, you can set new 2 options: * max-amount: Price max amount, useful for dynamic prices. **Optional.** * min-amount: Price min amount, useful for dynamic prices. **Optional.** When you use dynamic value in `amount` option, you can use `min-amount` and `max-amount` option to limit it's min value and max value. Useful for dynamic price. Please carefully note that if you want to use our PlaceholderAPI extansion's placeholder, you have to use our new format, for example: ```yaml buy-prices: 1: economy-plugin: Vault amount: '15 - {sell-times-player} * 0.1 + %ultimateshop_farming_B_sell-times-player% * 0.1' # We use the new format without { and } symbol. placeholder: '{amount}$' start-apply: 0 ``` Additionally, you need to set `menu.shop.click-update` to `true` if the related to product is also in the menu you opened. Otherwise this price won't auto update after you sell B product. ## Sub Buttons - Premium Sometimes, you want to display same product in different menus, or you want to make 2 or more buttons for same product. Well, `as-sub-button` option can help you. Just set another product ID here, then this button will also be considered as the product you set here. * display-item: Supports set different display item for sub buttons. * as-sub-button: Type `Product ID` or `ShopID;;ProductID` here. The example config of **Sub Buttons** can be found at [Shops](/shops/shops.md) page, please check out the `C` section under `items` in the head example. {% hint style="warning" %} If the corresponding product of the sub button is not displayed in the shop GUI, or if the player does not meet the conditions to open the corresponding shop menu, the item cannot be traded. If this is not desired, change the `settings.secret-shop-items` option in the shop configuration to `false`. {% endhint %} --- # Agent Instructions: 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: ``` GET https://ultimateshop.superiormc.cn/shops/products.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.