Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

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

Input#

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.

Output#

ReservationItemDTO[]ReservationItemDTO[]
ReservationItemDTOReservationItemDTO
The reservation item details.
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
⇧↵