Loading...
Was this page helpful?
Loading...
createProductsStep - Medusa Core Workflows Reference
This documentation provides a reference to the createProductsStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates one or more products.
Example#
Input#
CreateProductDTO[]CreateProductDTO[]
CreateProductDTO[]CreateProductDTO[]titlestringThe title of the product.
titlestringidstringOptionalOptionally pass an ID when creating a product.
idstringOptionalsubtitlestringOptionalThe subttle of the product.
subtitlestringOptionaldescriptionstringOptionalThe description of the product.
descriptionstringOptionalis_giftcardbooleanOptionalWhether the product is a gift card.
is_giftcardbooleanOptionaldiscountablebooleanOptionalWhether the product can be discounted.
discountablebooleanOptionalthumbnailstringOptionalThe URL of the product's thumbnail.
thumbnailstringOptionalhandlestringOptionalThe handle of the product. The handle can be used to create slug URL paths.
If not supplied, the value of the handle attribute of the product is set to the slug version of the title attribute.
handlestringOptionalhandle attribute of the product is set to the slug version of the title attribute.The status of the product.
The associated images to created or updated.
external_idstringOptionalThe id of the product in an external system
external_idstringOptionaltype_idstringOptionalThe product type id to associate with the product.
type_idstringOptionalcollection_idstringOptionalThe product collection to associate with the product.
collection_idstringOptionaltag_idsstring[]OptionalThe tags to be associated with the product.
tag_idsstring[]Optionalcategory_idsstring[]OptionalThe product categories to associate with the product.
category_idsstring[]OptionalThe product options to be created and associated with the product.
The product variants to be created and associated with the product.
widthnumberOptionalThe width of the product.
widthnumberOptionalheightnumberOptionalThe height of the product.
heightnumberOptionallengthnumberOptionalThe length of the product.
lengthnumberOptionalweightnumberOptionalThe weight of the product.
weightnumberOptionalorigin_countrystringOptionalThe origin country of the product.
origin_countrystringOptionalhs_codestringOptionalThe HS Code of the product.
hs_codestringOptionalmaterialstringOptionalThe material of the product.
materialstringOptionalmid_codestringOptionalThe MID Code of the product.
mid_codestringOptionalHolds custom data in key-value pairs.
Output#
ProductDTO[]ProductDTO[]
ProductDTO[]ProductDTO[]idstringThe ID of the product.
idstringtitlestringThe title of the product.
titlestringhandlestringThe handle of the product. The handle can be used to create slug URL paths.
handlestringsubtitlenull | stringThe subttle of the product.
subtitlenull | stringdescriptionnull | stringThe description of the product.
descriptionnull | stringis_giftcardbooleanWhether the product is a gift card.
is_giftcardbooleanstatusProductStatusThe status of the product.
statusProductStatusthumbnailnull | stringThe URL of the product's thumbnail.
thumbnailnull | stringwidthnull | numberThe width of the product.
widthnull | numberweightnull | numberThe weight of the product.
weightnull | numberlengthnull | numberThe length of the product.
lengthnull | numberheightnull | numberThe height of the product.
heightnull | numberorigin_countrynull | stringThe origin country of the product.
origin_countrynull | stringhs_codenull | stringThe HS Code of the product.
hs_codenull | stringmid_codenull | stringThe MID Code of the product.
mid_codenull | stringmaterialnull | stringThe material of the product.
materialnull | stringThe associated product collection.
collection_idnull | stringThe associated product collection id.
collection_idnull | stringThe associated product type.
type_idnull | stringThe associated product type id.
type_idnull | stringThe associated product tags.
The associated product variants.
The associated product options.
The associated product images.
external_idnull | stringThe ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain
a reference to the ID in the integrated service.
external_idnull | stringcreated_atstring | DateWhen the product was created.
created_atstring | Dateupdated_atstring | DateWhen the product was updated.
updated_atstring | Datedeleted_atstring | DateWhen the product was deleted.
deleted_atstring | DateThe associated product categories.
discountablebooleanOptionalWhether the product can be discounted.
discountablebooleanOptional