Loading...
Was this page helpful?
Loading...
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#
Input#
CreateReservationsStepInputCreateReservationsStepInputThe data to create reservation items.
CreateReservationsStepInputCreateReservationsStepInputinventory_item_idstringThe ID of the associated inventory item.
inventory_item_idstringlocation_idstringThe ID of the associated location.
location_idstringquantityBigNumberInputThe reserved quantity.
quantityBigNumberInputline_item_idnull | stringOptionalThe ID of the associated line item.
line_item_idnull | stringOptionalallow_backorderbooleanOptionalAllow backorder of the item. If true, it won't check inventory levels before reserving it.
allow_backorderbooleanOptionaldescriptionnull | stringOptionalThe description of the reservation.
descriptionnull | stringOptionalcreated_bynull | stringOptionalThe user or system that created the reservation. Can be any form of identification string.
created_bynull | stringOptionalexternal_idnull | stringOptionalAn ID associated with an external third-party system that the reservation item is connected to.
external_idnull | stringOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalOutput#
ReservationItemDTO[]ReservationItemDTO[]
ReservationItemDTO[]ReservationItemDTO[]idstringThe ID of the reservation item.
idstringlocation_idstringThe associated location's ID.
location_idstringinventory_item_idstringThe associated inventory item's ID.
inventory_item_idstringquantityBigNumberInputThe quantity of the reservation item.
quantityBigNumberInputmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atstring | DateThe creation date of the reservation item.
created_atstring | Dateupdated_atstring | DateThe update date of the reservation item.
updated_atstring | Datedeleted_atnull | string | DateThe deletion date of the reservation item.
deleted_atnull | string | Dateline_item_idnull | stringOptionalThe associated line item's ID.
line_item_idnull | stringOptionaldescriptionnull | stringOptionalThe description of the reservation item.
descriptionnull | stringOptionalallow_backorderbooleanOptionalAllow backorder of the item. If true, it won't check inventory levels before reserving it.
allow_backorderbooleanOptionalcreated_bynull | stringOptionalThe created by of the reservation item.
created_bynull | stringOptional