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#

createReservationsStep

Workflow Hook

Step conditioned by when

CreateReservationsWorkflowInputCreateReservationsWorkflowInput

The reservations to create.

CreateReservationsWorkflowOutputCreateReservationsWorkflowOutput

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.

Was this page helpful?