chore(docs): Generated References (#5666)
Generated the following references: - `entities` - `js-client` - `pricing` - `services` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
4774b8ff3a
commit
2b9e8bda5e
@@ -83,6 +83,15 @@ A product is a saleable item that holds general information such as name or desc
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
@@ -82,6 +82,15 @@ A product category can be used to categorize products into a hierarchy of catego
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -210,6 +219,15 @@ A product category can be used to categorize products into a hierarchy of catego
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
+2
-2
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "modules",
|
||||
"type": "`Record<string, boolean \\| [Partial](internal.Partial.mdx)<[InternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx) \\| [ExternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx)>>`",
|
||||
"type": "`Record<string, boolean \\| [Partial](../../internal/types/internal.Partial.mdx)<[InternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx) \\| [ExternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx)>>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "projectConfig",
|
||||
"type": "[ProjectConfigOptions](../../CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx)",
|
||||
"type": "[ProjectConfigOptions](internal.internal-1.CommonTypes.ProjectConfigOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
+7
-7
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[EmitData](../types/internal.EmitData.mdx)<T>[]",
|
||||
"type": "[EmitData](../types/internal.internal-1.EventBusTypes.EmitData.mdx)<T>[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/internal.internal-1.EventBusTypes.Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -129,7 +129,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusModuleService",
|
||||
"type": "[IEventBusModuleService](internal.IEventBusModuleService.mdx)",
|
||||
"type": "[IEventBusModuleService](internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/internal.internal-1.EventBusTypes.Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusModuleService",
|
||||
"type": "[IEventBusModuleService](internal.IEventBusModuleService.mdx)",
|
||||
"type": "[IEventBusModuleService](internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
+7
-7
@@ -74,7 +74,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/internal.internal-1.EventBusTypes.Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusService",
|
||||
"type": "[IEventBusService](internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
|
||||
"type": "[Subscriber](../types/internal.internal-1.EventBusTypes.Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -133,7 +133,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusService",
|
||||
"type": "[IEventBusService](internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusService",
|
||||
"type": "[IEventBusService](internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
+1
-1
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../../internal/types/internal.Subscriber.mdx)",
|
||||
"type": "[Subscriber](internal.internal-1.EventBusTypes.Subscriber.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ The attributes to update in an inventory level. The inventory level is identifie
|
||||
{
|
||||
"name": "incoming_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"description": "The incoming quantity of the associated inventory item in the associated location.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -41,7 +41,7 @@ The attributes to update in an inventory level. The inventory level is identifie
|
||||
{
|
||||
"name": "stocked_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"description": "The stocked quantity of the associated inventory item in the associated location.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -86,7 +86,7 @@ The details of the inventory item to be created.
|
||||
{
|
||||
"name": "requires_shipping",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"description": "Whether the inventory item requires shipping.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+36
-36
@@ -82,7 +82,7 @@ async function adjustInventory (
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The inventory level's details.",
|
||||
@@ -206,7 +206,7 @@ async function createInventoryItem (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
|
||||
"type": "[CreateInventoryItemInput](internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
|
||||
"description": "The details of the inventory item to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -229,7 +229,7 @@ async function createInventoryItem (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>",
|
||||
"type": "Promise<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created inventory item's details.",
|
||||
@@ -270,7 +270,7 @@ async function createInventoryItems (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[]",
|
||||
"type": "[CreateInventoryItemInput](internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[]",
|
||||
"description": "The details of the inventory items to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -293,7 +293,7 @@ async function createInventoryItems (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>",
|
||||
"type": "Promise<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created inventory items' details.",
|
||||
@@ -335,7 +335,7 @@ async function createInventoryLevel (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)",
|
||||
"type": "[CreateInventoryLevelInput](internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)",
|
||||
"description": "The details of the inventory level to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -358,7 +358,7 @@ async function createInventoryLevel (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created inventory level's details.",
|
||||
@@ -400,7 +400,7 @@ async function createInventoryLevels (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[]",
|
||||
"type": "[CreateInventoryLevelInput](internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[]",
|
||||
"description": "The details of the inventory levels to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -423,7 +423,7 @@ async function createInventoryLevels (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created inventory levels' details.",
|
||||
@@ -465,7 +465,7 @@ async function createReservationItem (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)",
|
||||
"type": "[CreateReservationItemInput](internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)",
|
||||
"description": "The details of the reservation item to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -488,7 +488,7 @@ async function createReservationItem (item: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>",
|
||||
"type": "Promise<[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created reservation item's details.",
|
||||
@@ -530,7 +530,7 @@ async function createReservationItems (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[]",
|
||||
"type": "[CreateReservationItemInput](internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[]",
|
||||
"description": "The details of the reservation items to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -553,7 +553,7 @@ async function createReservationItems (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>",
|
||||
"type": "Promise<[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created reservation items' details.",
|
||||
@@ -567,7 +567,7 @@ ___
|
||||
### deleteInventoryItem
|
||||
|
||||
This method is used to delete an inventory item or multiple inventory items. The inventory items are only soft deleted and can be restored using the
|
||||
[restoreInventoryItem](internal.IInventoryService.mdx#restoreinventoryitem) method.
|
||||
[restoreInventoryItem](internal.internal-1.InventoryTypes.IInventoryService.mdx#restoreinventoryitem) method.
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -1013,7 +1013,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)",
|
||||
"type": "[FilterableInventoryItemProps](internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)",
|
||||
"description": "The filters to apply on the retrieved inventory items.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1022,7 +1022,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)>",
|
||||
"description": "The configurations determining how the inventory items are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a inventory item.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1045,7 +1045,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>",
|
||||
"type": "Promise<[[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The list of inventory items along with the total count.",
|
||||
@@ -1127,7 +1127,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)",
|
||||
"type": "[FilterableInventoryLevelProps](internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)",
|
||||
"description": "The filters to apply on the retrieved inventory levels.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1136,7 +1136,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)>",
|
||||
"description": "The configurations determining how the inventory levels are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a inventory level.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1159,7 +1159,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>",
|
||||
"type": "Promise<[[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The list of inventory levels along with the total count.",
|
||||
@@ -1241,7 +1241,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)",
|
||||
"type": "[FilterableReservationItemProps](internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)",
|
||||
"description": "The filters to apply on the retrieved reservation items.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1250,7 +1250,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)>",
|
||||
"description": "The configurations determining how the reservation items are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a reservation item.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1273,7 +1273,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>",
|
||||
"type": "Promise<[[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The list of reservation items along with the total count.",
|
||||
@@ -1286,7 +1286,7 @@ ___
|
||||
|
||||
### restoreInventoryItem
|
||||
|
||||
This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](internal.IInventoryService.mdx#deleteinventoryitem) method.
|
||||
This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](internal.internal-1.InventoryTypes.IInventoryService.mdx#deleteinventoryitem) method.
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -1473,7 +1473,7 @@ async function retrieveInventoryItem (id: string) {
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)>",
|
||||
"description": "The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a inventory item.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1496,7 +1496,7 @@ async function retrieveInventoryItem (id: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>",
|
||||
"type": "Promise<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The retrieved inventory item.",
|
||||
@@ -1570,7 +1570,7 @@ async function retrieveInventoryLevel (
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The retrieved inventory level.",
|
||||
@@ -1629,7 +1629,7 @@ async function retrieveReservationItem (id: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>",
|
||||
"type": "Promise<[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The retrieved reservation item.",
|
||||
@@ -1830,7 +1830,7 @@ async function updateInventoryItem (
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[Partial](../types/internal.Partial.mdx)<[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>",
|
||||
"type": "[Partial](../../internal/types/internal.Partial.mdx)<[CreateInventoryItemInput](internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>",
|
||||
"description": "The attributes to update in the inventory item.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1853,7 +1853,7 @@ async function updateInventoryItem (
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>",
|
||||
"type": "Promise<[InventoryItemDTO](../../internal/types/internal.InventoryItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The updated inventory item's details.",
|
||||
@@ -1917,7 +1917,7 @@ async function updateInventoryLevel (
|
||||
},
|
||||
{
|
||||
"name": "update",
|
||||
"type": "[UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)",
|
||||
"type": "[UpdateInventoryLevelInput](internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)",
|
||||
"description": "The attributes to update in the location level.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1940,7 +1940,7 @@ async function updateInventoryLevel (
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The updated inventory level's details.",
|
||||
@@ -1982,7 +1982,7 @@ async function updateInventoryLevels (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "updates",
|
||||
"type": "[BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[]",
|
||||
"type": "[BulkUpdateInventoryLevelInput](internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[]",
|
||||
"description": "The attributes to update in each inventory level.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2005,7 +2005,7 @@ async function updateInventoryLevels (items: {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>",
|
||||
"type": "Promise<[InventoryLevelDTO](../../internal/types/internal.InventoryLevelDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The updated inventory levels' details.",
|
||||
@@ -2058,7 +2058,7 @@ async function updateReservationItem (
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)",
|
||||
"type": "[UpdateReservationItemInput](internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)",
|
||||
"description": "The attributes to update in the reservation item.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2081,7 +2081,7 @@ async function updateReservationItem (
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>",
|
||||
"type": "Promise<[ReservationItemDTO](../../internal/types/internal.ReservationItemDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The updated reservation item.",
|
||||
+1
-1
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "logger",
|
||||
"type": "[Logger](../../internal/interfaces/internal.Logger.mdx)",
|
||||
"type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "models",
|
||||
"type": "[Constructor](../../internal/types/internal.Constructor.mdx)<any>[]",
|
||||
"type": "[Constructor](internal.internal-1.ModulesSdkTypes.Constructor.mdx)<any>[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "service",
|
||||
"type": "[Constructor](../../internal/types/internal.Constructor.mdx)<any>",
|
||||
"type": "[Constructor](internal.internal-1.ModulesSdkTypes.Constructor.mdx)<any>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+126
-126
File diff suppressed because it is too large
Load Diff
+1
-1
@@ -71,7 +71,7 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The details of the relation between the money amount and its associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
+1
-1
@@ -59,7 +59,7 @@ A product category to create.
|
||||
{
|
||||
"name": "parent_category_id",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
|
||||
"description": "The ID of the parent product category, if it has any.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ A product collection to create.
|
||||
{
|
||||
"name": "product_ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"description": "The products to associate with the collection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -149,7 +149,7 @@ A product to create.
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).",
|
||||
"description": "The status of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ The filters to apply on retrieved product collections.
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"description": "The handles to filter product collections by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+6
-6
@@ -41,7 +41,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "categories.id",
|
||||
"type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>",
|
||||
"description": "",
|
||||
"description": "IDs to filter categories by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -50,7 +50,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "categories.is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"description": "Filter categories by whether they're active.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -59,7 +59,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "categories.is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"description": "Filter categories by whether they're internal",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -68,7 +68,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "category_id",
|
||||
"type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>",
|
||||
"description": "",
|
||||
"description": "Filter a product by the IDs of their associated categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -77,7 +77,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "collection_id",
|
||||
"type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>",
|
||||
"description": "Filters a product by its associated collections.",
|
||||
"description": "Filters a product by the IDs of their associated collections.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -122,7 +122,7 @@ The filters to apply on retrieved products.
|
||||
{
|
||||
"name": "tags.value",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"description": "Values to filter product tags by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -50,7 +50,7 @@ The filters to apply on retrieved product variants.
|
||||
{
|
||||
"name": "options.id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"description": "IDs to filter options by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+4
-4
@@ -14,10 +14,10 @@ A product category's data.
|
||||
{
|
||||
"name": "category_children",
|
||||
"type": "[ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]",
|
||||
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
|
||||
"description": "The associated child categories.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -86,10 +86,10 @@ A product category's data.
|
||||
{
|
||||
"name": "parent_category",
|
||||
"type": "[ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)",
|
||||
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
|
||||
"description": "The associated parent category.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
|
||||
+2
-2
@@ -50,10 +50,10 @@ A product collection's data.
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)[]",
|
||||
"description": "The associated products. It may only be available if the `products` relation is expanded.",
|
||||
"description": "The associated products.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
|
||||
+28
-28
@@ -14,19 +14,19 @@ A product's data.
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "`null` \\| [ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]",
|
||||
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
|
||||
"description": "The associated product categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection",
|
||||
"type": "[ProductCollectionDTO](internal.internal-1.ProductTypes.ProductCollectionDTO.mdx)",
|
||||
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
|
||||
"description": "The associated product collection.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -50,7 +50,7 @@ A product's data.
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The description of the product. It can possibly be `null`.",
|
||||
"description": "The description of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -77,7 +77,7 @@ A product's data.
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.",
|
||||
"description": "The handle of the product. The handle can be used to create slug URL paths.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -86,7 +86,7 @@ A product's data.
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The height of the product. It can possibly be `null`.",
|
||||
"description": "The height of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -95,7 +95,7 @@ A product's data.
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The HS Code of the product. It can possibly be `null`.",
|
||||
"description": "The HS Code of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -113,10 +113,10 @@ A product's data.
|
||||
{
|
||||
"name": "images",
|
||||
"type": "[ProductImageDTO](internal.internal-1.ProductTypes.ProductImageDTO.mdx)[]",
|
||||
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
|
||||
"description": "The associated product images.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -131,7 +131,7 @@ A product's data.
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The length of the product. It can possibly be `null`.",
|
||||
"description": "The length of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -140,7 +140,7 @@ A product's data.
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The material of the product. It can possibly be `null`.",
|
||||
"description": "The material of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -149,7 +149,7 @@ A product's data.
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -158,7 +158,7 @@ A product's data.
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The MID Code of the product. It can possibly be `null`.",
|
||||
"description": "The MID Code of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -167,16 +167,16 @@ A product's data.
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[ProductOptionDTO](internal.internal-1.ProductTypes.ProductOptionDTO.mdx)[]",
|
||||
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
|
||||
"description": "The associated product options.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The origin country of the product. It can possibly be `null`.",
|
||||
"description": "The origin country of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -185,7 +185,7 @@ A product's data.
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).",
|
||||
"description": "The status of the product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -194,7 +194,7 @@ A product's data.
|
||||
{
|
||||
"name": "subtitle",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The subttle of the product. It can possibly be `null`.",
|
||||
"description": "The subttle of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -203,16 +203,16 @@ A product's data.
|
||||
{
|
||||
"name": "tags",
|
||||
"type": "[ProductTagDTO](internal.internal-1.ProductTypes.ProductTagDTO.mdx)[]",
|
||||
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
|
||||
"description": "The associated product tags.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
|
||||
"description": "The URL of the product's thumbnail.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -230,10 +230,10 @@ A product's data.
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[ProductTypeDTO](internal.internal-1.ProductTypes.ProductTypeDTO.mdx)[]",
|
||||
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
|
||||
"description": "The associated product type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -248,16 +248,16 @@ A product's data.
|
||||
{
|
||||
"name": "variants",
|
||||
"type": "[ProductVariantDTO](internal.internal-1.ProductTypes.ProductVariantDTO.mdx)[]",
|
||||
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
|
||||
"description": "The associated product variants.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The weight of the product. It can possibly be `null`.",
|
||||
"description": "The weight of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -266,7 +266,7 @@ A product's data.
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "",
|
||||
"description": "The width of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+4
-4
@@ -41,10 +41,10 @@ A product option's data.
|
||||
{
|
||||
"name": "product",
|
||||
"type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)",
|
||||
"description": "The associated product. It may only be available if the `product` relation is expanded.",
|
||||
"description": "The associated product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,10 +59,10 @@ A product option's data.
|
||||
{
|
||||
"name": "values",
|
||||
"type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)[]",
|
||||
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
|
||||
"description": "The associated product option values.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
+4
-4
@@ -41,10 +41,10 @@ The product option value's data.
|
||||
{
|
||||
"name": "option",
|
||||
"type": "[ProductOptionDTO](internal.internal-1.ProductTypes.ProductOptionDTO.mdx)",
|
||||
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
|
||||
"description": "The associated product option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,10 +59,10 @@ The product option value's data.
|
||||
{
|
||||
"name": "variant",
|
||||
"type": "[ProductVariantDTO](internal.internal-1.ProductTypes.ProductVariantDTO.mdx)",
|
||||
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
|
||||
"description": "The associated product variant.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
+2
-2
@@ -32,10 +32,10 @@ A product tag's data.
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)[]",
|
||||
"description": "The associated products. It may only be available if the `products` relation is expanded.",
|
||||
"description": "The associated products.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
|
||||
+17
-17
@@ -23,7 +23,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "barcode",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The barcode of the product variant. It can possibly be `null`.",
|
||||
"description": "The barcode of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -50,7 +50,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "ean",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The EAN of the product variant. It can possibly be `null`.",
|
||||
"description": "The EAN of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -59,7 +59,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The height of the product variant. It can possibly be `null`.",
|
||||
"description": "The height of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -68,7 +68,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The HS Code of the product variant. It can possibly be `null`.",
|
||||
"description": "The HS Code of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -95,7 +95,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The length of the product variant. It can possibly be `null`.",
|
||||
"description": "The length of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -113,7 +113,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The material of the product variant. It can possibly be `null`.",
|
||||
"description": "The material of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -131,7 +131,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The MID Code of the product variant. It can possibly be `null`.",
|
||||
"description": "The MID Code of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -140,16 +140,16 @@ A product variant's data.
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)",
|
||||
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
|
||||
"description": "The associated product options.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The origin country of the product variant. It can possibly be `null`.",
|
||||
"description": "The origin country of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -158,10 +158,10 @@ A product variant's data.
|
||||
{
|
||||
"name": "product",
|
||||
"type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)",
|
||||
"description": "The associated product. It may only be available if the `product` relation is expanded.",
|
||||
"description": "The associated product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -176,7 +176,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The SKU of the product variant. It can possibly be `null`.",
|
||||
"description": "The SKU of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -194,7 +194,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "upc",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The UPC of the product variant. It can possibly be `null`.",
|
||||
"description": "The UPC of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -212,7 +212,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "variant_rank",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
|
||||
"description": "he ranking of the variant among other variants associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -221,7 +221,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The weight of the product variant. It can possibly be `null`.",
|
||||
"description": "The weight of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -230,7 +230,7 @@ A product variant's data.
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The width of the product variant. It can possibly be `null`.",
|
||||
"description": "The width of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -59,7 +59,7 @@ The data to update in a product category.
|
||||
{
|
||||
"name": "parent_category_id",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
|
||||
"description": "The ID of the parent product category, if it has any.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+1
-1
@@ -158,7 +158,7 @@ The data to update in a product. The `id` is used to identify which product to u
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).",
|
||||
"description": "The status of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+12
-12
@@ -35,7 +35,7 @@ async function createStockLocation (name: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx)",
|
||||
"type": "[CreateStockLocationInput](../types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx)",
|
||||
"description": "The details of the stock location to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -58,7 +58,7 @@ async function createStockLocation (name: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "Promise<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created stock location's details.",
|
||||
@@ -197,7 +197,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
|
||||
"type": "[FilterableStockLocationProps](internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
|
||||
"description": "The filters to apply on the retrieved stock locations.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -206,7 +206,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"description": "The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -229,7 +229,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>",
|
||||
"type": "Promise<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The list of stock locations.",
|
||||
@@ -311,7 +311,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
|
||||
"type": "[FilterableStockLocationProps](internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
|
||||
"description": "The filters to apply on the retrieved stock locations.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -320,7 +320,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"description": "The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -343,7 +343,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>",
|
||||
"type": "Promise<[[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The list of stock locations along with the total count.",
|
||||
@@ -408,7 +408,7 @@ async function retrieveStockLocation (id: string) {
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"description": "The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a stock location.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -431,7 +431,7 @@ async function retrieveStockLocation (id: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "Promise<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The stock location's details.",
|
||||
@@ -478,7 +478,7 @@ async function updateStockLocation (id:string, name: string) {
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx)",
|
||||
"type": "[UpdateStockLocationInput](../types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx)",
|
||||
"description": "The attributes to update in the stock location.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -501,7 +501,7 @@ async function updateStockLocation (id:string, name: string) {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>",
|
||||
"type": "Promise<[StockLocationDTO](../../internal/types/internal.StockLocationDTO.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The stock location's details.",
|
||||
@@ -189,6 +189,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -319,6 +328,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional set of key-value pairs to hold additional information.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -440,6 +458,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -871,6 +898,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -1100,6 +1136,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -1339,6 +1384,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -1478,6 +1532,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional set of key-value pairs to hold additional information.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -1608,6 +1671,15 @@ medusa.admin.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
@@ -302,6 +302,15 @@ medusa.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
@@ -541,6 +550,15 @@ medusa.productCategories
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
+2
-2
@@ -28,7 +28,7 @@ A shared context object that is used to share resources between the application
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -55,7 +55,7 @@ A shared context object that is used to share resources between the application
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+4
@@ -5,3 +5,7 @@ displayed_sidebar: jsClientSidebar
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CacheTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [ICacheService](../../CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx)
|
||||
|
||||
+1
@@ -24,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)
|
||||
- [ExtendedFindConfig](../../CommonTypes/types/internal.internal-1.CommonTypes.ExtendedFindConfig.mdx)
|
||||
- [HttpCompressionOptions](../../CommonTypes/types/internal.internal-1.CommonTypes.HttpCompressionOptions.mdx)
|
||||
- [PartialPick](../../CommonTypes/types/internal.internal-1.CommonTypes.PartialPick.mdx)
|
||||
|
||||
+8
@@ -6,7 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EventBusTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)
|
||||
- [IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)
|
||||
- [EventHandler](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EventHandler.mdx)
|
||||
- [Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)
|
||||
- [SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)
|
||||
- [SubscriberDescriptor](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberDescriptor.mdx)
|
||||
|
||||
+5
@@ -15,5 +15,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)
|
||||
- [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)
|
||||
- [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)
|
||||
- [IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)
|
||||
- [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)
|
||||
- [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [ReserveQuantityContext](../../InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx)
|
||||
|
||||
+4
@@ -5,3 +5,7 @@ displayed_sidebar: jsClientSidebar
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# LoggerTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)
|
||||
|
||||
+2
@@ -17,6 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [Constructor](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.Constructor.mdx)
|
||||
- [ExternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx)
|
||||
- [InternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx)
|
||||
- [LinkModuleDefinition](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LinkModuleDefinition.mdx)
|
||||
@@ -33,3 +34,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [ModuleResolution](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx)
|
||||
- [ModuleServiceInitializeCustomDataLayerOptions](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx)
|
||||
- [ModulesResponse](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModulesResponse.mdx)
|
||||
- [RemoteQueryFunction](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx)
|
||||
|
||||
+1
@@ -43,6 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [FilterablePriceSetProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx)
|
||||
- [FilterablePriceSetRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx)
|
||||
- [FilterableRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx)
|
||||
- [IPricingModuleService](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx)
|
||||
- [MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)
|
||||
- [PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)
|
||||
- [PriceListPriceDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx)
|
||||
|
||||
+1
@@ -9,6 +9,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
## Interfaces
|
||||
|
||||
- [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)
|
||||
- [IStockLocationService](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
|
||||
+7
-7
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Implements
|
||||
|
||||
- [IEventBusModuleService](../interfaces/internal.IEventBusModuleService.mdx)
|
||||
- [IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[EmitData](../types/internal.EmitData.mdx)<T>[]",
|
||||
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)<T>[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -151,7 +151,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)<unknown>",
|
||||
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)<unknown>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -201,7 +201,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)<unknown>",
|
||||
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)<unknown>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -210,7 +210,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -251,7 +251,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)<unknown>",
|
||||
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)<unknown>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -260,7 +260,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+9
@@ -45,6 +45,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional set of key-value pairs to hold additional information.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
+9
@@ -45,6 +45,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional set of key-value pairs to hold additional information.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
+9
@@ -74,6 +74,15 @@ A product category can be used to categorize products into a hierarchy of catego
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
|
||||
+9
-9
@@ -11,7 +11,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
## Implements
|
||||
|
||||
- [IEventBusService](../interfaces/internal.IEventBusService.mdx)
|
||||
- [IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -45,7 +45,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
},
|
||||
{
|
||||
"name": "config_",
|
||||
"type": "[ConfigModule](../types/internal.ConfigModule.mdx)",
|
||||
"type": "[ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -63,7 +63,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
},
|
||||
{
|
||||
"name": "logger_",
|
||||
"type": "[Logger](../interfaces/internal.Logger.mdx)",
|
||||
"type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -135,7 +135,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "IEventBusModuleService",
|
||||
"type": "[IEventBusModuleService](../interfaces/internal.IEventBusModuleService.mdx)",
|
||||
"type": "[IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -211,7 +211,7 @@ Calls all subscribers when an event occurs.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[EmitData](../types/internal.EmitData.mdx)<T>[]",
|
||||
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)<T>[]",
|
||||
"description": "The data to use to process the events",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -422,7 +422,7 @@ Adds a function to a list of event subscribers.
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)<unknown>",
|
||||
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)<unknown>",
|
||||
"description": "the function to be called when a certain event happens. Subscribers must return a Promise.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -431,7 +431,7 @@ Adds a function to a list of event subscribers.
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "subscriber context",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -474,7 +474,7 @@ Removes function from the list of event subscribers.
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[Subscriber](../types/internal.Subscriber.mdx)<unknown>",
|
||||
"type": "[Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx)<unknown>",
|
||||
"description": "the function to be removed",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -483,7 +483,7 @@ Removes function from the list of event subscribers.
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
|
||||
"type": "[SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx)",
|
||||
"description": "subscriber context",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "eventBus_",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -236,7 +236,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "undefined \\| IInventoryService",
|
||||
"type": "`undefined` \\| [IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "`undefined` \\| [IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
+1
-1
@@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "inventoryService_",
|
||||
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "eventBusService_",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1061,7 +1061,7 @@ Reserves a quantity of a variant
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[ReserveQuantityContext](../types/internal.ReserveQuantityContext.mdx)",
|
||||
"type": "[ReserveQuantityContext](../../InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx)",
|
||||
"description": "optional parameters",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "eventBusService_",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -40,7 +40,7 @@ Service for managing the stock locations of sales channels
|
||||
},
|
||||
{
|
||||
"name": "eventBusService_",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -148,7 +148,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[EmitData](../types/internal.EmitData.mdx)<unknown> \\| [EmitData](../types/internal.EmitData.mdx)<unknown>[]",
|
||||
"type": "[EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)<unknown> \\| [EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx)<unknown>[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -40,7 +40,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "cacheService_",
|
||||
"type": "[ICacheService](../interfaces/internal.ICacheService.mdx)",
|
||||
"type": "[ICacheService](../../CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -58,7 +58,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "eventBus_",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "configModule_",
|
||||
"type": "[ConfigModule](../types/internal.ConfigModule.mdx)",
|
||||
"type": "[ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SubscriberContext
|
||||
|
||||
Construct a type with a set of properties K of type T
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "subscriberId",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-1
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "logger",
|
||||
"type": "[Logger](../interfaces/internal.Logger.mdx)",
|
||||
"type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "inventoryService",
|
||||
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "inventoryService",
|
||||
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventBusService",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "pricingModuleService",
|
||||
"type": "[IPricingModuleService](../interfaces/internal.IPricingModuleService.mdx)",
|
||||
"type": "[IPricingModuleService](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "remoteQuery",
|
||||
"type": "[RemoteQueryFunction](internal.RemoteQueryFunction.mdx)",
|
||||
"type": "[RemoteQueryFunction](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+3
-3
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventBusService",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "inventoryService",
|
||||
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "stockLocationService",
|
||||
"type": "[IStockLocationService](../interfaces/internal.IStockLocationService.mdx)",
|
||||
"type": "[IStockLocationService](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventBusService",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "inventoryService",
|
||||
"type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)",
|
||||
"type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventBusService",
|
||||
"type": "[IEventBusService](../interfaces/internal.IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "stockLocationService",
|
||||
"type": "[IStockLocationService](../interfaces/internal.IStockLocationService.mdx)",
|
||||
"type": "[IStockLocationService](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
+9
@@ -36,6 +36,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "parent_category",
|
||||
"type": "[ProductCategory](../classes/internal.ProductCategory.mdx) \\| `null`",
|
||||
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ScheduledJobArgs
|
||||
|
||||
### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "container",
|
||||
"type": "[MedusaContainer](internal.MedusaContainer.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`T`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "pluginOptions",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ScheduledJobConfig
|
||||
|
||||
### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`T`",
|
||||
"description": "An optional data object to pass to the job handler",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the job",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "schedule",
|
||||
"type": "`string`",
|
||||
"description": "The cron schedule of the job, e.g. `0 0 * * *` for running every day at midnight.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SubscriberArgs
|
||||
|
||||
### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "container",
|
||||
"type": "[MedusaContainer](internal.MedusaContainer.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`T`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "eventName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "pluginOptions",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SubscriberConfig
|
||||
|
||||
### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[SubscriberContext](../interfaces/internal.SubscriberContext.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "event",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -449,12 +449,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [FilePropertyBag](../internal/interfaces/internal.FilePropertyBag.mdx)
|
||||
- [HTTPResponse](../internal/interfaces/internal.HTTPResponse.mdx)
|
||||
- [HeadersDefaults](../internal/interfaces/internal.HeadersDefaults.mdx)
|
||||
- [ICacheService](../internal/interfaces/internal.ICacheService.mdx)
|
||||
- [IEventBusModuleService](../internal/interfaces/internal.IEventBusModuleService.mdx)
|
||||
- [IEventBusService](../internal/interfaces/internal.IEventBusService.mdx)
|
||||
- [IInventoryService](../internal/interfaces/internal.IInventoryService.mdx)
|
||||
- [IPricingModuleService](../internal/interfaces/internal.IPricingModuleService.mdx)
|
||||
- [IStockLocationService](../internal/interfaces/internal.IStockLocationService.mdx)
|
||||
- [ITransactionBaseService](../internal/interfaces/internal.ITransactionBaseService.mdx)
|
||||
- [IncomingHttpHeaders](../internal/interfaces/internal.IncomingHttpHeaders.mdx)
|
||||
- [IpcSocketConnectOpts](../internal/interfaces/internal.IpcSocketConnectOpts.mdx)
|
||||
@@ -463,7 +457,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [Iterator](../internal/interfaces/internal.Iterator.mdx)
|
||||
- [IteratorReturnResult](../internal/interfaces/internal.IteratorReturnResult.mdx)
|
||||
- [IteratorYieldResult](../internal/interfaces/internal.IteratorYieldResult.mdx)
|
||||
- [Logger](../internal/interfaces/internal.Logger.mdx)
|
||||
- [LookupAddress](../internal/interfaces/internal.LookupAddress.mdx)
|
||||
- [LookupAllOptions](../internal/interfaces/internal.LookupAllOptions.mdx)
|
||||
- [LookupOptions](../internal/interfaces/internal.LookupOptions.mdx)
|
||||
@@ -509,6 +502,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [StaticEventEmitterOptions](../internal/interfaces/internal.StaticEventEmitterOptions.mdx)
|
||||
- [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions.mdx)
|
||||
- [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions-1.mdx)
|
||||
- [SubscriberContext](../internal/interfaces/internal.SubscriberContext.mdx)
|
||||
- [TcpSocketConnectOpts](../internal/interfaces/internal.TcpSocketConnectOpts.mdx)
|
||||
- [TransformOptions](../internal/interfaces/internal.TransformOptions.mdx)
|
||||
- [TransitionalOptions](../internal/interfaces/internal.TransitionalOptions.mdx)
|
||||
@@ -659,8 +653,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [CategoryQueryParams](../internal/types/internal.CategoryQueryParams.mdx)
|
||||
- [ClaimTypeValue](../internal/types/internal.ClaimTypeValue.mdx)
|
||||
- [ComposeFnParam](../internal/types/internal.ComposeFnParam.mdx)
|
||||
- [ConfigModule](../internal/types/internal.ConfigModule.mdx)
|
||||
- [Constructor](../internal/types/internal.Constructor.mdx)
|
||||
- [CreateAnalyticsConfig](../internal/types/internal.CreateAnalyticsConfig.mdx)
|
||||
- [CreateClaimInput](../internal/types/internal.CreateClaimInput.mdx)
|
||||
- [CreateClaimItemAdditionalItemInput](../internal/types/internal.CreateClaimItemAdditionalItemInput.mdx)
|
||||
@@ -717,7 +709,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [DiscountConditionInput](../internal/types/internal.DiscountConditionInput.mdx)
|
||||
- [DiscountConditionResourceType](../internal/types/internal.DiscountConditionResourceType.mdx)
|
||||
- [DraftOrderCreateProps](../internal/types/internal.DraftOrderCreateProps.mdx)
|
||||
- [EmitData](../internal/types/internal.EmitData.mdx)
|
||||
- [EndingType](../internal/types/internal.EndingType.mdx)
|
||||
- [Exclude](../internal/types/internal.Exclude.mdx)
|
||||
- [ExpandScalar](../internal/types/internal.ExpandScalar.mdx)
|
||||
@@ -859,12 +850,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [ReadonlyPrimary](../internal/types/internal.ReadonlyPrimary.mdx)
|
||||
- [Record](../internal/types/internal.Record.mdx)
|
||||
- [RegionDetails](../internal/types/internal.RegionDetails.mdx)
|
||||
- [RemoteQueryFunction](../internal/types/internal.RemoteQueryFunction.mdx)
|
||||
- [ReorderConditions](../internal/types/internal.ReorderConditions.mdx)
|
||||
- [RequestContext](../internal/types/internal.RequestContext.mdx)
|
||||
- [RequestMethod](../internal/types/internal.RequestMethod.mdx)
|
||||
- [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx)
|
||||
- [ReserveQuantityContext](../internal/types/internal.ReserveQuantityContext.mdx)
|
||||
- [Response](../internal/types/internal.Response.mdx)
|
||||
- [ResponsePromise](../internal/types/internal.ResponsePromise.mdx)
|
||||
- [ResponseType](../internal/types/internal.ResponseType.mdx)
|
||||
@@ -915,8 +904,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [StoreSwapsRes](../internal/types/internal.StoreSwapsRes.mdx)
|
||||
- [StoreVariantsListRes](../internal/types/internal.StoreVariantsListRes.mdx)
|
||||
- [StoreVariantsRes](../internal/types/internal.StoreVariantsRes.mdx)
|
||||
- [Subscriber](../internal/types/internal.Subscriber.mdx)
|
||||
- [SubscriberContext](../internal/types/internal.SubscriberContext.mdx)
|
||||
- [SubtotalOptions](../internal/types/internal.SubtotalOptions.mdx)
|
||||
- [TaxLinesMaps](../internal/types/internal.TaxLinesMaps.mdx)
|
||||
- [TaxRateListByConfig](../internal/types/internal.TaxRateListByConfig.mdx)
|
||||
|
||||
+315
@@ -0,0 +1,315 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
badge:
|
||||
variant: orange
|
||||
text: Beta
|
||||
slug: /references/pricing/addPriceListPrices
|
||||
sidebar_label: addPriceListPrices
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# addPriceListPrices - Pricing Module Reference
|
||||
|
||||
This documentation provides a reference to the `addPriceListPrices` method. This belongs to the Pricing Module.
|
||||
|
||||
This method is used to add prices to price lists.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function addPriceListPrices (items: {
|
||||
priceListId: string,
|
||||
prices: {
|
||||
currency_code: string,
|
||||
amount: number,
|
||||
price_set_id: string
|
||||
}[]
|
||||
}[]) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
const priceLists = await pricingService.addPriceListPrices(items)
|
||||
|
||||
// do something with the price lists or return them
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[AddPriceListPricesDTO](../../interfaces/AddPriceListPricesDTO.mdx)[]",
|
||||
"description": "The prices to add for each price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "priceListId",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price list to add prices to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[PriceListPriceDTO](../../interfaces/PriceListPriceDTO.mdx)[]",
|
||||
"description": "The prices to add.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "sharedContext",
|
||||
"type": "[Context](../../interfaces/Context.mdx)",
|
||||
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[PriceListDTO](../../interfaces/PriceListDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The updated price lists.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "PriceListDTO[]",
|
||||
"type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "ends_at",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The price list expires after this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The price list's ID.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
|
||||
"description": "The associated money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number_rules",
|
||||
"type": "`number`",
|
||||
"description": "The number of rules associated with this price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules",
|
||||
"type": "[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]",
|
||||
"description": "The price set's rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
|
||||
"description": "The associated price set money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
|
||||
"description": "The associated rule types.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]",
|
||||
"description": "The price set's rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "starts_at",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The price list is enabled starting from this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[PriceListStatus](../../enums/PriceListStatus.mdx)",
|
||||
"description": "The price list's status.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The price list's title.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+25
-16
@@ -22,7 +22,7 @@ This method adds prices to a price set.
|
||||
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -47,7 +47,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
To add prices with rules:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -120,7 +120,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
@@ -154,7 +154,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -163,7 +163,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -194,7 +194,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -221,7 +221,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -280,10 +280,10 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)",
|
||||
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
|
||||
"description": "The money amount's currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -321,6 +321,15 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The details of the relation between the money amount and its associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -383,7 +392,7 @@ This method adds prices to multiple price sets.
|
||||
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -408,7 +417,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
To add prices with rules:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -481,7 +490,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
@@ -515,7 +524,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -524,7 +533,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -555,7 +564,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -582,7 +591,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+23
-14
@@ -20,7 +20,7 @@ This method adds rules to a price set.
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -60,8 +60,8 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "`{ attribute: string }`[]",
|
||||
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"type": "``{ attribute: string }``[]",
|
||||
"description": "The rules to add to a price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -69,7 +69,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "The value of the rule's `rule_attribute` attribute.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -90,7 +90,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -117,7 +117,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -176,10 +176,10 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)",
|
||||
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
|
||||
"description": "The money amount's currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -217,6 +217,15 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The details of the relation between the money amount and its associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -277,7 +286,7 @@ This method adds rules to multiple price sets.
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -317,8 +326,8 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "`{ attribute: string }`[]",
|
||||
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"type": "``{ attribute: string }``[]",
|
||||
"description": "The rules to add to a price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -326,7 +335,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "The value of the rule's `rule_attribute` attribute.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -347,7 +356,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -374,7 +383,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+37
-10
@@ -20,7 +20,7 @@ This method is used to calculate prices based on the provided filters and contex
|
||||
When you calculate prices, you must at least specify the currency code:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
@@ -42,7 +42,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
To calculate prices for specific minimum and/or maximum quantity:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
@@ -65,7 +65,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
To calculate prices for custom rule types:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
@@ -137,7 +137,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -164,7 +164,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -196,7 +196,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -205,7 +205,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The currency code of the calculated price. It can possibly be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -215,7 +215,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -223,7 +223,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -232,12 +232,39 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The ID of the associated price list, if any.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_type",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The type of the associated price list, if any.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
+27
-18
@@ -114,7 +114,7 @@ async function createPriceSet() {
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
@@ -148,7 +148,7 @@ async function createPriceSet() {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -157,7 +157,7 @@ async function createPriceSet() {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -177,8 +177,8 @@ async function createPriceSet() {
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "`{ rule_attribute: string }`[]",
|
||||
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"type": "``{ rule_attribute: string }``[]",
|
||||
"description": "The rules to associate with the price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -186,7 +186,7 @@ async function createPriceSet() {
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "the value of the rule's `rule_attribute` attribute.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -207,7 +207,7 @@ async function createPriceSet() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -234,7 +234,7 @@ async function createPriceSet() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -293,10 +293,10 @@ async function createPriceSet() {
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)",
|
||||
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
|
||||
"description": "The money amount's currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -334,6 +334,15 @@ async function createPriceSet() {
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The details of the relation between the money amount and its associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -485,7 +494,7 @@ async function createPriceSets() {
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
@@ -519,7 +528,7 @@ async function createPriceSets() {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -528,7 +537,7 @@ async function createPriceSets() {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -548,8 +557,8 @@ async function createPriceSets() {
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "`{ rule_attribute: string }`[]",
|
||||
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"type": "``{ rule_attribute: string }``[]",
|
||||
"description": "The rules to associate with the price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -557,7 +566,7 @@ async function createPriceSets() {
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "the value of the rule's `rule_attribute` attribute.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -578,7 +587,7 @@ async function createPriceSets() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -605,7 +614,7 @@ async function createPriceSets() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+2
-2
@@ -96,7 +96,7 @@ async function createCurrencies() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -123,7 +123,7 @@ async function createCurrencies() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+16
-7
@@ -55,7 +55,7 @@ async function retrieveMoneyAmounts() {
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
@@ -126,7 +126,7 @@ async function retrieveMoneyAmounts() {
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -135,7 +135,7 @@ async function retrieveMoneyAmounts() {
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -155,7 +155,7 @@ async function retrieveMoneyAmounts() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -182,7 +182,7 @@ async function retrieveMoneyAmounts() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -232,10 +232,10 @@ async function retrieveMoneyAmounts() {
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)",
|
||||
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
|
||||
"description": "The money amount's currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -273,6 +273,15 @@ async function retrieveMoneyAmounts() {
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The details of the relation between the money amount and its associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
+211
@@ -0,0 +1,211 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
badge:
|
||||
variant: orange
|
||||
text: Beta
|
||||
slug: /references/pricing/createPriceListRules
|
||||
sidebar_label: createPriceListRules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# createPriceListRules - Pricing Module Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceListRules` method. This belongs to the Pricing Module.
|
||||
|
||||
This method is used to create price list rules.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function createPriceListRules (items: {
|
||||
rule_type_id: string
|
||||
price_list_id: string
|
||||
}[]) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
const priceListRules = await pricingService.createPriceListRules(items)
|
||||
|
||||
// do something with the price list rule or return them
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[CreatePriceListRuleDTO](../../interfaces/CreatePriceListRuleDTO.mdx)[]",
|
||||
"description": "The price list rules to create.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "price_list",
|
||||
"type": "`string` \\| [PriceListDTO](../../interfaces/PriceListDTO.mdx)",
|
||||
"description": "The ID of a price list or the details of an existing price list to be associated with the price list rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a price list to be associated with the price list rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "`string` \\| [RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
|
||||
"description": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a rule type to be associated with the price list rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "sharedContext",
|
||||
"type": "[Context](../../interfaces/Context.mdx)",
|
||||
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created price list rules.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "PriceListRuleDTO[]",
|
||||
"type": "[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The price list rule's ID.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list",
|
||||
"type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)",
|
||||
"description": "The associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rule_values",
|
||||
"type": "[PriceListRuleValueDTO](../../interfaces/PriceListRuleValueDTO.mdx)[]",
|
||||
"description": "The associated rule values.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+414
@@ -0,0 +1,414 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
badge:
|
||||
variant: orange
|
||||
text: Beta
|
||||
slug: /references/pricing/createPriceLists
|
||||
sidebar_label: createPriceLists
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# createPriceLists - Pricing Module Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceLists` method. This belongs to the Pricing Module.
|
||||
|
||||
This method is used to create price lists.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function createPriceList (items: {
|
||||
title: string
|
||||
description: string
|
||||
starts_at?: string
|
||||
ends_at?: string
|
||||
}[]) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
const priceList = await pricingService.createPriceLists(items)
|
||||
|
||||
// do something with the price lists or return them
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[CreatePriceListDTO](../../interfaces/CreatePriceListDTO.mdx)[]",
|
||||
"description": "The details of each price list to be created.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "The price list's description.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "ends_at",
|
||||
"type": "`string`",
|
||||
"description": "The price list expires after this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number_rules",
|
||||
"type": "`number`",
|
||||
"description": "The number of rules associated with the price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[PriceListPriceDTO](../../interfaces/PriceListPriceDTO.mdx)[]",
|
||||
"description": "The prices associated with the price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`null` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "[CreatePriceListRules](../../interfaces/CreatePriceListRules.mdx)",
|
||||
"description": "The rules to be created and associated with the price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "starts_at",
|
||||
"type": "`string`",
|
||||
"description": "The price list is enabled starting from this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[PriceListStatus](../../enums/PriceListStatus.mdx)",
|
||||
"description": "The price list's status.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "ACTIVE",
|
||||
"type": "`\"active\"`",
|
||||
"description": "The price list is enabled and its prices can be used.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "DRAFT",
|
||||
"type": "`\"draft\"`",
|
||||
"description": "The price list is disabled, meaning its prices can't be used yet.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The price list's title.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[PriceListType](../../enums/PriceListType.mdx)",
|
||||
"description": "The price list's type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "OVERRIDE",
|
||||
"type": "`\"override\"`",
|
||||
"description": "The price list's prices override original prices. This affects the calculated price of associated price sets.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "SALE",
|
||||
"type": "`\"sale\"`",
|
||||
"description": "The price list's prices are used for a sale.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "sharedContext",
|
||||
"type": "[Context](../../interfaces/Context.mdx)",
|
||||
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[PriceListDTO](../../interfaces/PriceListDTO.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The created price lists.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "PriceListDTO[]",
|
||||
"type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "ends_at",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The price list expires after this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The price list's ID.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
|
||||
"description": "The associated money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number_rules",
|
||||
"type": "`number`",
|
||||
"description": "The number of rules associated with this price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rules",
|
||||
"type": "[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]",
|
||||
"description": "The price set's rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
|
||||
"description": "The associated price set money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
|
||||
"description": "The associated rule types.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "[PriceListRuleDTO](../../interfaces/PriceListRuleDTO.mdx)[]",
|
||||
"description": "The price set's rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "starts_at",
|
||||
"type": "`null` \\| `string`",
|
||||
"description": "The price list is enabled starting from this date.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[PriceListStatus](../../enums/PriceListStatus.mdx)",
|
||||
"description": "The price list's status.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The price list's title.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+13
-22
@@ -18,16 +18,16 @@ This method is used to create new price rules based on the provided data.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function createPriceRules (
|
||||
id: string,
|
||||
priceSetId: string,
|
||||
ruleTypeId: string,
|
||||
value: string,
|
||||
priceSetMoneyAmountId: string,
|
||||
priceSetId: string,
|
||||
ruleTypeId: string,
|
||||
value: string,
|
||||
priceSetMoneyAmountId: string,
|
||||
priceListId: string
|
||||
) {
|
||||
const pricingService = await initializePricingModule()
|
||||
@@ -67,15 +67,6 @@ async function createPriceRules (
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
@@ -88,7 +79,7 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -97,7 +88,7 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -134,7 +125,7 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -161,7 +152,7 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -220,10 +211,10 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)",
|
||||
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
|
||||
"description": "The associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -256,10 +247,10 @@ async function createPriceRules (
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
|
||||
+7
-7
@@ -19,7 +19,7 @@ a rule type.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -89,7 +89,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -116,7 +116,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -166,19 +166,19 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
|
||||
"description": "The associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
|
||||
+2
-2
@@ -94,7 +94,7 @@ async function createRuleTypes() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -121,7 +121,7 @@ async function createRuleTypes() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ This method deletes price sets by their IDs.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -52,7 +52,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -79,7 +79,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+2
-2
@@ -50,7 +50,7 @@ async function deleteCurrencies() {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -77,7 +77,7 @@ async function deleteCurrencies() {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ This method deletes money amounts by their IDs.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -54,7 +54,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -81,7 +81,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+113
@@ -0,0 +1,113 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
badge:
|
||||
variant: orange
|
||||
text: Beta
|
||||
slug: /references/pricing/deletePriceListRules
|
||||
sidebar_label: deletePriceListRules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# deletePriceListRules - Pricing Module Reference
|
||||
|
||||
This documentation provides a reference to the `deletePriceListRules` method. This belongs to the Pricing Module.
|
||||
|
||||
This method is used to delete price list rules.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function deletePriceListRules (priceListRuleIds: string[]) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
await pricingService.deletePriceListRules(priceListRuleIds)
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "priceListRuleIds",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs of the price list rules to delete.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sharedContext",
|
||||
"type": "[Context](../../interfaces/Context.mdx)",
|
||||
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "Resolves successfully when the price list rules are deleted.",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+113
@@ -0,0 +1,113 @@
|
||||
---
|
||||
displayed_sidebar: pricingReference
|
||||
badge:
|
||||
variant: orange
|
||||
text: Beta
|
||||
slug: /references/pricing/deletePriceLists
|
||||
sidebar_label: deletePriceLists
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# deletePriceLists - Pricing Module Reference
|
||||
|
||||
This documentation provides a reference to the `deletePriceLists` method. This belongs to the Pricing Module.
|
||||
|
||||
This method is used to delete price lists.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
async function deletePriceLists (ids: string[]) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
await pricingService.deletePriceLists(ids)
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "priceListIds",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs of the price lists to delete.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sharedContext",
|
||||
"type": "[Context](../../interfaces/Context.mdx)",
|
||||
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "Resolves when the price lists are deleted successfully.",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+3
-3
@@ -18,7 +18,7 @@ This method is used to delete price rules based on the specified IDs.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -54,7 +54,7 @@ async function deletePriceRules (
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -81,7 +81,7 @@ async function deletePriceRules (
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ This method is used to delete price set money amount rules based on the specifie
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -52,7 +52,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -79,7 +79,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ This method is used to delete rule types based on the provided IDs.
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -52,7 +52,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -79,7 +79,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+7
-7
@@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price sets based on optional
|
||||
To retrieve a list of price sets using their IDs:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -40,7 +40,7 @@ async function retrievePriceSets (priceSetIds: string[]) {
|
||||
To specify relations that should be retrieved within the price sets:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -63,7 +63,7 @@ async function retrievePriceSets (priceSetIds: string[]) {
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -88,10 +88,10 @@ async function retrievePriceSets (priceSetIds: string[], skip: number, take: num
|
||||
You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
|
||||
async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
@@ -290,7 +290,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -317,7 +317,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+7
-7
@@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price sets along with the to
|
||||
To retrieve a list of prices sets using their IDs:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -40,7 +40,7 @@ async function retrievePriceSets (priceSetIds: string[]) {
|
||||
To specify relations that should be retrieved within the price sets:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -63,7 +63,7 @@ async function retrievePriceSets (priceSetIds: string[]) {
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -88,10 +88,10 @@ async function retrievePriceSets (priceSetIds: string[], skip: number, take: num
|
||||
You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
|
||||
async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) {
|
||||
const pricingService = await initializePricingModule()
|
||||
|
||||
@@ -290,7 +290,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -317,7 +317,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
+5
-5
@@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of currencies along with the to
|
||||
To retrieve a list of currencies using their codes:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -40,7 +40,7 @@ async function retrieveCurrencies (codes: string[]) {
|
||||
To specify attributes that should be retrieved within the money amounts:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -63,7 +63,7 @@ async function retrieveCurrencies (codes: string[]) {
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
import {
|
||||
import {
|
||||
initialize as initializePricingModule,
|
||||
} from "@medusajs/pricing"
|
||||
|
||||
@@ -210,7 +210,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"description": "A boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -237,7 +237,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"description": "A string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user