Menu

createReservationsStep - Medusa Core Workflows Reference

This documentation provides a reference to the createReservationsStep. It belongs to the @medusajs/medusa/core-flows package.

This step creates one or more reservations.

Example#

Code
1const data = createReservationsStep([2  {3    inventory_item_id: "iitem_123",4    location_id: "sloc_123",5    quantity: 1,6  }7])

Input#

CreateReservationsStepInputCreateReservationsStepInput
The data to create reservation items.
inventory_item_idstring
The ID of the associated inventory item.
location_idstring
The ID of the associated location.
quantityBigNumberInput
The reserved quantity.
line_item_idnull | stringOptional
The ID of the associated line item.
allow_backorderbooleanOptional
Allow backorder of the item. If true, it won't check inventory levels before reserving it.
descriptionnull | stringOptional
The description of the reservation.
created_bynull | stringOptional
The user or system that created the reservation. Can be any form of identification string.
external_idnull | stringOptional
An ID associated with an external third-party system that the reservation item is connected to.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.

Output#

ReservationItemDTO[]ReservationItemDTO[]
idstring
The ID of the reservation item.
location_idstring
The associated location's ID.
inventory_item_idstring
The associated inventory item's ID.
quantityBigNumberInput
The quantity of the reservation item.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
created_atstring | Date
The creation date of the reservation item.
updated_atstring | Date
The update date of the reservation item.
deleted_atnull | string | Date
The deletion date of the reservation item.
line_item_idnull | stringOptional
The associated line item's ID.
descriptionnull | stringOptional
The description of the reservation item.
allow_backorderbooleanOptional
Allow backorder of the item. If true, it won't check inventory levels before reserving it.
created_bynull | stringOptional
The created by of the reservation item.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵