chore(docs): Generated References (automated) (#13969)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
ed5e4a1ef8
commit
924d651188
496 files changed
+1070569
-1069999
No files matched your search
File diff suppressed because it is too large.
Load diff
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.
|
This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/api-key/src/models/api-key.ts#L3" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/api-key/src/models/api-key.ts#L3" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`TextProperty`","description":"The token of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salt","type":"`TextProperty`","description":"Salt used to create the API key token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`TextProperty`","description":"The redacted form of the api key's token. this is useful when showing portion of the token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<[\"publishable\", \"secret\"]>","description":"The type of the API key. Can be `secret` or `publishable`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`DateTimeProperty`","description":"The date the API key was last used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`TextProperty`","description":"The ID of the user that revoked the API key","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`DateTimeProperty`","description":"The date the API key was revoked.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKey"/>
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`TextProperty`","description":"The token of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salt","type":"`TextProperty`","description":"Salt used to create the API key token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`TextProperty`","description":"The redacted form of the api key's token. this is useful when showing portion of the token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<[\"publishable\", \"secret\"]>","description":"The type of the API key. Can be `secret` or `publishable`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`DateTimeProperty`","description":"The date the API key was last used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`TextProperty`","description":"The ID of the user that revoked the API key","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`DateTimeProperty`","description":"The date the API key was revoked.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKey"/>
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the AuthIdentity data model. It belongs to the Auth Module.
|
This documentation provides a reference to the AuthIdentity data model. It belongs to the Auth Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/auth/src/models/auth-identity.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/auth/src/models/auth-identity.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](./page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthIdentity"/>
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](./page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthIdentity"/>
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the ProviderIdentity data model. It belongs to the Auth Module.
|
This documentation provides a reference to the ProviderIdentity data model. It belongs to the Auth Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/auth/src/models/provider-identity.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/auth/src/models/provider-identity.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](./page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderIdentity"/>
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](./page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderIdentity"/>
|
||||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the Address data model. It belongs to the Cart Module.
|
This documentation provides a reference to the Address data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/address.ts#L3" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/address.ts#L3" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that the address belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The ISO 2 country code of the address. For example, `us`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Address"/>
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that the address belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The ISO 2 country code of the address. For example, `us`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Address"/>
|
||||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
|
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/cart.ts#L7" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/cart.ts#L7" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandableLine truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandableLine truncated
|
||||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the CreditLine data model. It belongs to the Cart Module.
|
This documentation provides a reference to the CreditLine data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/credit-line.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/credit-line.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProperty`","description":"The ID of the type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`TextProperty`","description":"The collection of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`TextProperty`","description":"The unique handle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","tLine truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProperty`","description":"The ID of the type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`TextProperty`","description":"The collection of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`TextProperty`","description":"The unique handle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","tLine truncated
|
||||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
|
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/line-item.ts#L6" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/line-item.ts#L6" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](./page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name"Line truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](./page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name"Line truncated
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
|
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/line-item-adjustment.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/line-item-adjustment.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](./page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,Line truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](./page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,Line truncated
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
|
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/line-item-tax-line.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/line-item-tax-line.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","typeLine truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","typeLine truncated
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
|
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/shipping-method.ts#L6" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/shipping-method.ts#L6" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProLine truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProLine truncated
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
|
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/shipping-method-adjustment.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/shipping-method-adjustment.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The shipping method adjustment's amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](../cart_models.ShippingMethodTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","Line truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The shipping method adjustment's amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](../cart_models.ShippingMethodTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","Line truncated
|
||||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
|
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/modules/cart/src/models/shipping-method-tax-line.ts#L4" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/cart/src/models/shipping-method-tax-line.ts#L4" />
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextPLine truncated
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextPLine truncated
|
||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow creates one or more API keys, which can be secret or publishable.
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
create API keys within your custom flows.
|
create API keys within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L51" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L51" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow deletes one or more secret or publishable API keys. It's used by t
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
delete API keys within your custom flows.
|
delete API keys within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L36" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L36" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow manages the sales channels of a publishable API key. It's used by
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
manage the sales channels of a publishable API key within your custom flows.
|
manage the sales channels of a publishable API key within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L39" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L39" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ This workflow is used by the [Revoke API Key API Route](https://docs.medusajs.co
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
revoke API keys within your custom flows.
|
revoke API keys within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L59" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L59" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow updates one or more secret or publishable API keys. It's used by t
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
update API keys within your custom flows.
|
update API keys within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L57" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L57" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -27,7 +27,7 @@ how to handle this event.
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
generate reset password tokens within your custom flows.
|
generate reset password tokens within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L43" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L43" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -162,8 +162,12 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createCartsStep({
|
const data = createCartsStep({
|
||||||
"currency_code": "cve"
|
"currency_code": "bsd"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = retrieveCartStep({
|
const data = retrieveCartStep({
|
||||||
"id": "id_6yfdwvd7Ql5VCMXKbx"
|
"id": "id_vqxFXLlF21ft"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = updateCartPromotionsStep({
|
const data = updateCartPromotionsStep({
|
||||||
"id": "id_rjYDM9OtxDGnbG1FBd"
|
"id": "id_xCs4eq5YhmB7"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+5
-1
@@ -28,7 +28,7 @@ This workflow adds a shipping method to a cart. It's executed by the
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart.
|
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts#L83" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts#L83" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -215,8 +215,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+5
-1
@@ -30,7 +30,7 @@ This workflow adds a product variant to a cart as a line item. It's executed by
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding an item to the cart.
|
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding an item to the cart.
|
||||||
For example, you can use this workflow to add a line item to the cart with a custom price.
|
For example, you can use this workflow to add a line item to the cart with a custom price.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/add-to-cart.ts#L114" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/add-to-cart.ts#L114" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -272,8 +272,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+5
-1
@@ -28,7 +28,7 @@ You can use this workflow within your own customizations or custom workflows, al
|
|||||||
For example, in the [Subscriptions recipe](https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard#create-workflow),
|
For example, in the [Subscriptions recipe](https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard#create-workflow),
|
||||||
this workflow is used within another workflow that creates a subscription order.
|
this workflow is used within another workflow that creates a subscription order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/complete-cart.ts#L93" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/complete-cart.ts#L93" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -179,8 +179,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -27,7 +27,7 @@ Learn more about the links between the product variant and sales channels and in
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to check whether a product variant has enough inventory quantity before adding them to the cart.
|
You can use this workflow within your own customizations or custom workflows, allowing you to check whether a product variant has enough inventory quantity before adding them to the cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/confirm-variant-inventory.ts#L147" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/confirm-variant-inventory.ts#L147" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createCartCreditLinesWorkflow`.
|
|||||||
|
|
||||||
This workflow creates one or more credit lines for a cart.
|
This workflow creates one or more credit lines for a cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/create-cart-credit-lines.ts#L31" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/create-cart-credit-lines.ts#L31" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -31,7 +31,7 @@ This workflow has a hook that allows you to perform custom actions on the create
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around cart creation.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around cart creation.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/create-carts.ts#L111" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/create-carts.ts#L111" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -292,8 +292,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow creates a payment collection for a cart. It's executed by the
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding creating a payment collection for a cart.
|
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding creating a payment collection for a cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/create-payment-collection-for-cart.ts#L84" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/create-payment-collection-for-cart.ts#L84" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteCartCreditLinesWorkflow`.
|
|||||||
|
|
||||||
This workflow deletes one or more credit lines from a cart.
|
This workflow deletes one or more credit lines from a cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/delete-cart-credit-lines.ts#L13" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/delete-cart-credit-lines.ts#L13" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ export async function POST(
|
|||||||
.run({
|
.run({
|
||||||
input: {
|
input: {
|
||||||
"id": [
|
"id": [
|
||||||
"id_gAPA9szKeYhiObNji4"
|
"id_YFpjfEkPM2UM"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -63,7 +63,7 @@ export default async function handleOrderPlaced({
|
|||||||
.run({
|
.run({
|
||||||
input: {
|
input: {
|
||||||
"id": [
|
"id": [
|
||||||
"id_gAPA9szKeYhiObNji4"
|
"id_YFpjfEkPM2UM"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -90,7 +90,7 @@ export default async function myCustomJob(
|
|||||||
.run({
|
.run({
|
||||||
input: {
|
input: {
|
||||||
"id": [
|
"id": [
|
||||||
"id_gAPA9szKeYhiObNji4"
|
"id_YFpjfEkPM2UM"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -118,7 +118,7 @@ const myWorkflow = createWorkflow(
|
|||||||
.runAsStep({
|
.runAsStep({
|
||||||
input: {
|
input: {
|
||||||
"id": [
|
"id": [
|
||||||
"id_gAPA9szKeYhiObNji4"
|
"id_YFpjfEkPM2UM"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ price of the shipping method being added to the cart.
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to retrieve the shipping options of a cart and their prices
|
You can use this workflow within your own customizations or custom workflows, allowing you to retrieve the shipping options of a cart and their prices
|
||||||
in your custom flows.
|
in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts#L126" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts#L126" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -25,7 +25,7 @@ use the [listShippingOptionsForCartWithPricingWorkflow](../core_flows.Cart.Workf
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of a cart
|
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of a cart
|
||||||
in your custom flows.
|
in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart.ts#L134" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart.ts#L134" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -31,7 +31,7 @@ is added to the cart.
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart after making updates to it in your
|
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart after making updates to it in your
|
||||||
custom flows.
|
custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts#L118" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts#L118" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"refreshCartItemsWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":1},{"type":"hook","name":"setPricingContext","description":"This hook is executed after the order is retrieved and before the line items are created. You can consume this hook to return any custom context useful for the prices retrieval of the variants to be added to the order.\n\nFor example, assuming you have the following custom pricing rule:\n\n```json\n{\n \"attribute\": \"location_id\",\n \"operator\": \"eq\",\n \"value\": \"sloc_123\",\n}\n```\n\nYou can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:\n\n```ts\nimport { addOrderLineItemsWorkflow } from \"@medusajs/medusa/core-flows\";\nimport { StepResponse } from \"@medusajs/workflows-sdk\";\n\naddOrderLineItemsWorkflow.hooks.setPricingContext((\n { order, variantIds, region, customerData, additional_data }, { container }\n) => {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":3}]},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":4},{"type":"workflow","name":"refreshCartShippingMethodsWorkflow","description":"Refresh a cart's shipping methods after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx","depth":5},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"6","steps":[{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":6}]},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":8},{"type":"hook","name":"beforeRefreshingPaymentCollection","description":"","link":"#beforeRefreshingPaymentCollection","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":10},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":11}]}} />
|
<WorkflowDiagram workflow={{"name":"refreshCartItemsWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":1},{"type":"hook","name":"setPricingContext","description":"This hook is executed after the order is retrieved and before the line items are created. You can consume this hook to return any custom context useful for the prices retrieval of the variants to be added to the order.\n\nFor example, assuming you have the following custom pricing rule:\n\n```json\n{\n \"attribute\": \"location_id\",\n \"operator\": \"eq\",\n \"value\": \"sloc_123\",\n}\n```\n\nYou can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:\n\n```ts\nimport { addOrderLineItemsWorkflow } from \"@medusajs/medusa/core-flows\";\nimport { StepResponse } from \"@medusajs/workflows-sdk\";\n\naddOrderLineItemsWorkflow.hooks.setPricingContext((\n { order, variantIds, region, customerData, additional_data }, { container }\n) => {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":3}]},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":4},{"type":"workflow","name":"refreshCartShippingMethodsWorkflow","description":"Refresh a cart's shipping methods after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx","depth":5},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"6","steps":[{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":6}]},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":8},{"type":"hook","name":"beforeRefreshingPaymentCollection","description":"","link":"#beforeRefreshingPaymentCollection","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":10},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":11}]}} />
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -20,7 +20,7 @@ and retrieve their correct pricing after a cart update. This workflow is used by
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's shipping method after making updates to the cart.
|
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's shipping method after making updates to the cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/refresh-cart-shipping-methods.ts#L54" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/refresh-cart-shipping-methods.ts#L54" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"refreshCartShippingMethodsWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":2},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":3},{"type":"when","condition":"{\n return !!listShippingOptionsInput?.length\n }","depth":"4","steps":[{"type":"workflow","name":"listShippingOptionsForCartWithPricingWorkflow","description":"List a cart's shipping options with prices.","link":"../core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx","depth":4},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":4},{"type":"step","name":"updateShippingMethodsStep","description":"This step updates a cart's shipping methods.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateShippingMethodsStep/page.mdx","depth":4},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":4}]}]}} />
|
<WorkflowDiagram workflow={{"name":"refreshCartShippingMethodsWorkflow","steps":[{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":2},{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":3},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":4},{"type":"when","condition":"{\n return !!listShippingOptionsInput?.length\n }","depth":"5","steps":[{"type":"workflow","name":"listShippingOptionsForCartWithPricingWorkflow","description":"List a cart's shipping options with prices.","link":"../core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx","depth":5},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":5},{"type":"step","name":"updateShippingMethodsStep","description":"This step updates a cart's shipping methods.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateShippingMethodsStep/page.mdx","depth":5},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":5}]}]}} />
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -25,7 +25,7 @@ payment collection after an update.
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's payment collection after making updates to it in your
|
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's payment collection after making updates to it in your
|
||||||
custom flows.
|
custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/refresh-payment-collection.ts#L57" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/refresh-payment-collection.ts#L58" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":2},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":3},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return shouldExecute\n }","depth":"4","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"Delete payment sessions.","link":"../../../../Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx","depth":4},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../../../Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx","depth":4}]},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":5}]}} />
|
<WorkflowDiagram workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":2},{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":3},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":4},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return shouldExecute\n }","depth":"5","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"Delete payment sessions.","link":"../../../../Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx","depth":5},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../../../Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx","depth":5}]},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":6}]}} />
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
|
|||||||
+5
-5
@@ -18,7 +18,7 @@ This documentation provides a reference to the `refundPaymentAndRecreatePaymentS
|
|||||||
|
|
||||||
This workflow refunds a payment and creates a new payment session.
|
This workflow refunds a payment and creates a new payment session.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/refund-payment-recreate-payment-session.ts#L67" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/refund-payment-recreate-payment-session.ts#L67" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -43,7 +43,7 @@ export async function POST(
|
|||||||
"payment_collection_id": "{value}",
|
"payment_collection_id": "{value}",
|
||||||
"provider_id": "{value}",
|
"provider_id": "{value}",
|
||||||
"payment_id": "{value}",
|
"payment_id": "{value}",
|
||||||
"amount": 45
|
"amount": 19
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ export default async function handleOrderPlaced({
|
|||||||
"payment_collection_id": "{value}",
|
"payment_collection_id": "{value}",
|
||||||
"provider_id": "{value}",
|
"provider_id": "{value}",
|
||||||
"payment_id": "{value}",
|
"payment_id": "{value}",
|
||||||
"amount": 45
|
"amount": 19
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -101,7 +101,7 @@ export default async function myCustomJob(
|
|||||||
"payment_collection_id": "{value}",
|
"payment_collection_id": "{value}",
|
||||||
"provider_id": "{value}",
|
"provider_id": "{value}",
|
||||||
"payment_id": "{value}",
|
"payment_id": "{value}",
|
||||||
"amount": 45
|
"amount": 19
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"payment_collection_id": "{value}",
|
"payment_collection_id": "{value}",
|
||||||
"provider_id": "{value}",
|
"provider_id": "{value}",
|
||||||
"payment_id": "{value}",
|
"payment_id": "{value}",
|
||||||
"amount": 45
|
"amount": 19
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-1
@@ -29,7 +29,7 @@ by the [Set Cart's Customer Store API Route](https://docs.medusajs.com/api/store
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to set the cart's customer within your custom flows.
|
You can use this workflow within your own customizations or custom workflows, allowing you to set the cart's customer within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/transfer-cart-customer.ts#L54" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/transfer-cart-customer.ts#L54" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -180,8 +180,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+2
-2
@@ -24,7 +24,7 @@ that need to be applied to the cart's line items and shipping methods based on t
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's promotions within your custom flows.
|
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's promotions within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/update-cart-promotions.ts#L76" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/update-cart-promotions.ts#L77" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -145,7 +145,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":2},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":3},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx","depth":4},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx","depth":5},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx","depth":6},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeLineItemAdjustmentsStep/page.mdx","depth":7},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx","depth":7},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart, such as when a promotion is applied.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemAdjustmentsStep/page.mdx","depth":7},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx","depth":7},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx","depth":7},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":8}]}} />
|
<WorkflowDiagram workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":2},{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":3},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":4},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx","depth":5},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx","depth":6},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx","depth":7},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeLineItemAdjustmentsStep/page.mdx","depth":8},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx","depth":8},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart, such as when a promotion is applied.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemAdjustmentsStep/page.mdx","depth":8},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx","depth":8},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx","depth":8},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":9}]}} />
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
|
|||||||
+6
-2
@@ -38,7 +38,7 @@ then update any associated details related to the cart in the workflow's hook.
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating a cart.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating a cart.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/update-cart.ts#L81" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/update-cart.ts#L82" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":1},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":2},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx","depth":3},{"type":"step","name":"findOrCreateCustomerStep","description":"This step finds or creates a customer based on the provided ID or email. It prioritizes finding the customer by ID, then by email.\n\nThe step creates a new customer either if:\n\n- No customer is found with the provided ID and email;\n- Or if it found the customer by ID but their email does not match the email in the input.\n\nThe step returns the details of the customer found or created, along with their email.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":3},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"4","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":4}]},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":5},{"type":"when","condition":"{\n return !!regionUpdated\n }","depth":"6","steps":[{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":6}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartsStep/page.mdx","depth":7},{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":7},{"type":"when","condition":"{\n return !!regionUpdated\n }","depth":"8","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":8},{"type":"step","name":"deleteLineItemsStep","description":"This step deletes line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.deleteLineItemsStep/page.mdx","depth":8}]},{"type":"workflow","name":"refreshCartItemsWorkflow","description":"Refresh a cart's details after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx","depth":9},{"type":"hook","name":"cartUpdated","description":"","link":"#cartUpdated","depth":10},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. LLine truncated
|
<WorkflowDiagram workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":1},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":2},{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":3},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx","depth":4},{"type":"step","name":"findOrCreateCustomerStep","description":"This step finds or creates a customer based on the provided ID or email. It prioritizes finding the customer by ID, then by email.\n\nThe step creates a new customer either if:\n\n- No customer is found with the provided ID and email;\n- Or if it found the customer by ID but their email does not match the email in the input.\n\nThe step returns the details of the customer found or created, along with their email.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":4},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"5","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":5}]},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":6},{"type":"when","condition":"{\n return !!regionUpdated\n }","depth":"7","steps":[{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":7}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartsStep/page.mdx","depth":8},{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":8},{"type":"when","condition":"{\n return !!regionUpdated\n }","depth":"9","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":9},{"type":"step","name":"deleteLineItemsStep","description":"This step deletes line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.StepsLine truncated
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
@@ -259,8 +259,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+5
-1
@@ -30,7 +30,7 @@ This workflow is executed by the [Update Line Item Store API Route](https://docs
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to update a line item's details in your custom flows.
|
You can use this workflow within your own customizations or custom workflows, allowing you to update a line item's details in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/update-line-item-in-cart.ts#L111" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/update-line-item-in-cart.ts#L111" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -248,8 +248,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+2
-2
@@ -20,7 +20,7 @@ by the [Calculate Taxes Store API Route](https://docs.medusajs.com/api/store#car
|
|||||||
|
|
||||||
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's tax lines in your custom flows.
|
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's tax lines in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/cart/workflows/update-tax-lines.ts#L124" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/cart/workflows/update-tax-lines.ts#L124" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
<WorkflowDiagram workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":2},{"type":"step","name":"getItemTaxLinesStep","description":"This step retrieves the tax lines for an order or cart's line items and shipping methods.\n\n:::note\n\nYou can retrieve an order, cart, item, shipping method, and address details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),\nor [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).\n\n:::","link":"../../../../Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx","depth":3},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.setTaxLinesForItemsStep/page.mdx","depth":4},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":5}]}} />
|
<WorkflowDiagram workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"validateCartStep","description":"This step validates a cart to ensure it exists and is not completed.\nIf not valid, the step throws an error.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartStep/page.mdx","depth":2},{"type":"step","name":"acquireLockStep","description":"This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx","depth":3},{"type":"step","name":"getItemTaxLinesStep","description":"This step retrieves the tax lines for an order or cart's line items and shipping methods.\n\n:::note\n\nYou can retrieve an order, cart, item, shipping method, and address details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),\nor [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).\n\n:::","link":"../../../../Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx","depth":4},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.\n\n:::tip\n\nYou can use the [retrieveCartStep](../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx) to retrieve a cart's details.\n\n:::","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.setTaxLinesForItemsStep/page.mdx","depth":5},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":6}]}} />
|
||||||
|
|
||||||
## Input
|
## Input
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ manage links within your custom flows.
|
|||||||
|
|
||||||
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/common/workflows/batch-links.ts#L70" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/common/workflows/batch-links.ts#L70" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ create links within your custom flows.
|
|||||||
|
|
||||||
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/common/workflows/create-links.ts#L38" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/common/workflows/create-links.ts#L38" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ dismiss links within your custom flows.
|
|||||||
|
|
||||||
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/common/workflows/dismiss-links.ts#L38" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/common/workflows/dismiss-links.ts#L38" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ update links within your custom flows.
|
|||||||
|
|
||||||
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/common/workflows/update-links.ts#L43" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/common/workflows/update-links.ts#L43" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -24,7 +24,7 @@ Learn more about basic authentication flows in [this documentation](https://docs
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
register or create customer accounts within your custom flows.
|
register or create customer accounts within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/create-customer-account.ts#L54" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/create-customer-account.ts#L54" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -167,8 +167,12 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ allows you to create custom data models linked to the addresses.
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customer addresses.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customer addresses.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/create-addresses.ts#L75" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/create-addresses.ts#L75" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -20,7 +20,7 @@ This workflow has a hook that allows you to perform custom actions on the create
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customers.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customers.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/create-customers.ts#L57" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/create-customers.ts#L57" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -199,8 +199,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -28,7 +28,7 @@ relevant to that module.
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
delete customer addresses in your custom flows.
|
delete customer addresses in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/delete-addresses.ts#L52" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/delete-addresses.ts#L52" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -20,7 +20,7 @@ This workflow deletes one or more customers. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
delete customers in your custom flows.
|
delete customers in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/delete-customers.ts#L46" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/delete-customers.ts#L46" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -175,8 +175,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+5
-1
@@ -29,7 +29,7 @@ custom actions after the customers are deleted.
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/remove-customer-account.ts#L43" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/remove-customer-account.ts#L43" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -152,8 +152,12 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ allows you to update custom data models linked to the addresses.
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customer addresses.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customer addresses.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/update-addresses.ts#L66" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/update-addresses.ts#L66" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -22,7 +22,7 @@ custom data models linked to the customers.
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customers.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customers.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer/workflows/update-customers.ts#L60" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer/workflows/update-customers.ts#L60" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -193,8 +193,12 @@ Handlers consuming this hook accept the following input.
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createCustomerGroupsStep({
|
const data = createCustomerGroupsStep({
|
||||||
"name": "Lurline"
|
"name": "Gladys"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ You can use this workflow within your customizations or your own custom workflow
|
|||||||
create customer groups within your custom flows. For example, you can create customer groups to segregate
|
create customer groups within your custom flows. For example, you can create customer groups to segregate
|
||||||
customers by age group or purchase habits.
|
customers by age group or purchase habits.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer-group/workflows/create-customer-groups.ts#L52" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer-group/workflows/create-customer-groups.ts#L52" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow deletes one or more customer groups. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
delete customer groups within your custom flows.
|
delete customer groups within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer-group/workflows/delete-customer-groups.ts#L34" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer-group/workflows/delete-customer-groups.ts#L34" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow manages the customer groups a customer is in. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
manage the customer groups of a customer in your custom flow.
|
manage the customer groups of a customer in your custom flow.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer-group/workflows/link-customer-groups-customer.ts#L37" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer-group/workflows/link-customer-groups-customer.ts#L37" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow manages the customers of a customer group. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
manage the customers of a customer group within your custom flows.
|
manage the customers of a customer group within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer-group/workflows/link-customers-customer-group.ts#L37" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer-group/workflows/link-customers-customer-group.ts#L37" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow updates one or more customer groups. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
update customer groups within your custom flows.
|
update customer groups within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/customer-group/workflows/update-customer-groups.ts#L57" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/customer-group/workflows/update-customer-groups.ts#L57" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ to create the default data, if not existing, when the application is first start
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
create default data within your custom flows, such as seed scripts.
|
create default data within your custom flows, such as seed scripts.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/defaults/workflows/create-defaults.ts#L25" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/defaults/workflows/create-defaults.ts#L25" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ This workflow adds items to a draft order. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
|
||||||
a draft order.
|
a draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/add-draft-order-items.ts#L55" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/add-draft-order-items.ts#L55" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow adds promotions to a draft order. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding promotions to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding promotions to
|
||||||
a draft order.
|
a draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/add-draft-order-promotions.ts#L64" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/add-draft-order-promotions.ts#L64" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ This workflow adds shipping methods to a draft order. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding shipping methods to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding shipping methods to
|
||||||
a draft order.
|
a draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/add-draft-order-shipping-methods.ts#L100" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/add-draft-order-shipping-methods.ts#L100" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ The draft order edit can later be requested using [requestDraftOrderEditWorkflow
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
creating a draft order edit request.
|
creating a draft order edit request.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/begin-draft-order-edit.ts#L36" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/begin-draft-order-edit.ts#L36" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow cancels a draft order edit. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
cancelling a draft order edit.
|
cancelling a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/cancel-draft-order-edit.ts#L53" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/cancel-draft-order-edit.ts#L53" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ This workflow confirms a draft order edit. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
confirming a draft order edit.
|
confirming a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/confirm-draft-order-edit.ts#L49" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/confirm-draft-order-edit.ts#L49" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = convertDraftOrderStep({
|
const data = convertDraftOrderStep({
|
||||||
"id": "id_VOj1WBZhvs6"
|
"id": "id_qFJrgEOwuVjcnZ90"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+5
-1
@@ -20,7 +20,7 @@ This workflow converts a draft order to a pending order. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
converting a draft order to a pending order.
|
converting a draft order to a pending order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/convert-draft-order.ts#L99" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/convert-draft-order.ts#L99" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -143,8 +143,12 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -18,7 +18,7 @@ This workflow deletes draft orders. It's used by the [Delete Draft Order API rou
|
|||||||
|
|
||||||
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a draft order.
|
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/delete-draft-order.ts#L59" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/delete-draft-order.ts#L59" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow removes an item that was added or updated in a draft order edit. I
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
removing an item from a draft order edit.
|
removing an item from a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-action-item.ts#L49" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-action-item.ts#L49" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow removes a shipping method that was added to an edited draft order.
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
removing a shipping method from an edited draft order.
|
removing a shipping method from an edited draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-action-shipping-method.ts#L53" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-action-shipping-method.ts#L53" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow removes promotions from a draft order edit. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
removing promotions from a draft order edit.
|
removing promotions from a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-promotions.ts#L65" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-promotions.ts#L65" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow removes an existing shipping method from a draft order edit. It's
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
removing a shipping method from a draft order edit.
|
removing a shipping method from a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-shipping-method.ts#L61" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/remove-draft-order-shipping-method.ts#L61" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ This workflow requests a draft order edit. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
requesting a draft order edit.
|
requesting a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/request-draft-order-edit.ts#L72" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/request-draft-order-edit.ts#L72" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow updates a new item that was added to a draft order edit. It's used
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
updating a new item in a draft order edit.
|
updating a new item in a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/update-draft-order-action-item.ts#L52" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/update-draft-order-action-item.ts#L52" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow updates a new shipping method that was added to a draft order edit
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
updating a new shipping method in a draft order edit.
|
updating a new shipping method in a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/update-draft-order-action-shipping-method.ts#L57" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/update-draft-order-action-shipping-method.ts#L57" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow updates an item in a draft order edit. It's used by the
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
updating an item in a draft order edit.
|
updating an item in a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/update-draft-order-item.ts#L54" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/update-draft-order-item.ts#L54" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ This workflow updates an existing shipping method in a draft order edit. It's us
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
updating an existing shipping method in a draft order edit.
|
updating an existing shipping method in a draft order edit.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/update-draft-order-shipping-method.ts#L84" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/update-draft-order-shipping-method.ts#L84" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+5
-1
@@ -26,7 +26,7 @@ using [requestDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
|
||||||
updating a draft order.
|
updating a draft order.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/draft-order/workflows/update-draft-order.ts#L150" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/draft-order/workflows/update-draft-order.ts#L150" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -157,8 +157,12 @@ const myWorkflow = createWorkflow(
|
|||||||
|
|
||||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||||
|
|
||||||
<Table>
|
<Table>
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ in your application will be used to delete the file from storage.
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
delete files within your custom flows.
|
delete files within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/file/workflows/delete-files.ts#L29" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/file/workflows/delete-files.ts#L29" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow uploads one or more files using the installed
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
You can use this workflow within your customizations or your own custom workflows, allowing you to
|
||||||
upload files within your custom flows.
|
upload files within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/file/workflows/upload-files.ts#L72" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/file/workflows/upload-files.ts#L72" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createFulfillmentSets({
|
const data = createFulfillmentSets({
|
||||||
"name": "Georgette",
|
"name": "Brycen",
|
||||||
"type": "{value}"
|
"type": "{value}"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createServiceZonesStep({
|
const data = createServiceZonesStep({
|
||||||
"name": "Frederik",
|
"name": "Maurine",
|
||||||
"fulfillment_set_id": "{value}"
|
"fulfillment_set_id": "{value}"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+3
-3
@@ -29,10 +29,10 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createShippingOptionsPriceSetsStep({
|
const data = createShippingOptionsPriceSetsStep({
|
||||||
"id": "id_igIfRnKlKVxul",
|
"id": "id_WxVGsrn6QHbcGEo8",
|
||||||
"prices": [{
|
"prices": [{
|
||||||
"currency_code": "kpw",
|
"currency_code": "ugx",
|
||||||
"amount": 7
|
"amount": 3
|
||||||
}]
|
}]
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
|||||||
"my-workflow",
|
"my-workflow",
|
||||||
() => {
|
() => {
|
||||||
const data = createShippingProfilesStep({
|
const data = createShippingProfilesStep({
|
||||||
"name": "Hipolito",
|
"name": "Torrance",
|
||||||
"type": "{value}"
|
"type": "{value}"
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
|||||||
() => {
|
() => {
|
||||||
const data = deleteShippingOptionRulesStep({
|
const data = deleteShippingOptionRulesStep({
|
||||||
"ids": [
|
"ids": [
|
||||||
"id_iGJwjksg6XRrH"
|
"id_27FheOVU8Am6b"
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow manages shipping option rules allowing you to create, update, or d
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
manage shipping option rules within your custom flows.
|
manage shipping option rules within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/batch-shipping-option-rules.ts#L76" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/batch-shipping-option-rules.ts#L76" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -26,7 +26,7 @@ This depends on the implementation of the fulfillment provider associated with t
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
calculate the prices of shipping options within your custom flows.
|
calculate the prices of shipping options within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/calculate-shipping-options-prices.ts#L49" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/calculate-shipping-options-prices.ts#L49" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow cancels a fulfillment. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
cancel a fulfillment within your custom flows.
|
cancel a fulfillment within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/cancel-fulfillment.ts#L34" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/cancel-fulfillment.ts#L34" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -26,7 +26,7 @@ or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-wor
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-fulfillment.ts#L64" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-fulfillment.ts#L64" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -26,7 +26,7 @@ or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-wor
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts#L65" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts#L65" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow creates one or more service zones. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
create service zones within your custom flows.
|
create service zones within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-service-zones.ts#L48" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-service-zones.ts#L48" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow creates shipments for a fulfillment. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
create shipments within your custom flows.
|
create shipments within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-shipment.ts#L38" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-shipment.ts#L38" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -21,7 +21,7 @@ This workflow creates one or more shipping options. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
create shipping options within your custom flows.
|
create shipping options within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L100" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L100" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow creates one or more shipping profiles. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
create shipping profiles within your custom flows.
|
create shipping profiles within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/create-shipping-profiles.ts#L35" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/create-shipping-profiles.ts#L35" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow deletes one or more fulfillment sets. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
delete fulfillment sets within your custom flows.
|
delete fulfillment sets within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/delete-fulfillment-sets.ts#L37" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/delete-fulfillment-sets.ts#L37" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow deletes one or more service zones. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
delete service zones within your custom flows.
|
delete service zones within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/delete-service-zones.ts#L34" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/delete-service-zones.ts#L34" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -20,7 +20,7 @@ This workflow deletes one or more shipping options. It's used by the
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
delete shipping options within your custom flows.
|
delete shipping options within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/delete-shipping-options.ts#L27" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/delete-shipping-options.ts#L27" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ This workflow marks a fulfillment as delivered. It's used by the markOrderFulfil
|
|||||||
You can use this workflow within your customizations or your own custom workflows, allowing you
|
You can use this workflow within your customizations or your own custom workflows, allowing you
|
||||||
to mark a fulfillment as delivered in your custom flows.
|
to mark a fulfillment as delivered in your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/mark-fulfillment-as-delivered.ts#L84" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/mark-fulfillment-as-delivered.ts#L84" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@ fulfillment, such as [markFulfillmentAsDeliveredWorkflow](../core_flows.Fulfillm
|
|||||||
You can use this workflow within your own customizations or custom workflows, allowing you to
|
You can use this workflow within your own customizations or custom workflows, allowing you to
|
||||||
update a fulfillment within your custom flows.
|
update a fulfillment within your custom flows.
|
||||||
|
|
||||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/96b2df170752a0d66628a84c46397a24ca9502da/packages/core/core-flows/src/fulfillment/workflows/update-fulfillment.ts#L30" />
|
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/core/core-flows/src/fulfillment/workflows/update-fulfillment.ts#L30" />
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
Loaded 100 of 496 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user