docs: add examples to price rules and tiers (#12700)
* docs: add examples to price rules and tiers * generate
This commit is contained in:
Shahed Nasser
GitHub
@@ -27516,6 +27516,11 @@ const price = await pricingModuleService.calculatePrices(
|
||||
|
||||
In this Pricing Module guide, you'll learn about tired prices, price rules for price sets and price lists, and how to add rules to a price.
|
||||
|
||||
You can manage prices and tiers using the Medusa Admin:
|
||||
|
||||
- [Edit shipping option prices with conditions](https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations#fixed-and-conditional-shipping-option-prices/index.html.md).
|
||||
- [Add price lists to set prices with conditions for product variants](https://docs.medusajs.com/user-guide/price-lists/index.html.md).
|
||||
|
||||
## Tiered Pricing
|
||||
|
||||
Each price, represented by the [Price data model](https://docs.medusajs.com/references/pricing/models/Price/index.html.md), has two optional properties that can be used to create tiered prices:
|
||||
@@ -27565,6 +27570,10 @@ For most use cases where you're building customizations in the Medusa applicatio
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts highlights={tieredPricingHighlights}
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
@@ -27693,18 +27702,19 @@ const { result } = await createShippingOptionsWorkflow(container)
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {},
|
||||
rules: [],
|
||||
},
|
||||
// price if cart total >= $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
item_total: {
|
||||
rules: [
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
@@ -27780,6 +27790,575 @@ In this example, the price is only applied if a cart's customer belongs to the c
|
||||
|
||||
These same rules apply to product variant prices as well, or any other resource that has a price.
|
||||
|
||||
***
|
||||
|
||||
## Examples
|
||||
|
||||
This section provides some examples of implementing price tiers and rules for products and shipping options.
|
||||
|
||||
### Product Variant Price by Quantity
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
products: [{
|
||||
title: "Premium T-Shirt",
|
||||
variants: [{
|
||||
title: "Small / Black",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// buy 5 or more, get a small discount
|
||||
{
|
||||
amount: 18,
|
||||
currency_code: "usd",
|
||||
min_quantity: 5,
|
||||
max_quantity: 9,
|
||||
},
|
||||
// buy 10 or more, get a bigger discount
|
||||
{
|
||||
amount: 15,
|
||||
currency_code: "usd",
|
||||
min_quantity: 10,
|
||||
},
|
||||
],
|
||||
}],
|
||||
}],
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
// this is the price set of the product variant
|
||||
priceSetId: "pset_product_123",
|
||||
prices: [
|
||||
// default price: $20.00
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// buy 5-9 shirts: $18.00 each
|
||||
{
|
||||
amount: 18,
|
||||
currency_code: "usd",
|
||||
min_quantity: 5,
|
||||
max_quantity: 9,
|
||||
},
|
||||
// buy 10+ shirts: $15.00 each
|
||||
{
|
||||
amount: 15,
|
||||
currency_code: "usd",
|
||||
min_quantity: 10,
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
### Product Variant Price by Customer Group
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
products: [{
|
||||
title: "Premium T-Shirt",
|
||||
variants: [{
|
||||
title: "Small / Black",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 40,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// discounted price for VIP customers
|
||||
{
|
||||
amount: 30,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_vip123",
|
||||
},
|
||||
},
|
||||
// special price for wholesale customers
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_wholesale456",
|
||||
},
|
||||
},
|
||||
],
|
||||
}],
|
||||
}],
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
// this is the price set of the product variant
|
||||
priceSetId: "pset_product_123",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 40,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// discounted price for VIP customers
|
||||
{
|
||||
amount: 30,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_vip123",
|
||||
},
|
||||
},
|
||||
// special price for wholesale customers
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_wholesale456",
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
### Free Shipping for Orders Above a Certain Amount
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Standard Shipping",
|
||||
service_zone_id: "serzo_123",
|
||||
shipping_profile_id: "sp_123",
|
||||
provider_id: "prov_123",
|
||||
type: {
|
||||
label: "Standard",
|
||||
description: "Standard shipping (2-5 business days)",
|
||||
code: "standard",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// regular shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: [],
|
||||
},
|
||||
// free shipping for carts over $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: [
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_123",
|
||||
prices: [
|
||||
// regular shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {},
|
||||
},
|
||||
// free shipping for orders over $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
item_total: [
|
||||
{
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
### Shipping Prices Based on Customer Groups
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Express Shipping",
|
||||
service_zone_id: "serzo_456",
|
||||
shipping_profile_id: "sp_456",
|
||||
provider_id: "prov_456",
|
||||
type: {
|
||||
label: "Express",
|
||||
description: "Express shipping (1-2 business days)",
|
||||
code: "express",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// regular express shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [],
|
||||
},
|
||||
// discounted express shipping for VIP customers
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// special rate for B2B customers
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 13,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_b2b789"],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_456",
|
||||
prices: [
|
||||
// regular express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {},
|
||||
},
|
||||
// VIP customer express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// B2B customer express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 13,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_b2b789"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
### Combined Tiered and Rule-Based Shipping Pricing
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Bulk Shipping",
|
||||
service_zone_id: "serzo_789",
|
||||
shipping_profile_id: "sp_789",
|
||||
provider_id: "prov_789",
|
||||
type: {
|
||||
label: "Bulk",
|
||||
description: "Shipping for bulk orders",
|
||||
code: "bulk",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// base shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [],
|
||||
},
|
||||
// discounted shipping for 5-10 items
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 18,
|
||||
min_quantity: 5,
|
||||
max_quantity: 10,
|
||||
rules: [],
|
||||
},
|
||||
// heavily discounted shipping for 10+ items
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
min_quantity: 11,
|
||||
rules: [],
|
||||
},
|
||||
// free shipping for VIP customers with carts over $200
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
item_total: [
|
||||
{
|
||||
operator: "gte",
|
||||
value: 200,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_789",
|
||||
prices: [
|
||||
// base shipping price: $20.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {},
|
||||
},
|
||||
// 5-10 items: $18.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 18,
|
||||
min_quantity: 5,
|
||||
max_quantity: 10,
|
||||
rules: {},
|
||||
},
|
||||
// 11+ items: $15.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
min_quantity: 11,
|
||||
rules: {},
|
||||
},
|
||||
// VIP customers with orders over $200: FREE
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 200,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
### Shipping Prices Based on Geographical Rules
|
||||
|
||||
### Using Medusa Workflows
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Regional Shipping",
|
||||
service_zone_id: "serzo_geo123",
|
||||
shipping_profile_id: "sp_standard",
|
||||
provider_id: "prov_standard",
|
||||
type: {
|
||||
label: "Standard",
|
||||
description: "Standard shipping with regional pricing",
|
||||
code: "standard_regional",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// default shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: [],
|
||||
},
|
||||
// special price for specific zip codes (metropolitan areas)
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.postal_code",
|
||||
operator: "in",
|
||||
value: ["10001", "10002", "10003", "90001", "90002", "90003"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// higher price for remote areas
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 25,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.postal_code",
|
||||
operator: "in",
|
||||
value: ["99501", "99502", "99503", "00601", "00602", "00603"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// different price for a specific region
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 12,
|
||||
rules: [
|
||||
{
|
||||
attribute: "region.id",
|
||||
operator: "eq",
|
||||
value: "reg_123",
|
||||
},
|
||||
],
|
||||
},
|
||||
// different price for a specific country
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.country_code",
|
||||
operator: "eq",
|
||||
value: "ca",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
### Using the Pricing Module
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_geo",
|
||||
prices: [
|
||||
// default shipping price: $15.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: {},
|
||||
},
|
||||
// metropolitan areas: $10.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {
|
||||
"shipping_address.postal_code": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["10001", "10002", "10003", "90001", "90002", "90003"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// remote areas: $25.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 25,
|
||||
rules: {
|
||||
"shipping_address.postal_code": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["99501", "99502", "99503", "00601", "00602", "00603"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// Northeast region: $12.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 12,
|
||||
rules: {
|
||||
"region.id": "reg_123",
|
||||
},
|
||||
},
|
||||
// Canada: $20.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {
|
||||
"shipping_address.country_code": "ca",
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
|
||||
# Tax-Inclusive Pricing
|
||||
|
||||
|
||||
@@ -5,6 +5,9 @@ tags:
|
||||
- name: fulfillment
|
||||
label: "Shipping Option Price Rules"
|
||||
- concept
|
||||
products:
|
||||
- product
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { CodeTabs, CodeTab } from "docs-ui"
|
||||
@@ -17,6 +20,15 @@ export const metadata = {
|
||||
|
||||
In this Pricing Module guide, you'll learn about tired prices, price rules for price sets and price lists, and how to add rules to a price.
|
||||
|
||||
<Note title="Looking for no-code docs?">
|
||||
|
||||
You can manage prices and tiers using the Medusa Admin:
|
||||
|
||||
- [Edit shipping option prices with conditions](!user-guide!/settings/locations-and-shipping/locations#fixed-and-conditional-shipping-option-prices).
|
||||
- [Add price lists to set prices with conditions for product variants](!user-guide!/price-lists).
|
||||
|
||||
</Note>
|
||||
|
||||
## Tiered Pricing
|
||||
|
||||
Each price, represented by the [Price data model](/references/pricing/models/Price), has two optional properties that can be used to create tiered prices:
|
||||
@@ -71,11 +83,15 @@ For most use cases where you're building customizations in the Medusa applicatio
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
export const tieredPricingHighlights = [
|
||||
["16", "min_quantity", "The minimum quantity that must be in the cart for the price to be applied."],
|
||||
["17", "max_quantity", "The maximum quantity that can be in the cart for the price to be applied."],
|
||||
["20", "min_quantity", "The minimum quantity that must be in the cart for the price to be applied."],
|
||||
["21", "max_quantity", "The maximum quantity that can be in the cart for the price to be applied."],
|
||||
]
|
||||
|
||||
```ts highlights={tieredPricingHighlights}
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
@@ -200,7 +216,7 @@ For most use cases where you're building customizations in the Medusa applicatio
|
||||
|
||||
export const workflowHighlights = [
|
||||
["19", "rules", "The default price doesn't have rules."],
|
||||
["26", "item_total", "Apply the price if the cart or order's total matches the condition."]
|
||||
["27", "attribute", "Apply the price if the cart or order's total matches the condition."]
|
||||
]
|
||||
|
||||
```ts highlights={workflowHighlights}
|
||||
@@ -222,18 +238,19 @@ const { result } = await createShippingOptionsWorkflow(container)
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {},
|
||||
rules: [],
|
||||
},
|
||||
// price if cart total >= $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
item_total: {
|
||||
rules: [
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
@@ -316,3 +333,602 @@ In this example, the price is only applied if a cart's customer belongs to the c
|
||||
These same rules apply to product variant prices as well, or any other resource that has a price.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
This section provides some examples of implementing price tiers and rules for products and shipping options.
|
||||
|
||||
### Product Variant Price by Quantity
|
||||
|
||||
<CodeTabs group="product-tier-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
products: [{
|
||||
title: "Premium T-Shirt",
|
||||
variants: [{
|
||||
title: "Small / Black",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// buy 5 or more, get a small discount
|
||||
{
|
||||
amount: 18,
|
||||
currency_code: "usd",
|
||||
min_quantity: 5,
|
||||
max_quantity: 9,
|
||||
},
|
||||
// buy 10 or more, get a bigger discount
|
||||
{
|
||||
amount: 15,
|
||||
currency_code: "usd",
|
||||
min_quantity: 10,
|
||||
},
|
||||
],
|
||||
}],
|
||||
}],
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
// this is the price set of the product variant
|
||||
priceSetId: "pset_product_123",
|
||||
prices: [
|
||||
// default price: $20.00
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// buy 5-9 shirts: $18.00 each
|
||||
{
|
||||
amount: 18,
|
||||
currency_code: "usd",
|
||||
min_quantity: 5,
|
||||
max_quantity: 9,
|
||||
},
|
||||
// buy 10+ shirts: $15.00 each
|
||||
{
|
||||
amount: 15,
|
||||
currency_code: "usd",
|
||||
min_quantity: 10,
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
### Product Variant Price by Customer Group
|
||||
|
||||
<CodeTabs group="product-rule-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
// ...
|
||||
|
||||
const { result } = await createProductsWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
products: [{
|
||||
title: "Premium T-Shirt",
|
||||
variants: [{
|
||||
title: "Small / Black",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 40,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// discounted price for VIP customers
|
||||
{
|
||||
amount: 30,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_vip123",
|
||||
},
|
||||
},
|
||||
// special price for wholesale customers
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_wholesale456",
|
||||
},
|
||||
},
|
||||
],
|
||||
}],
|
||||
}],
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
// this is the price set of the product variant
|
||||
priceSetId: "pset_product_123",
|
||||
prices: [
|
||||
// default price
|
||||
{
|
||||
amount: 40,
|
||||
currency_code: "usd",
|
||||
},
|
||||
// discounted price for VIP customers
|
||||
{
|
||||
amount: 30,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_vip123",
|
||||
},
|
||||
},
|
||||
// special price for wholesale customers
|
||||
{
|
||||
amount: 20,
|
||||
currency_code: "usd",
|
||||
rules: {
|
||||
"customer.groups.id": "cusgrp_wholesale456",
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
### Free Shipping for Orders Above a Certain Amount
|
||||
|
||||
<CodeTabs group="shipping-tier-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Standard Shipping",
|
||||
service_zone_id: "serzo_123",
|
||||
shipping_profile_id: "sp_123",
|
||||
provider_id: "prov_123",
|
||||
type: {
|
||||
label: "Standard",
|
||||
description: "Standard shipping (2-5 business days)",
|
||||
code: "standard",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// regular shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: [],
|
||||
},
|
||||
// free shipping for carts over $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: [
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_123",
|
||||
prices: [
|
||||
// regular shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {},
|
||||
},
|
||||
// free shipping for orders over $100
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
item_total: [
|
||||
{
|
||||
operator: "gte",
|
||||
value: 100,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
### Shipping Prices Based on Customer Groups
|
||||
|
||||
<CodeTabs group="shipping-customer-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Express Shipping",
|
||||
service_zone_id: "serzo_456",
|
||||
shipping_profile_id: "sp_456",
|
||||
provider_id: "prov_456",
|
||||
type: {
|
||||
label: "Express",
|
||||
description: "Express shipping (1-2 business days)",
|
||||
code: "express",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// regular express shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [],
|
||||
},
|
||||
// discounted express shipping for VIP customers
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// special rate for B2B customers
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 13,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_b2b789"],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_456",
|
||||
prices: [
|
||||
// regular express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {},
|
||||
},
|
||||
// VIP customer express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// B2B customer express shipping
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 13,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_b2b789"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
### Combined Tiered and Rule-Based Shipping Pricing
|
||||
|
||||
<CodeTabs group="shipping-combined-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Bulk Shipping",
|
||||
service_zone_id: "serzo_789",
|
||||
shipping_profile_id: "sp_789",
|
||||
provider_id: "prov_789",
|
||||
type: {
|
||||
label: "Bulk",
|
||||
description: "Shipping for bulk orders",
|
||||
code: "bulk",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// base shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [],
|
||||
},
|
||||
// discounted shipping for 5-10 items
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 18,
|
||||
min_quantity: 5,
|
||||
max_quantity: 10,
|
||||
rules: [],
|
||||
},
|
||||
// heavily discounted shipping for 10+ items
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
min_quantity: 11,
|
||||
rules: [],
|
||||
},
|
||||
// free shipping for VIP customers with carts over $200
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: {
|
||||
"customer.groups.id": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
],
|
||||
item_total: [
|
||||
{
|
||||
operator: "gte",
|
||||
value: 200,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_789",
|
||||
prices: [
|
||||
// base shipping price: $20.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {},
|
||||
},
|
||||
// 5-10 items: $18.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 18,
|
||||
min_quantity: 5,
|
||||
max_quantity: 10,
|
||||
rules: {},
|
||||
},
|
||||
// 11+ items: $15.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
min_quantity: 11,
|
||||
rules: {},
|
||||
},
|
||||
// VIP customers with orders over $200: FREE
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 0,
|
||||
rules: [
|
||||
{
|
||||
attribute: "customer.groups.id",
|
||||
operator: "in",
|
||||
value: ["cusgrp_vip123"],
|
||||
},
|
||||
{
|
||||
attribute: "item_total",
|
||||
operator: "gte",
|
||||
value: 200,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
### Shipping Prices Based on Geographical Rules
|
||||
|
||||
<CodeTabs group="shipping-geo-example">
|
||||
<CodeTab label="Using Medusa Workflows" value="workflows">
|
||||
|
||||
```ts
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
name: "Regional Shipping",
|
||||
service_zone_id: "serzo_geo123",
|
||||
shipping_profile_id: "sp_standard",
|
||||
provider_id: "prov_standard",
|
||||
type: {
|
||||
label: "Standard",
|
||||
description: "Standard shipping with regional pricing",
|
||||
code: "standard_regional",
|
||||
},
|
||||
price_type: "flat",
|
||||
prices: [
|
||||
// default shipping price
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: [],
|
||||
},
|
||||
// special price for specific zip codes (metropolitan areas)
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.postal_code",
|
||||
operator: "in",
|
||||
value: ["10001", "10002", "10003", "90001", "90002", "90003"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// higher price for remote areas
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 25,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.postal_code",
|
||||
operator: "in",
|
||||
value: ["99501", "99502", "99503", "00601", "00602", "00603"],
|
||||
},
|
||||
],
|
||||
},
|
||||
// different price for a specific region
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 12,
|
||||
rules: [
|
||||
{
|
||||
attribute: "region.id",
|
||||
operator: "eq",
|
||||
value: "reg_123",
|
||||
},
|
||||
],
|
||||
},
|
||||
// different price for a specific country
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: [
|
||||
{
|
||||
attribute: "shipping_address.country_code",
|
||||
operator: "eq",
|
||||
value: "ca",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
<CodeTab label="Using the Pricing Module" value="pricing-module">
|
||||
|
||||
```ts
|
||||
const priceSet = await pricingModule.addPrices({
|
||||
priceSetId: "pset_shipping_geo",
|
||||
prices: [
|
||||
// default shipping price: $15.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 15,
|
||||
rules: {},
|
||||
},
|
||||
// metropolitan areas: $10.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 10,
|
||||
rules: {
|
||||
"shipping_address.postal_code": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["10001", "10002", "10003", "90001", "90002", "90003"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// remote areas: $25.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 25,
|
||||
rules: {
|
||||
"shipping_address.postal_code": [
|
||||
{
|
||||
operator: "in",
|
||||
value: ["99501", "99502", "99503", "00601", "00602", "00603"],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// Northeast region: $12.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 12,
|
||||
rules: {
|
||||
"region.id": "reg_123",
|
||||
},
|
||||
},
|
||||
// Canada: $20.00
|
||||
{
|
||||
currency_code: "usd",
|
||||
amount: 20,
|
||||
rules: {
|
||||
"shipping_address.country_code": "ca",
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
</CodeTab>
|
||||
</CodeTabs>
|
||||
|
||||
@@ -57,7 +57,7 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/pricing/_events/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
"app/commerce-modules/pricing/concepts/page.mdx": "2024-10-09T13:37:25.678Z",
|
||||
"app/commerce-modules/pricing/price-calculation/page.mdx": "2025-05-20T07:51:40.710Z",
|
||||
"app/commerce-modules/pricing/price-rules/page.mdx": "2025-05-20T07:51:40.710Z",
|
||||
"app/commerce-modules/pricing/price-rules/page.mdx": "2025-06-10T15:56:43.648Z",
|
||||
"app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx": "2025-06-27T15:43:35.193Z",
|
||||
"app/commerce-modules/pricing/page.mdx": "2025-05-20T07:51:40.710Z",
|
||||
"app/commerce-modules/product/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
@@ -6484,9 +6484,9 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/tax/tax-provider/page.mdx": "2025-05-20T07:51:40.711Z",
|
||||
"app/recipes/bundled-products/examples/standard/page.mdx": "2025-06-26T11:52:18.819Z",
|
||||
"app/recipes/bundled-products/page.mdx": "2025-05-20T07:51:40.718Z",
|
||||
"app/infrastructure-modules/analytics/local/page.mdx": "2025-05-29T07:08:55.749Z",
|
||||
"app/infrastructure-modules/analytics/local/page.mdx": "2025-06-10T15:56:43.648Z",
|
||||
"app/infrastructure-modules/analytics/page.mdx": "2025-05-26T14:48:25.803Z",
|
||||
"app/infrastructure-modules/analytics/posthog/page.mdx": "2025-05-29T07:08:23.727Z",
|
||||
"app/infrastructure-modules/analytics/posthog/page.mdx": "2025-06-10T15:56:43.648Z",
|
||||
"references/analytics/interfaces/analytics.IAnalyticsModuleService/page.mdx": "2025-06-05T19:05:43.239Z",
|
||||
"references/analytics_provider/classes/analytics_provider.AbstractAnalyticsProviderService/page.mdx": "2025-05-21T14:22:04.267Z",
|
||||
"references/modules/analytics/page.mdx": "2025-05-21T14:21:59.323Z",
|
||||
|
||||
Reference in New Issue
Block a user