Get Started
Product
Framework
Commerce Modules
Infrastructure Modules
Build
Recipes
How-to & Tutorials
Integrations
Storefront
Tools
CLI Tools
JS SDK
Next.js Starter
Medusa UI
Reference
Admin API
Store API
Admin Injection Zones
Container Resources
Core Workflows
Data Model Language
Data Model Repository
Events Reference
Helper Steps
Service Factory
Testing Framework
Workflows SDK
User Guide
Cloud

Help

Troubleshooting

Discord Community

Hide Sidebar⌘\

Theme

Light

Dark

Menu

Get Started
Product
Build
Tools
Reference
User Guide
Cloud

Loading...

Was this page helpful?

New versionv2.8.7 details

Loading...

View as Markdown

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

⇧↵

Navigation↑↓

Open Result↵

createReservationsWorkflow - Medusa Core Workflows Reference - Medusa Documentation

createReservationsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more reservations. It's used by the Create Reservations Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to create reservations in your custom flows.

Examples#

Steps#

createReservationsStep

Workflow hook

Step conditioned by when

View step details

Input#

CreateReservationsWorkflowInputCreateReservationsWorkflowInput

reservationsCreateReservationItemInput[]

The reservations to create.

Output#

CreateReservationsWorkflowOutputCreateReservationsWorkflowOutput

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.