docs: add additional data description in generated references (#10944)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
1b86c17b72
commit
2a2b387bc3
917 files changed
+15807
-15158
No files matched your search
File diff suppressed because it is too large.
Load diff
+3
-3
@@ -23,9 +23,9 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = createApiKeysStep({
|
||||
"api_keys": [{
|
||||
"title": "taedium",
|
||||
"type": "publishable",
|
||||
"created_by": "user_9GIqV2ijVCcadE"
|
||||
"title": "acervus",
|
||||
"type": "secret",
|
||||
"created_by": "user_VvjemccZRm1P9fT0"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = linkSalesChannelsToApiKeyStep({
|
||||
"id": "id_gs4SG6qHNzu7i7vl"
|
||||
"id": "id_lIAGOo3vxm"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -34,7 +34,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RevokeApiKeysStepInput","type":"[RevokeApiKeysStepInput](../../../../types/core_flows.RevokeApiKeysStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfaces/api_key.BLine truncated
|
||||
<TypeList types={[{"name":"RevokeApiKeysStepInput","type":"[RevokeApiKeysStepInput](../../../../types/core_flows.RevokeApiKeysStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfaces/api_key.BLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateApiKeysStepInput","type":"[UpdateApiKeysStepInput](../../../../types/core_flows.UpdateApiKeysStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfaces/api_key.BLine truncated
|
||||
<TypeList types={[{"name":"UpdateApiKeysStepInput","type":"[UpdateApiKeysStepInput](../../../../types/core_flows.UpdateApiKeysStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfaces/api_key.BLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+13
-13
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createApiKeysWorkflow`. It belon
|
||||
|
||||
This workflow creates one or more API keys.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L15" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/create-api-keys.ts#L15" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,9 +30,9 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"api_keys": [{
|
||||
"title": "pecto",
|
||||
"type": "secret",
|
||||
"created_by": "user_ZZyesoXDHhRHvJy"
|
||||
"title": "subvenio",
|
||||
"type": "publishable",
|
||||
"created_by": "user_lFoawrDa6j3BQZPV"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -58,9 +58,9 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"api_keys": [{
|
||||
"title": "pecto",
|
||||
"type": "secret",
|
||||
"created_by": "user_ZZyesoXDHhRHvJy"
|
||||
"title": "subvenio",
|
||||
"type": "publishable",
|
||||
"created_by": "user_lFoawrDa6j3BQZPV"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -87,9 +87,9 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"api_keys": [{
|
||||
"title": "pecto",
|
||||
"type": "secret",
|
||||
"created_by": "user_ZZyesoXDHhRHvJy"
|
||||
"title": "subvenio",
|
||||
"type": "publishable",
|
||||
"created_by": "user_lFoawrDa6j3BQZPV"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -116,9 +116,9 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"api_keys": [{
|
||||
"title": "pecto",
|
||||
"type": "secret",
|
||||
"created_by": "user_ZZyesoXDHhRHvJy"
|
||||
"title": "subvenio",
|
||||
"type": "publishable",
|
||||
"created_by": "user_lFoawrDa6j3BQZPV"
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `deleteApiKeysWorkflow`. It belon
|
||||
|
||||
This workflow deletes one or more API keys.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L12" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts#L12" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_JpTj1834b6"
|
||||
"id_oAdfP14QUoqh"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_JpTj1834b6"
|
||||
"id_oAdfP14QUoqh"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -84,7 +84,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_JpTj1834b6"
|
||||
"id_oAdfP14QUoqh"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -111,7 +111,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_JpTj1834b6"
|
||||
"id_oAdfP14QUoqh"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflo
|
||||
|
||||
This workflow links sales channels to API keys.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = linkSalesChannelsToApiKeyWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_mVzQuMhmHQ8q1iF"
|
||||
"id": "id_fzIS54SNGIfmYj8Ad"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -54,7 +54,7 @@ export async function POST(
|
||||
const { result } = await linkSalesChannelsToApiKeyWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_mVzQuMhmHQ8q1iF"
|
||||
"id": "id_fzIS54SNGIfmYj8Ad"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -79,7 +79,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_mVzQuMhmHQ8q1iF"
|
||||
"id": "id_fzIS54SNGIfmYj8Ad"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -104,7 +104,7 @@ export default async function myCustomJob(
|
||||
const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_mVzQuMhmHQ8q1iF"
|
||||
"id": "id_fzIS54SNGIfmYj8Ad"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ This documentation provides a reference to the `revokeApiKeysWorkflow`. It belon
|
||||
|
||||
This workflow revokes one or more API keys.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -137,7 +137,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RevokeApiKeysWorkflowInput","type":"[RevokeApiKeysWorkflowInput](../../../../types/core_flows.RevokeApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfacLine truncated
|
||||
<TypeList types={[{"name":"RevokeApiKeysWorkflowInput","type":"[RevokeApiKeysWorkflowInput](../../../../types/core_flows.RevokeApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfacLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateApiKeysWorkflow`. It belon
|
||||
|
||||
This workflow creates one or more API keys.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/api-key/workflows/update-api-keys.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -129,7 +129,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateApiKeysWorkflowInput","type":"[UpdateApiKeysWorkflowInput](../../../../types/core_flows.UpdateApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfacLine truncated
|
||||
<TypeList types={[{"name":"UpdateApiKeysWorkflowInput","type":"[UpdateApiKeysWorkflowInput](../../../../types/core_flows.UpdateApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx)","description":"The filters to apply on the retrieved API keys.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through the api key names and redacted keys using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string` \\| `string`[]","description":"The tokens to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"The titles to filter the API keys by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"Filter the API keys by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"[OperatorMap](../../../../../api_key/types/api_key.OperatorMap/page.mdx)<null \\| Date>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../api_key/types/api_key.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../api_key/types/api_key.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableApiKeyProps](../../../../../api_key/interfaces/api_key.FilterableApiKeyProps/page.mdx) \\| [BaseFilterable](../../../../../api_key/interfacLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+2
-2
@@ -23,9 +23,9 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = addShippingMethodToCartStep({
|
||||
"shipping_methods": [{
|
||||
"name": "Napoleon",
|
||||
"name": "Emory",
|
||||
"cart_id": "{value}",
|
||||
"amount": 8
|
||||
"amount": 46
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+2
-2
@@ -24,9 +24,9 @@ const myWorkflow = createWorkflow(
|
||||
const data = confirmInventoryStep({
|
||||
"items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"required_quantity": 23,
|
||||
"required_quantity": 48,
|
||||
"allow_backorder": true,
|
||||
"quantity": 37,
|
||||
"quantity": 33,
|
||||
"location_ids": [
|
||||
"{value}"
|
||||
]
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
const data = createLineItemAdjustmentsStep({
|
||||
"lineItemAdjustmentsToCreate": [{
|
||||
"code": "{value}",
|
||||
"amount": 10,
|
||||
"amount": 27,
|
||||
"item_id": "{value}"
|
||||
}]
|
||||
})
|
||||
|
||||
+4
-4
@@ -22,11 +22,11 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createLineItemsStep({
|
||||
"id": "id_iQU9pzB53YHRh",
|
||||
"id": "id_Qz07MRX126D4QhT",
|
||||
"items": [{
|
||||
"title": "vulgivagus",
|
||||
"quantity": 33,
|
||||
"unit_price": 12,
|
||||
"title": "bardus",
|
||||
"quantity": 11,
|
||||
"unit_price": 8,
|
||||
"cart_id": "{value}"
|
||||
}]
|
||||
})
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
const data = createPaymentCollectionsStep([{
|
||||
"region_id": "{value}",
|
||||
"currency_code": "{value}",
|
||||
"amount": 8
|
||||
"amount": 44
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@ const myWorkflow = createWorkflow(
|
||||
"shippingMethodAdjustmentsToCreate": [{
|
||||
"shipping_method_id": "{value}",
|
||||
"code": "{value}",
|
||||
"amount": 13
|
||||
"amount": 34
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+39
-39
@@ -24,73 +24,73 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = getActionsToComputeFromPromotionsStep({
|
||||
"cart": {
|
||||
"id": "id_zptDVH0xHA9lBDu",
|
||||
"id": "id_QqBWCiL5Mq0aqsfLRiM",
|
||||
"currency_code": "{value}",
|
||||
"original_item_total": {
|
||||
"numeric": 50
|
||||
"numeric": 41
|
||||
},
|
||||
"original_item_subtotal": {
|
||||
"numeric": 36
|
||||
"numeric": 3
|
||||
},
|
||||
"original_item_tax_total": {
|
||||
"numeric": 36
|
||||
"numeric": 45
|
||||
},
|
||||
"item_total": {
|
||||
"numeric": 43
|
||||
"numeric": 37
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 49
|
||||
"numeric": 41
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 38
|
||||
"numeric": 19
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 0
|
||||
"numeric": 30
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 12
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 11
|
||||
},
|
||||
"total": {
|
||||
"numeric": 47
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 28
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 15
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 26
|
||||
"original_tax_total": {
|
||||
"numeric": 35
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 43
|
||||
"total": {
|
||||
"numeric": 1
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 12
|
||||
"subtotal": {
|
||||
"numeric": 27
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 44
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 46
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 14
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"tax_total": {
|
||||
"numeric": 29
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 27
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 21
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 23
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 25
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 19
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 34
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"numeric": 1
|
||||
},
|
||||
"original_shipping_total": {
|
||||
"numeric": 43
|
||||
"numeric": 41
|
||||
},
|
||||
"original_shipping_subtotal": {
|
||||
"numeric": 26
|
||||
"numeric": 43
|
||||
},
|
||||
"original_shipping_tax_total": {
|
||||
"numeric": 33
|
||||
"numeric": 21
|
||||
},
|
||||
"raw_original_item_total": {
|
||||
"value": "{value}"
|
||||
|
||||
+4
-4
@@ -23,11 +23,11 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = getLineItemActionsStep({
|
||||
"id": "id_9KdI6QFsw5",
|
||||
"id": "id_DVg8cS9mkh8GBzj",
|
||||
"items": [{
|
||||
"title": "tactus",
|
||||
"quantity": 49,
|
||||
"unit_price": 8,
|
||||
"title": "quidem",
|
||||
"quantity": 33,
|
||||
"unit_price": 36,
|
||||
"cart_id": "{value}"
|
||||
}]
|
||||
})
|
||||
|
||||
+1
-1
@@ -26,7 +26,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"GetVariantsStepInput","type":"[GetVariantsStepInput](../../../../interfaces/core_flows.GetVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filter","type":"[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"The filters to apply on retrieved product variants.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterabLine truncated
|
||||
<TypeList types={[{"name":"GetVariantsStepInput","type":"[GetVariantsStepInput](../../../../interfaces/core_flows.GetVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filter","type":"[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"The filters to apply on retrieved product variants.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../../../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../../../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultVaLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+2
-2
@@ -26,7 +26,7 @@ const myWorkflow = createWorkflow(
|
||||
"actions": [{
|
||||
"action": "{value}",
|
||||
"item_id": "{value}",
|
||||
"amount": 6,
|
||||
"amount": 41,
|
||||
"code": "{value}",
|
||||
"adjustment_id": "{value}",
|
||||
"shipping_method_id": "{value}"
|
||||
@@ -39,7 +39,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"PrepareAdjustmentsFromPromotionActionsStepInput","type":"[PrepareAdjustmentsFromPromotionActionsStepInput](../../../../interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"actions","type":"[ComputeActions](../../../../../promotion/types/promotion.ComputeActions/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"addShippingMethodAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeShippingMethodAdjustment\"`","description":"The type of action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"campaignBudgetExceeded\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="prepareAdjustmentsFromPromotionActionsStep"/>
|
||||
<TypeList types={[{"name":"PrepareAdjustmentsFromPromotionActionsStepInput","type":"[PrepareAdjustmentsFromPromotionActionsStepInput](../../../../interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"actions","type":"[ComputeActions](../../../../../promotion/types/promotion.ComputeActions/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="prepareAdjustmentsFromPromotionActionsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+3
-3
@@ -26,9 +26,9 @@ const myWorkflow = createWorkflow(
|
||||
const data = reserveInventoryStep({
|
||||
"items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"required_quantity": 26,
|
||||
"allow_backorder": true,
|
||||
"quantity": 32,
|
||||
"required_quantity": 29,
|
||||
"allow_backorder": false,
|
||||
"quantity": 37,
|
||||
"location_ids": [
|
||||
"{value}"
|
||||
]
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = retrieveCartStep({
|
||||
"id": "id_uUVnNfybe5E9vnQ"
|
||||
"id": "id_Al0pN6inqwdqSOMfCYdp"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+9
-9
@@ -23,32 +23,32 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = setTaxLinesForItemsStep({
|
||||
"cart": {
|
||||
"id": "id_5mbRIym4idK",
|
||||
"id": "id_QGs7DVFYtBnAC01YYLu",
|
||||
"payment_collection": {
|
||||
"id": "id_M5f9gWHLzVkeZq76UE",
|
||||
"id": "id_uzQSnUuzKkPJ0cZEXPD",
|
||||
"currency_code": "{value}",
|
||||
"region_id": "{value}",
|
||||
"amount": {
|
||||
"numeric": 12
|
||||
"numeric": 42
|
||||
},
|
||||
"status": "not_paid",
|
||||
"status": "partially_authorized",
|
||||
"payment_providers": [{
|
||||
"id": "id_hJAh50FKw1ygb7jWn",
|
||||
"id": "id_dod8tvJed0DpEL",
|
||||
"is_enabled": true
|
||||
}]
|
||||
}
|
||||
},
|
||||
"item_tax_lines": [{
|
||||
"rate": 24,
|
||||
"rate": 34,
|
||||
"code": {},
|
||||
"name": "Kiarra",
|
||||
"name": "Cameron",
|
||||
"provider_id": "{value}",
|
||||
"line_item_id": "{value}"
|
||||
}],
|
||||
"shipping_tax_lines": [{
|
||||
"rate": 15,
|
||||
"rate": 23,
|
||||
"code": {},
|
||||
"name": "Adan",
|
||||
"name": "Lauryn",
|
||||
"provider_id": "{value}",
|
||||
"shipping_line_id": "{value}"
|
||||
}]
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateCartPromotionsStep({
|
||||
"id": "id_VFLHVfj3FYm1LmveC8"
|
||||
"id": "id_XKHrtCG62Q"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateCartsStep([{
|
||||
"id": "id_Nn0XVW08zuvq0h"
|
||||
"id": "id_VkY7iHaYRI"
|
||||
}])
|
||||
}
|
||||
)
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO[]","type":"[UpdateCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"The details to update in a cart.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"An array of promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email address of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code for the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable"Line truncated
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO[]","type":"[UpdateCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"The details to update in a cart.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"An array of promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email address of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code for the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's billing address. You can either update the cart's existing billing address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","descLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateLineItemsStep({
|
||||
"id": "id_g7e8PRtlL2",
|
||||
"id": "id_CvqQujmairnOWwNpb",
|
||||
"items": [{
|
||||
"selector": "{value}",
|
||||
"data": "{value}"
|
||||
|
||||
+4
-4
@@ -23,17 +23,17 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateCartPaymentsStep({
|
||||
"cart": {
|
||||
"id": "id_8iYgufrCf508etN7y",
|
||||
"id": "id_hJ8eQupUnBXPwu3XmA",
|
||||
"payment_collection": {
|
||||
"id": "id_jRTpw9HzZrIKup",
|
||||
"id": "id_Stg7R7qDiLOdVGxT",
|
||||
"currency_code": "{value}",
|
||||
"region_id": "{value}",
|
||||
"amount": {
|
||||
"numeric": 30
|
||||
"numeric": 14
|
||||
},
|
||||
"status": "partially_authorized",
|
||||
"payment_providers": [{
|
||||
"id": "id_zCdJhF1xORByqjARH",
|
||||
"id": "id_cFquXPwY4GOVkBmc",
|
||||
"is_enabled": true
|
||||
}]
|
||||
}
|
||||
|
||||
+54
-54
@@ -23,73 +23,73 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateCartShippingOptionsStep({
|
||||
"cart": {
|
||||
"id": "id_LBLkIuYN2G",
|
||||
"id": "id_7nHH3S5HORwltFT5",
|
||||
"currency_code": "{value}",
|
||||
"original_item_total": {
|
||||
"numeric": 7
|
||||
"numeric": 49
|
||||
},
|
||||
"original_item_subtotal": {
|
||||
"numeric": 20
|
||||
"numeric": 36
|
||||
},
|
||||
"original_item_tax_total": {
|
||||
"numeric": 38
|
||||
"numeric": 33
|
||||
},
|
||||
"item_total": {
|
||||
"numeric": 38
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 3
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 24
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 46
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 23
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 39
|
||||
},
|
||||
"total": {
|
||||
"numeric": 49
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 49
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 48
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 42
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 32
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 16
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 24
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 12
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 0
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"numeric": 45
|
||||
},
|
||||
"original_shipping_total": {
|
||||
"numeric": 47
|
||||
},
|
||||
"original_shipping_subtotal": {
|
||||
"item_subtotal": {
|
||||
"numeric": 27
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 50
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 16
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 18
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 36
|
||||
},
|
||||
"total": {
|
||||
"numeric": 21
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 4
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 18
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 30
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 27
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 47
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 16
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 16
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 33
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"numeric": 18
|
||||
},
|
||||
"original_shipping_total": {
|
||||
"numeric": 1
|
||||
},
|
||||
"original_shipping_subtotal": {
|
||||
"numeric": 16
|
||||
},
|
||||
"original_shipping_tax_total": {
|
||||
"numeric": 6
|
||||
"numeric": 20
|
||||
},
|
||||
"raw_original_item_total": {
|
||||
"value": "{value}"
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateVariantPricesStep({
|
||||
"variants": [{
|
||||
"id": "id_jWHTfzIrseIK2Bdqq04"
|
||||
"id": "id_Z5G91ooGu6tQYK"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+5
-5
@@ -18,7 +18,7 @@ This documentation provides a reference to the `addShippingMethodToCartWorkflow`
|
||||
|
||||
This workflow adds shipping methods to a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts#L34" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts#L34" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -35,7 +35,7 @@ const myWorkflow = createWorkflow(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"options": [{
|
||||
"id": "id_N13MU4tqnjMt0X"
|
||||
"id": "id_KDqNxUUvYbyo"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -62,7 +62,7 @@ export async function POST(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"options": [{
|
||||
"id": "id_N13MU4tqnjMt0X"
|
||||
"id": "id_KDqNxUUvYbyo"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -90,7 +90,7 @@ export default async function handleOrderPlaced({
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"options": [{
|
||||
"id": "id_N13MU4tqnjMt0X"
|
||||
"id": "id_KDqNxUUvYbyo"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -118,7 +118,7 @@ export default async function myCustomJob(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"options": [{
|
||||
"id": "id_N13MU4tqnjMt0X"
|
||||
"id": "id_KDqNxUUvYbyo"
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -18,7 +18,7 @@ This documentation provides a reference to the `addToCartWorkflow`. It belongs t
|
||||
|
||||
This workflow adds items to a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/add-to-cart.ts#L38" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/add-to-cart.ts#L38" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -35,7 +35,7 @@ const myWorkflow = createWorkflow(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"items": [{
|
||||
"quantity": 37
|
||||
"quantity": 39
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -62,7 +62,7 @@ export async function POST(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"items": [{
|
||||
"quantity": 37
|
||||
"quantity": 39
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -90,7 +90,7 @@ export default async function handleOrderPlaced({
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"items": [{
|
||||
"quantity": 37
|
||||
"quantity": 39
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -118,7 +118,7 @@ export default async function myCustomJob(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"items": [{
|
||||
"quantity": 37
|
||||
"quantity": 39
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -23,7 +23,7 @@ This documentation provides a reference to the `completeCartWorkflow`. It belong
|
||||
|
||||
This workflow completes a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/complete-cart.ts#L48" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/complete-cart.ts#L48" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -38,7 +38,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = completeCartWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_zLtCGWkU8AW"
|
||||
"id": "id_9q9ZC6uMIpc99zWSXD"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -62,7 +62,7 @@ export async function POST(
|
||||
const { result } = await completeCartWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_zLtCGWkU8AW"
|
||||
"id": "id_9q9ZC6uMIpc99zWSXD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -87,7 +87,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await completeCartWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_zLtCGWkU8AW"
|
||||
"id": "id_9q9ZC6uMIpc99zWSXD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -112,7 +112,7 @@ export default async function myCustomJob(
|
||||
const { result } = await completeCartWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_zLtCGWkU8AW"
|
||||
"id": "id_9q9ZC6uMIpc99zWSXD"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+13
-13
@@ -14,7 +14,7 @@ This documentation provides a reference to the `confirmVariantInventoryWorkflow`
|
||||
|
||||
This workflow confirms for one or more variants that their inventory has a required quantity.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/confirm-variant-inventory.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/confirm-variant-inventory.ts#L27" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,19 +31,19 @@ const myWorkflow = createWorkflow(
|
||||
input: {
|
||||
"sales_channel_id": "{value}",
|
||||
"variants": [{
|
||||
"id": "id_JDZ51ZIt3S",
|
||||
"id": "id_VLKE0Uxl925CCyfZYn0",
|
||||
"manage_inventory": true,
|
||||
"inventory_items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"variant_id": "{value}",
|
||||
"required_quantity": 31,
|
||||
"required_quantity": 21,
|
||||
"inventory": [{
|
||||
"location_levels": {}
|
||||
}]
|
||||
}]
|
||||
}],
|
||||
"items": [{
|
||||
"quantity": 35
|
||||
"quantity": 30
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -70,19 +70,19 @@ export async function POST(
|
||||
input: {
|
||||
"sales_channel_id": "{value}",
|
||||
"variants": [{
|
||||
"id": "id_JDZ51ZIt3S",
|
||||
"id": "id_VLKE0Uxl925CCyfZYn0",
|
||||
"manage_inventory": true,
|
||||
"inventory_items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"variant_id": "{value}",
|
||||
"required_quantity": 31,
|
||||
"required_quantity": 21,
|
||||
"inventory": [{
|
||||
"location_levels": {}
|
||||
}]
|
||||
}]
|
||||
}],
|
||||
"items": [{
|
||||
"quantity": 35
|
||||
"quantity": 30
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -110,19 +110,19 @@ export default async function handleOrderPlaced({
|
||||
input: {
|
||||
"sales_channel_id": "{value}",
|
||||
"variants": [{
|
||||
"id": "id_JDZ51ZIt3S",
|
||||
"id": "id_VLKE0Uxl925CCyfZYn0",
|
||||
"manage_inventory": true,
|
||||
"inventory_items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"variant_id": "{value}",
|
||||
"required_quantity": 31,
|
||||
"required_quantity": 21,
|
||||
"inventory": [{
|
||||
"location_levels": {}
|
||||
}]
|
||||
}]
|
||||
}],
|
||||
"items": [{
|
||||
"quantity": 35
|
||||
"quantity": 30
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -150,19 +150,19 @@ export default async function myCustomJob(
|
||||
input: {
|
||||
"sales_channel_id": "{value}",
|
||||
"variants": [{
|
||||
"id": "id_JDZ51ZIt3S",
|
||||
"id": "id_VLKE0Uxl925CCyfZYn0",
|
||||
"manage_inventory": true,
|
||||
"inventory_items": [{
|
||||
"inventory_item_id": "{value}",
|
||||
"variant_id": "{value}",
|
||||
"required_quantity": 31,
|
||||
"required_quantity": 21,
|
||||
"inventory": [{
|
||||
"location_levels": {}
|
||||
}]
|
||||
}]
|
||||
}],
|
||||
"items": [{
|
||||
"quantity": 35
|
||||
"quantity": 30
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+2
-2
@@ -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 own custom workflows, allowing you to wrap custom logic around cart creation.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/create-carts.ts#L77" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/create-carts.ts#L77" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -206,4 +206,4 @@ createCartWorkflow.hooks.cartCreated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"[CartDTO](../../../../../cart/interfaces/cart.CartDTO/page.mdx)","description":"The cart details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The subtotal of the cart. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The discount total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The discount tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The gift card total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The gift card tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_total","type":"[BigLine truncated
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"[CartDTO](../../../../../cart/interfaces/cart.CartDTO/page.mdx)","description":"The cart details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The item tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The original tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The subtotal of the cart. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The discount total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The discount tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The gift card total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The gift card tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_subtotal","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping subtotal of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_tax_total","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The shipping tax total of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_total","type":"[BigLine truncated
|
||||
+1
-1
@@ -16,7 +16,7 @@ This documentation provides a reference to the `createPaymentCollectionForCartWo
|
||||
|
||||
This workflow creates a payment collection for a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/create-payment-collection-for-cart.ts#L35" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/create-payment-collection-for-cart.ts#L35" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ This documentation provides a reference to the `listShippingOptionsForCartWithPr
|
||||
|
||||
This workflow lists the shipping options of a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts#L44" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts#L44" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This documentation provides a reference to the `listShippingOptionsForCartWorkfl
|
||||
|
||||
This workflow lists the shipping options of a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart.ts#L16" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/list-shipping-options-for-cart.ts#L16" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ This documentation provides a reference to the `refreshPaymentCollectionForCartW
|
||||
|
||||
This workflow refreshes the payment collections of a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/refresh-payment-collection.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/refresh-payment-collection.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `transferCartCustomerWorkflow`. I
|
||||
|
||||
This workflow transfers cart's customer.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/transfer-cart-customer.ts#L15" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/transfer-cart-customer.ts#L15" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = transferCartCustomerWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_JQRgCwHORln4XsVYzV6P",
|
||||
"id": "id_bBYMRZAzM816",
|
||||
"customer_id": "{value}"
|
||||
}
|
||||
})
|
||||
@@ -55,7 +55,7 @@ export async function POST(
|
||||
const { result } = await transferCartCustomerWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_JQRgCwHORln4XsVYzV6P",
|
||||
"id": "id_bBYMRZAzM816",
|
||||
"customer_id": "{value}"
|
||||
}
|
||||
})
|
||||
@@ -81,7 +81,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await transferCartCustomerWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_JQRgCwHORln4XsVYzV6P",
|
||||
"id": "id_bBYMRZAzM816",
|
||||
"customer_id": "{value}"
|
||||
}
|
||||
})
|
||||
@@ -107,7 +107,7 @@ export default async function myCustomJob(
|
||||
const { result } = await transferCartCustomerWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_JQRgCwHORln4XsVYzV6P",
|
||||
"id": "id_bBYMRZAzM816",
|
||||
"customer_id": "{value}"
|
||||
}
|
||||
})
|
||||
|
||||
+1
-1
@@ -17,7 +17,7 @@ This documentation provides a reference to the `updateCartPromotionsWorkflow`. I
|
||||
|
||||
This workflow updates a cart's promotions.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/update-cart-promotions.ts#L34" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/update-cart-promotions.ts#L34" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+3
-3
@@ -32,7 +32,7 @@ then update any associated details related to the cart in the workflow's hook.
|
||||
|
||||
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around updating a cart.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/update-cart.ts#L80" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/update-cart.ts#L80" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -195,7 +195,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInput","type":"[UpdateCartWorkflowInput](../../../../types/core_flows.UpdateCartWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to update the cart, along with custom data that's passed to the workflow's hooks.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"An array of promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email address of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code for the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type"Line truncated
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInput","type":"[UpdateCartWorkflowInput](../../../../types/core_flows.UpdateCartWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to update the cart, along with custom data that's passed to the workflow's hooks.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"An array of promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email address of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code for the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"`null` \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The cart's billing address. You can either update the cart's existing billing address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
@@ -227,4 +227,4 @@ updateCartWorkflow.hooks.cartUpdated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"Additional data that can be passed through the `additional\\_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartUpdated"/>
|
||||
+2
-2
@@ -17,7 +17,7 @@ This documentation provides a reference to the `updateLineItemInCartWorkflow`. I
|
||||
|
||||
This workflow updates a cart's line item.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/update-line-item-in-cart.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/update-line-item-in-cart.ts#L27" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -136,4 +136,4 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateLineItemInCartWorkflowInputDTO","type":"[UpdateLineItemInCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"Partial<[UpdateLineItemDTO](../../../../../cart/interfaces/cart.UpdateLineItemDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The associated cart's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`string`","description":"The title of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`string`","description":"The description of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`string`","description":"The subtitle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`string`","description":"The type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`string`","description":"The collection of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`string`","description":"The handle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`string`","description":"The SKU of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`string`","description":"The barcode of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`string`","description":"The title of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`Record<string, unknown>`","description":"The option values of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the line item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Whether the line item is discountable.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the line item's amount is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`boolean`","description":"Whether the line item's amount is a custom price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberInput](../../../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The calculated price of the line item after applying promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":fLine truncated
|
||||
<TypeList types={[{"name":"UpdateLineItemInCartWorkflowInputDTO","type":"[UpdateLineItemInCartWorkflowInputDTO](../../../../../types/interfaces/types.UpdateLineItemInCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"Partial<[UpdateLineItemDTO](../../../../../cart/interfaces/cart.UpdateLineItemDTO/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The associated cart's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`string`","description":"The title of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`string`","description":"The description of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`string`","description":"The subtitle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`string`","description":"The type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of type of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`string`","description":"The collection of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`string`","description":"The handle of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`string`","description":"The SKU of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`string`","description":"The barcode of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`string`","description":"The title of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`Record<string, unknown>`","description":"The option values of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the line item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Whether the line item is discountable.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the line item's amount is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_custom_price","type":"`boolean`","description":"Whether the line item's amount is a custom price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberInput](../../../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The calculated price of the line item after applying promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":fLine truncated
|
||||
+1
-1
@@ -16,7 +16,7 @@ This documentation provides a reference to the `updateTaxLinesWorkflow`. It belo
|
||||
|
||||
This workflow updates a cart's tax lines.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/cart/workflows/update-tax-lines.ts#L74" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/cart/workflows/update-tax-lines.ts#L74" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+33
-33
@@ -22,73 +22,73 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateExistingPaymentCollectionStep({
|
||||
"cart": {
|
||||
"id": "id_bIxajXqYOywiS32",
|
||||
"id": "id_sol4HzZNPK",
|
||||
"currency_code": "{value}",
|
||||
"original_item_total": {
|
||||
"numeric": 33
|
||||
"numeric": 42
|
||||
},
|
||||
"original_item_subtotal": {
|
||||
"numeric": 1
|
||||
"numeric": 30
|
||||
},
|
||||
"original_item_tax_total": {
|
||||
"numeric": 24
|
||||
},
|
||||
"item_total": {
|
||||
"numeric": 22
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 9
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 15
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 1
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 41
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 38
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 44
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 36
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 18
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 48
|
||||
"numeric": 44
|
||||
},
|
||||
"total": {
|
||||
"numeric": 12
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 45
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 24
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 42
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 3
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 14
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 37
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 40
|
||||
"numeric": 23
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 16
|
||||
"numeric": 8
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 34
|
||||
"numeric": 23
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 31
|
||||
"numeric": 6
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 49
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"numeric": 45
|
||||
"numeric": 28
|
||||
},
|
||||
"original_shipping_total": {
|
||||
"numeric": 22
|
||||
"numeric": 12
|
||||
},
|
||||
"original_shipping_subtotal": {
|
||||
"numeric": 39
|
||||
"numeric": 14
|
||||
},
|
||||
"original_shipping_tax_total": {
|
||||
"numeric": 23
|
||||
"numeric": 10
|
||||
},
|
||||
"raw_original_item_total": {
|
||||
"value": "{value}"
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `batchLinksWorkflow`. It belongs
|
||||
|
||||
This workflow manages one or more links to create, update, or dismiss them.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/common/workflows/batch-links.ts#L16" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/common/workflows/batch-links.ts#L16" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createLinksWorkflow`. It belongs
|
||||
|
||||
This workflow creates one or more links between records.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/common/workflows/create-links.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/common/workflows/create-links.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `dismissLinksWorkflow`. It belong
|
||||
|
||||
This workflow dismisses one or more links between records.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/common/workflows/dismiss-links.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/common/workflows/dismiss-links.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateLinksWorkflow`. It belongs
|
||||
|
||||
This workflow updates one or more links between records.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/common/workflows/update-links.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/common/workflows/update-links.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCustomerAddresseStepInput","type":"[UpdateCustomerAddresseStepInput](../../../../types/core_flows.UpdateCustomerAddresseStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)","description":"The filters to apply on the retrieved customer address.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addresses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaLine truncated
|
||||
<TypeList types={[{"name":"UpdateCustomerAddresseStepInput","type":"[UpdateCustomerAddresseStepInput](../../../../types/core_flows.UpdateCustomerAddresseStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)","description":"The filters to apply on the retrieved customer address.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addresses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCustomersStepInput","type":"[UpdateCustomersStepInput](../../../../types/core_flows.UpdateCustomersStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"The filters to apply on the retrieved customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"groups","type":"`string` \\| `string`[] \\| [FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`Line truncated
|
||||
<TypeList types={[{"name":"UpdateCustomersStepInput","type":"[UpdateCustomersStepInput](../../../../types/core_flows.UpdateCustomersStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"The filters to apply on the retrieved customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"groups","type":"`string` \\| `string`[] \\| [FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ This documentation provides a reference to the `createCustomerAccountWorkflow`.
|
||||
|
||||
This workflow creates an authentication account for a customer.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/create-customer-account.ts#L21" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/create-customer-account.ts#L21" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+2
-2
@@ -20,7 +20,7 @@ allows you to create custom data models linked to the addresses.
|
||||
|
||||
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around creating customer addresses.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/create-addresses.ts#L74" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/create-addresses.ts#L74" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -247,4 +247,4 @@ createCustomerAddressesWorkflow.hooks.addressesCreated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="addressesCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"Additional data that can be passed through the `additional\\_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="addressesCreated"/>
|
||||
+2
-2
@@ -19,7 +19,7 @@ This workflow has a hook that allows you to perform custom actions on the create
|
||||
|
||||
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around creating customers.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/create-customers.ts#L53" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/create-customers.ts#L53" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -190,4 +190,4 @@ createCustomersWorkflow.hooks.customersCreated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="customersCreated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"Additional data that can be passed through the `additional\\_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="customersCreated"/>
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteCustomerAddressesWorkflow`
|
||||
|
||||
This workflow deletes one or more customer addresses.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/delete-addresses.ts#L15" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/delete-addresses.ts#L15" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_VUGUWhlLf2"
|
||||
"id_aMbyMBeBAP3a7KPCIXCa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -56,7 +56,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_VUGUWhlLf2"
|
||||
"id_aMbyMBeBAP3a7KPCIXCa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -83,7 +83,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_VUGUWhlLf2"
|
||||
"id_aMbyMBeBAP3a7KPCIXCa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -110,7 +110,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_VUGUWhlLf2"
|
||||
"id_aMbyMBeBAP3a7KPCIXCa"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `deleteCustomersWorkflow`. It bel
|
||||
|
||||
This workflow deletes one or more customers.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/delete-customers.ts#L18" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/delete-customers.ts#L18" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_R7DCfco7Y4tVFHn1Nf"
|
||||
"id_CAKCZqXNMHsyXYxqkzd"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_R7DCfco7Y4tVFHn1Nf"
|
||||
"id_CAKCZqXNMHsyXYxqkzd"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -84,7 +84,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_R7DCfco7Y4tVFHn1Nf"
|
||||
"id_CAKCZqXNMHsyXYxqkzd"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -111,7 +111,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_R7DCfco7Y4tVFHn1Nf"
|
||||
"id_CAKCZqXNMHsyXYxqkzd"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+1
-1
@@ -17,7 +17,7 @@ This documentation provides a reference to the `removeCustomerAccountWorkflow`.
|
||||
|
||||
This workflow deletes a user and remove the association in the auth identity.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/remove-customer-account.ts#L20" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/remove-customer-account.ts#L20" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+2
-2
@@ -20,7 +20,7 @@ allows you to update custom data models linked to the addresses.
|
||||
|
||||
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around updating customer addresses.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/update-addresses.ts#L65" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/update-addresses.ts#L65" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -195,4 +195,4 @@ updateCustomerAddressesWorkflow.hooks.addressesUpdated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="addressesUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the customer address is default shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the customer address is default billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string`","description":"The address name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the customer address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"Additional data that can be passed through the `additional\\_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="addressesUpdated"/>
|
||||
+3
-3
@@ -21,7 +21,7 @@ custom data models linked to the customers.
|
||||
|
||||
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around updating customers.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer/workflows/update-customers.ts#L60" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer/workflows/update-customers.ts#L60" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -152,7 +152,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCustomersWorkflowInput","type":"[UpdateCustomersWorkflowInput](../../../../types/core_flows.UpdateCustomersWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to update one or more customers, along with custom data that's passed to the workflow's hooks.","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"The filters to select the customers to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"groups","type":"`string` \\| `string`[] \\| [FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the custoLine truncated
|
||||
<TypeList types={[{"name":"UpdateCustomersWorkflowInput","type":"[UpdateCustomersWorkflowInput](../../../../types/core_flows.UpdateCustomersWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to update one or more customers, along with custom data that's passed to the workflow's hooks.","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"The filters to select the customers to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"groups","type":"`string` \\| `string`[] \\| [FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the custoLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
@@ -184,4 +184,4 @@ updateCustomersWorkflow.hooks.customersUpdated(
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="customersUpdated"/>
|
||||
<TypeList types={[{"name":"input","type":"object","description":"The input data for the hook.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customers","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../../../../../customer/interfaces/customer.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"Additional data that can be passed through the `additional\\_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="customersUpdated"/>
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCustomerGroupsStep([{
|
||||
"name": "Nestor"
|
||||
"name": "Greg"
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = linkCustomerGroupsToCustomerStep({
|
||||
"id": "id_0HBHZHX4Lxs"
|
||||
"id": "id_uARhHtuQ8u71"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = linkCustomersToCustomerGroupStep({
|
||||
"id": "id_QZ2Aan6ITY5j"
|
||||
"id": "id_1mH3cde2SqVRrrCbY4"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCustomerGroupStepInput","type":"[UpdateCustomerGroupStepInput](../../../../types/core_flows.UpdateCustomerGroupStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"The filters to apply on the retrieved customer group.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter customer groups by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customers","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter customer groups by associated customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},Line truncated
|
||||
<TypeList types={[{"name":"UpdateCustomerGroupStepInput","type":"[UpdateCustomerGroupStepInput](../../../../types/core_flows.UpdateCustomerGroupStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"The filters to apply on the retrieved customer group.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter customer groups by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customers","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter customer groups by associated customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createCustomerGroupsWorkflow`. I
|
||||
|
||||
This workflow creates one or more customer groups.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer-group/workflows/create-customer-groups.ts#L20" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer-group/workflows/create-customer-groups.ts#L20" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"customersData": [{
|
||||
"name": "Adrienne"
|
||||
"name": "Itzel"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -56,7 +56,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"customersData": [{
|
||||
"name": "Adrienne"
|
||||
"name": "Itzel"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -83,7 +83,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"customersData": [{
|
||||
"name": "Adrienne"
|
||||
"name": "Itzel"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -110,7 +110,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"customersData": [{
|
||||
"name": "Adrienne"
|
||||
"name": "Itzel"
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteCustomerGroupsWorkflow`. I
|
||||
|
||||
This workflow deletes one or more customer groups.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer-group/workflows/delete-customer-groups.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer-group/workflows/delete-customer-groups.ts#L10" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_eEAW1wiPQ4DIS"
|
||||
"id_SmWv0Ai6rssYpbojx9"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -56,7 +56,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_eEAW1wiPQ4DIS"
|
||||
"id_SmWv0Ai6rssYpbojx9"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -83,7 +83,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_eEAW1wiPQ4DIS"
|
||||
"id_SmWv0Ai6rssYpbojx9"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -110,7 +110,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_eEAW1wiPQ4DIS"
|
||||
"id_SmWv0Ai6rssYpbojx9"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `linkCustomerGroupsToCustomerWork
|
||||
|
||||
This workflow creates one or more links between a customer and customer groups.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer-group/workflows/link-customer-groups-customer.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer-group/workflows/link-customer-groups-customer.ts#L10" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -29,7 +29,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = linkCustomerGroupsToCustomerWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_yOd3qQdrZ5X"
|
||||
"id": "id_CiSUSZ2SgEgmeo3"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -53,7 +53,7 @@ export async function POST(
|
||||
const { result } = await linkCustomerGroupsToCustomerWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_yOd3qQdrZ5X"
|
||||
"id": "id_CiSUSZ2SgEgmeo3"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -78,7 +78,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await linkCustomerGroupsToCustomerWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_yOd3qQdrZ5X"
|
||||
"id": "id_CiSUSZ2SgEgmeo3"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -103,7 +103,7 @@ export default async function myCustomJob(
|
||||
const { result } = await linkCustomerGroupsToCustomerWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_yOd3qQdrZ5X"
|
||||
"id": "id_CiSUSZ2SgEgmeo3"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `linkCustomersToCustomerGroupWork
|
||||
|
||||
This workflow creates one or more links between customer and customer group records.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer-group/workflows/link-customers-customer-group.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer-group/workflows/link-customers-customer-group.ts#L10" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -29,7 +29,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = linkCustomersToCustomerGroupWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_XNoTX6luazqi0"
|
||||
"id": "id_NCyoXlgAgeLdZEbQqojs"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -53,7 +53,7 @@ export async function POST(
|
||||
const { result } = await linkCustomersToCustomerGroupWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_XNoTX6luazqi0"
|
||||
"id": "id_NCyoXlgAgeLdZEbQqojs"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -78,7 +78,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await linkCustomersToCustomerGroupWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_XNoTX6luazqi0"
|
||||
"id": "id_NCyoXlgAgeLdZEbQqojs"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -103,7 +103,7 @@ export default async function myCustomJob(
|
||||
const { result } = await linkCustomersToCustomerGroupWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_XNoTX6luazqi0"
|
||||
"id": "id_NCyoXlgAgeLdZEbQqojs"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateCustomerGroupsWorkflow`. I
|
||||
|
||||
This workflow updates one or more customer groups.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/customer-group/workflows/update-customer-groups.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/customer-group/workflows/update-customer-groups.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -129,7 +129,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCustomerGroupsWorkflowInput","type":"[UpdateCustomerGroupsWorkflowInput](../../../../types/core_flows.UpdateCustomerGroupsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"The filters to apply on the retrieved customer group.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter customer groups by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customers","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter customer groups by associated customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,Line truncated
|
||||
<TypeList types={[{"name":"UpdateCustomerGroupsWorkflowInput","type":"[UpdateCustomerGroupsWorkflowInput](../../../../types/core_flows.UpdateCustomerGroupsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableCustomerGroupProps](../../../../../customer/interfaces/customer.FilterableCustomerGroupProps/page.mdx)","description":"The filters to apply on the retrieved customer group.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter customer groups by name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customers","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter customer groups by associated customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ This documentation provides a reference to the `createDefaultsWorkflow`. It belo
|
||||
|
||||
This workflow creates default data for a Medusa application.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/defaults/workflows/create-defaults.ts#L12" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/defaults/workflows/create-defaults.ts#L12" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteFilesWorkflow`. It belongs
|
||||
|
||||
This workflow deletes one or more files.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/file/workflows/delete-files.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/file/workflows/delete-files.ts#L10" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_D6joLaHhNXS1ZP"
|
||||
"id_AuJEFglaDgHjQ1WY"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -56,7 +56,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_D6joLaHhNXS1ZP"
|
||||
"id_AuJEFglaDgHjQ1WY"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -83,7 +83,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_D6joLaHhNXS1ZP"
|
||||
"id_AuJEFglaDgHjQ1WY"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -110,7 +110,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_D6joLaHhNXS1ZP"
|
||||
"id_AuJEFglaDgHjQ1WY"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `uploadFilesWorkflow`. It belongs
|
||||
|
||||
This workflow uploads one or more files.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/file/workflows/upload-files.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/file/workflows/upload-files.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+7
-7
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = calculateShippingOptionsPricesStep([{
|
||||
"id": "id_HyBw67BzV666Elna",
|
||||
"id": "id_jzRxRelD9jL8ee",
|
||||
"provider_id": "{value}",
|
||||
"optionData": "{value}",
|
||||
"data": "{value}",
|
||||
@@ -32,16 +32,16 @@ const myWorkflow = createWorkflow(
|
||||
"items": {
|
||||
"items": "{value}",
|
||||
"variant": {
|
||||
"id": "id_Bdh7VyjAwIu1Th",
|
||||
"weight": 11,
|
||||
"length": 34,
|
||||
"height": 24,
|
||||
"width": 41,
|
||||
"id": "id_dt4EbECnUc",
|
||||
"weight": 21,
|
||||
"length": 44,
|
||||
"height": 45,
|
||||
"width": 49,
|
||||
"material": "{value}",
|
||||
"product": {}
|
||||
},
|
||||
"product": {
|
||||
"id": "id_Hxu12X5Hg6C8Tc5ck790",
|
||||
"id": "id_zEUUgykUbVbj",
|
||||
"collection_id": "{value}",
|
||||
"categories": [],
|
||||
"tags": []
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createFulfillmentSets([{
|
||||
"name": "Edward",
|
||||
"name": "Brendon",
|
||||
"type": "{value}"
|
||||
}])
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createServiceZonesStep([{
|
||||
"name": "Raquel",
|
||||
"name": "Javier",
|
||||
"fulfillment_set_id": "{value}"
|
||||
}])
|
||||
}
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
const data = createShippingOptionRulesStep({
|
||||
"data": [{
|
||||
"attribute": "{value}",
|
||||
"operator": "eq",
|
||||
"operator": "gt",
|
||||
"value": "{value}",
|
||||
"shipping_option_id": "{value}"
|
||||
}]
|
||||
|
||||
+2
-2
@@ -22,10 +22,10 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingOptionsPriceSetsStep({
|
||||
"id": "id_7OW2TpM2eDMJJW",
|
||||
"id": "id_7tCg3xlcKlEDuvTWJ",
|
||||
"prices": [{
|
||||
"currency_code": "{value}",
|
||||
"amount": 2
|
||||
"amount": 47
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingProfilesStep([{
|
||||
"name": "Eloisa"
|
||||
"name": "Glennie"
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteShippingOptionRulesStep({
|
||||
"ids": [
|
||||
"id_zQt5GPbOxRCbG7lqOv2"
|
||||
"id_HtoP0MXFVhX77x7sX"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+2
-2
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = setShippingOptionsPricesStep({
|
||||
"id": "id_z9TjInRHyKQWOW"
|
||||
"id": "id_9gKIqs4eBuMxZg"
|
||||
})
|
||||
}
|
||||
)
|
||||
@@ -32,4 +32,4 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"SetShippingOptionsPricesStepInput","type":"[SetShippingOptionsPricesStepInput](../../../../types/core_flows.SetShippingOptionsPricesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../../types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)<TConfig>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../../types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)<TConfig>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsPricesStep"/>
|
||||
<TypeList types={[{"name":"SetShippingOptionsPricesStepInput","type":"[SetShippingOptionsPricesStepInput](../../../../types/core_flows.SetShippingOptionsPricesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../../types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)<TConfig>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsPricesStep"/>
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateFulfillmentStep({
|
||||
"id": "id_eJZVKDiqdI"
|
||||
"id": "id_bJFtqFK4URmUv8tSaK"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateShippingProfilesStepInput","type":"[UpdateShippingProfilesStepInput](../../../../types/core_flows.UpdateShippingProfilesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"update","type":"[UpdateShippingProfileDTO](../../../../../fulfillment/interfaces/fulfillment.UpdateShippingProfileDTO/page.mdx)","description":"The attributes to update in the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"selector","type":"[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.Line truncated
|
||||
<TypeList types={[{"name":"UpdateShippingProfilesStepInput","type":"[UpdateShippingProfilesStepInput](../../../../types/core_flows.UpdateShippingProfilesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"update","type":"[UpdateShippingProfileDTO](../../../../../fulfillment/interfaces/fulfillment.UpdateShippingProfileDTO/page.mdx)","description":"The attributes to update in the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"selector","type":"[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterablLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ This documentation provides a reference to the `batchShippingOptionRulesWorkflow
|
||||
|
||||
This workflow manages shipping option rules by creating, updating, or deleting them.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/batch-shipping-option-rules.ts#L25" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/batch-shipping-option-rules.ts#L25" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `calculateShippingOptionsPricesWo
|
||||
|
||||
This workflow calculates the prices for one or more shipping options.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/calculate-shipping-options-prices.ts#L17" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/calculate-shipping-options-prices.ts#L17" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"shipping_options": [{
|
||||
"id": "id_0jkAGp8EB83lkQMVBMR"
|
||||
"id": "id_x1hNs3lIOdL2bRrtlC"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -59,7 +59,7 @@ export async function POST(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"shipping_options": [{
|
||||
"id": "id_0jkAGp8EB83lkQMVBMR"
|
||||
"id": "id_x1hNs3lIOdL2bRrtlC"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -87,7 +87,7 @@ export default async function handleOrderPlaced({
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"shipping_options": [{
|
||||
"id": "id_0jkAGp8EB83lkQMVBMR"
|
||||
"id": "id_x1hNs3lIOdL2bRrtlC"
|
||||
}]
|
||||
}
|
||||
})
|
||||
@@ -115,7 +115,7 @@ export default async function myCustomJob(
|
||||
input: {
|
||||
"cart_id": "{value}",
|
||||
"shipping_options": [{
|
||||
"id": "id_0jkAGp8EB83lkQMVBMR"
|
||||
"id": "id_x1hNs3lIOdL2bRrtlC"
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `cancelFulfillmentWorkflow`. It b
|
||||
|
||||
This workflow cancels a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/cancel-fulfillment.ts#L8" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/cancel-fulfillment.ts#L8" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -29,7 +29,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = cancelFulfillmentWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_FJOwKxy8uqVvHp"
|
||||
"id": "id_noogJCRH2T"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -53,7 +53,7 @@ export async function POST(
|
||||
const { result } = await cancelFulfillmentWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_FJOwKxy8uqVvHp"
|
||||
"id": "id_noogJCRH2T"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -78,7 +78,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await cancelFulfillmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_FJOwKxy8uqVvHp"
|
||||
"id": "id_noogJCRH2T"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -103,7 +103,7 @@ export default async function myCustomJob(
|
||||
const { result } = await cancelFulfillmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_FJOwKxy8uqVvHp"
|
||||
"id": "id_noogJCRH2T"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+9
-9
@@ -15,7 +15,7 @@ This documentation provides a reference to the `createFulfillmentWorkflow`. It b
|
||||
|
||||
This workflow creates a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-fulfillment.ts#L19" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-fulfillment.ts#L19" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -34,9 +34,9 @@ const myWorkflow = createWorkflow(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "corrupti",
|
||||
"title": "esse",
|
||||
"sku": "{value}",
|
||||
"quantity": 2,
|
||||
"quantity": 34,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -66,9 +66,9 @@ export async function POST(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "corrupti",
|
||||
"title": "esse",
|
||||
"sku": "{value}",
|
||||
"quantity": 2,
|
||||
"quantity": 34,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -99,9 +99,9 @@ export default async function handleOrderPlaced({
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "corrupti",
|
||||
"title": "esse",
|
||||
"sku": "{value}",
|
||||
"quantity": 2,
|
||||
"quantity": 34,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -132,9 +132,9 @@ export default async function myCustomJob(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "corrupti",
|
||||
"title": "esse",
|
||||
"sku": "{value}",
|
||||
"quantity": 2,
|
||||
"quantity": 34,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
|
||||
+9
-9
@@ -15,7 +15,7 @@ This documentation provides a reference to the `createReturnFulfillmentWorkflow`
|
||||
|
||||
This workflow creates a fulfillment for a return.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts#L20" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts#L20" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -34,9 +34,9 @@ const myWorkflow = createWorkflow(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "aptus",
|
||||
"title": "alias",
|
||||
"sku": "{value}",
|
||||
"quantity": 19,
|
||||
"quantity": 1,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -66,9 +66,9 @@ export async function POST(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "aptus",
|
||||
"title": "alias",
|
||||
"sku": "{value}",
|
||||
"quantity": 19,
|
||||
"quantity": 1,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -99,9 +99,9 @@ export default async function handleOrderPlaced({
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "aptus",
|
||||
"title": "alias",
|
||||
"sku": "{value}",
|
||||
"quantity": 19,
|
||||
"quantity": 1,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -132,9 +132,9 @@ export default async function myCustomJob(
|
||||
"provider_id": "{value}",
|
||||
"delivery_address": {},
|
||||
"items": [{
|
||||
"title": "aptus",
|
||||
"title": "alias",
|
||||
"sku": "{value}",
|
||||
"quantity": 19,
|
||||
"quantity": 1,
|
||||
"barcode": "{value}"
|
||||
}]
|
||||
}
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createServiceZonesWorkflow`. It
|
||||
|
||||
This workflow creates one or more service zones.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-service-zones.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-service-zones.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Hailey",
|
||||
"name": "Megane",
|
||||
"fulfillment_set_id": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Hailey",
|
||||
"name": "Megane",
|
||||
"fulfillment_set_id": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -85,7 +85,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Hailey",
|
||||
"name": "Megane",
|
||||
"fulfillment_set_id": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -113,7 +113,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Hailey",
|
||||
"name": "Megane",
|
||||
"fulfillment_set_id": "{value}"
|
||||
}]
|
||||
}
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createShipmentWorkflow`. It belo
|
||||
|
||||
This workflow creates shipments for a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-shipment.ts#L15" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-shipment.ts#L15" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -29,7 +29,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = createShipmentWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_QUZMHJ3Vnhk1nlUUk",
|
||||
"id": "id_6KxdfnQqmcKxHrk1m",
|
||||
"labels": [{
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
@@ -58,7 +58,7 @@ export async function POST(
|
||||
const { result } = await createShipmentWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_QUZMHJ3Vnhk1nlUUk",
|
||||
"id": "id_6KxdfnQqmcKxHrk1m",
|
||||
"labels": [{
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
@@ -88,7 +88,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await createShipmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_QUZMHJ3Vnhk1nlUUk",
|
||||
"id": "id_6KxdfnQqmcKxHrk1m",
|
||||
"labels": [{
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
@@ -118,7 +118,7 @@ export default async function myCustomJob(
|
||||
const { result } = await createShipmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_QUZMHJ3Vnhk1nlUUk",
|
||||
"id": "id_6KxdfnQqmcKxHrk1m",
|
||||
"labels": [{
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
|
||||
+14
-14
@@ -15,7 +15,7 @@ This documentation provides a reference to the `createShippingOptionsWorkflow`.
|
||||
|
||||
This workflow creates one or more shipping options.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,19 +30,19 @@ const myWorkflow = createWorkflow(
|
||||
const result = createShippingOptionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"name": "Alec",
|
||||
"name": "Earnest",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"type": {
|
||||
"label": "{value}",
|
||||
"description": "Sponte caveo claudeo.",
|
||||
"description": "Stips antea absens aperte capto solus vobis animi.",
|
||||
"code": "{value}"
|
||||
},
|
||||
"price_type": "{value}",
|
||||
"prices": [{
|
||||
"currency_code": "{value}",
|
||||
"amount": 1,
|
||||
"amount": 4,
|
||||
"region_id": "{value}"
|
||||
}]
|
||||
}]
|
||||
@@ -68,19 +68,19 @@ export async function POST(
|
||||
const { result } = await createShippingOptionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"name": "Alec",
|
||||
"name": "Earnest",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"type": {
|
||||
"label": "{value}",
|
||||
"description": "Sponte caveo claudeo.",
|
||||
"description": "Stips antea absens aperte capto solus vobis animi.",
|
||||
"code": "{value}"
|
||||
},
|
||||
"price_type": "{value}",
|
||||
"prices": [{
|
||||
"currency_code": "{value}",
|
||||
"amount": 1,
|
||||
"amount": 4,
|
||||
"region_id": "{value}"
|
||||
}]
|
||||
}]
|
||||
@@ -107,19 +107,19 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"name": "Alec",
|
||||
"name": "Earnest",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"type": {
|
||||
"label": "{value}",
|
||||
"description": "Sponte caveo claudeo.",
|
||||
"description": "Stips antea absens aperte capto solus vobis animi.",
|
||||
"code": "{value}"
|
||||
},
|
||||
"price_type": "{value}",
|
||||
"prices": [{
|
||||
"currency_code": "{value}",
|
||||
"amount": 1,
|
||||
"amount": 4,
|
||||
"region_id": "{value}"
|
||||
}]
|
||||
}]
|
||||
@@ -146,19 +146,19 @@ export default async function myCustomJob(
|
||||
const { result } = await createShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"name": "Alec",
|
||||
"name": "Earnest",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"type": {
|
||||
"label": "{value}",
|
||||
"description": "Sponte caveo claudeo.",
|
||||
"description": "Stips antea absens aperte capto solus vobis animi.",
|
||||
"code": "{value}"
|
||||
},
|
||||
"price_type": "{value}",
|
||||
"prices": [{
|
||||
"currency_code": "{value}",
|
||||
"amount": 1,
|
||||
"amount": 4,
|
||||
"region_id": "{value}"
|
||||
}]
|
||||
}]
|
||||
@@ -182,7 +182,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateShippingOptionsWorkflowInput[]","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateFlatRateShippingOptionInput](../../../../../types/types/types.CreateFlatRateShippingOptionInput/page.mdx) \\| [CreateCalculatedShippingOptionInput](../../../../../types/types/types.CreateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateFlatRateShippingOptionPriceRecord](../../../../../types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"calculated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createShippingOptionsWorkflow"/>
|
||||
<TypeList types={[{"name":"CreateShippingOptionsWorkflowInput[]","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CreateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateShippingOptionsWorkflowInput","type":"[CreateFlatRateShippingOptionInput](../../../../../types/types/types.CreateFlatRateShippingOptionInput/page.mdx) \\| [CreateCalculatedShippingOptionInput](../../../../../types/types/types.CreateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateFlatRateShippingOptionPriceRecord](../../../../../types/types/types.CreateFlatRateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createShippingOptionsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createShippingProfilesWorkflow`.
|
||||
|
||||
This workflow creates one or more shipping profiles.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/create-shipping-profiles.ts#L14" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/create-shipping-profiles.ts#L14" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Jaydon",
|
||||
"name": "Rosanna",
|
||||
"type": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Jaydon",
|
||||
"name": "Rosanna",
|
||||
"type": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -85,7 +85,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Jaydon",
|
||||
"name": "Rosanna",
|
||||
"type": "{value}"
|
||||
}]
|
||||
}
|
||||
@@ -113,7 +113,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"data": [{
|
||||
"name": "Jaydon",
|
||||
"name": "Rosanna",
|
||||
"type": "{value}"
|
||||
}]
|
||||
}
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `deleteFulfillmentSetsWorkflow`.
|
||||
|
||||
This workflow deletes one or more fulfillment sets.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/delete-fulfillment-sets.ts#L11" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/delete-fulfillment-sets.ts#L11" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_rwyT2C2vEHukZp9lPQtx"
|
||||
"id_xpzekH8fDmbjGYb1"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_rwyT2C2vEHukZp9lPQtx"
|
||||
"id_xpzekH8fDmbjGYb1"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -84,7 +84,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_rwyT2C2vEHukZp9lPQtx"
|
||||
"id_xpzekH8fDmbjGYb1"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -111,7 +111,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_rwyT2C2vEHukZp9lPQtx"
|
||||
"id_xpzekH8fDmbjGYb1"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteServiceZonesWorkflow`. It
|
||||
|
||||
This workflow deletes one or more service zones.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/delete-service-zones.ts#L8" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/delete-service-zones.ts#L8" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ZmlAP0shlytSYLgFn8"
|
||||
"id_yTtSLLYn6RIfjdb5Q"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -56,7 +56,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ZmlAP0shlytSYLgFn8"
|
||||
"id_yTtSLLYn6RIfjdb5Q"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -83,7 +83,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ZmlAP0shlytSYLgFn8"
|
||||
"id_yTtSLLYn6RIfjdb5Q"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -110,7 +110,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_ZmlAP0shlytSYLgFn8"
|
||||
"id_yTtSLLYn6RIfjdb5Q"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `deleteShippingOptionsWorkflow`.
|
||||
|
||||
This workflow deletes one or more shipping options.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/delete-shipping-options.ts#L11" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/delete-shipping-options.ts#L11" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_cg88GR6mgcljm6bRQ"
|
||||
"id_G2fEBjyT1zNDdaPUSAa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -57,7 +57,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_cg88GR6mgcljm6bRQ"
|
||||
"id_G2fEBjyT1zNDdaPUSAa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -84,7 +84,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_cg88GR6mgcljm6bRQ"
|
||||
"id_G2fEBjyT1zNDdaPUSAa"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -111,7 +111,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_cg88GR6mgcljm6bRQ"
|
||||
"id_G2fEBjyT1zNDdaPUSAa"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+5
-5
@@ -15,7 +15,7 @@ This documentation provides a reference to the `markFulfillmentAsDeliveredWorkfl
|
||||
|
||||
This workflow marks fulfillment as delivered.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/mark-fulfillment-as-delivered.ts#L45" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/mark-fulfillment-as-delivered.ts#L45" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -30,7 +30,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = markFulfillmentAsDeliveredWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_gobfQy7Y89MzK1gqGTx"
|
||||
"id": "id_JeepOuXot0iLRX"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -54,7 +54,7 @@ export async function POST(
|
||||
const { result } = await markFulfillmentAsDeliveredWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_gobfQy7Y89MzK1gqGTx"
|
||||
"id": "id_JeepOuXot0iLRX"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -79,7 +79,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await markFulfillmentAsDeliveredWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_gobfQy7Y89MzK1gqGTx"
|
||||
"id": "id_JeepOuXot0iLRX"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -104,7 +104,7 @@ export default async function myCustomJob(
|
||||
const { result } = await markFulfillmentAsDeliveredWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_gobfQy7Y89MzK1gqGTx"
|
||||
"id": "id_JeepOuXot0iLRX"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+5
-5
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateFulfillmentWorkflow`. It b
|
||||
|
||||
This workflow updates a fulfillment.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/update-fulfillment.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/update-fulfillment.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -29,7 +29,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateFulfillmentWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_aaN5419kMQTft5Tei"
|
||||
"id": "id_MUrEy6v8tUXD"
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -53,7 +53,7 @@ export async function POST(
|
||||
const { result } = await updateFulfillmentWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_aaN5419kMQTft5Tei"
|
||||
"id": "id_MUrEy6v8tUXD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -78,7 +78,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateFulfillmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_aaN5419kMQTft5Tei"
|
||||
"id": "id_MUrEy6v8tUXD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -103,7 +103,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateFulfillmentWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_aaN5419kMQTft5Tei"
|
||||
"id": "id_MUrEy6v8tUXD"
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+2
-2
@@ -13,7 +13,7 @@ This documentation provides a reference to the `updateServiceZonesWorkflow`. It
|
||||
|
||||
This workflow updates one or more service zones.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/update-service-zones.ts#L13" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/update-service-zones.ts#L13" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -124,7 +124,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateServiceZonesWorkflowInput","type":"[UpdateServiceZonesWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateServiceZonesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../../../fulfillment/interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>Line truncated
|
||||
<TypeList types={[{"name":"UpdateServiceZonesWorkflowInput","type":"[UpdateServiceZonesWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateServiceZonesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../../../fulfillment/interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableServiceZoneProps](../../../../../fulfillment/interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joineLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+6
-6
@@ -16,7 +16,7 @@ This documentation provides a reference to the `updateShippingOptionsWorkflow`.
|
||||
|
||||
This workflow updates one or more shipping options.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/update-shipping-options.ts#L22" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/update-shipping-options.ts#L22" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -31,7 +31,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateShippingOptionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"id": "id_GXzSnJd6MH9Isms3"
|
||||
"id": "id_solavLhHlKdKuvW7Wr"
|
||||
}]
|
||||
})
|
||||
}
|
||||
@@ -55,7 +55,7 @@ export async function POST(
|
||||
const { result } = await updateShippingOptionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_GXzSnJd6MH9Isms3"
|
||||
"id": "id_solavLhHlKdKuvW7Wr"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -80,7 +80,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_GXzSnJd6MH9Isms3"
|
||||
"id": "id_solavLhHlKdKuvW7Wr"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -105,7 +105,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateShippingOptionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_GXzSnJd6MH9Isms3"
|
||||
"id": "id_solavLhHlKdKuvW7Wr"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -127,7 +127,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateFlatRateShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput/page.mdx) \\| [UpdateCalculatedShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateShippingOptionsWorkflow"/>
|
||||
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateFlatRateShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateFlatRateShippingOptionInput/page.mdx) \\| [UpdateCalculatedShippingOptionInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateCalculatedShippingOptionInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[UpdateShippingOptionPriceRecord](../../../../../types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionPriceRecord/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateShippingOptionsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateShippingProfilesWorkflow`.
|
||||
|
||||
This workflow updates one or more shipping profiles.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1758bfb8d042fa9fc82f23c36ccd61e4a439448e/packages/core/core-flows/src/fulfillment/workflows/update-shipping-profiles.ts#L14" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/1b86c17b7293f3b810c062d78ec6ef563f968366/packages/core/core-flows/src/fulfillment/workflows/update-shipping-profiles.ts#L14" />
|
||||
|
||||
<CodeTabs group="workflow-exection">
|
||||
<CodeTab label="Another Workflow" value="another-workflow">
|
||||
@@ -129,7 +129,7 @@ export const config = {
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateShippingProfilesWorkflowInput","type":"[UpdateShippingProfilesWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingProfilesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)&Line truncated
|
||||
<TypeList types={[{"name":"UpdateShippingProfilesWorkflowInput","type":"[UpdateShippingProfilesWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingProfilesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../fulfillment/types/fulfillment.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../../../fulfillment/interfaces/fulfillment.BaseFilterable/page.mdx)<[FilterableShippingProfileProps](../../../../../fulfillment/interfaces/fulfillmentLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+73
-73
@@ -21,7 +21,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = validateFulfillmentDeliverabilityStep({
|
||||
"id": "id_oHkYbVKRtalDzd",
|
||||
"id": "id_52Q9Jzw5X1cS6xmE4",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -34,13 +34,13 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option": {},
|
||||
"requires_shipping": false,
|
||||
"provider": {
|
||||
"id": "id_9Bv0DnYupLF8yQtDEi",
|
||||
"name": "Tavares",
|
||||
"id": "id_ns8d5Y8IHQAj9a",
|
||||
"name": "Judy",
|
||||
"metadata": {},
|
||||
"shipping_options": [{
|
||||
"id": "id_QMQ4vh10V28Zyd",
|
||||
"name": "Dortha",
|
||||
"price_type": "flat",
|
||||
"id": "id_D6BSEjbMx0ai7",
|
||||
"name": "Blake",
|
||||
"price_type": "calculated",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
@@ -48,12 +48,12 @@ const myWorkflow = createWorkflow(
|
||||
"data": {},
|
||||
"metadata": {},
|
||||
"service_zone": {
|
||||
"id": "id_m41IcIKoeY5IoPf7hhy",
|
||||
"name": "Rhiannon",
|
||||
"id": "id_GCgTlCVmouvkoWVOn8",
|
||||
"name": "Clifford",
|
||||
"metadata": {},
|
||||
"fulfillment_set": {
|
||||
"id": "id_T3BZLoluZpTDI8buX1j3",
|
||||
"name": "Scotty",
|
||||
"id": "id_v8V4xa9dTIla1WqZOBZ",
|
||||
"name": "Erling",
|
||||
"type": "{value}",
|
||||
"metadata": {},
|
||||
"service_zones": [
|
||||
@@ -65,7 +65,7 @@ const myWorkflow = createWorkflow(
|
||||
},
|
||||
"fulfillment_set_id": "{value}",
|
||||
"geo_zones": [{
|
||||
"id": "id_z570L5wM2NAkxZ",
|
||||
"id": "id_PounO6cYZAzF",
|
||||
"type": {},
|
||||
"country_code": "{value}",
|
||||
"province_code": {},
|
||||
@@ -77,8 +77,8 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
}],
|
||||
"shipping_options": [{
|
||||
"id": "id_mjNRuykg2vdP",
|
||||
"name": "Jan",
|
||||
"id": "id_GbC1woJ0i56t6A",
|
||||
"name": "Reginald",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -101,13 +101,13 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"shipping_profile": {
|
||||
"id": "id_KFEtoTRQyqZRi",
|
||||
"name": "Brianne",
|
||||
"id": "id_Sg4nAg3p7phO",
|
||||
"name": "Elton",
|
||||
"type": "{value}",
|
||||
"metadata": {},
|
||||
"shipping_options": [{
|
||||
"id": "id_FlI90XWrbaBAEDXR52",
|
||||
"name": "Eunice",
|
||||
"id": "id_74d0xcVrSl0RCxb",
|
||||
"name": "Bennie",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -130,12 +130,12 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"fulfillment_provider": {
|
||||
"id": "id_MK5y27APNhc9",
|
||||
"name": "Cordie",
|
||||
"id": "id_YQenaWavpjJlyGWw9tn9",
|
||||
"name": "Jaiden",
|
||||
"metadata": {},
|
||||
"shipping_options": [{
|
||||
"id": "id_BtoRsJTzg0R0zfiAz7qK",
|
||||
"name": "Isobel",
|
||||
"id": "id_Tag6CbAzPc1",
|
||||
"name": "Brandy",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -158,14 +158,14 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"type": {
|
||||
"id": "id_En8gRdg106R9vMCqDAB",
|
||||
"id": "id_YQ6zKe8n4aGLu",
|
||||
"label": "{value}",
|
||||
"description": "Timor quibusdam accommodo.",
|
||||
"description": "Delego uberrime convoco appositus defungo artificiose cernuus necessitatibus officia tandem.",
|
||||
"code": "{value}",
|
||||
"shipping_option_id": "{value}",
|
||||
"shipping_option": {
|
||||
"id": "id_z5LRup9lpx",
|
||||
"name": "Dannie",
|
||||
"id": "id_koVG7NiZxOSC2iJhI16d",
|
||||
"name": "Rollin",
|
||||
"price_type": "flat",
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -174,8 +174,8 @@ const myWorkflow = createWorkflow(
|
||||
"data": {},
|
||||
"metadata": {},
|
||||
"service_zone": {
|
||||
"id": "id_HaqvU2GUaB",
|
||||
"name": "Alexa",
|
||||
"id": "id_fXoIBqubQBbxtDX0jE",
|
||||
"name": "Ephraim",
|
||||
"metadata": {},
|
||||
"fulfillment_set": {},
|
||||
"fulfillment_set_id": "{value}",
|
||||
@@ -186,8 +186,8 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"shipping_profile": {
|
||||
"id": "id_dpLDW2NzOMnMiI",
|
||||
"name": "Micheal",
|
||||
"id": "id_cL3m2NZMe4TzcRbPj8YN",
|
||||
"name": "Rosalee",
|
||||
"type": "{value}",
|
||||
"metadata": {},
|
||||
"shipping_options": [],
|
||||
@@ -196,8 +196,8 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"fulfillment_provider": {
|
||||
"id": "id_NEZYIbpZjTzesMfjQ",
|
||||
"name": "Brisa",
|
||||
"id": "id_zKZi2YYj7eiSQbFw",
|
||||
"name": "Augustine",
|
||||
"metadata": {},
|
||||
"shipping_options": [],
|
||||
"created_at": {},
|
||||
@@ -205,9 +205,9 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"type": {
|
||||
"id": "id_pfENHhp386bfFCt9wR",
|
||||
"id": "id_Y3OdhITzdTkL",
|
||||
"label": "{value}",
|
||||
"description": "Admiratio vergo adfero minus.",
|
||||
"description": "Currus tumultus comitatus vis agnosco sortitus cunabula verto umbra.",
|
||||
"code": "{value}",
|
||||
"shipping_option_id": "{value}",
|
||||
"shipping_option": {},
|
||||
@@ -230,14 +230,14 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"rules": [{
|
||||
"id": "id_FOCU1CnulEwT2d",
|
||||
"id": "id_tfHvXYbW6YkN3s",
|
||||
"attribute": "{value}",
|
||||
"operator": "{value}",
|
||||
"value": {},
|
||||
"shipping_option_id": "{value}",
|
||||
"shipping_option": {
|
||||
"id": "id_VsoUmVVj8P0",
|
||||
"name": "Nathan",
|
||||
"id": "id_VE5unUO3K4ZCD",
|
||||
"name": "Megane",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -260,7 +260,7 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
}],
|
||||
"fulfillments": [{
|
||||
"id": "id_O9IeMdcxjYZb8SaLfRZn",
|
||||
"id": "id_avqnMHjxB4ORp2bYwvd",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -273,8 +273,8 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option": {},
|
||||
"requires_shipping": false,
|
||||
"provider": {
|
||||
"id": "id_jew4ZkkxpW4SvYA0sVEW",
|
||||
"name": "Susan",
|
||||
"id": "id_5Zhzv7v85gWevjw",
|
||||
"name": "Naomi",
|
||||
"metadata": {},
|
||||
"shipping_options": [],
|
||||
"created_at": {},
|
||||
@@ -282,7 +282,7 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"delivery_address": {
|
||||
"id": "id_uTDbr2oQ3g7a",
|
||||
"id": "id_c8rdGrXL9NYE9Jw6agMp",
|
||||
"fulfillment_id": {},
|
||||
"company": {},
|
||||
"first_name": {},
|
||||
@@ -318,7 +318,7 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"delivery_address": {
|
||||
"id": "id_MaXPCqVSKSexr5",
|
||||
"id": "id_LKeuWFqzr9Ehm",
|
||||
"fulfillment_id": {},
|
||||
"company": {},
|
||||
"first_name": {},
|
||||
@@ -336,16 +336,16 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"items": [{
|
||||
"id": "id_XK9SUk9PRRZ",
|
||||
"title": "numquam",
|
||||
"quantity": 41,
|
||||
"id": "id_DBBArP0uNg1C1c",
|
||||
"title": "accusantium",
|
||||
"quantity": 8,
|
||||
"sku": "{value}",
|
||||
"barcode": "{value}",
|
||||
"line_item_id": {},
|
||||
"inventory_item_id": {},
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_LguzSPA7EZMI",
|
||||
"id": "id_QtjTKRghhYN",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -356,14 +356,14 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option_id": {},
|
||||
"metadata": {},
|
||||
"shipping_option": {},
|
||||
"requires_shipping": false,
|
||||
"requires_shipping": true,
|
||||
"provider": {
|
||||
"id": "id_1bKByDWEi0ZeIFb0DH6",
|
||||
"name": "Armani",
|
||||
"id": "id_hmigWr90t3u",
|
||||
"name": "Odessa",
|
||||
"metadata": {},
|
||||
"shipping_options": [{
|
||||
"id": "id_aUWS3AbJrcnyY",
|
||||
"name": "Eileen",
|
||||
"id": "id_9hlCMabUbP",
|
||||
"name": "Griffin",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -386,7 +386,7 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"delivery_address": {
|
||||
"id": "id_mLmMYYRTen",
|
||||
"id": "id_eVZKJ48OpoJwgj1Pg",
|
||||
"fulfillment_id": {},
|
||||
"company": {},
|
||||
"first_name": {},
|
||||
@@ -404,16 +404,16 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"items": [{
|
||||
"id": "id_yX6v9t9DtuG",
|
||||
"title": "corpus",
|
||||
"quantity": 18,
|
||||
"id": "id_5rCp7mgDLdJO",
|
||||
"title": "ducimus",
|
||||
"quantity": 22,
|
||||
"sku": "{value}",
|
||||
"barcode": "{value}",
|
||||
"line_item_id": {},
|
||||
"inventory_item_id": {},
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_4VtuXRbFNIzO",
|
||||
"id": "id_LcySjIv26ybf",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -424,7 +424,7 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option_id": {},
|
||||
"metadata": {},
|
||||
"shipping_option": {},
|
||||
"requires_shipping": true,
|
||||
"requires_shipping": false,
|
||||
"provider": {},
|
||||
"delivery_address": {},
|
||||
"items": [],
|
||||
@@ -438,13 +438,13 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
}],
|
||||
"labels": [{
|
||||
"id": "id_XM4CxU3J2pM",
|
||||
"id": "id_w3RLp4etcyC0WRt",
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
"label_url": "{value}",
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_tz7rsSPgIOKS1b75kT",
|
||||
"id": "id_0oQIWkhxPbmvdz",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -477,13 +477,13 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
}],
|
||||
"labels": [{
|
||||
"id": "id_Krw9y6quRd",
|
||||
"id": "id_Dnw80W292ntay",
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
"label_url": "{value}",
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_GbmCxenghJT",
|
||||
"id": "id_IGUAte51Aa",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -496,12 +496,12 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option": {},
|
||||
"requires_shipping": true,
|
||||
"provider": {
|
||||
"id": "id_kIC4NtLrwsemEz0j",
|
||||
"name": "Ara",
|
||||
"id": "id_x2EqCDQGCzMnQK96KHuF",
|
||||
"name": "Charlene",
|
||||
"metadata": {},
|
||||
"shipping_options": [{
|
||||
"id": "id_8DB2ndIqeewQ",
|
||||
"name": "Marcelo",
|
||||
"id": "id_SvXn59ZmCAh",
|
||||
"name": "Kattie",
|
||||
"price_type": {},
|
||||
"service_zone_id": "{value}",
|
||||
"shipping_profile_id": "{value}",
|
||||
@@ -524,7 +524,7 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"delivery_address": {
|
||||
"id": "id_EE5D3OPFIYC336hg",
|
||||
"id": "id_cYylHM00I4PPBd",
|
||||
"fulfillment_id": {},
|
||||
"company": {},
|
||||
"first_name": {},
|
||||
@@ -542,16 +542,16 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
},
|
||||
"items": [{
|
||||
"id": "id_PvZ1AmZFnlQzCUFIy",
|
||||
"title": "labore",
|
||||
"quantity": 40,
|
||||
"id": "id_JBg9e978G21QqfujBHK5",
|
||||
"title": "volaticus",
|
||||
"quantity": 37,
|
||||
"sku": "{value}",
|
||||
"barcode": "{value}",
|
||||
"line_item_id": {},
|
||||
"inventory_item_id": {},
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_rfnAdocGxpM",
|
||||
"id": "id_ZUlMIqTdSemfwf",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -562,7 +562,7 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option_id": {},
|
||||
"metadata": {},
|
||||
"shipping_option": {},
|
||||
"requires_shipping": true,
|
||||
"requires_shipping": false,
|
||||
"provider": {},
|
||||
"delivery_address": {},
|
||||
"items": [],
|
||||
@@ -576,13 +576,13 @@ const myWorkflow = createWorkflow(
|
||||
"deleted_at": {}
|
||||
}],
|
||||
"labels": [{
|
||||
"id": "id_XqmHh8NR2feAzwF",
|
||||
"id": "id_GuIoYhwgNItg2Fm9es7",
|
||||
"tracking_number": "{value}",
|
||||
"tracking_url": "{value}",
|
||||
"label_url": "{value}",
|
||||
"fulfillment_id": "{value}",
|
||||
"fulfillment": {
|
||||
"id": "id_7XMbJaSTGb5x1W",
|
||||
"id": "id_zmQi7cTL02w",
|
||||
"location_id": "{value}",
|
||||
"packed_at": {},
|
||||
"shipped_at": {},
|
||||
@@ -593,7 +593,7 @@ const myWorkflow = createWorkflow(
|
||||
"shipping_option_id": {},
|
||||
"metadata": {},
|
||||
"shipping_option": {},
|
||||
"requires_shipping": true,
|
||||
"requires_shipping": false,
|
||||
"provider": {},
|
||||
"delivery_address": {},
|
||||
"items": [],
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
const data = adjustInventoryLevelsStep([{
|
||||
"inventory_item_id": "{value}",
|
||||
"location_id": "{value}",
|
||||
"adjustment": 8
|
||||
"adjustment": 38
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
Loaded 100 of 917 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user