createInventoryItemsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createInventoryItemsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more inventory items. It's used by the Create Inventory Item Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create inventory items in your custom flows.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
CreateInventoryItemsWorkflowInputCreateInventoryItemsWorkflowInputThe data to create the inventory items.
CreateInventoryItemsWorkflowInputCreateInventoryItemsWorkflowInputitemsCreateInventoryItemInput & object[]The items to create.
itemsCreateInventoryItemInput & object[]Output#
InventoryItemDTO[]InventoryItemDTO[]
InventoryItemDTO[]InventoryItemDTO[]idstringThe ID of the inventory item.
idstringrequires_shippingbooleanWhether the inventory item requires shipping.
requires_shippingbooleancreated_atstring | DateThe creation date of the inventory item.
created_atstring | Dateupdated_atstring | DateThe update date of the inventory item.
updated_atstring | Datedeleted_atnull | string | DateThe deletion date of the inventory item.
deleted_atnull | string | Dateskunull | stringOptionalThe SKU of the inventory item.
skunull | stringOptionalorigin_countrynull | stringOptionalThe origin country of the inventory item.
origin_countrynull | stringOptionalhs_codenull | stringOptionalThe HS code of the inventory item.
hs_codenull | stringOptionalmid_codenull | stringOptionalThe mid code of the inventory item.
mid_codenull | stringOptionalmaterialnull | stringOptionalThe material of the inventory item.
materialnull | stringOptionalweightnull | numberOptionalThe weight of the inventory item.
weightnull | numberOptionallengthnull | numberOptionalThe length of the inventory item.
lengthnull | numberOptionalheightnull | numberOptionalThe height of the inventory item.
heightnull | numberOptionalwidthnull | numberOptionalThe width of the inventory item.
widthnull | numberOptionaltitlenull | stringOptionalThe title of the inventory item.
titlenull | stringOptionaldescriptionnull | stringOptionalThe description of the inventory item.
descriptionnull | stringOptionalthumbnailnull | stringOptionalThe thumbnail of the inventory item.
thumbnailnull | stringOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalWas this page helpful?