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])

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.

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.

ReservationItemDTO[]ReservationItemDTO[]

ReservationItemDTOReservationItemDTO

The reservation item details.

Was this page helpful?