createStockLocations - Medusa Core Workflows Reference

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

This step creates one or more stock locations.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createStockLocations } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = createStockLocations({8      "name": "Forrest"9    })10  }11)

Input#

CreateStockLocationsStepInputCreateStockLocationsStepInput
namestring
The name of the stock location.
address_idstring | nullOptional
The associated address's ID.
addressstring | StockLocationAddressInputOptional
The associated address.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.

Output#

StockLocationDTO[]StockLocationDTO[]
StockLocationDTOStockLocationDTO
Represents a Stock Location
Was this page helpful?