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": "Brice"9    })10  }11)

Input#

CreateStockLocationsStepInputCreateStockLocationsStepInput

The stock locations to create.

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

idstring

The ID of the stock location.

namestring

The name of the stock location.

metadataRecord<string, unknown> | null

Holds custom data in key-value pairs.

address_idstring

The associated address's ID.

fulfillment_setsFulfillmentSetDTO[]

Fulfillment sets for the location

created_atstring | Date

The creation date of the stock location.

updated_atstring | Date

The update date of the stock location.

deleted_atstring | Date | null

The deletion date of the stock location.

addressStockLocationAddressDTOOptional

The address of the stock location.

Was this page helpful?