asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update fulfillment provider module docs to reflect CalculatedShippingOptionPrice (#10778)

Browse Source 
The return value below the example for the `calculatePrice` method is shown correctly as `CalculatedShippingOptionPrice` but the example is not updated in the guide "How to Create a Fulfillment Provider Module"

This PR updates the example in the guide and the TS doc
This commit is contained in:
Ranjith kumar
2024-12-31 17:14:17 +05:30
committed by GitHub
parent 6780ea9f13
commit 1ef3e4b8de
2 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
packages/core/utils/src/fulfillment/provider.ts
View File

@@ -229,13 +229,22 @@ export class AbstractFulfillmentProviderService
* @returns The calculated price's details.
*
* @example
* import { CalculateShippingOptionPriceDTO } from "@medusajs/framework/types"
* class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
* // ...
* async calculatePrice(optionData: any, data: any, context: any): Promise<number> {
* async calculatePrice(
* optionData: CalculateShippingOptionPriceDTO["optionData"],
* data: CalculateShippingOptionPriceDTO["data"],
* context: CalculateShippingOptionPriceDTO["context"]
* ): Promise<CalculatedShippingOptionPrice> {
* // assuming the client can calculate the price using
* // the third-party service
* const price = await this.client.calculate(data)
* return price
* return {
* calculated_amount: price,
* // Update this boolean value based on your logic
* is_calculated_price_tax_inclusive: true,
* }
* }
* }
*/
@@ -346,7 +355,7 @@ export class AbstractFulfillmentProviderService
* `data` property, it's stored in the fulfillment's `data` property.
*
* The `data` property is useful when handling the fulfillment later,
* as you can access information useful for your integration. For example, you
* as you can access information useful for your integration. For example, you
* can store an ID for the fulfillment in the third-party service.
*
* Use this method to perform actions necessary in the third-party fulfillment service, such as

12
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
View File

@@ -241,11 +241,19 @@ you can retrieve the calculated price of the shipping method.
```ts
class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
// ...
async calculatePrice(optionData: any, data: any, context: any): Promise<number> {
async calculatePrice(
optionData: CalculateShippingOptionPriceDTO["optionData"],
data: CalculateShippingOptionPriceDTO["data"],
context: CalculateShippingOptionPriceDTO["context"]
): Promise<CalculatedShippingOptionPrice> {
// assuming the client can calculate the price using
// the third-party service
const price = await this.client.calculate(data)
return price
return {
calculated_amount: price,
// update this boolean value based on your logic
is_calculated_price_tax_inclusive: true
}
}
}
```