docs: generate references for v2.3.0 (#11035)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
2f7ec55f2e
commit
45847fef19
538 files changed
+304288
-199194
No files matched your search
+77
-10
@@ -15,7 +15,7 @@ This documentation provides a reference to the `sdk.admin.inventoryItem` set of
|
||||
|
||||
## create
|
||||
|
||||
This method creates an inventory item. It sends a request to the
|
||||
This method creates an inventory item. It sends a request to the
|
||||
[Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitems)
|
||||
API route.
|
||||
|
||||
@@ -69,7 +69,7 @@ ___
|
||||
|
||||
## list
|
||||
|
||||
This method retrieves a paginated list of inventory items. It sends a request to the
|
||||
This method retrieves a paginated list of inventory items. It sends a request to the
|
||||
[List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items\_getinventoryitems)
|
||||
API route.
|
||||
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
|
||||
## retrieve
|
||||
|
||||
This method retrieves an inventory item by its ID. It sends a request to the
|
||||
This method retrieves an inventory item by its ID. It sends a request to the
|
||||
[Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items\_getinventoryitemsid) API route.
|
||||
|
||||
### Example
|
||||
@@ -246,7 +246,7 @@ ___
|
||||
This method updates the inventory level of the specified inventory item and
|
||||
stock location.
|
||||
|
||||
This method sends a request to the
|
||||
This method sends a request to the
|
||||
[Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitemsidlocationlevelslocation\_id)
|
||||
API route.
|
||||
|
||||
@@ -280,7 +280,7 @@ ___
|
||||
This method deletes an inventory level associated with an inventory item
|
||||
and a stock location.
|
||||
|
||||
This method sends a request to the
|
||||
This method sends a request to the
|
||||
[Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items\_deleteinventoryitemsidlocationlevelslocation\_id)
|
||||
API route.
|
||||
|
||||
@@ -320,17 +320,84 @@ sdk.admin.inventoryItem.batchUpdateLevels("iitem_123", {
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["sloc_123"]
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ inventory_item }) => {
|
||||
console.log(inventory_item)
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`AdminBatchUpdateInventoryLevelLocation`","description":"The inventory levels to create or delete.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminBatchInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels/page.mdx)","description":"The inventory levels to create or delete.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"update","type":"[AdminBatchUpdateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"create","type":"[AdminBatchCreateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to create.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"A list of location IDs to\ndelete their associated inventory\nlevels of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"Whether to force the deletion of the inventory levels,\neven if the the location has stocked quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminInventoryItemResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminInventoryItemResponse","type":"[AdminInventoryItemResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"inventory_item","type":"[AdminInventoryItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx)","description":"The inventory item's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The inventory item's SKU.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The inventory item's origin country.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The inventory item's HS code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The inventory item's MID code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The inventory item's material.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The inventory item's weight.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The inventory item's length.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The inventory item's height.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The inventory item's width.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The inventory item's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The inventory item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The inventory item's thumbnail URL.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"The item's associated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemLocationLevelsResponse","type":"[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
|
||||
:::note[Deprecated]
|
||||
|
||||
Use `batchInventoryItemLocationLevels` instead.
|
||||
|
||||
:::
|
||||
|
||||
___
|
||||
|
||||
## batchInventoryItemLocationLevels
|
||||
|
||||
This method manages the inventory levels of an inventory item. It sends a request to the
|
||||
[Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitemsidlocationlevelsbatch)
|
||||
API route.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
sdk.admin.inventoryItem.batchInventoryItemLocationLevels("iitem_123", {
|
||||
create: [{
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminBatchInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels/page.mdx)","description":"The inventory levels to create, update or delete, and an optional `force` flag.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"update","type":"[AdminBatchUpdateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"create","type":"[AdminBatchCreateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to create.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"A list of location IDs to\ndelete their associated inventory\nlevels of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"Whether to force the deletion of the inventory levels,\neven if the the location has stocked quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemLocationLevels"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemLocationLevelsResponse","type":"[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemLocationLevels"/>
|
||||
|
||||
___
|
||||
|
||||
## batchInventoryItemsLocationLevels
|
||||
|
||||
This method manages the inventory levels of multiple inventory items.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
sdk.admin.inventoryItem.batchInventoryItemsLocationLevels({
|
||||
create: [{
|
||||
inventory_item_id: "iitem_123",
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"body","type":"[AdminBatchInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevels/page.mdx)","description":"The inventory levels to create, update or delete, and an optional `force` flag.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"create","type":"[AdminBatchCreateInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemsLocationLevels/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[AdminBatchUpdateInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemsLocationLevels/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemsLocationLevels"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemsLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemsLocationLevelsResponse","type":"[AdminBatchInventoryItemsLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemsLocationLevels"/>
|
||||
+7
-7
@@ -21,7 +21,7 @@ This documentation provides a reference to the `sdk.admin.promotion` set of meth
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -45,7 +45,7 @@ ___
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -53,11 +53,11 @@ ___
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optionalLine truncated
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../typLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +81,7 @@ ___
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -93,7 +93,7 @@ ___
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ ___
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
|
||||
|
||||
___
|
||||
|
||||
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# batchInventoryItemLocationLevels
|
||||
|
||||
This method manages the inventory levels of an inventory item. It sends a request to the
|
||||
[Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitemsidlocationlevelsbatch)
|
||||
API route.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
sdk.admin.inventoryItem.batchInventoryItemLocationLevels("iitem_123", {
|
||||
create: [{
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminBatchInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels/page.mdx)","description":"The inventory levels to create, update or delete, and an optional `force` flag.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"update","type":"[AdminBatchUpdateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"create","type":"[AdminBatchCreateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to create.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"A list of location IDs to\ndelete their associated inventory\nlevels of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"Whether to force the deletion of the inventory levels,\neven if the the location has stocked quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemLocationLevels"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemLocationLevelsResponse","type":"[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemLocationLevels"/>
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# batchInventoryItemsLocationLevels
|
||||
|
||||
This method manages the inventory levels of multiple inventory items.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
sdk.admin.inventoryItem.batchInventoryItemsLocationLevels({
|
||||
create: [{
|
||||
inventory_item_id: "iitem_123",
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"body","type":"[AdminBatchInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevels/page.mdx)","description":"The inventory levels to create, update or delete, and an optional `force` flag.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"create","type":"[AdminBatchCreateInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemsLocationLevels/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[AdminBatchUpdateInventoryItemsLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemsLocationLevels/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemsLocationLevels"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemsLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemsLocationLevelsResponse","type":"[AdminBatchInventoryItemsLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchInventoryItemsLocationLevels"/>
|
||||
+11
-5
@@ -14,17 +14,23 @@ sdk.admin.inventoryItem.batchUpdateLevels("iitem_123", {
|
||||
location_id: "sloc_123",
|
||||
stocked_quantity: 10
|
||||
}],
|
||||
delete: ["sloc_123"]
|
||||
delete: ["ilvl_123"]
|
||||
})
|
||||
.then(({ inventory_item }) => {
|
||||
console.log(inventory_item)
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`AdminBatchUpdateInventoryLevelLocation`","description":"The inventory levels to create or delete.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminBatchInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels/page.mdx)","description":"The inventory levels to create or delete.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"update","type":"[AdminBatchUpdateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the inventory level to update.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"create","type":"[AdminBatchCreateInventoryItemLocationLevels](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemLocationLevels/page.mdx)[]","description":"A list of inventory levels to create.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the associated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"A list of location IDs to\ndelete their associated inventory\nlevels of the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"force","type":"`boolean`","description":"Whether to force the deletion of the inventory levels,\neven if the the location has stocked quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminInventoryItemResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminInventoryItemResponse","type":"[AdminInventoryItemResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"inventory_item","type":"[AdminInventoryItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx)","description":"The inventory item's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The inventory item's SKU.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The inventory item's origin country.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The inventory item's HS code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The inventory item's MID code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The inventory item's material.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The inventory item's weight.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The inventory item's length.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The inventory item's height.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The inventory item's width.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The inventory item's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The inventory item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The inventory item's thumbnail URL.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"The item's associated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The inventory item's details.","expandable":false,"children":[{"name":"AdminBatchInventoryItemLocationLevelsResponse","type":"[AdminBatchInventoryItemLocationLevelsResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevelsResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"created","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The created inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[InventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)[]","description":"The updated inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The inventory level's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the associated inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the associated stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"The associated inventory item's stocked quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"The associated inventory item's reserved quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"available_quantity","type":"`number`","description":"The associated inventory item's available quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`number`","description":"The associated inventory item's incoming quantity in the\nassociated stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the deleted inventory levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/>
|
||||
|
||||
:::note[Deprecated]
|
||||
|
||||
Use `batchInventoryItemLocationLevels` instead.
|
||||
|
||||
:::
|
||||
+1
-1
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# create
|
||||
|
||||
This method creates an inventory item. It sends a request to the
|
||||
This method creates an inventory item. It sends a request to the
|
||||
[Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitems)
|
||||
API route.
|
||||
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@ import { TypeList } from "docs-ui"
|
||||
This method deletes an inventory level associated with an inventory item
|
||||
and a stock location.
|
||||
|
||||
This method sends a request to the
|
||||
This method sends a request to the
|
||||
[Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items\_deleteinventoryitemsidlocationlevelslocation\_id)
|
||||
API route.
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# list
|
||||
|
||||
This method retrieves a paginated list of inventory items. It sends a request to the
|
||||
This method retrieves a paginated list of inventory items. It sends a request to the
|
||||
[List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items\_getinventoryitems)
|
||||
API route.
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# retrieve
|
||||
|
||||
This method retrieves an inventory item by its ID. It sends a request to the
|
||||
This method retrieves an inventory item by its ID. It sends a request to the
|
||||
[Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items\_getinventoryitemsid) API route.
|
||||
|
||||
## Example
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@ import { TypeList } from "docs-ui"
|
||||
This method updates the inventory level of the specified inventory item and
|
||||
stock location.
|
||||
|
||||
This method sends a request to the
|
||||
This method sends a request to the
|
||||
[Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items\_postinventoryitemsidlocationlevelslocation\_id)
|
||||
API route.
|
||||
|
||||
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addRules"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeRules"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
+2
-2
@@ -4,8 +4,8 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optionalLine truncated
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminUpdatePromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCreateCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The campaign's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The campaign's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"`null` \\| `string`","description":"The campaign's currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign's identifier.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions start at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date the campaign and its promotions end at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| `object`","description":"The campaign's budget.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"application_method","type":"[AdminUpdateApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"The application method's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"The application method's possible target types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[ApplicationMethodAllocationValues](../../../../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)","description":"The application method's possible allocation values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules","type":"[AdminCreatePromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminCreatePromotionRule](../../../../../typLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`PromotionStatusValues`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminPromotionResponse","type":"[AdminPromotionResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"promotion","type":"[AdminPromotion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[AdminApplicationMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminApplicationMethod/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminPromotionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PromotionStatusValues](../../../../../promotion/types/promotion.PromotionStatusValues/page.mdx)","description":"The promotion's possible types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[AdminCampaign](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRules"/>
|
||||
@@ -4,6 +4,8 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Methods
|
||||
|
||||
- [batchInventoryItemLocationLevels](../../InventoryItem/methods/js_sdk.admin.InventoryItem.batchInventoryItemLocationLevels/page.mdx)
|
||||
- [batchInventoryItemsLocationLevels](../../InventoryItem/methods/js_sdk.admin.InventoryItem.batchInventoryItemsLocationLevels/page.mdx)
|
||||
- [batchUpdateLevels](../../InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx)
|
||||
- [create](../../InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx)
|
||||
- [delete](../../InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx)
|
||||
|
||||
+2
-1
@@ -23,6 +23,7 @@ sdk.auth.callback(
|
||||
"google",
|
||||
{
|
||||
code: "123",
|
||||
state: "456"
|
||||
}
|
||||
).then((token) => {
|
||||
console.log(token)
|
||||
@@ -31,7 +32,7 @@ sdk.auth.callback(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"actor","type":"`string`","description":"The actor type. For example, `user` for admin user, or `customer` for customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"`string`","description":"The authentication provider to use. For example, `google`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, unknown>`","description":"The query parameters from the Oauth callback, which should be passed to the API route.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="callback"/>
|
||||
<TypeList types={[{"name":"actor","type":"`string`","description":"The actor type. For example, `user` for admin user, or `customer` for customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method","type":"`string`","description":"The authentication provider to use. For example, `google`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, unknown>`","description":"The query parameters from the Oauth callback, which should be passed to the API route. This includes query parameters like\n`code` and `state`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="callback"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user