docs-util: fix hook input type showing as __type (#10905)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ff725090bb
commit
a607b8e800
42 files changed
+139
-160
No files matched your search
@@ -277,226 +277,226 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/>
|
||||
|
||||
### addressesDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type-2)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesDeleted"/>
|
||||
|
||||
### addressesUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type-4)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"([CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)>)[] & [CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedAddresses","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/>
|
||||
|
||||
### campaignsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsCreated"/>
|
||||
|
||||
### campaignsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type-2)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsDeleted"/>
|
||||
|
||||
### campaignsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type-4)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"campaigns","type":"([CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)>)[] & [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCampaigns","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"[CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsUpdated"/>
|
||||
|
||||
### cartCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Cart/core_flows.Cart.Workflows_Cart/page.mdx#__type)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartCreated"/>
|
||||
|
||||
### cartUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Cart/core_flows.Cart.Workflows_Cart/page.mdx#__type-1)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartUpdated"/>
|
||||
|
||||
### collectionsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"collections","type":"([ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)>)[] & [ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"collections","type":"([ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)>)[] & [ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsCreated"/>
|
||||
|
||||
### collectionsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-15)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsDeleted"/>
|
||||
|
||||
### collectionsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-21)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]},{"name":"collections","type":"([ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)>)[] & [ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCollections","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":"__step__","type":"`string`","description":"","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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]},{"name":"collections","type":"([ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)>)[] & [ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductCollectionDTO](../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCollections","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":"__step__","type":"`string`","description":"","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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsUpdated"/>
|
||||
|
||||
### customersCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type-1)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/>
|
||||
|
||||
### customersDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type-3)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersDeleted"/>
|
||||
|
||||
### customersUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx#__type-5)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"([CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)>)[] & [CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[CustomerDTO](../../customer/interfaces/customer.CustomerDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedCustomers","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/>
|
||||
|
||||
### fulfillmentCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type-3)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","dLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optionalLine truncated
|
||||
|
||||
### orderCanceled
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type-1)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCanceled"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCanceled"/>
|
||||
|
||||
### orderCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type-4)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCreated"/>
|
||||
|
||||
### orderFulfillmentCanceled
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/>
|
||||
|
||||
### ordersCompleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type-2)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"orders","type":"([OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>)[] & [OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"completedOrders","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"orders","type":"([OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)>)[] & [OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"completedOrders","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","opLine truncated
|
||||
|
||||
### productOptionsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-1)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_options","type":"([ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)>)[] & [ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productOptions","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":"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":"__step__","type":"`string`","description":"","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":"product_id","type":"`null` \\| `string`","description":"The associated product 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 was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_options","type":"([ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)>)[] & [ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productOptions","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":"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":"__step__","type":"`string`","description":"","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":"product_id","type":"`null` \\| `string`","description":"The associated product 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 was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsCreated"/>
|
||||
|
||||
### productOptionsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-16)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsDeleted"/>
|
||||
|
||||
### productOptionsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-22)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_options","type":"([ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)>)[] & [ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductOptions","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":"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":"__step__","type":"`string`","description":"","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":"product_id","type":"`null` \\| `string`","description":"The associated product 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 was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_options","type":"([ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)>)[] & [ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductOptions","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":"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":"__step__","type":"`string`","description":"","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":"product_id","type":"`null` \\| `string`","description":"The associated product 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 was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsUpdated"/>
|
||||
|
||||
### productsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-14)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"products","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"products","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsCreated"/>
|
||||
|
||||
### productsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-20)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsDeleted"/>
|
||||
|
||||
### productsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-35)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"products","type":"([ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)>)[] & [ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProducts","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":"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,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"TLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"products","type":"([ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)>)[] & [ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductDTO](../../product/interfaces/product.ProductDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProducts","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":"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,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":trueLine truncated
|
||||
|
||||
### productTagsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-2)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_tags","type":"([ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)>)[] & [ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productTags","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_tags","type":"([ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)>)[] & [ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productTags","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsCreated"/>
|
||||
|
||||
### productTagsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-18)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsDeleted"/>
|
||||
|
||||
### productTagsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-24)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_tags","type":"([ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)>)[] & [ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductTags","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_tags","type":"([ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)>)[] & [ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTagDTO](../../product/interfaces/product.ProductTagDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductTags","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":"__step__","type":"`string`","description":"","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":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsUpdated"/>
|
||||
|
||||
### productTypesCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-3)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_types","type":"([ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)>)[] & [ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productTypes","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":"__step__","type":"`string`","description":"","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":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_types","type":"([ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)>)[] & [ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"productTypes","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":"__step__","type":"`string`","description":"","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":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesCreated"/>
|
||||
|
||||
### productTypesDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-17)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesDeleted"/>
|
||||
|
||||
### productTypesUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-23)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_types","type":"([ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)>)[] & [ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductTypes","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":"__step__","type":"`string`","description":"","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":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_types","type":"([ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)>)[] & [ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedProductTypes","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":"__step__","type":"`string`","description":"","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":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesUpdated"/>
|
||||
|
||||
### productVariantsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-12)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_variants","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_variants","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsCreated"/>
|
||||
|
||||
### productVariantsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-19)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsDeleted"/>
|
||||
|
||||
### productVariantsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Product/core_flows.Product.Workflows_Product/page.mdx#__type-33)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_variants","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product_variants","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<object[]>","description":"","optional":false,"defaultValue":"response","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsUpdated"/>
|
||||
|
||||
### promotionsCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type-1)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"createdPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsCreated"/>
|
||||
|
||||
### promotionsDeleted
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type-3)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsDeleted"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string[]> & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsDeleted"/>
|
||||
|
||||
### promotionsUpdated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Promotion/core_flows.Promotion.Workflows_Promotion/page.mdx#__type-5)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"promotions","type":"([PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)>)[] & [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)[]>","description":"","optional":false,"defaultValue":"updatedPromotions","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"The type of the promotion:\n\n- `standard` indicates that a promotion is a standard one applied with conditions.\n- `buyget` indicates that a promotion is a \"Buy X get Y\" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"[CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsUpdated"/>
|
||||
|
||||
### shipmentCreated
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[__type](../../core_flows/Order/core_flows.Order.Workflows_Order/page.mdx#__type-6)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","descLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipment","type":"`object` & [FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx) & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[FulfillmentDTO](../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optional":fLine truncated
|
||||
Reference in new issue
Block a user