Oryx Docs

Price Lists

The Price Lists section in the PIM system is a specialized area for managing pricing data and generating prices for product variants in the PIM system.

Attention: In the context of the PIM system, only a "product variant" has a cost and can be sold.

To navigate to the working area of the Price Lists section, select Store and CatalogPrice Lists from the system menu of the portal.

Interface of the Section

Toolbar

The toolbar is located in the main working area of the Price Lists section above the price list table.

Filters and Search Field

  • The Search field supports searching for price lists by the name of the product variant and provides:
    • Case Insensitivity: the system automatically ignores differences in the capitalization of words.
    • Search Accuracy: finds all variations of writing that match the query, considering spaces and special characters.
    • Partial Match Search: you can enter both full words and their parts.
  • To invoke the Filters panel, click the Filters button.
    • No Retail Price option.
    • No Dealer Price option.
    • No Purchase Price option.
    • Brands value selection field.
    • Categories value selection field.
    • Families value selection field.
    • Product Status value selection field.

Combining search and filters allows for more precise results.

Region Switch Panel

Allows you to select a region for calculating dealer and retail prices for products in the region's currency. The default currency values for the selected region are described in the Regions section.

Attention: Region switching is available only to product managers, administrators, and those employees who have access to multiple tenants.

Add Formula

  • To invoke the New Formula form in the right part of the working area of the section, click Add Formula:
    • Name input field (required): defines the name of the column in the price list. Enter the name of the new column to which the formula will be applied. For example: Retail Price.

    • Label input field (required): defines the label (slug) name of the column in the price list.

      • Recommended characters: lowercase Latin letters, numbers, and underscores.
      • Prohibited characters: spaces.

      For example: retail_price.

Each field in price lists has a label (slug). Access to the field value for each price list record and its subsequent use in formulas is done via the label: To view labels, formulas, and field values in the price list, go to the Formula Diagnostics section. For the structure of system fields, see the Price Lists: System Fields section.

  • Formula Type selection field (required): defines the data type in expressions. The default value is numeric.

  • Formula Order input field (required): defines the position of the column in the price list. Set the desired value using the “+” and “-” buttons. The default value is 1.

  • Formula input field (required): defines the formula for calculating the corresponding value.

Each field in price lists has a label (slug). Access to the field value for each price list record and its subsequent use in formulas is done via the label: To view labels, formulas, and field values in the price list, go to the Formula Diagnostics section. For the structure of system fields, see the Price Lists: System Fields section.

  • The Help section contains reference material for entering formulas:

    • The Operators field contains a list of mathematical operators used in formula expressions.

      OperatorOperation NameExample
      +Addition5+3=8
      -Subtraction10-4=6
      *Multiplication2*3=6
      /Division10/2=5
      %Modulus (mod)10%3=1
      **Exponentiation2**3=8
    • The Conditions and Functions field contains a list of ready-made functions and constructs used in formula expressions.

      ConstructDescriptionExample
      if(condition, then, else)Conditional operator (analogous to Excel IF)if(10 > 5, 1, 2) +=1
      x ? a : bTernary operator (analogous to IF)price > 100 ? 0.9 : 1
      coalesce(a, b, ...)Returns the first non-empty (not null, not undefined, not an empty string) argumentcoalesce(null, "", 0, 5)=0
      clamp(value, min, max)Limits the value from below and above: if less than min — returns min, if greater than max — returns maxclamp(120, 0, 100)=100
      rate_usd(cur)Exchange rate for USDrate_usd('RUB')=100
      inverse_rate_usd(cur)Inverse exchange rate for USDinverse_rate_usd('EUR')=0.5
    • The Mathematical Functions field contains a list of standard mathematical functions used in formula expressions.

      Function NameFunction DescriptionExample
      round(number, precision)Rounds to the specified number of digitsround(1.55, 1)=1.6
      floor(number)Rounds downfloor(1.9)=1
      ceil(number)Rounds upceil(1.1)=2
      abs(number)Absolute valueabs(-5)=5
      sqrt(number)Square rootsqrt(9)=3
      min(a, b, ...)Minimum of the listmin(3, 1, 7)=1
      max(a, b, ...)Maximum of the listmax(3, 1, 7)=7
      log(number)Natural logarithmlog(1)=0
      log10(number)Decimal logarithmlog10(100)=2
  • The Back button: used to cancel actions.

  • The Save button: used to save changes.

Price Lists: System Fields

Price lists are displayed in the working area of the Price Lists section in tabular form. Each record in the table represents a price list for a product variant.

System fields are set by default and have a white color; the editable formula system field Expenses is colored blue.

Attention: Each system field has a label (slug). Access to the field value for each price list record and its subsequent use in formulas is done via the label. To view labels, formulas, and values of system fields, go to the Formula Diagnostics section.

Field NameDescription
NameName of the product variant in the PIM system
Production SiteCode of the production site
Volume (m³)Volume of the product. The field value for each record is calculated from the logistics parameters (Height, Width, Depth) for the corresponding product variant.
Purchase PricePurchase Price is the total price of the product for all regions (usually in CNY). Purchase price (manufacturer's price) of the product variant. Field type: amount with currency.
  • Number input field.
  • Currency selection field.

Attention: The field is available for users with the role: product manager
Dealer MarkupPercentage markup from the manufacturer. Calculated from the purchase price to the dealer price. The parameter value is calculated automatically.
Attention: The field is available for users with the role: product manager. All currencies are converted through US dollars (USD) at the current exchange rate
Dealer PricePrice of the product variant for the dealer. Field type: amount with currency.
  • Number input field.
  • Currency selection field.

Attention: The field is available for viewing to users with roles: product manager, franchisee. The field is available for editing to users with the role: product manager
Dealer Price in Dealer Currency of Region (<cur>)Price of the product variant for the dealer, converted to the region's currency (Dealer Currency of Region).
Dealer Currency of Region is the currency for transactions between the manufacturer and the dealer (<cur>).
Attention: The field is available for viewing to users with roles: product manager, franchisee
Regional Currency of Dealer PriceRegional currency of the dealer price
Dealer Price in Retail Currency of Region (<cur>)Price of the product variant for the dealer, converted to the region's currency (Retail Currency of Region).Retail Currency of Region is the currency for which the product is sold in the dealer's region (<cur>).
Attention: The field is available for viewing to users with roles: product manager, franchisee
Regional Currency of Retail PriceRegional currency of the retail price
Retail Markup(Retail markup)Percentage of retail markup. The field value for each record is calculated generally as: Retail Price / (Dealer Price + Expenses).
Attention: The field is available for users with roles: product manager, franchisee. All currencies are converted through US dollars (USD) at the current exchange rate
Retail Price(Retail price)Retail price of the region (by default in the retail currency of the region). Field type: amount with currency.
  • Number input field.
  • Currency selection field.

Attention: The field is available for viewing to users with roles: product manager, franchisee. The field is available for editing to users with the role: product manager
ExpensesCosts. The field is intended for calculating all expenses. Field type: formula. Field label: expenses

Price Lists: User Fields

User fields (formulas) are defined by the user and are colored blue.

Attention: Each user field has a label (slug). Access to the field value for each price list record and its subsequent use in formulas is done via the label. To view labels, formulas, and values of fields in the price list, go to the Formula Diagnostics section. For the structure of system fields, see the Price Lists: System Fields section.

Managing Price Lists

The Price Lists section allows:

Creating a Formula

  1. To create a formula, click Add Formula.
  2. Fill out the New Formula form according to the description in the Add Formula section.
  3. To create a new formula, click Save, to cancel, click Back.

Editing a Formula

  1. Select the desired field in the price lists.
  2. To invoke the Edit Formula form on the selected price list field, click the "Pencil" icon.
  3. Edit the necessary data according to the description in the Add Formula section.

Attention: The description of the fields in the New Formula form corresponds to the description of the fields in the Edit Formula form.

  1. To save changes, click Save, to cancel, click Back.

Deleting a Formula

  1. Select the desired field in the price lists.
  2. To invoke the Edit Formula form on the selected field, click the "Pencil" icon.
  3. To delete the formula, click Delete. To confirm the deletion, click Confirm, to cancel the deletion, click Cancel.

Entering Data into System Fields

  1. Select the desired record in the price lists.
  2. Enter data into the selected system field.

Attention: Before entering data into system fields, familiarize yourself with the Price Lists: System Fields section. Some system fields are combined and consist of elements:

  • Input field: enter the price value for the selected product variant. The entered values are saved automatically.
  • Selection field: select the currency value for the selected product variant. The entered values are saved automatically.

Formula Diagnostics

To invoke the Formula Diagnostics window, click on the value of the Expenses field for the selected price list record.

In the Formula Diagnostics window for “Expenses”, the information displayed includes:

  • Formula: the value of the formula.
  • Name: the name of the product variant.
  • Brand: the name of the brand of the product variant.
  • Category: the name of the category of the product variant.
  • Family: the name of the family of the product variant.

In the Formula Diagnostics window for “Expenses”, the Formulas section will display a list of product variables for the selected price list record:

  • The first column contains the names of the fields in the price list table;
  • The second column contains the labels of existing fields in the price lists;
  • The third column contains the values (formulas) of existing fields for the selected price list.

Example for an arbitrarily selected price list record:

Field NameField LabelValue
Volume (m³)product_variant_volumevolume
Dealer Pricedealer_price_amountdealer_price_amount = 10
Currency of Dealer Pricedealer_price_currencydealer_price_currency = CNY
Dealer Price in Dealer Currency of Region (AED)dealer_price_in_region_dealer_currency_amountround((dealer_price_amount * exchange_rate(dealer_price_currency, region_dealer_currency)), 2) = 5.16
Regional Currency of Dealer Priceregion_dealer_currencyregion_dealer_currency = AED
Dealer Price in Retail Currency of Region (AED)dealer_price_in_region_retail_currency_amountround((dealer_price_amount * exchange_rate(dealer_price_currency, region_retail_currency)), 2) = 5.16
Regional Currency of Retail Priceregion_retail_currencyregion_retail_currency = AED
Retail Markupretail_price_markupif((dealer_price_amount > 0), round((((retail_price_amount - ((dealer_price_amount * exchange_rate(dealer_price_currency, retail_price_currency)) + expenses)) / ((dealer_price_amount * exchange_rate(dealer_price_currency, retail_price_currency)) + expenses)) * 100), 2), 0) = 93.88
Retail Priceretail_price_amountretail_price_amount = 10
Currency of Retail Priceretail_price_currencyretail

Attention: The Formula Diagnostics window can be invoked from any user field.

image

Attention: Before starting work with price lists, ensure that the corresponding products and product variants are created in the PIM system. Clarification of the process for different roles:

  • Process for Product Managers:
  • Search for products.
  • Enter retail price.
  • Enter dealer price.
  • Check all markups.
  • Add formulas (if necessary).
  • Process for Franchisees:
    • Search for products.
    • Check retail price.
    • Check dealer price.
    • Check retail markup.
    • Add a formula column with different types of expenses.
    • Edit the Expenses column to calculate the total expenses.
    • Check retail markup.

1. Select Region

In the region switch panel, select the region for which the price calculation will be performed.

After selecting the region, the working area of the section will display price lists for product variants with price values in regional currencies.

The default currency values for the selected region are described in the Regions section.

2. Set Filters

  • Setting Filters. To invoke the Filters panel on the toolbar of the Price Lists section, click the Filters button. In the Filters panel, set the necessary options and select the required field values:

    • No Retail Price option: select this option to display price lists without retail prices (if necessary).
    • No Dealer Price option: select this option to display price lists without dealer prices (if necessary).
    • No Purchase Price option: select this option to display price lists without purchase prices (if necessary).
    • Brands selection field: this field allows you to select multiple values. Select the necessary product brands (if necessary).
    • Categories selection field: this field allows you to select multiple values. Select the necessary product categories (if necessary).
    • Families selection field: this field allows you to select multiple values. Select the necessary product families (if necessary).
    • Product Status selection field: this field allows you to select multiple values. Select the necessary product statuses (if necessary).

    After setting the filters, the working area of the section will display the filtered price lists, and the Filters button will show the value of the set filters.

  • Reset Filters. In the Filters panel, click the Clear Filters button (if necessary).

To search for a price list of a specific product variant, enter the name of the product variant in the Search field.

4. Enter Data

Enter data for system fields according to the Entering Data into System Fields section.

5. Enter Formulas

Enter new formulas or edit existing ones according to the sections:

On this page