updateReservationsStep - Medusa Core Workflows Reference

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

This step updates one or more reservations.

Example#

Code
1const data = updateReservationsStep([2  {3    id: "res_123",4    quantity: 1,5  }6])

UpdateReservationsStepInputUpdateReservationsStepInput

The data to update reservation items.

idstring

The ID of the reservation to update.

quantityBigNumberInputOptional

The reserved quantity.

location_idstringOptional

The ID of the associated location.

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.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

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.

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.