You are browsing the documentation for version 4.2 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
An account represents a person, a company or a group of people you do business activities with. An account aggregates details of all the customer identities assigned to it, providing for a 360-degree view of the customer activity.
A characteristic of an entity. For example, a zip-code and a street name are attributes of an address.
- Business Unit¶
A channel represents a source of customers and customer data, for example a specific shop, an outlet, a web-store, etc.
- Configurable Product¶
A configurable product is an item available in multiple variations. Customers ‘configure’ the product in terms of its color, size or any other applicable parameters according to buying needs. Buyers in the storefront choose from the options provided to ‘configure’ a product according to their needs.
In compliance with the GDPR in the EU, OroCommerce provides flexible mechanisms for collecting and managing customer consents. Mandatory consents restrict buyers in the storefront from proceeding to the checkout or creating RFQs, unless they accept these consents. Optional consents do not restrict buyers from working with the application and are usually used to retrieve permissions to send them email newsletters, inform about upcoming sales or seasonal discounts, etc.
A set of records related to a certain email.
- Custom Entity¶
An entity added to the system by a user from the UI.
- Custom Field¶
An field added to an entity by a user from the UI.
A system entity. Customers represent businesses, companies or divisions who buy products using the storefront.
- Customer Group¶
Customer groups organize customers into groups and share the price lists, payment and tax-related settings between several customers.
- Customer User¶
Customer users are actual people who act on behalf of companies (i.e. customers) and have a limited set of permissions which depend on their role and function in the customer organization.
Dashboard is a default page you see after you log in. It is an adjustable view that may contain many types of information blocks (widgets), such as today’s calendar, recent calls and emails, quick launchpad, etc. You can have several dashboards that serve different purposes and switch between them.
- Digital Assets¶
Digital Assets are multimedia content like videos, pictures, documents and other media. These digital files must possess the rights to use them to be considered an asset, otherwise, they are not assets.
A grouping of things with common rules that represent objects of similar nature. For example, orders, customers, addresses, etc.
Fields are used to store details of entity records. For example, a street name, a zip code, and a building number may be fields of an address. You can add new fields to any custom entity or an extendable system entity.
- Flat Rate¶
A fixed fee that is charged for a shipping service. A flat rate is used to specify one specific price to ship orders. This fee remains the same for everyone in all cases.
- Global Organization¶
An organization, from which a user can (subject to the permissions and access settings) see and process details of records in each and any organization within an Oro application instance.
- Grid (Record Table)¶
A grid is an aggregated view of all the records within an entity. Each row of a grid is one record and each column is one of the grid properties.
- Landing Page¶
Landing page is a marketing tool that generates interest and leads for your sales pipeline and has a distinct call to action with a single focused objective.
A system entity. Its records represent commercial activity with people or businesses that have authority, budget and interest to purchase goods and/or services from you, such that probability of the actual sales is not yet high or impossible to define.
- Lifetime Sales Value¶
A metric that helps understand the Customer. It predicts the potential benefit that the selling organization can obtain from a relationship with the customer in the long-term perspective. Lifetime sales value measures the total amount of money received from the customer based on orders placed and registered in the Oro application. When calculating a lifetime sales value, OroCommerce takes into account an average order amount, purchase frequency, and an average retention period.
- Listed Price¶
The pricing assigned to the available product units and their variations of quantity.
Localization is the process of translating and adapting a product for a specific country or region. Oro application allows a user to customize the format of date and time, numeric, percent, and monetary values as well as the format of names and addresses.
- Marketing Lists¶
Marketing lists are lists of contacts segmented according to conditions which are defined for the purpose of bulk emailing or telephone outreach.
- Master Catalog¶
Master catalog is a tree structure that organizes all the products of your store under corresponding categories. A category combines the products of the same type into groups and helps enforce the unified selling strategy by configuring a special set of product options, visibility, and SEO settings that best fit the resulting product family.
An order contains information about a buyer’s shopping list submitted for purchase and the collected information about billing and shipping address, payment method, etc.
A system entity. The highest level of the system permissions grouping. Its records represent a group of users that belong to the same enterprise, business, commerce or another organization. Different roles and permission settings can be defined for different organization records.
An open-source B2B Commerce solution with built in sales interaction tools for a commerce business.
An open-source CRM with built in marketing automation tools for a commerce business.
- Payment Term¶
A Payment Term describes the conditions under which a seller will complete a sale (e.g. the period allowed to a buyer to pay off the amount due).
- Price Attribute¶
Price attributes are custom parameters, like manufacturer’s suggested retail price (MSRP) or minimum advertised price (MAP), that may be needed as input information for your retail price listed on the website. Price attributes help you extend the product options with any custom value related to the price formation.
- Product Attribute¶
A product attribute is a special type of custom field in the product details. For product attributes, OroCommerce enables you to manage and group attributes that are unique to a special product family. By adding the product attributes only to the product families they fit, you can limit the product data to the necessary characteristics.
- Product Family¶
A product family is a set of the product attributes that are enough to store complete information about the products of a similar type (e.g., TV attributes vs T-shirts attributes). In the product family, attributes are organized into attribute groups that are displayed as titled sections on the OroCommerce storefront.
- Product Tax Code¶
Product Tax Code is a label that is assigned to a product or product group and indicates the tax obligations and exemptions customers have when they purchase this product. These tax obligations are taken into account when a customer (user) submits an order.
- Product Unit¶
Product units represent a measurement system of products or their combinations. All products in OroCommerce must have a product unit assigned to them for the customer users to be able to add items to the shopping list and determine their quantity in the OroCommerce storefront. Product units are also used throughout the system for inventory and pricing control. Each product in OroCommerce can be assigned multiple units with custom pricing added to each particular product unit.
Promotions provide discounts for customer users in the storefront, enable sellers to apply various discounts to their orders, generate personalized discount coupons, and build a strategic schedule for promotions.
A quote is used to negotiate with the customer (e.g. offer better price, more convenient quantities and additional services). A quote may be created in response to a customer request for quote, or as a result of the direct communication with the customer. Once the customer is happy with the offer in the quote and is ready to proceed with their order, they accept the quote.
One item of each entity <Entity>, such as an address record, a contact record, etc.
- Request for Quote¶
RFQs are used by sales representatives to assist customers and meet their needs through negotiations on a better price, more convenient quantities of products, or additional services. Once a customer submits a request for quotes in the Oro storefront, it immediately becomes available in the Oro back-office.
- Sales Territories¶
A sales territory is the customer group or geographical area for which an individual sales person or a sales team holds responsibility. Territories can be based on various factors such as geography, industry, product line, the expected revenue, etc.
- Shipping Rule¶
Shipping rules enable shipping methods for the provided destinations and set the customized shipping service price by adding a surcharge per service option or globally for all options of the service provider.
- Shopping List¶
Shopping lists are similar to shopping carts in most online stores. However, shopping lists have additional features. These include the ability to manage multiple shopping lists simultaneously, request quotes from a shopping list, submit orders from a shopping list, create as many shopping lists as needed, via the back-office, you can access any shopping list created in the Oro storefront.
- Simple Product¶
Simple products are physical items that exist in a basic, single variation. Their qualifiers, such as color or size, cannot be modified meaning customers cannot select the same product with slightly different characteristics. Simple products have a unique SKU and serve as ‘building blocks’ for configurable products. You can manage the inventory information and the price for a simple product.
- Stock keeping unit (SKU)¶
An SKU is a machine readable identifier of a product or service that helps inventory an item.
- System Entity¶
An entity available in the system out of the box.
A non-hierarchical keyword assigned to a record. Can be used for filtering.
- Tax Jurisdiction¶
Tax Jurisdiction is a geographical address of the area that is governed by the same tax laws and regulations, and that requires a dedicated set of tax calculation rules in OroCommerce: the tax rates for taxable/tax-exempt types of customers and products.
- Tier Price¶
A price determined by the system for the specified product quantity. Price tiers for a selected product can be derived from the same price list, or from the different price lists if they allow price merge. For example, you set the following prices in the price list:
If you buy 9 or less item, it would cost you $44.99 for 1 item
If you buy from 10 to 19 items, the price per item is lowered to $42.74 per item
If you buy from 20 to 49 items, the price per item is lowered further to $40.49, and so on
User records represent a person, a group of people or a third-party system using the Oro application. User’s credentials (login and password) identify a unique user and define what part of the system, which features and actions will available for them in the system.
- Web Catalog¶
Web catalog is a content management tool that helps build personalized custom versions of websites by mixing in category pages, product pages, landing pages and pre-existing system pages in different variations based on the customer account information, their customer group or language preference.
A website is OroCommerce customer-facing interface (web store). OroCommerce Enterprise supports multiple websites (web stores) that are attached to the same store administration and configuration interface (back-office). Every website may have unique product lines, localization settings, prices, etc.
- WYSIWYG (What You See Is What You Get)¶
The editor that enables to edit the content of a landing page, product page, and any other HTML-like web page, embed codes, media files, and widgets, and preview the results in the editor’s framework directly.
- Your Price¶