chore(docs): Generated References (automated) (#9727)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `notification` - `order` - `order_models` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
2313 files changed
+533036
-383477
No files matched your search
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `cancelFulfillment` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method cancels a fulfillment.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createFulfillment` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method creates a fulfillment and call the provider to create a fulfillment.
|
||||
|
||||
## Example
|
||||
@@ -44,7 +50,7 @@ const fulfillment =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFulfillmentDTO](../../../interfaces/fulfillment.CreateFulfillmentDTO/page.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit<[CreateFulfillmentAddressDTO](../../../interfaces/fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\">","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit<[CreateFulfillmentItemDTO](../../../interfaces/fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\">[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../interfLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[CreateFulfillmentDTO](../../../interfaces/fulfillment.CreateFulfillmentDTO/page.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit<[CreateFulfillmentAddressDTO](../../../interfaces/fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\">","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit<[CreateFulfillmentItemDTO](../../../interfaces/fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\">[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../interfLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createFulfillmentSets(data, sharedContext?): Promise<[FulfillmentSetDTO](../../../interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]>
|
||||
|
||||
This method creates fulfillment sets.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createGeoZones(data, sharedContext?): Promise<[GeoZoneDTO](../../../interfaces/fulfillment.GeoZoneDTO/page.mdx)[]>
|
||||
|
||||
This method creates geo zones.
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createReturnFulfillment` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method creates a fulfillment and call the provider to create a return.
|
||||
|
||||
## Example
|
||||
@@ -44,7 +50,7 @@ const fulfillment =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFulfillmentDTO](../../../interfaces/fulfillment.CreateFulfillmentDTO/page.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit<[CreateFulfillmentAddressDTO](../../../interfaces/fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\">","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit<[CreateFulfillmentItemDTO](../../../interfaces/fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\">[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../interfLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[CreateFulfillmentDTO](../../../interfaces/fulfillment.CreateFulfillmentDTO/page.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit<[CreateFulfillmentAddressDTO](../../../interfaces/fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\">","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit<[CreateFulfillmentItemDTO](../../../interfaces/fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\">[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../interfLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createServiceZones(data, sharedContext?): Promise<[ServiceZoneDTO](../../../interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]>
|
||||
|
||||
This method creates service zones.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createShippingOptionRules` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createShippingOptionRules(data, sharedContext?): Promise<[ShippingOptionRuleDTO](../../../interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)[]>
|
||||
|
||||
This method creates shipping option rules.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createShippingOptions(data, sharedContext?): Promise<[ShippingOptionDTO](../../../interfaces/fulfillment.ShippingOptionDTO/page.mdx)[]>
|
||||
|
||||
This method creates shipping options.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createShippingProfiles(data, sharedContext?): Promise<[ShippingProfileDTO](../../../interfaces/fulfillment.ShippingProfileDTO/page.mdx)[]>
|
||||
|
||||
This method creates shipping profiles.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteFulfillmentSets(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes fulfillment sets by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteGeoZones(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes geo zones by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteServiceZones(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes service zones by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteShippingOptionRules` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteShippingOptionRules(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes shipping option rules by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteShippingOptionTypes` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteShippingOptionTypes(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes shipping option types by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteShippingOptions(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes shipping options by their IDs.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteShippingProfiles(ids, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes shipping profiles by their IDs.
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of fulfillment sets along with the total count of available fulfillment sets satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
@@ -55,7 +61,7 @@ const [fulfillmentSets, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountFulfillments` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of fulfillments along with the total count of available fulfillments satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of geo zones along with the total count of available geo zones satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of service zones along with the total count of available service zones satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
@@ -55,7 +61,7 @@ const [serviceZones, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item inLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountShippingOptionRules` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping option rules along with the total count of available shipping option rules satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountShippingOptionTypes` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping option types along with the total count of available shipping option types satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping options along with the total count of available shipping options satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
@@ -55,7 +61,7 @@ const [shippingOptions, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"Omit<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx), \"context\">","description":"Construct a type with the properties of T except for those in type K.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","dLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"Omit<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx), \"context\">","description":"Construct a type with the properties of T except for those in type K.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","dLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping profiles along with the total count of available shipping profiles satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listFulfillmentProviders` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of fulfillment providers based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of fulfillment sets based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
@@ -52,7 +58,7 @@ const fulfillmentSets = await fulfillmentModuleService.listFulfillmentSets(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listFulfillments` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of fulfillments based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of geo zones based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of service zones based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
@@ -55,7 +61,7 @@ const serviceZones =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item inLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listShippingOptionRules` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping option rules based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listShippingOptionTypes` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping option types based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping options based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
@@ -55,7 +61,7 @@ const shippingOptions =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An arrayLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An arrayLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listShippingOptionsForContext` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping options based on the provided context.
|
||||
|
||||
## Example
|
||||
@@ -66,7 +72,7 @@ const shippingOptions =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The context of the how the shipping option is being used. It\nacts as a filter for the retrieved shipping options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The context of the how the shipping option is being used. It\nacts as a filter for the retrieved shipping options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of shipping profiles based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores a soft deleted fulfillment by its IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores soft deleted geo zones by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores a soft deleted service zones by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores soft deleted shipping options by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores soft deleted shipping profiles by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveFulfillment` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a fulfillment by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveFulfillmentOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves the fulfillment options of a fulfillment provider.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveFulfillmentSet` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a fulfillment set by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveGeoZone` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a geo zone by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveServiceZone` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a service zone by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveShippingOption` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a shipping option by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveShippingOptionRule` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a shipping option rule by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveShippingOptionType` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a shipping option type by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveShippingProfile` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a shipping profile by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes fulfillment sets by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes geo zones by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes service zones by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes shipping option by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes shipping profiles by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateFulfillment` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method updates an existing fulfillment.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateFulfillmentSets` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateFulfillmentSets(data, sharedContext?): Promise<[FulfillmentSetDTO](../../../interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing fulfillment sets.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateGeoZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateGeoZones(data, sharedContext?): Promise<[GeoZoneDTO](../../../interfaces/fulfillment.GeoZoneDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing geo zones.
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateServiceZones(id, data, sharedContext?): Promise<[ServiceZoneDTO](../../../interfaces/fulfillment.ServiceZoneDTO/page.mdx)>
|
||||
|
||||
This method updates an existing service zone.
|
||||
@@ -54,7 +60,7 @@ const serviceZones =
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters specifying which service zones to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each itemLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters specifying which service zones to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":Line truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateShippingOptionRules` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateShippingOptionRules(data, sharedContext?): Promise<[ShippingOptionRuleDTO](../../../interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing shipping option rules.
|
||||
|
||||
+7
-1
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateShippingOptions(id, data, sharedContext?): Promise<[ShippingOptionDTO](../../../interfaces/fulfillment.ShippingOptionDTO/page.mdx)>
|
||||
|
||||
This method updates an existing shipping option.
|
||||
@@ -54,7 +60,7 @@ const shippingOptions =
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters specifying which shipping options to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters specifying which shipping options to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)>)[]","description":"An array of filters to apLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateShippingProfiles(selector, data, sharedContext?): Promise<[ShippingProfileDTO](../../../interfaces/fulfillment.ShippingProfileDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing shipping profiles.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `upsertServiceZones` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## upsertServiceZones(data, sharedContext?): Promise<[ServiceZoneDTO](../../../interfaces/fulfillment.ServiceZoneDTO/page.mdx)>
|
||||
|
||||
This method updates or creates a service zone if it doesn't exist.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `upsertShippingOptions` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## upsertShippingOptions(data, sharedContext?): Promise<[ShippingOptionDTO](../../../interfaces/fulfillment.ShippingOptionDTO/page.mdx)>
|
||||
|
||||
This method updates or creates a shipping option if it doesn't exist.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `upsertShippingProfiles` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## upsertShippingProfiles(data, sharedContext?): Promise<[ShippingProfileDTO](../../../interfaces/fulfillment.ShippingProfileDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing shipping profiles, or creates new ones if they don't exist.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `validateFulfillmentData` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method validates fulfillment data with the provider it belongs to.
|
||||
e.g. if the shipping option requires a drop point, the data you pass to create the
|
||||
shipping method must contain a drop point ID. This method can be used to
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `validateFulfillmentOption` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method validates a fulfillment option with the provider it belongs to.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `validateShippingOption` method. This belongs to the Fulfillment Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method checks whether a shipping option can be used for a specified context.
|
||||
|
||||
## Example
|
||||
|
||||
Reference in new issue
Block a user