- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
updateInventoryItemsStep - Medusa Core Workflows Reference
This documentation provides a reference to the updateInventoryItemsStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step updates one or more inventory items.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { updateInventoryItemsStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = updateInventoryItemsStep({8 "id": "id_vs6et3mu1AkGXePDZr"9 })10 }11)
Input#
UpdateInventoryItemsStepInput
UpdateInventoryItemsStepInputThe data to update the inventory items.
UpdateInventoryItemsStepInput
UpdateInventoryItemsStepInputid
stringThe ID of the inventory item to update.
id
stringsku
null | stringOptionalThe SKU of the inventory item.
sku
null | stringOptionalorigin_country
null | stringOptionalThe origin country of the inventory item.
origin_country
null | stringOptionalmid_code
null | stringOptionalThe MID code of the inventory item.
mid_code
null | stringOptionalmaterial
null | stringOptionalThe material of the inventory item.
material
null | stringOptionalweight
null | numberOptionalThe weight of the inventory item.
weight
null | numberOptionallength
null | numberOptionalThe length of the inventory item.
length
null | numberOptionalheight
null | numberOptionalThe height of the inventory item.
height
null | numberOptionalwidth
null | numberOptionalThe width of the inventory item.
width
null | numberOptionaltitle
null | stringOptionalThe title of the inventory item.
title
null | stringOptionaldescription
null | stringOptionalThe description of the inventory item.
description
null | stringOptionalthumbnail
null | stringOptionalThe thumbnail of the inventory item.
thumbnail
null | stringOptionalmetadata
null | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadata
null | Record<string, unknown>Optionalhs_code
null | stringOptionalThe HS code of the inventory item.
hs_code
null | stringOptionalrequires_shipping
booleanOptionalWhether the inventory item requires shipping.
requires_shipping
booleanOptionalOutput#
InventoryItemDTO[]
InventoryItemDTO[]
InventoryItemDTO[]
InventoryItemDTO[]InventoryItemDTO
InventoryItemDTOThe inventory item details.
InventoryItemDTO
InventoryItemDTOWas this page helpful?