chore: Individual Pricing documentation #2133
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| --- | ||
| nav: | ||
| title: Entities and workflow | ||
| position: 10 | ||
|
|
||
| --- | ||
|
|
||
| # Entities and workflow | ||
|
|
||
| ## Entities | ||
|
|
||
| ### Individual Pricing | ||
|
|
||
| The Individual Pricing entity is the main configuration entity that defines a pricing rule. It contains all the settings needed to determine which products get special pricing, who receives it, and how the pricing is calculated. | ||
|
|
||
| **Key properties:** | ||
|
|
||
| - **name**: Human-readable name for the pricing rule | ||
| - **description**: Optional description of the pricing rule | ||
| - **active**: Boolean flag to enable/disable the rule | ||
| - **priority**: Integer value determining evaluation order (higher values = higher priority) | ||
| - **target**: Type of audience (companies, tags) | ||
| - **actionType**: Type of price modification (by_percent, by_fixed, to_fixed, volume_pricing) | ||
silverDuy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - **actionAmount**: Amount for the pricing action (percentage or fixed value) | ||
| - **applyToAllProducts**: If true, applies to all products in the catalog | ||
| - **productStreamId**: Reference to a Shopware product stream for filtering specific products | ||
| - **useValidityRange**: Boolean indicating if time-based validity is used | ||
| - **validFrom**: Start date/time for the pricing rule | ||
| - **validUntil**: End date/time for the pricing rule | ||
| - **showStrikeThrough**: Whether to show original price with strike-through | ||
|
|
||
| **Action Types:** | ||
|
|
||
| - `by_percent`: Reduce price by a percentage (e.g., 10% off) | ||
| - `by_fixed`: Reduce price by a fixed amount (e.g., 5$ off) | ||
| - `to_fixed`: Set price to a specific amount (e.g., 99.99$) | ||
| - `volume_pricing`: Use tiered pricing based on quantity | ||
|
|
||
| ### Individual Pricing Tier | ||
|
|
||
| The tier entity defines volume-based pricing tiers for quantity discounts. Multiple tiers can be associated with a single Individual Pricing rule when the action type is set to `volume_pricing`. | ||
|
|
||
| **Key properties:** | ||
|
|
||
| - **individualPricingId**: Reference to the parent pricing rule | ||
| - **qtyFrom**: Minimum quantity for this tier (inclusive) | ||
| - **qtyTo**: Maximum quantity for this tier (inclusive, null for unlimited) | ||
| - **price**: Price collection containing prices for different currencies | ||
|
|
||
| **Example tiers:** | ||
|
|
||
| - Tier 1: 1-9 units @ 10$ each | ||
|
Check warning on line 52 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| - Tier 2: 10-49 units @ 9$ each | ||
|
Check warning on line 53 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| - Tier 3: 50+ units @ 8$ each | ||
|
Comment on lines
+34
to
+54
There was a problem hiding this comment. The examples use currency formatting like |
||
|
|
||
| ### Individual Pricing Company Assignment | ||
|
|
||
| This entity links pricing rules to specific business partner companies or organization units. It determines which companies or parts of companies receive the special pricing. | ||
|
|
||
| **Key properties:** | ||
|
|
||
| - **individualPricingId**: Reference to the pricing rule | ||
| - **customerId**: Reference to the business partner customer | ||
| - **scope**: Defines assignment scope (whole_company, all_org_units, specific_units) | ||
| - **organizationUnitIds**: JSON array of specific organization unit IDs (when scope is specific_units) | ||
|
|
||
| **Scopes:** | ||
|
|
||
| - `whole_company`: Applies to all employees of the business partner | ||
| - `all_org_units`: Applies to all organization units within the company | ||
| - `specific_units`: Applies only to specific organization units (requires organizationUnitIds) | ||
|
|
||
| ### Individual Pricing Computed Cache | ||
|
|
||
| The computed cache entity pre-calculates which products are affected by which pricing rules. This significantly improves performance by avoiding repeated filter evaluations. | ||
|
|
||
| **Key properties:** | ||
|
|
||
| - **individualPricingId**: Reference to the pricing rule | ||
| - **productId**: Reference to the affected product (NULL if rule applies to all products) | ||
|
|
||
| This cache uses a hybrid approach: specific cache entries for targeted rules, and NULL entries for catalog-wide rules. | ||
|
|
||
| ## Schema | ||
|
|
||
| ```mermaid | ||
| erDiagram | ||
| b2b_components_individual_pricing { | ||
| uuid id PK | ||
|
Check warning on line 89 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| boolean active | ||
| boolean show_strike_through | ||
| string name | ||
| string target | ||
| int priority | ||
| boolean apply_to_all_products | ||
| uuid product_stream_id FK | ||
| boolean use_validity_range | ||
| datetime valid_from | ||
| datetime valid_until | ||
| string description | ||
| string action_type | ||
| float action_amount | ||
| uuid created_by_id FK | ||
| uuid updated_by_id FK | ||
| json custom_fields | ||
| } | ||
| b2b_components_individual_pricing_tier { | ||
| uuid id PK | ||
|
Check warning on line 108 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| uuid individual_pricing_id FK | ||
| int qty_from | ||
| int qty_to | ||
| json price | ||
| } | ||
| b2b_components_individual_pricing_company_assignment { | ||
| uuid id PK | ||
|
Check warning on line 115 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| uuid individual_pricing_id FK | ||
| uuid customer_id FK | ||
| string scope | ||
| json organization_unit_ids | ||
| } | ||
| b2b_components_individual_pricing_computed_cache { | ||
| uuid id PK | ||
|
Check warning on line 122 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| uuid individual_pricing_id FK | ||
| uuid product_id FK | ||
| } | ||
| b2b_components_individual_pricing_tag { | ||
| uuid individual_pricing_id FK | ||
| uuid tag_id FK | ||
| } | ||
| product_stream { | ||
| uuid id PK | ||
|
Check warning on line 131 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| string name | ||
| } | ||
|
|
||
| b2b_components_individual_pricing ||--o{ b2b_components_individual_pricing_tier : "has volume tiers" | ||
| b2b_components_individual_pricing ||--o{ b2b_components_individual_pricing_company_assignment : "assigned to companies" | ||
| b2b_components_individual_pricing ||--o{ b2b_components_individual_pricing_computed_cache : "cached for products" | ||
| b2b_components_individual_pricing ||--o{ b2b_components_individual_pricing_tag : "targets tags" | ||
| b2b_components_individual_pricing }o--|| product_stream : "uses" | ||
| b2b_components_individual_pricing_company_assignment }o--|| customer : "belongs to" | ||
| b2b_components_individual_pricing_computed_cache }o--|| product : "references" | ||
| b2b_components_individual_pricing_tag }o--|| tag : "references" | ||
| ``` | ||
|
|
||
| ## Workflow | ||
|
|
||
| The following diagram shows how individual pricing is applied to a product: | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A[Customer views product] --> B{Is logged-in?} | ||
| B -->|No| C[Show standard catalog price] | ||
| B -->|Yes| D[Load customer context] | ||
| D --> E[Query active pricing rules] | ||
| E --> F{Any rules found?} | ||
| F -->|No| C | ||
| F -->|Yes| G[Get all rules at highest priority] | ||
| G --> H[Evaluate all rules at this priority] | ||
| H --> I{Any rules match product streams?} | ||
| I -->|No| C | ||
| I -->|Yes| J{Multiple rules match?} | ||
| J -->|No| K[Use single matching rule] | ||
| J -->|Yes| L[Calculate price for each rule] | ||
| L --> M[Select rule with lowest price] | ||
|
Check warning on line 164 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| K --> N{Volume pricing?} | ||
| M --> N | ||
|
Check warning on line 166 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| N -->|Yes| O[Select appropriate tier] | ||
| N -->|No| P[Apply action type] | ||
| O --> Q[Calculate final price] | ||
| P --> Q | ||
|
Check warning on line 170 in products/extensions/b2b-components/individual-pricing/concepts/01-entities-and-workflow.md
|
||
| Q --> R{Show strike-through?} | ||
| R -->|Yes| S[Display with original price] | ||
| R -->|No| T[Display discounted price] | ||
| ``` | ||
|
|
||
| ## Target type evaluation | ||
|
|
||
| Depending on the target type, different evaluation logic applies: | ||
|
|
||
| ### Companies target | ||
|
|
||
| - Customer must be a business partner or employee | ||
| - Company assignment must exist linking the pricing rule to the customer's company | ||
| - Scope is checked (whole company, all units, or specific units) | ||
| - If specific units, customer must belong to one of the specified organization units | ||
|
|
||
| ### Tags target | ||
|
|
||
| - Customer must have at least one of the tags specified in the pricing rule | ||
|
|
||
| ## Priority and rule selection | ||
|
|
||
| When multiple pricing rules could apply to the same product: | ||
|
|
||
| 1. Only rules at the highest priority level are considered | ||
| 2. All rules at this priority level are evaluated | ||
| 3. If multiple rules match, the one resulting in the lowest price is selected | ||
| 4. If no rules match at the highest priority, standard catalog pricing is used | ||
|
|
||
| **Note:** Lower priority rules are never evaluated. This ensures the most important pricing takes precedence, and when multiple rules compete at the same level, customers always get the best price. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.