0ffc5b48d7
* docs: price lists and price selection strategy * added missing type property * Removed duplicate links
112 lines
2.9 KiB
Markdown
112 lines
2.9 KiB
Markdown
# Override Price Selection Strategy
|
||
|
||
In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy.
|
||
|
||
:::note
|
||
|
||
If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](./index.md) instead.
|
||
|
||
:::
|
||
|
||
## 1. Create Class
|
||
|
||
Create a TypeScript or JavaScript file in `src/strategies` of your Medusa server project with a class that extends the `AbstractPriceSelectionStrategy` class:
|
||
|
||
```typescript
|
||
import { AbstractPriceSelectionStrategy, IPriceSelectionStrategy, PriceSelectionContext, PriceSelectionResult } from "@medusajs/medusa";
|
||
|
||
import { EntityManager } from "typeorm";
|
||
|
||
export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy {
|
||
|
||
withTransaction(manager: EntityManager): IPriceSelectionStrategy {
|
||
if (!manager) {
|
||
return this
|
||
}
|
||
|
||
return new MyPriceListStrategy()
|
||
}
|
||
|
||
async calculateVariantPrice(
|
||
variant_id: string,
|
||
context: PriceSelectionContext
|
||
): Promise<PriceSelectionResult> {
|
||
//TODO
|
||
}
|
||
}
|
||
```
|
||
|
||
You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyPriceListStrategy` constructor in `withTransaction`. For example:
|
||
|
||
```typescript
|
||
export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy {
|
||
private productsService: ProductService
|
||
|
||
constructor({
|
||
productsService
|
||
}) {
|
||
super()
|
||
this.productsService = productsService
|
||
}
|
||
|
||
withTransaction(manager: EntityManager): IPriceSelectionStrategy {
|
||
if (!manager) {
|
||
return this
|
||
}
|
||
|
||
return new MyPriceListStrategy({
|
||
productsService: this.productsService
|
||
})
|
||
}
|
||
//...
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
## 2. Implement calculateVariantPrice
|
||
|
||
Implement the price selection strategy you want inside the `calculateVariantPrice` method.
|
||
|
||
This method accepts the variant ID as a first parameter and the [context](./index.md#context-object) object as a second parameter.
|
||
|
||
This method must return an object having the following fields:
|
||
|
||
```typescript
|
||
{
|
||
originalPrice, //number | null
|
||
calculatedPrice, //number | null
|
||
prices // MoneyAmount[]
|
||
}
|
||
```
|
||
|
||
You can learn more about optional properties and the meaning behind every property [here](./index.md#calculatevariantprice-method).
|
||
|
||
---
|
||
|
||
## 3. Run Build Command
|
||
|
||
In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory:
|
||
|
||
```bash npm2yarn
|
||
npm run build
|
||
```
|
||
|
||
---
|
||
|
||
## Test it Out
|
||
|
||
Run your server to test it out:
|
||
|
||
```bash npm2yarn
|
||
npm run start
|
||
```
|
||
|
||
Then, try out your strategy using any of the [Products](https://docs.medusajs.com/api/store/#tag/Product) or [Carts](https://docs.medusajs.com/api/store/#tag/Cart) endpoints which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy.
|
||
|
||
---
|
||
|
||
## What’s Next 🚀
|
||
|
||
- Learn more about [price list selection strategy](./index.md).
|