createStockLocationsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createStockLocationsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more stock locations. It's used by the Create Stock Location Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create stock locations in your custom flows.
Source CodeExamples#
Steps#
Input#
CreateStockLocationsWorkflowInputCreateStockLocationsWorkflowInputThe data to create the stock locations.
CreateStockLocationsWorkflowInputCreateStockLocationsWorkflowInputlocationsCreateStockLocationInput[]The stock locations to create.
locationsCreateStockLocationInput[]Output#
StockLocationDTO[]StockLocationDTO[]
StockLocationDTO[]StockLocationDTO[]idstringThe ID of the stock location.
idstringnamestringThe name of the stock location.
namestringmetadataRecord<string, unknown> | nullHolds custom data in key-value pairs.
metadataRecord<string, unknown> | nulladdress_idstringThe associated address's ID.
address_idstringfulfillment_setsFulfillmentSetDTO[]Fulfillment sets for the location
fulfillment_setsFulfillmentSetDTO[]created_atstring | DateThe creation date of the stock location.
created_atstring | Dateupdated_atstring | DateThe update date of the stock location.
updated_atstring | Datedeleted_atstring | Date | nullThe deletion date of the stock location.
deleted_atstring | Date | nullThe address of the stock location.
Hooks#
Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
stockLocationsCreated#
Handlers consuming this hook accept the following input.
inputobject
inputobjectstockLocationsStockLocationDTO[]
stockLocationsStockLocationDTO[]Was this page helpful?