createCollectionsStep - Medusa Core Workflows Reference

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

This step creates one or more collection.

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

Input#

CreateProductCollectionDTO[]CreateProductCollectionDTO[]

titlestring

The product collection's title.

handlestringOptional

The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.

product_idsstring[]Optional

The products to associate with the collection.

metadataMetadataTypeOptional

Holds custom data in key-value pairs.

Output#

ProductCollectionDTO[]ProductCollectionDTO[]

idstring

The ID of the product collection.

titlestring

The title of the product collection.

handlestring

The handle of the product collection. The handle can be used to create slug URL paths.

created_atstring | Date

When the product collection was created.

updated_atstring | Date

When the product collection was updated.

metadataMetadataTypeOptional

Holds custom data in key-value pairs.

deleted_atstring | DateOptional

When the product collection was deleted.

productsProductDTO[]Optional

The associated products.

Was this page helpful?