docs: [11/n] generate core-flows reference (#8792)
This commit is contained in:
1 parent
c4dd82e814
commit
d4aaf70667
68 files changed
+1187
No files matched your search
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/batchLinkProductsToCollectionStep
|
||||||
|
sidebar_label: batchLinkProductsToCollectionStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# batchLinkProductsToCollectionStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `batchLinkProductsToCollectionStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates links between product and collection records.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinkProductsToCollectionStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createCollectionsStep
|
||||||
|
sidebar_label: createCollectionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createCollectionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createCollectionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more collection.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCollectionDTO[]","type":"[CreateProductCollectionDTO](../../../../../product/interfaces/product.CreateProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductCollectionDTO","type":"[CreateProductCollectionDTO](../../../../../product/interfaces/product.CreateProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product collection's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_ids","type":"`string`[]","description":"The products to associate with the collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCollectionsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCollectionDTO[]","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCollectionDTO","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductOptionsStep
|
||||||
|
sidebar_label: createProductOptionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductOptionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductOptionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more product options.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductOptionDTO[]","type":"[CreateProductOptionDTO](../../../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductOptionDTO","type":"[CreateProductOptionDTO](../../../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductOptionDTO[]","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionDTO","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The hLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductTagsStep
|
||||||
|
sidebar_label: createProductTagsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductTagsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductTagsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more product tags.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductTagDTO[]","type":"[CreateProductTagDTO](../../../../../product/interfaces/product.CreateProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductTagDTO","type":"[CreateProductTagDTO](../../../../../product/interfaces/product.CreateProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag to create.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTagsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTagDTO[]","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTagDTO","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The Line truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductTypesStep
|
||||||
|
sidebar_label: createProductTypesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductTypesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductTypesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more product types.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductTypeDTO[]","type":"[CreateProductTypeDTO](../../../../../product/interfaces/product.CreateProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductTypeDTO","type":"[CreateProductTypeDTO](../../../../../product/interfaces/product.CreateProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type to create.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The product type's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTypesStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTypeDTO[]","type":"[ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTypeDTO","type":"[ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTypesStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductVariantsStep
|
||||||
|
sidebar_label: createProductVariantsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductVariantsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductVariantsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more product variants.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductVariantDTO[]","type":"[CreateProductVariantDTO](../../../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductVariantDTO","type":"[CreateProductVariantDTO](../../../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The id of the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductVariantsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductVariantDTO[]","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductVariantDTO","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `DaLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductsStep
|
||||||
|
sidebar_label: createProductsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more products.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductDTO[]","type":"[CreateProductDTO](../../../../../product/interfaces/product.CreateProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductDTO","type":"[CreateProductDTO](../../../../../product/interfaces/product.CreateProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"Optionally pass an ID when creating a product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to created or updated.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`string`","description":"The product type id to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to be associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[CreateProductOptionDTO](../../../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)[]","description":"The product options to be created and associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[CreateProductVariantDTO](../../../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The id of the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKULine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`nullLine truncated
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createVariantPricingLinkStep
|
||||||
|
sidebar_label: createVariantPricingLinkStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createVariantPricingLinkStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createVariantPricingLinkStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates links between variant and price set records.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateVariantPricingLinkStepInput","type":"[CreateVariantPricingLinkStepInput](../../../../types/core_flows.CreateVariantPricingLinkStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createVariantPricingLinkStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteCollectionsStep
|
||||||
|
sidebar_label: deleteCollectionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteCollectionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteCollectionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more collections.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCollectionsStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductOptionsStep
|
||||||
|
sidebar_label: deleteProductOptionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductOptionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductOptionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more product options.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductOptionsStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductTagsStep
|
||||||
|
sidebar_label: deleteProductTagsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductTagsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductTagsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more product tags.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductTagsStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductTypesStep
|
||||||
|
sidebar_label: deleteProductTypesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductTypesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductTypesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more product types.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductTypesStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductVariantsStep
|
||||||
|
sidebar_label: deleteProductVariantsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductVariantsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductVariantsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more product variants.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductVariantsStep"/>
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductsStep
|
||||||
|
sidebar_label: deleteProductsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more products.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductsStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/generateProductCsvStep
|
||||||
|
sidebar_label: generateProductCsvStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# generateProductCsvStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `generateProductCsvStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step generates a CSV file to be exported.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminProduct[]","type":"`AdminProduct`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminProduct","type":"`AdminProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="generateProductCsvStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"file.id","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="generateProductCsvStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/getAllProductsStep
|
||||||
|
sidebar_label: getAllProductsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getAllProductsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `getAllProductsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step retrieves all products.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"GetAllProductsStepInput","type":"[GetAllProductsStepInput](../../../../types/core_flows.GetAllProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"select","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filter","type":"[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the products' attributes, such as titles and descriptions, using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)[]","description":"The status to filter products by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filters only or excluding gift card products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`object`","description":"Filters on a product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`object`","description":"Filters on a product's variant properties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter a product by the ID of the associated type","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`object` \\| `object`","description":"Filter a product by the IDs of their associated categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product by its associated collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was created","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was updated","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters soft-deleted products based on the date they were deleted at.","optional":true,"defauLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"any[]","type":"`any`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getAllProductsStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/getProductsStep
|
||||||
|
sidebar_label: getProductsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getProductsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `getProductsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step retrieves products.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"GetProductsStepInput","type":"[GetProductsStepInput](../../../../types/core_flows.GetProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ids","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getProductsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`nullLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/groupProductsForBatchStep
|
||||||
|
sidebar_label: groupProductsForBatchStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# groupProductsForBatchStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `groupProductsForBatchStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step groups products to be created and updated.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminCreateProduct & object[]","type":"`AdminCreateProduct` & `object`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminCreateProduct","type":"`AdminCreateProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="groupProductsForBatchStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"create","type":"`AdminCreateProduct`[]","description":"","optional":false,"defaultValue":"toCreate","expandable":false,"children":[]},{"name":"update","type":"`AdminUpdateProduct` & `object`[]","description":"","optional":false,"defaultValue":"toUpdate","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="groupProductsForBatchStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/parseProductCsvStep
|
||||||
|
sidebar_label: parseProductCsvStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# parseProductCsvStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `parseProductCsvStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step parses a CSV file holding products to import.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="parseProductCsvStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminCreateProduct[]","type":"`AdminCreateProduct`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminCreateProduct","type":"`AdminCreateProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="parseProductCsvStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateCollectionsStep
|
||||||
|
sidebar_label: updateCollectionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateCollectionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateCollectionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates collections matching the specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateCollectionsStepInput","type":"[UpdateCollectionsStepInput](../../../../types/core_flows.UpdateCollectionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the collections' titles.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The title to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on tLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCollectionDTO[]","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCollectionDTO","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductOptionsStep
|
||||||
|
sidebar_label: updateProductOptionsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductOptionsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductOptionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates product options matching the specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductOptionsStepInput","type":"[UpdateProductOptionsStepInput](../../../../types/core_flows.UpdateProductOptionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the options' titles.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product options by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optionalLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductOptionDTO[]","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionDTO","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The hLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductTagsStep
|
||||||
|
sidebar_label: updateProductTagsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductTagsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductTagsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates product tags matching the specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductTagsStepInput","type":"[UpdateProductTagsStepInput](../../../../types/core_flows.UpdateProductTagsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The value to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product tagsLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTagDTO[]","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTagDTO","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The Line truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductTypesStep
|
||||||
|
sidebar_label: updateProductTypesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductTypesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductTypesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates product types matching the specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductTypesStepInput","type":"[UpdateProductTypesStepInput](../../../../types/core_flows.UpdateProductTypesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to fLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTypeDTO[]","type":"[ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTypeDTO","type":"[ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProductTypesStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductVariantsStep
|
||||||
|
sidebar_label: updateProductVariantsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductVariantsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductVariantsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates one or more product variants.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductVariantsStepInput","type":"[UpdateProductVariantsStepInput](../../../../types/core_flows.UpdateProductVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilteLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductVariantDTO[]","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductVariantDTO","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `DaLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductsStep
|
||||||
|
sidebar_label: updateProductsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates one or more products.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductsStepInput","type":"[UpdateProductsStepInput](../../../../types/core_flows.UpdateProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the products' attributes, such as titles and descriptions, using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)[]","description":"The status to filter products by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filters only or excluding gift card products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`object`","description":"Filters on a product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`object`","description":"Filters on a product's variant properties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter a product by the ID of the associated type","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`object` \\| `object`","description":"Filter a product by the IDs of their associated categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product by its associated collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was created","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was updated","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters soft-deleted products based on the date they were deleted at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfacesLine truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`nullLine truncated
|
||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/waitConfirmationProductImportStep
|
||||||
|
sidebar_label: waitConfirmationProductImportStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# waitConfirmationProductImportStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `waitConfirmationProductImportStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step waits until a product import is confirmed.
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# batchLinkProductsToCollectionStepId
|
||||||
|
|
||||||
|
`Const` **batchLinkProductsToCollectionStepId**: `"batch-link-products-to-collection"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createCollectionsStepId
|
||||||
|
|
||||||
|
`Const` **createCollectionsStepId**: `"create-collections"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductOptionsStepId
|
||||||
|
|
||||||
|
`Const` **createProductOptionsStepId**: `"create-product-options"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductTagsStepId
|
||||||
|
|
||||||
|
`Const` **createProductTagsStepId**: `"create-product-tags"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductTypesStepId
|
||||||
|
|
||||||
|
`Const` **createProductTypesStepId**: `"create-product-types"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductVariantsStepId
|
||||||
|
|
||||||
|
`Const` **createProductVariantsStepId**: `"create-product-variants"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductsStepId
|
||||||
|
|
||||||
|
`Const` **createProductsStepId**: `"create-products"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createVariantPricingLinkStepId
|
||||||
|
|
||||||
|
`Const` **createVariantPricingLinkStepId**: `"create-variant-pricing-link"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteCollectionsStepId
|
||||||
|
|
||||||
|
`Const` **deleteCollectionsStepId**: `"delete-collections"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductOptionsStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductOptionsStepId**: `"delete-product-options"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductTagsStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductTagsStepId**: `"delete-product-tags"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductTypesStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductTypesStepId**: `"delete-product-types"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductVariantsStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductVariantsStepId**: `"delete-product-variants"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductsStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductsStepId**: `"delete-products"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# generateProductCsvStepId
|
||||||
|
|
||||||
|
`Const` **generateProductCsvStepId**: `"generate-product-csv"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getAllProductsStepId
|
||||||
|
|
||||||
|
`Const` **getAllProductsStepId**: `"get-all-products"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getProductsStepId
|
||||||
|
|
||||||
|
`Const` **getProductsStepId**: `"get-products"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# groupProductsForBatchStepId
|
||||||
|
|
||||||
|
`Const` **groupProductsForBatchStepId**: `"group-products-for-batch"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# parseProductCsvStepId
|
||||||
|
|
||||||
|
`Const` **parseProductCsvStepId**: `"parse-product-csv"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateCollectionsStepId
|
||||||
|
|
||||||
|
`Const` **updateCollectionsStepId**: `"update-collections"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductOptionsStepId
|
||||||
|
|
||||||
|
`Const` **updateProductOptionsStepId**: `"update-product-options"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductTagsStepId
|
||||||
|
|
||||||
|
`Const` **updateProductTagsStepId**: `"update-product-tags"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductTypesStepId
|
||||||
|
|
||||||
|
`Const` **updateProductTypesStepId**: `"update-product-types"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductVariantsStepId
|
||||||
|
|
||||||
|
`Const` **updateProductVariantsStepId**: `"update-product-variants"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductsStepId
|
||||||
|
|
||||||
|
`Const` **updateProductsStepId**: `"update-products"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# waitConfirmationProductImportStepId
|
||||||
|
|
||||||
|
`Const` **waitConfirmationProductImportStepId**: `"wait-confirmation-product-import"`
|
||||||
+325
@@ -0,0 +1,325 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Steps\_Product
|
||||||
|
|
||||||
|
## batchLinkProductsToCollectionStep
|
||||||
|
|
||||||
|
This step creates links between product and collection records.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinkProductsToCollectionStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createCollectionsStep
|
||||||
|
|
||||||
|
This step creates one or more collection.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCollectionDTO[]","type":"[CreateProductCollectionDTO](../../../product/interfaces/product.CreateProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductCollectionDTO","type":"[CreateProductCollectionDTO](../../../product/interfaces/product.CreateProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product collection's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_ids","type":"`string`[]","description":"The products to associate with the collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCollectionsStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCollectionDTO[]","type":"[ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCollectionDTO","type":"[ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children"Line truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createProductOptionsStep
|
||||||
|
|
||||||
|
This step creates one or more product options.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductOptionDTO[]","type":"[CreateProductOptionDTO](../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductOptionDTO","type":"[CreateProductOptionDTO](../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductOptionsStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductOptionDTO[]","type":"[ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionDTO","type":"[ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"dLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createProductTagsStep
|
||||||
|
|
||||||
|
This step creates one or more product tags.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductTagDTO[]","type":"[CreateProductTagDTO](../../../product/interfaces/product.CreateProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductTagDTO","type":"[CreateProductTagDTO](../../../product/interfaces/product.CreateProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag to create.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTagsStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTagDTO[]","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTagDTO","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaulLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createProductTypesStep
|
||||||
|
|
||||||
|
This step creates one or more product types.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductTypeDTO[]","type":"[CreateProductTypeDTO](../../../product/interfaces/product.CreateProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductTypeDTO","type":"[CreateProductTypeDTO](../../../product/interfaces/product.CreateProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type to create.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The product type's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTypesStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTypeDTO[]","type":"[ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTypeDTO","type":"[ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductTypesStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createProductVariantsStep
|
||||||
|
|
||||||
|
This step creates one or more product variants.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductVariantDTO[]","type":"[CreateProductVariantDTO](../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductVariantDTO","type":"[CreateProductVariantDTO](../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The id of the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductVariantsStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductVariantDTO[]","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductVariantDTO","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the pLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createProductsStep
|
||||||
|
|
||||||
|
This step creates one or more products.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductDTO[]","type":"[CreateProductDTO](../../../product/interfaces/product.CreateProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateProductDTO","type":"[CreateProductDTO](../../../product/interfaces/product.CreateProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product to create.","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"Optionally pass an ID when creating a product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to created or updated.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`string`","description":"The product type id to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to be associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[CreateProductOptionDTO](../../../product/interfaces/product.CreateProductOptionDTO/page.mdx)[]","description":"The product options to be created and associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The product option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[CreateProductVariantDTO](../../../product/interfaces/product.CreateProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The id of the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the product variant.","optional":true,Line truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../prodLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## createVariantPricingLinkStep
|
||||||
|
|
||||||
|
This step creates links between variant and price set records.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateVariantPricingLinkStepInput","type":"[CreateVariantPricingLinkStepInput](../../types/core_flows.CreateVariantPricingLinkStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createVariantPricingLinkStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteCollectionsStep
|
||||||
|
|
||||||
|
This step deletes one or more collections.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCollectionsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductOptionsStep
|
||||||
|
|
||||||
|
This step deletes one or more product options.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductOptionsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductTagsStep
|
||||||
|
|
||||||
|
This step deletes one or more product tags.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductTagsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductTypesStep
|
||||||
|
|
||||||
|
This step deletes one or more product types.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductTypesStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductVariantsStep
|
||||||
|
|
||||||
|
This step deletes one or more product variants.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductVariantsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductsStep
|
||||||
|
|
||||||
|
This step deletes one or more products.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## generateProductCsvStep
|
||||||
|
|
||||||
|
This step generates a CSV file to be exported.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminProduct[]","type":"`AdminProduct`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminProduct","type":"`AdminProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="generateProductCsvStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"file.id","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="generateProductCsvStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## getAllProductsStep
|
||||||
|
|
||||||
|
This step retrieves all products.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"GetAllProductsStepInput","type":"[GetAllProductsStepInput](../../types/core_flows.GetAllProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"select","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filter","type":"[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the products' attributes, such as titles and descriptions, using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx) \\| [ProductStatus](../../../product/types/product.ProductStatus/page.mdx)[]","description":"The status to filter products by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filters only or excluding gift card products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`object`","description":"Filters on a product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`object`","description":"Filters on a product's variant properties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter a product by the ID of the associated type","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`object` \\| `object`","description":"Filter a product by the IDs of their associated categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product by its associated collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was created","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was updated","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters soft-deleted products based on the date they were deleted at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../producLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"any[]","type":"`any`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getAllProductsStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## getProductsStep
|
||||||
|
|
||||||
|
This step retrieves products.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"GetProductsStepInput","type":"[GetProductsStepInput](../../types/core_flows.GetProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ids","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getProductsStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../prodLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## groupProductsForBatchStep
|
||||||
|
|
||||||
|
This step groups products to be created and updated.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminCreateProduct & object[]","type":"`AdminCreateProduct` & `object`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminCreateProduct","type":"`AdminCreateProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="groupProductsForBatchStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"create","type":"`AdminCreateProduct`[]","description":"","optional":false,"defaultValue":"toCreate","expandable":false,"children":[]},{"name":"update","type":"`AdminUpdateProduct` & `object`[]","description":"","optional":false,"defaultValue":"toUpdate","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="groupProductsForBatchStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## parseProductCsvStep
|
||||||
|
|
||||||
|
This step parses a CSV file holding products to import.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="parseProductCsvStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"AdminCreateProduct[]","type":"`AdminCreateProduct`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AdminCreateProduct","type":"`AdminCreateProduct`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="parseProductCsvStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateCollectionsStep
|
||||||
|
|
||||||
|
This step updates collections matching the specified filters.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateCollectionsStepInput","type":"[UpdateCollectionsStepInput](../../types/core_flows.UpdateCollectionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the collections' titles.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The title to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCollectionProps](../../../product/interfaces/product.FilterableProductCollectionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"cLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCollectionDTO[]","type":"[ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCollectionDTO","type":"[ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product collection's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children"Line truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductOptionsStep
|
||||||
|
|
||||||
|
This step updates product options matching the specified filters.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductOptionsStepInput","type":"[UpdateProductOptionsStepInput](../../types/core_flows.UpdateProductOptionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the options' titles.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product options by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionProps](../../../product/interfaces/product.FilterableProductOptionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the options' Line truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductOptionDTO[]","type":"[ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductOptionDTO","type":"[ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product option's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"dLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductTagsStep
|
||||||
|
|
||||||
|
This step updates product tags matching the specified filters.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductTagsStepInput","type":"[UpdateProductTagsStepInput](../../types/core_flows.UpdateProductTagsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The value to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTagProps](../../../product/interfaces/product.FilterableProductTagProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","descriptLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTagDTO[]","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTagDTO","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product tag's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaulLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductTypesStep
|
||||||
|
|
||||||
|
This step updates product types matching the specified filters.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductTypesStepInput","type":"[UpdateProductTypesStepInput](../../types/core_flows.UpdateProductTypesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductTypeProps](../../../product/interfaces/product.FilterableProductTypeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","descLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductTypeDTO[]","type":"[ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductTypeDTO","type":"[ProductTypeDTO](../../../product/interfaces/product.ProductTypeDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product type's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProductTypesStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductVariantsStep
|
||||||
|
|
||||||
|
This step updates one or more product variants.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductVariantsStepInput","type":"[UpdateProductVariantsStepInput](../../types/core_flows.UpdateProductVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"Line truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductVariantDTO[]","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductVariantDTO","type":"[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product variant's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the pLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductsStep
|
||||||
|
|
||||||
|
This step updates one or more products.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductsStepInput","type":"[UpdateProductsStepInput](../../types/core_flows.UpdateProductsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductProps](../../../product/interfaces/product.FilterableProductProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the products' attributes, such as titles and descriptions, using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx) \\| [ProductStatus](../../../product/types/product.ProductStatus/page.mdx)[]","description":"The status to filter products by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filters only or excluding gift card products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`object`","description":"Filters on a product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`object`","description":"Filters on a product's variant properties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter a product by the ID of the associated type","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`object` \\| `object`","description":"Filter a product by the IDs of their associated categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product by its associated collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was created","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters a product based on when it was updated","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../product/types/product.OperatorMap/page.mdx)<string>","description":"Filters soft-deleted products based on the date they were deleted at.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the enLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductDTO[]","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductDTO","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../prodLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## waitConfirmationProductImportStep
|
||||||
|
|
||||||
|
This step waits until a product import is confirmed.
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createProductCategoriesStep
|
||||||
|
sidebar_label: createProductCategoriesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductCategoriesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductCategoriesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more product categories.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCategoriesStepInput","type":"[CreateProductCategoriesStepInput](../../../../types/core_flows.CreateProductCategoriesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"product_categories","type":"[CreateProductCategoryDTO](../../../../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The product category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent product category, if it has any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductCategoriesStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","descLine truncated
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteProductCategoriesStep
|
||||||
|
sidebar_label: deleteProductCategoriesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductCategoriesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductCategoriesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more product categories.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductCategoriesStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updateProductCategoriesStep
|
||||||
|
sidebar_label: updateProductCategoriesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductCategoriesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductCategoriesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates product categories matching specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductCategoriesStepInput","type":"[UpdateProductCategoriesStepInput](../../../../types/core_flows.UpdateProductCategoriesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Filter product categories based on searchable fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"The names to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string` \\| `string`[]","description":"Filter product categories by their parent category's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Filter product categories by whether they're active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Filter product categories by whether they're internal.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"Whether to include children of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"Whether to include parents of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and",Line truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","descLine truncated
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductCategoriesStepId
|
||||||
|
|
||||||
|
`Const` **createProductCategoriesStepId**: `"create-product-categories"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductCategoriesStepId
|
||||||
|
|
||||||
|
`Const` **deleteProductCategoriesStepId**: `"delete-product-categories"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductCategoriesStepId
|
||||||
|
|
||||||
|
`Const` **updateProductCategoriesStepId**: `"update-product-categories"`
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/createProductCategoriesWorkflow
|
||||||
|
sidebar_label: createProductCategoriesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductCategoriesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createProductCategoriesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow creates one or more product categories.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"createProductCategoriesWorkflow","steps":[{"type":"step","name":"createProductCategoriesStep","description":"This step creates one or more product categories.","link":"../../../../core_flows.Steps_Product_Category/page.mdx#createproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCategoriesWorkflowInput","type":"[CreateProductCategoriesWorkflowInput](../../../../../types/WorkflowTypes/ProductCategoryWorkflow/interfaces/types.WorkflowTypes.ProductCategoryWorkflow.CreateProductCategoriesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"product_categories","type":"[CreateProductCategoryDTO](../../../../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The product category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent product category, if it has any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductCategoriesWorkflow"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","descLine truncated
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/deleteProductCategoriesWorkflow
|
||||||
|
sidebar_label: deleteProductCategoriesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductCategoriesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteProductCategoriesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow deletes one or more product categories.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deleteProductCategoriesWorkflow","steps":[{"type":"step","name":"deleteProductCategoriesStep","description":"This step deletes one or more product categories.","link":"../../../../core_flows.Steps_Product_Category/page.mdx#deleteproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductCategoriesWorkflow"/>
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/updateProductCategoriesWorkflow
|
||||||
|
sidebar_label: updateProductCategoriesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductCategoriesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updateProductCategoriesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow updates product categories matching specified filters.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"updateProductCategoriesWorkflow","steps":[{"type":"step","name":"updateProductCategoriesStep","description":"This step updates product categories matching specified filters.","link":"../../../../core_flows.Steps_Product_Category/page.mdx#updateproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductCategoriesWorkflowInput","type":"[UpdateProductCategoriesWorkflowInput](../../../../../types/WorkflowTypes/ProductCategoryWorkflow/interfaces/types.WorkflowTypes.ProductCategoryWorkflow.UpdateProductCategoriesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Filter product categories based on searchable fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"The names to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string` \\| `string`[]","description":"Filter product categories by their parent category's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Filter product categories by whether they're active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Filter product categories by whether they're internal.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"Whether to include children of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"Whether to include parents of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"Line truncated
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","descLine truncated
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createProductCategoriesWorkflowId
|
||||||
|
|
||||||
|
`Const` **createProductCategoriesWorkflowId**: `"create-product-categories"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteProductCategoriesWorkflowId
|
||||||
|
|
||||||
|
`Const` **deleteProductCategoriesWorkflowId**: `"delete-product-categories"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateProductCategoriesWorkflowId
|
||||||
|
|
||||||
|
`Const` **updateProductCategoriesWorkflowId**: `"update-product-categories"`
|
||||||
+39
@@ -0,0 +1,39 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Steps\_Product Category
|
||||||
|
|
||||||
|
## createProductCategoriesStep
|
||||||
|
|
||||||
|
This step creates one or more product categories.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCategoriesStepInput","type":"[CreateProductCategoriesStepInput](../../types/core_flows.CreateProductCategoriesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"product_categories","type":"[CreateProductCategoryDTO](../../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The product category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent product category, if it has any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductCategoriesStep"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category iLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductCategoriesStep
|
||||||
|
|
||||||
|
This step deletes one or more product categories.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductCategoriesStep"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductCategoriesStep
|
||||||
|
|
||||||
|
This step updates product categories matching specified filters.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductCategoriesStepInput","type":"[UpdateProductCategoriesStepInput](../../types/core_flows.UpdateProductCategoriesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Filter product categories based on searchable fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"The names to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string` \\| `string`[]","description":"Filter product categories by their parent category's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Filter product categories by whether they're active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Filter product categories by whether they're internal.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"Whether to include children of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"Whether to include parents of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCLine truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category iLine truncated
|
||||||
+51
@@ -0,0 +1,51 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Workflows\_Product Category
|
||||||
|
|
||||||
|
## createProductCategoriesWorkflow
|
||||||
|
|
||||||
|
This workflow creates one or more product categories.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"createProductCategoriesWorkflow","steps":[{"type":"step","name":"createProductCategoriesStep","description":"This step creates one or more product categories.","link":"../../core_flows.Steps_Product_Category/page.mdx#createproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreateProductCategoriesWorkflowInput","type":"[CreateProductCategoriesWorkflowInput](../../../types/WorkflowTypes/ProductCategoryWorkflow/interfaces/types.WorkflowTypes.ProductCategoryWorkflow.CreateProductCategoriesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"product_categories","type":"[CreateProductCategoryDTO](../../../product/interfaces/product.CreateProductCategoryDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The product category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent product category, if it has any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProductCategoriesWorkflow"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category iLine truncated
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deleteProductCategoriesWorkflow
|
||||||
|
|
||||||
|
This workflow deletes one or more product categories.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deleteProductCategoriesWorkflow","steps":[{"type":"step","name":"deleteProductCategoriesStep","description":"This step deletes one or more product categories.","link":"../../core_flows.Steps_Product_Category/page.mdx#deleteproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProductCategoriesWorkflow"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updateProductCategoriesWorkflow
|
||||||
|
|
||||||
|
This workflow updates product categories matching specified filters.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"updateProductCategoriesWorkflow","steps":[{"type":"step","name":"updateProductCategoriesStep","description":"This step updates product categories matching specified filters.","link":"../../core_flows.Steps_Product_Category/page.mdx#updateproductcategoriesstep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdateProductCategoriesWorkflowInput","type":"[UpdateProductCategoriesWorkflowInput](../../../types/WorkflowTypes/ProductCategoryWorkflow/interfaces/types.WorkflowTypes.ProductCategoryWorkflow.UpdateProductCategoriesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Filter product categories based on searchable fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"The names to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string` \\| `string`[]","description":"Filter product categories by their parent category's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"The handles to filter product categories by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Filter product categories by whether they're active.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Filter product categories by whether they're internal.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"Whether to include children of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"Whether to include parents of retrieved product categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx) \\| [BaseFilterable](../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductCategoryProps](../../../product/interfaces/product.FilterableProductCategoryProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and"Line truncated
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"ProductCategoryDTO[]","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProductCategoryDTO","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","optional":false,"defaultValue":"","description":"A product category's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category iLine truncated
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Product Category
|
||||||
|
|
||||||
|
## Namespaces
|
||||||
|
|
||||||
|
- [Steps\_Product Category](../core_flows.Steps_Product_Category/page.mdx)
|
||||||
|
- [Workflows\_Product Category](../core_flows.Workflows_Product_Category/page.mdx)
|
||||||
Reference in new issue
Block a user