asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-13 20:11:50 +02:00
1 parent cedab58339
commit c6dff873de
2224 files changed
+26905 -27937
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.github/workflows/docs-test.yml
+1 -1
View File
@@ -22,7 +22,7 @@ jobs:
- name: Setup Node.js environment
uses: actions/setup-node@v3
with:
node-version: "16.14.0"
node-version: "18"
cache: "yarn"
- name: Install dependencies
docs-util/packages/typedoc-config/entities.js
+6
View File
@@ -20,6 +20,12 @@ module.exports = {
sections: {
member_sources_definedIn: false,
reflection_hierarchy: false,
member_sources_inheritedFrom: false,
member_sources_implementationOf: false,
reflection_implementedBy: false,
member_signature_sources: false,
reflection_callable: false,
reflection_indexable: false,
},
parameterStyle: "component",
parameterComponent: "ParameterTypes",
docs-util/packages/typedoc-config/js-client.js
+4
View File
@@ -14,6 +14,10 @@ const defaultFormattingOptions = {
member_signature_title: false,
member_signature_returns: false,
title_reflectionPath: false,
reflection_callable: false,
reflection_indexable: false,
reflection_implementedBy: false,
member_declaration_title: false,
},
parameterStyle: "component",
parameterComponent: "ParameterTypes",
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment.ts
+3
View File
@@ -3,6 +3,7 @@ import * as Handlebars from "handlebars"
import * as Path from "path"
import { CommentDisplayPart } from "typedoc/dist/lib/models/comments/comment"
import { MarkdownTheme } from "../../theme"
import { escapeChars } from "../../utils"
export default function (theme: MarkdownTheme) {
Handlebars.registerHelper("comment", function (parts: CommentDisplayPart[]) {
@@ -10,6 +11,8 @@ export default function (theme: MarkdownTheme) {
for (const part of parts) {
switch (part.kind) {
case "text":
result.push(escapeChars(part.text, false))
break
case "code":
result.push(part.text)
break
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts
+3 -6
View File
@@ -31,7 +31,8 @@ export default function (theme: MarkdownTheme) {
(reflection.parent?.kindOf(ReflectionKind.Enum) ? " = " : ": ") +
Handlebars.helpers.type.call(
reflectionType ? reflectionType : reflection,
"object"
"object",
false
)
)
}
@@ -43,11 +44,7 @@ export default function (theme: MarkdownTheme) {
`${this.flags.isRest ? "... " : ""} **${escapeChars(this.name)}**`
)
if (this instanceof DeclarationReflection && this.typeParameters) {
md.push(
`<${this.typeParameters
.map((typeParameter) => `\`${typeParameter.name}\``)
.join(", ")}\\>`
)
md.push(`\`<${this.typeParameters.join(", ")}>\``)
}
md.push(getType(this))
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/reflection-title.ts
+1 -1
View File
@@ -28,7 +28,7 @@ export default function (theme: MarkdownTheme) {
const typeParameters = this.model.typeParameters
.map((typeParameter: ParameterReflection) => typeParameter.name)
.join(", ")
title.push(`<${typeParameters}${shouldEscape ? "\\>" : ">"}`)
title.push(`\`<${typeParameters}>\``)
}
}
if (reflectionTitle?.suffix) {
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-title.ts
+18 -28
View File
@@ -4,7 +4,7 @@ import {
ReflectionKind,
SignatureReflection,
} from "typedoc"
import { memberSymbol } from "../../utils"
import { getHTMLChar, memberSymbol } from "../../utils"
import { MarkdownTheme } from "../../theme"
export default function (theme: MarkdownTheme) {
@@ -21,30 +21,23 @@ export default function (theme: MarkdownTheme) {
}
const md: string[] = []
if (!expandMembers) {
md.push("`")
}
if (standalone && !theme.hideMembersSymbol) {
md.push(`${memberSymbol(this)} `)
}
if (this.parent && this.parent.flags?.length > 0) {
md.push(
this.parent.flags
.map(
(flag) =>
`${!expandMembers ? "`" : ""}${flag}${
!expandMembers ? "`" : ""
}`
)
.join(" ") + " "
)
md.push(this.parent.flags.join(" ") + " ")
}
if (accessor) {
md.push(
`${!expandMembers ? "`" : ""}${accessor}${
!expandMembers ? "`" : ""
} ${expandMembers ? `${Handlebars.helpers.titleLevel(4)} ` : "**"}${
this.name
}${!expandMembers ? "**" : ""}`
`${accessor}${
expandMembers ? `${Handlebars.helpers.titleLevel(4)} ` : "**"
}${this.name}${!expandMembers ? "**" : ""}`
)
} else if (this.name !== "__call" && this.name !== "__type") {
md.push(
@@ -56,22 +49,19 @@ export default function (theme: MarkdownTheme) {
if (this.typeParameters) {
md.push(
`<${this.typeParameters
.map(
(typeParameter) =>
`${!expandMembers ? "`" : ""}${typeParameter.name}${
!expandMembers ? "`" : ""
}`
)
.join(", ")}\\>`
`${expandMembers ? getHTMLChar("<") : "<"}${this.typeParameters.join(
", "
)}${expandMembers ? getHTMLChar(">") : ">"}`
)
}
md.push(`(${getParameters(this.parameters, !expandMembers)})`)
md.push(`(${getParameters(this.parameters, false)})`)
if (this.type && !this.parent?.kindOf(ReflectionKind.Constructor)) {
md.push(
`: ${Handlebars.helpers.type.call(this.type, "none", !expandMembers)}`
)
md.push(`: ${Handlebars.helpers.type.call(this.type, "none", false)}`)
}
if (!expandMembers) {
md.push("`")
}
return md.join("") + (standalone ? "\n" : "")
}
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/comment.hbs
+1 -1
View File
@@ -4,7 +4,7 @@
{{#if hasVisibleComponent}}
{{{comments this}}}
{{{comments this true true 4 model}}}
{{/if}}
docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs
+14 -6
View File
@@ -1,10 +1,18 @@
{{#if (sectionEnabled "member_declaration_title")}}
{{{declarationTitle}}}
{{/if}}
{{#if (sectionEnabled "member_declaration_comment")}}
{{> comment}}
{{/if}}
{{#if (sectionEnabled "member_declaration_example")}}
{{{example this 4}}}
{{{example this 3}}}
{{/if}}
@@ -12,7 +20,7 @@
{{#if typeParameters}}
{{titleLevel 4}} Type parameters
{{titleLevel 3}} Type parameters
{{#with typeParameters}}
@@ -32,7 +40,7 @@
{{#with type.declaration.indexSignature}}
{{titleLevel 4}} Index signature
{{titleLevel 3}} Index signature
{{{indexSignatureTitle}}}
@@ -50,11 +58,11 @@
{{#if type.declaration.children}}
{{titleLevel 4}} Call signature
{{titleLevel 3}} Call signature
{{else}}
{{titleLevel 4}} Type declaration
{{titleLevel 3}} Type declaration
{{/if}}
@@ -74,7 +82,7 @@
{{#with type.declaration}}
{{titleLevel 4}} Type declaration
{{titleLevel 3}} Type declaration
{{/with}}
docs-util/packages/typedoc-plugin-markdown-medusa/src/types.ts
+3 -1
View File
@@ -19,6 +19,9 @@ export type ObjectLiteralDeclarationStyle = "table" | "list" | "component"
export type SectionKey =
| "comment"
| "member_declaration"
| "member_declaration_title"
| "member_declaration_comment"
| "member_declaration_typeParameters"
| "member_declaration_indexSignature"
| "member_declaration_signatures"
@@ -29,7 +32,6 @@ export type SectionKey =
| "member_signatures"
| "member_getterSetter"
| "member_reference"
| "member_declaration"
| "member_signature_title"
| "member_signature_comment"
| "member_signature_typeParameters"
docs-util/packages/typedoc-plugin-markdown-medusa/src/utils.ts
+10 -6
View File
@@ -16,13 +16,17 @@ export function formatContents(contents: string) {
)
}
export function escapeChars(str: string) {
export function getHTMLChar(str: string) {
return str
.replace(/>/g, "\\>")
.replace(/>/g, "\\>")
.replace(/_/g, "\\_")
.replace(/`/g, "\\`")
.replace(/\|/g, "\\|")
.replace(/</g, "&#60;")
.replace(/{/g, "&#123;")
.replace(/}/g, "&#125;")
.replace(/>/g, "&#62;")
}
export function escapeChars(str: string, escapeBackticks = true) {
const result = getHTMLChar(str).replace(/_/g, "\\_").replace(/\|/g, "\\|")
return escapeBackticks ? result.replace(/`/g, "\\`") : result
}
export function memberSymbol(
docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts
+13 -6
View File
@@ -1,4 +1,9 @@
import { Comment, ReflectionKind, ReflectionType } from "typedoc"
import {
Comment,
DeclarationReflection,
ReflectionKind,
ReflectionType,
} from "typedoc"
import * as Handlebars from "handlebars"
import { stripCode, stripLineBreaks } from "../utils"
import { Parameter, ParameterStyle, ReflectionParameterType } from "../types"
@@ -72,7 +77,7 @@ export function reflectionListFormatter(
: getTypeChildren(reflection.type!, reflection.project)
const itemChildren: string[] = []
let itemChildrenKind: ReflectionKind | null = null
children?.forEach((childItem) => {
children?.forEach((childItem: DeclarationReflection) => {
if (!itemChildrenKind) {
itemChildrenKind = childItem.kind
}
@@ -102,7 +107,7 @@ export function reflectionComponentFormatter(
name: reflection.name,
type: reflection.type
? getType(reflection.type, "object")
: getReflectionType(reflection, "object"),
: getReflectionType(reflection, "object", true),
description: comments
? stripLineBreaks(Handlebars.helpers.comments(comments, true, false))
: "",
@@ -124,8 +129,10 @@ export function reflectionComponentFormatter(
: getTypeChildren(reflection.type!, reflection.project)
children
?.filter((childItem) => childItem.kindOf(ALLOWED_KINDS))
.forEach((childItem) => {
?.filter((childItem: DeclarationReflection) =>
childItem.kindOf(ALLOWED_KINDS)
)
.forEach((childItem: DeclarationReflection) => {
componentItem.children?.push(
reflectionComponentFormatter(childItem, level + 1, maxLevel)
)
@@ -163,7 +170,7 @@ export function reflectionTableFormatter(
row.push(
parameter.type
? Handlebars.helpers.type.call(parameter.type, "object")
: getReflectionType(parameter, "object")
: getReflectionType(parameter, "object", true)
)
if (showDefaults) {
docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/return-reflection-formatter.ts
+1 -1
View File
@@ -21,7 +21,7 @@ export function returnReflectionComponentFormatter(
level = 1,
maxLevel?: number | undefined
): Parameter[] {
const typeName = getType(reflectionType, "object", false)
const typeName = getType(reflectionType, "object", false, true)
const type = getType(reflectionType, "object")
const componentItem: Parameter[] = []
if (reflectionType.type === "reference") {
docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts
+153 -71
View File
@@ -20,33 +20,34 @@ import {
} from "typedoc"
import * as Handlebars from "handlebars"
import { ReflectionParameterType } from "../types"
import { escapeChars } from "../utils"
import { escapeChars, getHTMLChar } from "../utils"
export type Collapse = "object" | "function" | "all" | "none"
export default function getType(
reflectionType: SomeType,
collapse: Collapse = "none",
emphasis = true
emphasis = true,
hideLink = false
): string {
if (reflectionType instanceof ReferenceType) {
return getReferenceType(reflectionType, emphasis)
return getReferenceType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof ArrayType && reflectionType.elementType) {
return getArrayType(reflectionType, emphasis)
return getArrayType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof UnionType && reflectionType.types) {
return getUnionType(reflectionType, emphasis)
return getUnionType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof IntersectionType && reflectionType.types) {
return getIntersectionType(reflectionType)
return getIntersectionType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof TupleType && reflectionType.elements) {
return getTupleType(reflectionType)
return getTupleType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof IntrinsicType && reflectionType.name) {
@@ -54,27 +55,32 @@ export default function getType(
}
if (reflectionType instanceof ReflectionType) {
return getReflectionType(reflectionType.declaration, collapse)
return getReflectionType(
reflectionType.declaration,
collapse,
emphasis,
hideLink
)
}
if (reflectionType instanceof DeclarationReflection) {
return getReflectionType(reflectionType, collapse)
return getReflectionType(reflectionType, collapse, emphasis, hideLink)
}
if (reflectionType instanceof TypeOperatorType) {
return getTypeOperatorType(reflectionType)
return getTypeOperatorType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof QueryType) {
return getQueryType(reflectionType)
return getQueryType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof ConditionalType) {
return getConditionalType(reflectionType)
return getConditionalType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof IndexedAccessType) {
return getIndexAccessType(reflectionType)
return getIndexAccessType(reflectionType, emphasis, hideLink)
}
if (reflectionType instanceof UnknownType) {
@@ -86,7 +92,7 @@ export default function getType(
}
if (reflectionType instanceof LiteralType) {
return getLiteralType(reflectionType)
return getLiteralType(reflectionType, emphasis)
}
return reflectionType ? escapeChars(reflectionType.toString()) : ""
@@ -94,148 +100,203 @@ export default function getType(
export function getReflectionType(
model: ReflectionParameterType,
collapse: Collapse
collapse: Collapse,
emphasis: boolean,
hideLink = false
): string {
if ("signatures" in model && model.signatures) {
return collapse === "function" || collapse === "all"
? `\`fn\``
: getFunctionType(model.signatures)
? `${emphasis ? "`" : ""}fn${emphasis ? "`" : ""}`
: getFunctionType(model.signatures, emphasis, hideLink)
}
return collapse === "object" || collapse === "all"
? `\`object\``
: getDeclarationType(model as DeclarationReflection)
? `${emphasis ? "`" : ""}object${emphasis ? "`" : ""}`
: `${emphasis ? "`" : ""}${getDeclarationType(
model as DeclarationReflection,
false,
hideLink
)}${emphasis ? "`" : ""}`
}
export function getDeclarationType(model: DeclarationReflection): string {
export function getDeclarationType(
model: DeclarationReflection,
emphasis: boolean,
hideLink = false
): string {
if (model.indexSignature || model.children) {
let indexSignature = ""
const declarationIndexSignature = model.indexSignature
if (declarationIndexSignature) {
const key = declarationIndexSignature.parameters
? declarationIndexSignature.parameters.map(
(param) => `\`[${param.name}: ${param.type}]\``
(param) => `[${param.name}: ${param.type}]`
)
: ""
const obj = declarationIndexSignature.type
? getType(declarationIndexSignature.type)
? getType(declarationIndexSignature.type, "none", false, hideLink)
: ""
indexSignature = `${key}: ${obj}; `
}
const types =
model.children &&
model.children.map((obj) => {
return `\`${obj.name}${obj.flags.isOptional ? "?" : ""}\`: ${
obj.type ? getType(obj.type) : escapeChars(obj.toString())
return `${obj.name}${obj.flags.isOptional ? "?" : ""}: ${
obj.type
? getType(obj.type, "none", false, hideLink)
: escapeChars(obj.toString())
} ${
obj.defaultValue && obj.defaultValue !== "..."
? `= ${escapeChars(`${obj.defaultValue}`)}`
: ""
}`
})
return `{ ${indexSignature ? indexSignature : ""}${
types ? types.join("; ") : ""
} }${
return `${emphasis ? "`{" : getHTMLChar("{")} ${
indexSignature ? indexSignature : ""
}${types ? types.join("; ") : ""} ${emphasis ? "}`" : getHTMLChar("}")}${
model.defaultValue && model.defaultValue !== "..."
? `= ${escapeChars(`${model.defaultValue}`)}`
: ""
}`
}
return "{}"
return emphasis ? "`{}`" : escapeChars("{}")
}
export function getFunctionType(
modelSignatures: SignatureReflection[]
modelSignatures: SignatureReflection[],
emphasis: boolean,
hideLink = false
): string {
const functions = modelSignatures.map((fn) => {
const typeParams = fn.typeParameters
? `<${fn.typeParameters
? `${emphasis ? "`<" : getHTMLChar("<")}${fn.typeParameters
.map((typeParameter) => typeParameter.name)
.join(", ")}\\>`
.join(", ")}${emphasis ? ">`" : getHTMLChar(">")}`
: []
const params = fn.parameters
? fn.parameters.map((param) => {
return `${param.flags.isRest ? "..." : ""}\`${param.name}${
param.flags.isOptional ? "?" : ""
}\`: ${
param.type ? getType(param.type) : escapeChars(param.toString())
return `${param.flags.isRest ? "..." : ""}${emphasis ? "`" : ""}${
param.name
}${param.flags.isOptional ? "?" : ""}${emphasis ? "`" : ""}: ${
param.type
? getType(param.type, "none", emphasis, hideLink)
: escapeChars(param.toString())
}`
})
: []
const returns = fn.type ? getType(fn.type) : escapeChars(fn.toString())
const returns = fn.type
? getType(fn.type, "none", emphasis, hideLink)
: escapeChars(fn.toString())
return typeParams + `(${params.join(", ")}) => ${returns}`
})
return functions.join("")
}
export function getLiteralType(model: LiteralType): string {
export function getLiteralType(model: LiteralType, emphasis: boolean): string {
if (typeof model.value === "bigint") {
return `\`${model.value}n\``
return `${emphasis ? "`" : ""}${model.value}n${emphasis ? "`" : ""}`
}
return `\`\`${JSON.stringify(model.value)}\`\``
return `${emphasis ? "`" : ""}\`${JSON.stringify(model.value)}\`${
emphasis ? "`" : ""
}`
}
export function getReferenceType(
model: ReferenceType,
emphasis: boolean
emphasis: boolean,
hideLink = false
): string {
const shouldShowLink = emphasis && model.name !== "Record"
const shouldShowLink = !hideLink && model.name !== "Record"
const wrappingBackticks = emphasis && !shouldShowLink
if (model.reflection || (model.name && model.typeArguments)) {
const reflection: string[] = []
const reflection: string[] = [wrappingBackticks ? "`" : ""]
if (model.reflection?.url) {
reflection.push(
shouldShowLink
? `[${`\`${model.reflection.name}\``}](${Handlebars.helpers.relativeURL(
? `[${model.reflection.name}](${Handlebars.helpers.relativeURL(
model.reflection.url
)})`
: model.reflection.name
: emphasis
? model.reflection.name
: escapeChars(model.reflection.name)
)
} else {
reflection.push(
shouldShowLink
? model.externalUrl
? `[${`\`${model.name}\``}]( ${model.externalUrl} )`
: `\`${model.name}\``
? `[${model.name}]( ${model.externalUrl} )`
: model.name
: emphasis
? model.name
: escapeChars(model.name)
)
}
if (model.typeArguments && model.typeArguments.length > 0) {
reflection.push(
`<${model.typeArguments
.map((typeArgument) => getType(typeArgument, "none", emphasis))
.join(", ")}\\>`
`${wrappingBackticks ? "<" : getHTMLChar("<")}${model.typeArguments
.map((typeArgument) => getType(typeArgument, "none", false, hideLink))
.join(", ")}${wrappingBackticks ? ">" : getHTMLChar(">")}`
)
}
if (wrappingBackticks) {
reflection.push("`")
}
return reflection.join("")
}
return shouldShowLink
? model.externalUrl
? `[${`\`${model.name}\``}]( ${model.externalUrl} )`
: `\`${model.name}\``
? `[${emphasis ? `\`${model.name}\`` : escapeChars(model.name)}]( ${
model.externalUrl
} )`
: emphasis
? `\`${model.name}\``
: escapeChars(model.name)
: emphasis
? `\`${model.name}\``
: escapeChars(model.name)
}
export function getArrayType(model: ArrayType, emphasis: boolean): string {
const arrayType = getType(model.elementType, "none", emphasis)
export function getArrayType(
model: ArrayType,
emphasis: boolean,
hideLink = false
): string {
const arrayType = getType(model.elementType, "none", emphasis, hideLink)
return model.elementType.type === "union"
? `(${arrayType})[]`
: `${arrayType}[]`
}
export function getUnionType(model: UnionType, emphasis: boolean): string {
export function getUnionType(
model: UnionType,
emphasis: boolean,
hideLink = false
): string {
return model.types
.map((unionType) => getType(unionType, "none", emphasis))
.map((unionType) => getType(unionType, "none", emphasis, hideLink))
.join(` \\| `)
}
export function getIntersectionType(model: IntersectionType): string {
export function getIntersectionType(
model: IntersectionType,
emphasis: boolean,
hideLink = false
): string {
return model.types
.map((intersectionType) => getType(intersectionType))
.map((intersectionType) =>
getType(intersectionType, "none", emphasis, hideLink)
)
.join(" & ")
}
export function getTupleType(model: TupleType): string {
return `[${model.elements.map((element) => getType(element)).join(", ")}]`
export function getTupleType(
model: TupleType,
emphasis: boolean,
hideLink = false
): string {
return `[${model.elements
.map((element) => getType(element, "none", emphasis, hideLink))
.join(", ")}]`
}
export function getIntrinsicType(
@@ -245,12 +306,25 @@ export function getIntrinsicType(
return emphasis ? `\`${model.name}\`` : escapeChars(model.name)
}
export function getTypeOperatorType(model: TypeOperatorType): string {
return `${model.operator} ${getType(model.target)}`
export function getTypeOperatorType(
model: TypeOperatorType,
emphasis: boolean,
hideLink = false
): string {
return `${model.operator} ${getType(
model.target,
"none",
emphasis,
hideLink
)}`
}
export function getQueryType(model: QueryType): string {
return `typeof ${getType(model.queryType)}`
export function getQueryType(
model: QueryType,
emphasis: boolean,
hideLink = false
): string {
return `typeof ${getType(model.queryType, "none", emphasis, hideLink)}`
}
export function getInferredType(model: InferredType): string {
@@ -261,33 +335,41 @@ export function getUnknownType(model: UnknownType): string {
return escapeChars(model.name)
}
export function getConditionalType(model: ConditionalType): string {
export function getConditionalType(
model: ConditionalType,
emphasis: boolean,
hideLink = false
): string {
const md: string[] = []
if (model.checkType) {
md.push(getType(model.checkType))
md.push(getType(model.checkType, "none", emphasis, hideLink))
}
md.push("extends")
if (model.extendsType) {
md.push(getType(model.extendsType))
md.push(getType(model.extendsType, "none", emphasis, hideLink))
}
md.push("?")
if (model.trueType) {
md.push(getType(model.trueType))
md.push(getType(model.trueType, "none", emphasis, hideLink))
}
md.push(":")
if (model.falseType) {
md.push(getType(model.falseType))
md.push(getType(model.falseType, "none", emphasis, hideLink))
}
return md.join(" ")
}
export function getIndexAccessType(model: IndexedAccessType): string {
export function getIndexAccessType(
model: IndexedAccessType,
emphasis: boolean,
hideLink = false
): string {
const md: string[] = []
if (model.objectType) {
md.push(getType(model.objectType))
md.push(getType(model.objectType, "none", emphasis, hideLink))
}
if (model.indexType) {
md.push(`[${getType(model.indexType)}]`)
md.push(`[${getType(model.indexType, "none", false, hideLink)}]`)
}
return md.join("")
}
packages/utils/src/feature-flags/utils/flag-router.ts
+2 -2
View File
@@ -40,8 +40,8 @@ export class FlagRouter implements FeatureFlagTypes.IFlagRouter {
/**
* Sets a feature flag.
* Flags take two shapes:
* setFlag("myFeatureFlag", true)
* setFlag("myFeatureFlag", { nestedFlag: true })
* `setFlag("myFeatureFlag", true)`
* `setFlag("myFeatureFlag", { nestedFlag: true })`
* These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled.
* @param key - The key of the flag to set.
* @param value - The value of the flag to set.
www/apps/docs/content/admin/onboarding.md
-2012
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/admin/onboarding.mdx
+1981
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/create-medusa-app.mdx
+9 -18
View File
@@ -63,10 +63,8 @@ In your terminal, run the following command:
</TabItem>
</Tabs>
<details>
<summary>
Command Options
</summary>
<Details>
<Summary>Command Options</Summary>
The `create-medusa-app` command can accept the following options:
@@ -79,13 +77,10 @@ The `create-medusa-app` command can accept the following options:
- `--no-migrations`: Skips running migrations, creating admin user, and seeding. If used, it's expected that you pass the `--db-url` option with a URL of a database that has all necessary migrations. Otherwise, unexpected errors will occur. Helpful only if combined with `--db-url`.
- `--directory-path <path>`: Allows specifying the parent directory path to create the directory of the new project in.
- `--with-nextjs-starter`: Installs the Next.js starter storefront under the `<PROJECT_NAME>-storefront` directory, where `<PROJECT_NAME>` is the name of the project you enter in the first question. If the `<PROJECT_NAME>-storefront` directory already exists, random characters are added at the end of `<PROJECT_NAME>-storefront`.
</Details>
</details>
<details className="border-t-0">
<summary>
Example: Connect to a Vercel PostgreSQL Database
</summary>
<Details className="border-t-0">
<Summary>Example: Connect to a Vercel PostgreSQL Database</Summary>
If you want to use a PostgreSQL database hosted on Vercel, you must use the `--db-url` option and add to the end of your connection URL `?sslmode=require`. For example:
@@ -98,13 +93,10 @@ npx create-medusa-app@latest --db-url "postgres://default:<password><host-region
If the database already has the necessary migrations and you don't need the command to run migrations, you can pass the `--no-migrations` option.
:::
</Details>
</details>
<details className="border-t-0">
<summary>
Example: Connect to a Supabase Database
</summary>
<Details className="border-t-0">
<Summary>Example: Connect to a Supabase Database</Summary>
If you want to connect to a Supabase database, you must use the `--db-url` option with its value beign the connection URL to your Supabase database. For example:
@@ -117,8 +109,7 @@ npx create-medusa-app@latest --db-url postgresql://postgres:<password>@<host>.su
If the database already has the necessary migrations and you don't need the command to run migrations, you can pass the `--no-migrations` option.
:::
</details>
</Details>
## Step 2: Specify Project Name
www/apps/docs/content/deployments/server/deploying-on-railway.md
+2 -2
View File
@@ -22,8 +22,8 @@ If you're deploying the admin plugin along with the backend, you'll need at leas
If you also don't have a Medusa project, you can deploy to Railway instantly with this button:
<a
href="https://railway.app/template/zC7eOq?referralCode=TW4Qi0" class="img-url no-zoom-img">
<img src="https://railway.app/button.svg" alt="Deploy with Railway" class="no-zoom-img"/>
href="https://railway.app/template/zC7eOq?referralCode=TW4Qi0" className="img-url no-zoom-img">
<img src="https://railway.app/button.svg" alt="Deploy with Railway" className="no-zoom-img"/>
</a>
---
www/apps/docs/content/deployments/storefront/deploying-next-on-vercel.mdx
+2 -2
View File
@@ -13,8 +13,8 @@ In this document, you’ll learn how to deploy the Next.js Starter Template on V
Alternatively, you can directly deploy the Next.js Starter Template to Vercel with this button.
<a
href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmedusajs%2Fnextjs-starter-medusa.git&env=NEXT_PUBLIC_MEDUSA_BACKEND_URL&envDescription=URL%20of%20your%20Medusa%20Backend" class="img-url no-zoom-img">
<img src="https://vercel.com/button" alt="Deploy with Vercel" class="no-zoom-img"/>
href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmedusajs%2Fnextjs-starter-medusa.git&env=NEXT_PUBLIC_MEDUSA_BACKEND_URL&envDescription=URL%20of%20your%20Medusa%20Backend" className="img-url no-zoom-img">
<img src="https://vercel.com/button" alt="Deploy with Vercel" className="no-zoom-img"/>
</a>
:::note
www/apps/docs/content/development/api-routes/create.mdx
+3 -5
View File
@@ -538,10 +538,8 @@ After using `MedusaError`, the returned error in the response provides a clearer
}
```
<details>
<summary>
Available MedusaError Types and their respective status codes
</summary>
<Details>
<Summary>Available MedusaError Types and their respective status codes</Summary>
The default response code is `500` unless mentioned otherwise.
@@ -556,7 +554,7 @@ The default response code is `500` unless mentioned otherwise.
- `MedusaError.Types.CONFLICT`: Sets the resposne code to `409`.
- `MedusaError.Types.PAYMENT_AUTHORIZATION_ERROR`: Sets the resposne code to `422`.
</details>
</Details>
### Override Error Handler
www/apps/docs/content/development/backend/prepare-environment.mdx
+1 -25
View File
@@ -26,14 +26,11 @@ node -v
<Tabs groupId="operating-systems" queryString="os">
<TabItem value="windows" label="Windows" default>
You can install the executable directly from [the Node.js website](https://nodejs.org/en/#home-downloadhead).
For other approaches, you can check out [Node.js’s guide](https://nodejs.org/en/download/package-manager/#windows-1).
</TabItem>
<TabItem value="linux" label="Linux">
You can use the following commands to install Node.js on Ubuntu:
```bash
@@ -43,22 +40,17 @@ sudo apt install nodejs
```
For other Linux distributions, you can check out [Node.js’s guide](https://nodejs.org/en/download/package-manager/).
</TabItem>
<TabItem value="macos" label="macOS">
You can use the following commands to install Node.js on macOS:
<Tabs groupId="homebrew" isCodeTabs={true}>
<TabItem value="homebrew" label="Homebrew">
```bash
brew install node
```
</TabItem>
<TabItem value="no-homebrew" label="Without Homebrew">
```bash
curl \
"https://nodejs.org/dist/latest/node-${VERSION:-$(wget -qO- \
@@ -67,17 +59,13 @@ curl \
> "$HOME/Downloads/node-latest.pkg" &&
sudo installer -store -pkg "$HOME/Downloads/node-latest.pkg" -target "/"
```
</TabItem>
</Tabs>
For other approaches, you can check out [Node.js’s guide](https://nodejs.org/en/download/package-manager/#macos).
:::tip
Make sure that you have Xcode command line tools installed. If not, run the following command to install it: `xcode-select --install`.
Make sure that you have Xcode command line tools installed; if not, run the following command to install it: `xcode-select --install`
:::
</TabItem>
</Tabs>
@@ -87,12 +75,9 @@ Medusa uses Git behind the scenes when you create a new project. So, you'll have
<Tabs groupId="operating-systems" queryString="os">
<TabItem value="windows" label="Windows" default>
To install Git on Windows, you need to [download the installable package](https://git-scm.com/download/win).
</TabItem>
<TabItem value="linux" label="Linux">
For Debian/Ubuntu, you can use the following command:
```bash
@@ -100,10 +85,8 @@ apt-get install git
```
As for other Linux distributions, please check [git’s guide](https://git-scm.com/download/linux).
</TabItem>
<TabItem value="macos" label="macOS">
You should already have Git installed as part of the Xcode command-line tools.
However, if for any reason you need to install it manually, you can install it with Homebrew:
@@ -113,7 +96,6 @@ brew install git
```
You can also check out [git’s guide](https://git-scm.com/download/mac) for more installation options.
</TabItem>
</Tabs>
@@ -123,12 +105,9 @@ The Medusa backend uses PostgreSQL to store data of your commerce system.
<Tabs groupId="operating-systems" queryString="os">
<TabItem value="windows" label="Windows">
You can [download the PostgreSQL Windows installer](https://www.postgresql.org/download/windows/) from their website.
</TabItem>
<TabItem value="linux" label="Linux">
If you’re using Ubuntu, you can use the following commands to download and install PostgreSQL:
```bash
@@ -141,12 +120,9 @@ sudo apt-get -y install postgresql
```
For other distributions, you can check out [PostgreSQL’s website for more guides](https://www.postgresql.org/download/linux/).
</TabItem>
<TabItem value="macos" label="macOS">
You can download PostgreSQL on your macOS using [the installer on their website](https://www.postgresql.org/download/macosx/).
</TabItem>
</Tabs>
www/apps/docs/content/development/plugins/create.mdx
-3
View File
@@ -417,7 +417,6 @@ While you develop your plugin, you’ll need to test it on an actual Medusa back
<Tabs groupId="plugin-preference">
<TabItem value="without-admin" label="Without Admin Customizations" default>
In the root of your plugin directory, run the `build` command:
```bash
@@ -426,7 +425,6 @@ While you develop your plugin, you’ll need to test it on an actual Medusa back
</TabItem>
<TabItem value="with-admin" label="With Admin Customizations">
In the root of your plugin directory, run the `prepare` command:
```bash
@@ -434,7 +432,6 @@ While you develop your plugin, you’ll need to test it on an actual Medusa back
```
If the `prepare` script is not available in your project, you can find it in [this section](#changes-for-admin-plugins).
</TabItem>
</Tabs>
www/apps/docs/content/development/plugins/publish.mdx
-4
View File
@@ -45,7 +45,6 @@ Before publishing your plugin, make sure you've set the following fields in your
<Tabs groupId="plugin-preference">
<TabItem value="without-admin" label="Without Admin Customizations" default>
Make sure you add the `publish` script to your `scripts` field:
```json title=package.json
@@ -59,10 +58,8 @@ Before publishing your plugin, make sure you've set the following fields in your
The `build` script ensures that the plugin's built files are placed as explained in the [plugin structure](./create.mdx#plugin-structure) section of the Create Plugin documentation.
The `prepare` script facilitates your publishing process. You would typically run this script before publishing your plugin.
</TabItem>
<TabItem value="with-admin" label="With Admin Customizations">
First, make sure to change `tsconfig` files as recommended in the [create guide](./create.mdx#changes-for-admin-plugins).
Then, add the following `prepare` and `build` scripts to your `scripts`
@@ -78,7 +75,6 @@ Before publishing your plugin, make sure you've set the following fields in your
The `build:server` script builds the resources of the backend for development and ensures they are placed as explained in the [plugin structure](./create.mdx#plugin-structure) section of the Create Plugin documentation.
The `prepare` script creates a production build of both backend and admin resources.
</TabItem>
</Tabs>
www/apps/docs/content/js-client/overview.mdx
+5 -7
View File
@@ -2,8 +2,8 @@
description: 'Learn how to install the Medusa JS Client in a storefront. Medusa JS Client provides easy access to the Medusa API from a client written in TypeScript.'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
# Medusa JS Client
@@ -39,10 +39,8 @@ Where `MEDUSA_BACKEND_URL` is the URL to your Medusa backend. If the `baseUrl` o
After initialization, you can use the client's properties and methods to send requests to the Medusa backend.
<details>
<summary>
Troubleshooting: Could not find a declaration file for module '@medusajs/medusa-js'
</summary>
<Details>
<Summary>Troubleshooting: Could not find a declaration file for module '@medusajs/medusa-js'</Summary>
If you import `@medusajs/medusa-js` in your code and see the following TypeScript error:
@@ -62,7 +60,7 @@ Make sure to set `moduleResolution` in your `tsconfig.json` to `nodenext` or `no
}
```
</details>
</Details>
## How to Use this Reference
www/apps/docs/content/modules/orders/admin/edit-order.mdx
-1
View File
@@ -318,7 +318,6 @@ fetch(`<BACKEND_URL>/admin/order-edits/${orderEditId}/items/${itemId}`, {
console.log(order_edit.changes)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
www/apps/docs/content/modules/orders/admin/manage-orders.mdx
-1
View File
@@ -580,7 +580,6 @@ const CapturePayment = () => {
export default CapturePayment
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx
+6 -7
View File
@@ -3,8 +3,9 @@ description: 'Learn how to bulk-import prices into Medusa using the Admin REST A
addHowToData: true
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
import Details from "@site/src/theme/MDXProvider/Details"
# How to Bulk Import Prices
@@ -39,10 +40,8 @@ Part of the process of importing prices is uploading a CSV file. This requires a
You must have a CSV file that you will use to import prices into your Medusa backend. You can check [this CSV example file](https://medusa-doc-files.s3.amazonaws.com/price-list-import-template.csv) to see which format is required for your import.
<details>
<summary>
Expected columns
</summary>
<Details>
<Summary>Expected columns</Summary>
<table class="reference-table">
<thead>
@@ -113,7 +112,7 @@ No
</table>
</details>
</Details>
### JS Client
www/apps/docs/content/modules/products/admin/import-products.mdx
+5 -7
View File
@@ -3,8 +3,8 @@ description: 'Learn how to import products into Medusa using the Admin REST APIs
addHowToData: true
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
# How to Bulk Import Products
@@ -39,10 +39,8 @@ The local file service can't be used for product import.
You must have a CSV file that you will use to import products into your Medusa backend. You can check [this CSV example file](https://medusa-doc-files.s3.amazonaws.com/product-import-sales-channels.csv) to see which format is required for your import.
<details>
<summary>
Expected columns
</summary>
<Details>
<Summary>Expected columns</Summary>
#### Product columns
@@ -842,7 +840,7 @@ No
</tbody>
</table>
</details>
</Details>
### JS Client
www/apps/docs/content/modules/products/admin/manage-categories.mdx
-1
View File
@@ -657,7 +657,6 @@ fetch(`<BACKEND_URL>/admin/product-categories/${productCategoryId}`, {
console.log(id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
www/apps/docs/content/modules/products/admin/manage-products.mdx
+1 -1
View File
@@ -393,7 +393,7 @@ For currencies that are not zero-decimal, you must set the prices of product var
So, in the example above, if the `amount` is set to `1000`, it means the price is actually `10`.
You can learn more about pricing and zero-decimal currencies [here](../products.md#storing-the-product-variants-price).
You can learn more about pricing and zero-decimal currencies [here](../products.mdx#storing-the-product-variants-price).
---
www/apps/docs/content/modules/products/products.md → www/apps/docs/content/modules/products/products.mdx
+3 -3
View File
@@ -111,8 +111,8 @@ For example, if a variant's price is 10 USD, it's stored is `1000`, as in 1,000
For zero-decimal currencies, the amount is still stored as an integer without multiplying by a 100. For example, if a variant's price is ¥500, it's stored as `500`.
<details>
<summary>Zero-decimal Currencies</summary>
<Details>
<Summary>Zero-decimal Currencies</Summary>
- BIF
- CLP
@@ -131,7 +131,7 @@ For zero-decimal currencies, the amount is still stored as an integer without mu
- XOF
- XPF
</details>
</Details>
This logic of formatting the price is not handled in the backend. So, when you add a product variant using the Admin APIs, you must format the price as explained earlier. The backend stores the price as received from API requests.
www/apps/docs/content/modules/products/serverless-module.md → www/apps/docs/content/modules/products/serverless-module.mdx
+3 -3
View File
@@ -100,8 +100,8 @@ Migrations are used to create your database schema. Before you can run migration
The first command runs the migrations, and the second command allows you to optionally seed your database with demo products. However, you’d need the following seed file added in the root of your Next.js directory:
<details>
<summary>Seed file</summary>
<Details>
<Summary>Seed file</Summary>
```js title=seed-data.js
const productCategoriesData = [
@@ -194,7 +194,7 @@ The first command runs the migrations, and the second command allows you to opti
}
```
</details>
</Details>
Then run the first and optionally second commands to migrate the database schema:
www/apps/docs/content/modules/products/storefront/show-products.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ If you follow the Medusa React code blocks, it's assumed you already have [Medus
This guide also includes code snippets to utilize the `@medusajs/product` module in your storefront, among other methods.
If you follow the `@medusajs/product` code blocks, it's assumed you already have the [@medusajs/product](../serverless-module.md) installed.
If you follow the `@medusajs/product` code blocks, it's assumed you already have the [@medusajs/product](../serverless-module.mdx) installed.
---
@@ -447,7 +447,7 @@ You must pass one of the [pricing parameters](#product-pricing-parameters) to th
:::
Prices in Medusa are stored as the currency's smallest unit. So, for currencies that are not zero-decimal, the amount is stored multiplied by a `100`. You can learn more about this in the [Product conceptual guide](../products.md#storing-the-product-variants-price).
Prices in Medusa are stored as the currency's smallest unit. So, for currencies that are not zero-decimal, the amount is stored multiplied by a `100`. You can learn more about this in the [Product conceptual guide](../products.mdx#storing-the-product-variants-price).
So, to show the correct price, you would need to convert it to its actual price with a method like this:
www/apps/docs/content/modules/products/storefront/use-categories.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ If you follow the Medusa React code blocks, it's assumed you already have [Medus
This guide also includes code snippets to utilize the `@medusajs/product` module in your storefront, among other methods.
If you follow the `@medusajs/product` code blocks, it's assumed you already have the [@medusajs/product](../serverless-module.md) installed.
If you follow the `@medusajs/product` code blocks, it's assumed you already have the [@medusajs/product](../serverless-module.mdx) installed.
---
www/apps/docs/content/modules/sales-channels/storefront/use-sales-channels.mdx
-1
View File
@@ -132,7 +132,6 @@ To associate a sales channel with a cart while creating it, you can pass the `sa
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.carts.create({
sales_channel_id: salesChannelId,
www/apps/docs/content/modules/users/backend/rbac.mdx
+9 -13
View File
@@ -47,10 +47,8 @@ So, the first step would be to create the `Role` and `Permission` entities to re
},
]} />
<details>
<summary>
Example Implementation
</summary>
<Details>
<Summary>Example Implementation</Summary>
This is an example implementation of how you can create the Role and Permission entities, and extend the `User` and `Store` entities.
@@ -327,7 +325,7 @@ npx medusa migrations run
This will reflect the entity changes in your database.
</details>
</Details>
---
@@ -347,8 +345,8 @@ Since the Medusa backend uses Express, you can create a middleware and attach it
}
}} />
<details>
<summary>Example Implementation</summary>
<Details>
<Summary>Example Implementation</Summary>
In this example, you’ll create a middleware that runs on all admin-authenticated routes and checks the logged-in user’s permissions before giving them access to an API Route.
@@ -439,7 +437,7 @@ Notice that you use `req.path` here to get the current API Route path. However,
After defining the middleware, you apply it on all API Routes starting with `/admin/`.
</details>
</Details>
---
@@ -481,10 +479,8 @@ Furthermore, you may need to extend core services if you need to perform actions
},
]} />
<details>
<summary>
Example Implementation
</summary>
<Details>
<Summary>Example Implementation</Summary>
In this example, you’ll only implement two API Routes for simplicity: create role API Route that create a new role with permissions, and associate user API Route that associates a user with a role.
@@ -766,7 +762,7 @@ Next, create a new user using the [Create User API Route](https://docs.medusajs.
Finally, login with the user you created, then try to access any API Route other than `/admin/products`. You’ll receive a `401` unauthorized response. Then, try to access the [List Products API Route](https://docs.medusajs.com/api/admin#products_getproducts), and the user should be able to access it as expected.
</details>
</Details>
---
www/apps/docs/content/plugins/cms/contentful.md → www/apps/docs/content/plugins/cms/contentful.mdx
+32 -50
View File
@@ -95,10 +95,8 @@ const plugins = [
The rest of this section includes the field names you can customize using this option for each content model type.
<details>
<summary>
product
</summary>
<Details>
<Summary>product</Summary>
- `title`
- `subtitle`
@@ -111,12 +109,10 @@ product
- `tags`
- `handle`
</details>
</Details>
<details>
<summary>
variant
</summary>
<Details>
<Summary>variant</Summary>
- `title`
- `sku`
@@ -124,12 +120,10 @@ variant
- `options`
- `medusaId`
</details>
</Details>
<details>
<summary>
region
</summary>
<Details>
<Summary>region</Summary>
- `name`
- `countries`
@@ -137,27 +131,23 @@ region
- `fulfillmentProviders`
- `medusaId`
</details>
</Details>
<details>
<summary>
collection
</summary>
<Details>
<Summary>collection</Summary>
- `title`
- `medusaId`
</details>
</Details>
<details>
<summary>
type
</summary>
<Details>
<Summary>type</Summary>
- `name`
- `medusaId`
</details>
</Details>
### Migrate Content Models
@@ -173,10 +163,8 @@ Before creating the migration scripts, run the following command in the root of
npm install --save-dev contentful-migration
```
<details>
<summary>
product Content Model
</summary>
<Details>
<Summary>product Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product.ts` with the following content:
@@ -252,12 +240,10 @@ export function productMigration(
}
```
</details>
</Details>
<details>
<summary>
productVariant Content Model
</summary>
<Details>
<Summary>productVariant Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product-variant.ts` with the following content:
@@ -299,12 +285,10 @@ export function productVariantMigration(
}
```
</details>
</Details>
<details>
<summary>
collection Content Model
</summary>
<Details>
<Summary>collection Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product-collection.ts` with the following content:
@@ -333,12 +317,11 @@ export function productCollectionMigration(
.type("Symbol")
}
```
</details>
<details>
<summary>
productType Content Model
</summary>
</Details>
<Details>
<Summary>productType Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product-type.ts` with the following content:
@@ -367,12 +350,11 @@ export function productTypeMigration(
.type("Symbol")
}
```
</details>
<details>
<summary>
region Content Model
</summary>
</Details>
<Details>
<Summary>region Content Model</Summary>
Create the file `src/loaders/contentful-migrations/region.ts` with the following content:
@@ -418,7 +400,7 @@ export function regionMigration(
}
```
</details>
</Details>
Finally, create a [loader](../../development/loaders/overview.mdx) at `src/loaders/index.ts` with the following content:
www/apps/docs/content/plugins/notifications/sendgrid.mdx
+53 -41
View File
@@ -71,7 +71,7 @@ Medusa supports localization so you can also create multiple templates for multi
## Template Reference
This section covers the template types supported by the plugin and what variables you can expect in your dynamic template. You can use the variables to add details like order total or customer name.
This section covers the template types supported by the plugin and what variables you can expect in your dynamic template. You can use the variables to add Details like order total or customer name.
:::note
@@ -85,8 +85,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when they place a new order.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -304,7 +304,8 @@ You don’t have to create a template for every type in the reference. You can s
"updated_at": Any<Date>,
}
```
</details>
</Details>
### Order Canceled
@@ -312,8 +313,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to a customer when their order is canceled.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -535,7 +536,8 @@ You don’t have to create a template for every type in the reference. You can s
"updated_at": Any<Date>,
}
```
</details>
</Details>
### Order Shipment Created
@@ -543,8 +545,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a shipment of their order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -817,7 +819,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Order Return Requested
@@ -825,8 +828,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a return request is made for an order.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1259,7 +1262,8 @@ You don’t have to create a template for every type in the reference. You can s
"subtotal": "12.00 USD",
}
```
</details>
</Details>
### Order Items Returned
@@ -1267,8 +1271,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when an order’s items have been returned.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1701,7 +1705,8 @@ You don’t have to create a template for every type in the reference. You can s
"subtotal": "12.00 USD",
}
```
</details>
</Details>
### Claim Shipment Created
@@ -1709,8 +1714,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a Claim shipment has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1998,7 +2003,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Swap Created
@@ -2006,8 +2012,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a swap for an order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -2507,7 +2513,8 @@ You don’t have to create a template for every type in the reference. You can s
"additional_total": "11.25 USD"
}
```
</details>
</Details>
### Swap Shipment Created
@@ -2515,8 +2522,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a shipment of a swap of an order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3087,7 +3094,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Swap Received
@@ -3095,8 +3103,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a swap of an order has been received.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -3597,7 +3605,8 @@ You don’t have to create a template for every type in the reference. You can s
"additional_total": "11.25 USD"
}
```
</details>
</Details>
### Gift Card Created
@@ -3605,8 +3614,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be to the customer sent when a gift card in their order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3765,7 +3774,8 @@ You don’t have to create a template for every type in the reference. You can s
"display_value": 4
}
```
</details>
</Details>
### Customer Password Reset
@@ -3773,8 +3783,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when they request a password reset.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3785,7 +3795,8 @@ You don’t have to create a template for every type in the reference. You can s
"token": Any<String>,
}
```
</details>
</Details>
### User Password Reset
@@ -3793,8 +3804,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the admin user when they request a password reset.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3802,7 +3813,8 @@ You don’t have to create a template for every type in the reference. You can s
"token": Any<String>,
}
```
</details>
</Details>
### Restock Notification
@@ -3810,8 +3822,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to admin users when a product has hit the restock quantity threshold.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3899,7 +3911,8 @@ You don’t have to create a template for every type in the reference. You can s
]
}
```
</details>
</Details>
---
@@ -4004,7 +4017,6 @@ export const POST = async (
to: "customer@mail.com",
dynamic_template_data: { dynamic: "data" },
}
sendgridService.sendEmail(sendOptions)
}
```
www/apps/docs/content/recipes/b2b.mdx
+3 -5
View File
@@ -266,10 +266,8 @@ Medusa allows you to create custom API Routes exposed as REST APIs.
}
}} />
<details>
<summary>
Example Implementation
</summary>
<Details>
<Summary>Example Implementation</Summary>
For example, create the following API Route that allows you to check the customer’s group and whether it has the `is_b2b` flag enabled:
@@ -321,7 +319,7 @@ export const config: MiddlewaresConfig = {
}
```
</details>
</Details>
---
www/apps/docs/content/recipes/commerce-automation.mdx
+12 -20
View File
@@ -100,10 +100,8 @@ Medusa also provides official notification plugins that integrate with third-par
},
]} />
<details>
<summary>
Example: Sending an email for new notes
</summary>
<Details>
<Summary>Example: Sending an email for new notes</Summary>
Here’s an example of a subscriber that uses the SendGrid plugin to send an email to the customer when the order has a new note:
@@ -178,7 +176,7 @@ class NewNoteSubscriber {
export default NewNoteSubscriber
```
</details>
</Details>
---
@@ -198,10 +196,8 @@ You can implement automatic synchronization in Medusa using scheduled jobs. A sc
}
}} />
<details>
<summary>
Example: Synchronizing products with a third-party service
</summary>
<Details>
<Summary>Example: Synchronizing products with a third-party service</Summary>
Here’s an example of synchronizing products with a third party service using a [loader](../development/loaders/create.md):
@@ -266,7 +262,7 @@ Notice that here it’s assumed that:
1. The last update date is stored in the `Store`'s metadata object. You can instead use a custom entity to handle this.
2. The connection to the third-party service is assumed to be available and handled within the `client` variable.
</details>
</Details>
---
@@ -419,10 +415,8 @@ For example, if you're grouping customers with over twenty orders, you can use a
},
]} />
<details>
<summary>
Example: Add customer to VIP group
</summary>
<Details>
<Summary>Example: Add customer to VIP group</Summary>
Here’s an example of a subscriber that listens to the `order.placed` event and checks if the customer should be added to the VIP customer group based on their number of orders:
@@ -500,7 +494,7 @@ class AddCustomerToVipSubscriber {
export default AddCustomerToVipSubscriber
```
</details>
</Details>
---
@@ -543,10 +537,8 @@ You can alternatively have a Scheduled Job that checks if the number of new prod
},
]} />
<details>
<summary>
Example: Sending a newsletter email after adding ten products
</summary>
<Details>
<Summary>Example: Sending a newsletter email after adding ten products</Summary>
Here’s an example of listening to the `product.created` event in a subscriber and send a newsletter if the condition is met:
@@ -641,7 +633,7 @@ class SendProductsNewsletterSubscriber {
export default SendProductsNewsletterSubscriber
```
</details>
</Details>
---
www/apps/docs/content/recipes/digital-products.mdx
+24 -42
View File
@@ -135,10 +135,8 @@ For example, if you're selling the Harry Potter movies, you would have a `Produc
},
]} />
<details>
<summary>
Example: Create ProductMedia Entity
</summary>
<Details>
<Summary>Example: Create ProductMedia Entity</Summary>
In this example, you’ll create a `ProductMedia` entity that is associated with the `ProductVariant` entity in a one-to-many relation.
@@ -227,7 +225,7 @@ npm run build
npx medusa migrations run
```
</details>
</Details>
---
@@ -267,10 +265,8 @@ Creating an API Route also requires creating a service, which is a class that ty
},
]} />
<details>
<summary>
Example: List and Create API Routes
</summary>
<Details>
<Summary>Example: List and Create API Routes</Summary>
This example showcases how you can create the list and create API Routes for digital products. These API Routes are chosen in particular as they’re used in later parts of this recipe. You may follow the same instructions to create other necessary API Routes.
@@ -523,7 +519,7 @@ This creates two API Routes:
- a `GET` API Route at `/admin/product-media` that retrieves a list of product media records that have the type `main`. It also retrieves the relations `variant` and `variant.product` to access the product media’s variant and main product.
- a `POST` API Route at `/admin/product-media` that accepts the necessary data to create a product media, then returns the created product media.
</details>
</Details>
---
@@ -564,10 +560,8 @@ To add an interface that allows the admin user to upload digital products, you c
},
]} />
<details>
<summary>
Example: Digital Products Page in Admin
</summary>
<Details>
<Summary>Example: Digital Products Page in Admin</Summary>
In this example, you’ll add a single page that lists the digital products and allows you to create a new one. The implementation will be minimal for the purpose of simplicity, so you can elaborate on it based on your use case.
@@ -919,7 +913,7 @@ npx medusa develop
If you open the admin now, you’ll find a new Digital Products item in the sidebar. You can try adding Digital Products and viewing them.
</details>
</Details>
---
@@ -947,10 +941,8 @@ Finally, you can send a notification, such as an email, to the customer using th
}
}} />
<details>
<summary>
Example: Using SendGrid
</summary>
<Details>
<Summary>Example: Using SendGrid</Summary>
:::note
@@ -1050,7 +1042,7 @@ Notice that regardless of what file service you have installed, you can access i
The `handleOrderPlaced` method retrieves the order, loops over its items to find digital products and retrieve their download links, then uses SendGrid to send the email, passing it the urls as a data payload. You can customize the sent data based on your SendGrid template and your use case.
</details>
</Details>
---
@@ -1070,10 +1062,8 @@ In the product detail's page, you can add a button that allows customers to down
To implement this, create a storefront API Route that allows you to fetch the digital product, then customize the Next.js storefront to show the preview button if a product is digital.
<details>
<summary>
Example
</summary>
<Details>
<Summary>Example</Summary>
Before you customize the Next.js storefront, you need to add a store API Route in your backend.
@@ -1312,9 +1302,7 @@ const ProductActions: React.FC<ProductActionsProps> = ({
export default ProductActions
```
The
</details>
</Details>
### Update Product Tabs
@@ -1322,10 +1310,8 @@ In the product details page, additional information related to the product and i
You can change this section to show information relevant to the product. For example, how many pages are in an e-book, or how the e-book will be delivered to the customer.
<details>
<summary>
Example
</summary>
<Details>
<Summary>Example</Summary>
In this example, you'll change the content of the Product Information and Shipping & Returns tabs to show information relevant to the digital product. The Product Information tab will include custom information relevant to digital products, and the Shipping & Returns tab will be changed to "E-book delivery" and will hold details about how the e-book will be delivered to the customer.
@@ -1441,16 +1427,14 @@ const ShippingInfoTab = () => {
This changes the titles of the tabs and their content.
</details>
</Details>
### Change Shipping Form in Checkout
When a customer purchases a digital product, the shipping form shown during checkout is not relevant. So, you can change its content to instead only ask for the customer's name and email.
<details>
<summary>
Example
</summary>
<Details>
<Summary>Example</Summary>
The checkout flow is managed by a checkout context defined in `src/lib/context/checkout-context.tsx`. Change the content of the file to the following:
@@ -2028,16 +2012,14 @@ const ShippingDetails = ({
export default ShippingDetails
```
</details>
</Details>
### Download Product After Purchase
After the customer purchases the digital product you can show a download button to allow them to immediately download the product.
<details>
<summary>
Example
</summary>
<Details>
<Summary>Example</Summary>
Before you implement the storefront changes, you need to create a new API Route in the backend that ensures that the currently logged-in customer has purchased the digital product and, if so, returns a presigned URL to download it.
@@ -2275,7 +2257,7 @@ const Items = ({ items, region, cartId }: ItemsProps) => {
export default Items
```
</details>
</Details>
---
www/apps/docs/content/recipes/marketplace.mdx
+11 -9
View File
@@ -41,8 +41,8 @@ To associate these entities with the `Store` entity, you need to extend and cust
}
}} />
<details>
<summary>Example: Associate User with Store</summary>
<Details>
<Summary>Example: Associate User with Store</Summary>
For example, to associate the `User` entity with the `Store` entity, create the file `src/models/user.ts` with the following content:
@@ -139,7 +139,7 @@ npx medusa migrations run
You can extend other entities in a similar manner to associate them with a store.
</details>
</Details>
---
@@ -179,8 +179,8 @@ You can also extend services if you need to customize a functionality implemente
}
}} />
<details>
<summary>Example: Extend User Service</summary>
<Details>
<Summary>Example: Extend User Service</Summary>
You can extend the user service to change how the `create` method is implemented.
@@ -247,7 +247,8 @@ You can then test out your customization by running the `build` command and star
npm run build
npx medusa develop
```
</details>
</Details>
---
@@ -267,8 +268,8 @@ To listen to events, you need to create Subscribers that subscribe a handler met
}
}} />
<details>
<summary>Example: Listen to Order Created Event</summary>
<Details>
<Summary>Example: Listen to Order Created Event</Summary>
To listen to the `order.placed` event, create the file `src/subscribers/orderNotifier.ts` with the following content:
@@ -294,7 +295,8 @@ You can then test out your subscriber by running the `build` command and startin
npm run build
npx medusa develop
```
</details>
</Details>
---
www/apps/docs/content/recipes/pos.mdx
+3 -5
View File
@@ -94,10 +94,8 @@ To search through product variants by their barcode, you can create a custom API
},
]} />
<details>
<summary>
Example: Search Products By Barcode API Route
</summary>
<Details>
<Summary>Example: Search Products By Barcode API Route</Summary>
Here’s an example of creating a custom API Route at `/store/pos/search-barcode` that searches product variants by a barcode:
@@ -137,7 +135,7 @@ export const GET = async (
}
```
</details>
</Details>
---
www/apps/docs/content/references/entities/classes/Address.mdx
+3 -3
View File
@@ -49,7 +49,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country",
"type": "``null`` \\| [`Country`](Country.mdx)",
"type": "``null`` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer",
"type": "``null`` \\| [`Customer`](Customer.mdx)",
"type": "``null`` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/BatchJob.mdx
+8 -8
View File
@@ -40,7 +40,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the batch job, the type of the batch job determines what the context should contain.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "created_by_user",
"type": "[`User`](User.mdx)",
"type": "[User](User.mdx)",
"description": "The details of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -230,7 +230,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "result",
"type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| [`BatchJobResultError`](../types/BatchJobResultError.mdx))[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../types/BatchJobResultStatDescriptor.mdx)[] } & Record<`string`, `unknown`\\>",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "errors",
"type": "(`string` \\| [`BatchJobResultError`](../types/BatchJobResultError.mdx))[]",
"type": "(`string` \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -292,7 +292,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "stat_descriptors",
"type": "[`BatchJobResultStatDescriptor`](../types/BatchJobResultStatDescriptor.mdx)[]",
"type": "[BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -303,7 +303,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "status",
"type": "[`BatchJobStatus`](../enums/BatchJobStatus.mdx)",
"type": "[BatchJobStatus](../enums/BatchJobStatus.mdx)",
"description": "The status of the batch job.",
"optional": false,
"defaultValue": "created",
www/apps/docs/content/references/entities/classes/Cart.mdx
+15 -15
View File
@@ -13,7 +13,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_session",
"type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_address",
"type": "``null`` \\| [`Address`](Address.mdx)",
"type": "``null`` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "type",
"type": "[`CartType`](../enums/CartType.mdx)",
"type": "[CartType](../enums/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
www/apps/docs/content/references/entities/classes/ClaimImage.mdx
+9 -9
View File
@@ -13,7 +13,7 @@ The details of an image attached to a claim.
<ParameterTypes parameters={[
{
"name": "claim_item",
"type": "[`ClaimItem`](ClaimItem.mdx)",
"type": "[ClaimItem](ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ The details of an image attached to a claim.
"children": [
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ The details of an image attached to a claim.
},
{
"name": "images",
"type": "[`ClaimImage`](ClaimImage.mdx)[]",
"type": "[ClaimImage](ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ The details of an image attached to a claim.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ The details of an image attached to a claim.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ The details of an image attached to a claim.
},
{
"name": "reason",
"type": "[`ClaimReason`](../enums/ClaimReason.mdx)",
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ The details of an image attached to a claim.
},
{
"name": "tags",
"type": "[`ClaimTag`](ClaimTag.mdx)[]",
"type": "[ClaimTag](ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ The details of an image attached to a claim.
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ The details of an image attached to a claim.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimItem.mdx
+37 -37
View File
@@ -13,7 +13,7 @@ A claim item is an item created as part of a claim. It references an item in the
<ParameterTypes parameters={[
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "claim_items",
"type": "[`ClaimItem`](ClaimItem.mdx)[]",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "fulfillment_status",
"type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -75,7 +75,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "payment_status",
"type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -156,7 +156,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "type",
"type": "[`ClaimType`](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "images",
"type": "[`ClaimImage`](ClaimImage.mdx)[]",
"type": "[ClaimImage](ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "claim_item",
"type": "[`ClaimItem`](ClaimItem.mdx)",
"type": "[ClaimItem](ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -338,7 +338,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "adjustments",
"type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -374,7 +374,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,7 @@ A claim item is an item created as part of a claim. It references an item in the
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -483,7 +483,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order_edit",
"type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -627,7 +627,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "tax_lines",
"type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -737,7 +737,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -764,7 +764,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "reason",
"type": "[`ClaimReason`](../enums/ClaimReason.mdx)",
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -810,7 +810,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "tags",
"type": "[`ClaimTag`](ClaimTag.mdx)[]",
"type": "[ClaimTag](ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -845,7 +845,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -883,7 +883,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -892,7 +892,7 @@ A claim item is an item created as part of a claim. It references an item in the
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -963,7 +963,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1008,7 +1008,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1026,7 +1026,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1044,7 +1044,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -1053,7 +1053,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimOrder.mdx
+11 -11
View File
@@ -13,7 +13,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
<ParameterTypes parameters={[
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "claim_items",
"type": "[`ClaimItem`](ClaimItem.mdx)[]",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "fulfillment_status",
"type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -67,7 +67,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "payment_status",
"type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -148,7 +148,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "type",
"type": "[`ClaimType`](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimTag.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Country.mdx
+8 -8
View File
@@ -67,7 +67,7 @@ Country details
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ Country details
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Country details
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ Country details
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ Country details
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Country details
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ Country details
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ Country details
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx
+27 -27
View File
@@ -13,7 +13,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart this shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -228,7 +228,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_session",
"type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_address",
"type": "``null`` \\| [`Address`](Address.mdx)",
"type": "``null`` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "type",
"type": "[`CartType`](../enums/CartType.mdx)",
"type": "[CartType](../enums/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -437,7 +437,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the overridden shipping options.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -490,7 +490,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -554,8 +554,8 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -563,7 +563,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -581,7 +581,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "requirements",
"type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Customer.mdx
+39 -39
View File
@@ -13,7 +13,7 @@ A customer can make purchases in your store and manage their profile.
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [`Country`](Country.mdx)",
"type": "``null`` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [`Customer`](Customer.mdx)",
"type": "``null`` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -339,7 +339,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +536,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +662,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +707,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +725,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -734,7 +734,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +743,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +824,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -889,7 +889,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_addresses",
"type": "[`Address`](Address.mdx)[]",
"type": "[Address](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [`Country`](Country.mdx)",
"type": "``null`` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -960,7 +960,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [`Customer`](Customer.mdx)",
"type": "``null`` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -1014,7 +1014,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomerGroup.mdx
+12 -12
View File
@@ -22,7 +22,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A customer group that can be used to organize customers into groups of similar t
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "shipping_addresses",
"type": "[`Address`](Address.mdx)[]",
"type": "[Address](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "status",
"type": "[`PriceListStatus`](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -320,7 +320,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "type",
"type": "[`PriceListType`](../enums/PriceListType.mdx)",
"type": "[PriceListType](../enums/PriceListType.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
www/apps/docs/content/references/entities/classes/Discount.mdx
+20 -20
View File
@@ -76,7 +76,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[`Region`](Region.mdx)[]",
"type": "[Region](Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule that defines how the discount will be applied to a cart..",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[`Region`](Region.mdx)[]",
"type": "[Region](Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -365,7 +365,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -448,7 +448,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule that defines how the discount will be applied to a cart..",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,7 @@ A discount can be applied to a cart for promotional purposes.
"children": [
{
"name": "allocation",
"type": "[`AllocationType`](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -465,7 +465,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -510,7 +510,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -519,8 +519,8 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/DiscountCondition.mdx
+38 -38
View File
@@ -22,8 +22,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -39,7 +39,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -113,7 +113,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "allocation",
"type": "[`AllocationType`](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,8 +184,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -231,7 +231,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -240,8 +240,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -268,8 +268,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -312,7 +312,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -350,8 +350,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -385,7 +385,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -414,8 +414,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -449,7 +449,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -478,7 +478,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -486,7 +486,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -496,7 +496,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -595,7 +595,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -631,7 +631,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -649,7 +649,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -667,7 +667,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -685,7 +685,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -694,7 +694,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -703,7 +703,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -721,7 +721,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -748,7 +748,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -775,7 +775,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -804,7 +804,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx
+22 -22
View File
@@ -31,8 +31,8 @@ Associates a discount condition with a customer group
},
{
"name": "customer_group",
"type": "[`CustomerGroup`](CustomerGroup.mdx)",
"description": "Available if the relation `customer_group` is expanded.",
"type": "[CustomerGroup](CustomerGroup.mdx)",
"description": "Available if the relation `customer\\_group` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -48,7 +48,7 @@ Associates a discount condition with a customer group
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ Associates a discount condition with a customer group
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -122,8 +122,8 @@ Associates a discount condition with a customer group
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"description": "Available if the relation `discount_condition` is expanded.",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "Available if the relation `discount\\_condition` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -139,8 +139,8 @@ Associates a discount condition with a customer group
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -157,7 +157,7 @@ Associates a discount condition with a customer group
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -193,8 +193,8 @@ Associates a discount condition with a customer group
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -202,8 +202,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -211,8 +211,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -220,8 +220,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -229,7 +229,7 @@ Associates a discount condition with a customer group
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ Associates a discount condition with a customer group
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -258,7 +258,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx
+29 -29
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a discount condition and a product
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ This represents the association between a discount condition and a product
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ This represents the association between a discount condition and a product
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ This represents the association between a discount condition and a product
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -365,7 +365,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ This represents the association between a discount condition and a product
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ This represents the association between a discount condition and a product
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -419,7 +419,7 @@ This represents the association between a discount condition and a product
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ This represents the association between a discount condition and a product
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx
+19 -19
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection.",
"optional": true,
"defaultValue": "",
@@ -220,7 +220,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx
+18 -18
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tag",
"type": "[`ProductTag`](ProductTag.mdx)",
"type": "[ProductTag](ProductTag.mdx)",
"description": "The details of the product tag.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx
+18 -18
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountRule.mdx
+19 -19
View File
@@ -13,7 +13,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
<ParameterTypes parameters={[
{
"name": "allocation",
"type": "[`AllocationType`](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -41,7 +41,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -58,8 +58,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -76,7 +76,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -112,8 +112,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -121,8 +121,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -130,8 +130,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -139,8 +139,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -148,7 +148,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -213,7 +213,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -222,8 +222,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/DraftOrder.mdx
+4 -4
View File
@@ -22,7 +22,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the draft order.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order created from the draft order when its payment is captured.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "status",
"type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)",
"type": "[DraftOrderStatus](../enums/DraftOrderStatus.mdx)",
"description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
"optional": false,
"defaultValue": "open",
www/apps/docs/content/references/entities/classes/Fulfillment.mdx
+61 -61
View File
@@ -22,7 +22,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_items",
"type": "[`ClaimItem`](ClaimItem.mdx)[]",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -84,7 +84,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -165,7 +165,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "type",
"type": "[`ClaimType`](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +536,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +662,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +707,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +725,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -734,7 +734,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +743,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +824,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -880,7 +880,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -898,7 +898,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -926,7 +926,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -934,7 +934,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -961,7 +961,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1015,7 +1015,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1024,7 +1024,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1051,7 +1051,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1069,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1087,8 +1087,8 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1096,7 +1096,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1105,7 +1105,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1114,7 +1114,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1132,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1161,7 +1161,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "tracking_links",
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
"type": "[TrackingLink](TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
@@ -1187,7 +1187,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
@@ -1223,7 +1223,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx
+20 -20
View File
@@ -13,7 +13,7 @@ This represents the association between a Line Item and a Fulfillment.
<ParameterTypes parameters={[
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "items",
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tracking_links",
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
"type": "[TrackingLink](TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ This represents the association between a Line Item and a Fulfillment.
"children": [
{
"name": "adjustments",
"type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ This represents the association between a Line Item and a Fulfillment.
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -374,7 +374,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_edit",
"type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -518,7 +518,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tax_lines",
"type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A fulfillment provider represents a fulfillment service installed in the Medusa
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/GiftCard.mdx
+35 -35
View File
@@ -76,7 +76,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -273,7 +273,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -354,7 +354,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -390,7 +390,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -399,7 +399,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -435,7 +435,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -444,7 +444,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -462,7 +462,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -471,7 +471,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -480,7 +480,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -498,7 +498,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -516,7 +516,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -543,7 +543,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -561,7 +561,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -634,7 +634,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -652,7 +652,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -679,7 +679,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -716,7 +716,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -734,7 +734,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx
+30 -30
View File
@@ -31,7 +31,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_card",
"type": "[`GiftCard`](GiftCard.mdx)",
"type": "[GiftCard](GiftCard.mdx)",
"description": "The details of the gift card associated used in this transaction.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the gift card was used for payment.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -382,7 +382,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -391,7 +391,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -427,7 +427,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -472,7 +472,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -508,7 +508,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -517,7 +517,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -553,7 +553,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -562,7 +562,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -589,7 +589,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -598,7 +598,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -616,7 +616,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -634,7 +634,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -661,7 +661,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -679,7 +679,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx
+2 -2
View File
@@ -67,7 +67,7 @@ Idempotency Key is used to continue a process in case of any failure that might
},
{
"name": "request_params",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The parameters passed to the request",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Idempotency Key is used to continue a process in case of any failure that might
},
{
"name": "response_body",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The response's body",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Image.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ An Image is used to store details about uploaded images. Images are uploaded by
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Invite.mdx
+2 -2
View File
@@ -58,7 +58,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "The user's role. These roles don't change the privileges of the user.",
"optional": false,
"defaultValue": "member",
www/apps/docs/content/references/entities/classes/LineItem.mdx
+10 -10
View File
@@ -13,7 +13,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
<ParameterTypes parameters={[
{
"name": "adjustments",
"type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -131,7 +131,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -158,7 +158,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit",
"type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -302,7 +302,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "tax_lines",
"type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx
+3 -3
View File
@@ -31,7 +31,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the discount associated with the adjustment.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx
+2 -2
View File
@@ -40,7 +40,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx
+24 -24
View File
@@ -31,7 +31,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list",
"type": "``null`` \\| [`PriceList`](PriceList.mdx)",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -167,7 +167,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -249,7 +249,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -267,7 +267,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -285,7 +285,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -312,7 +312,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -350,7 +350,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -359,7 +359,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -430,7 +430,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -511,7 +511,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -621,7 +621,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -630,7 +630,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -701,7 +701,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -746,7 +746,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -764,7 +764,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -782,7 +782,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -791,7 +791,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Note.mdx
+4 -4
View File
@@ -13,7 +13,7 @@ A Note is an element that can be used in association with different resources to
<ParameterTypes parameters={[
{
"name": "author",
"type": "[`User`](User.mdx)",
"type": "[User](User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -158,7 +158,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Notification.mdx
+21 -21
View File
@@ -22,7 +22,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A notification is an alert sent, typically to customers, using the installed Not
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "shipping_addresses",
"type": "[`Address`](Address.mdx)[]",
"type": "[Address](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -384,7 +384,7 @@ A notification is an alert sent, typically to customers, using the installed Not
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -403,7 +403,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -420,7 +420,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -438,7 +438,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -474,7 +474,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/NotificationProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A notification provider represents a notification service installed in the Medus
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/Oauth.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Order.mdx
+25 -25
View File
@@ -13,7 +13,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -193,7 +193,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -319,7 +319,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -382,7 +382,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -391,7 +391,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -400,7 +400,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -436,7 +436,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -481,7 +481,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderEdit.mdx
+5 -5
View File
@@ -31,7 +31,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "changes",
"type": "[`OrderItemChange`](OrderItemChange.mdx)[]",
"type": "[OrderItemChange](OrderItemChange.mdx)[]",
"description": "The details of all the changes on the original order's line items.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this order edit was created for.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "payment_collection",
"type": "[`PaymentCollection`](PaymentCollection.mdx)",
"type": "[PaymentCollection](PaymentCollection.mdx)",
"description": "The details of the payment collection used to authorize additional payment if necessary.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "status",
"type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)",
"type": "[OrderEditStatus](../enums/OrderEditStatus.mdx)",
"description": "The status of the order edit.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderItemChange.mdx
+4 -4
View File
@@ -40,7 +40,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "line_item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "order_edit",
"type": "[`OrderEdit`](OrderEdit.mdx)",
"type": "[OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit the item change is associated with.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "original_line_item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.",
"optional": true,
"defaultValue": "",
@@ -94,7 +94,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "type",
"type": "[`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.mdx)",
"type": "[OrderEditItemChangeType](../enums/OrderEditItemChangeType.mdx)",
"description": "The order item change's status",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Payment.mdx
+58 -58
View File
@@ -49,7 +49,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_session",
"type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "``null`` \\| [`Address`](Address.mdx)",
"type": "``null`` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -363,7 +363,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -417,7 +417,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "type",
"type": "[`CartType`](../enums/CartType.mdx)",
"type": "[CartType](../enums/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -455,7 +455,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -556,7 +556,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -564,7 +564,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -591,7 +591,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -609,7 +609,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -627,7 +627,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -672,7 +672,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -690,7 +690,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -744,7 +744,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -771,7 +771,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -780,7 +780,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -816,7 +816,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -825,7 +825,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -861,7 +861,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -870,7 +870,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -906,7 +906,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -915,7 +915,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -942,7 +942,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -951,7 +951,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -969,7 +969,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -1014,7 +1014,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -1032,7 +1032,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -1097,7 +1097,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -1105,7 +1105,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1132,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1186,7 +1186,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillment_status",
"type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1195,7 +1195,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1222,7 +1222,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1240,7 +1240,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1258,8 +1258,8 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1267,7 +1267,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_status",
"type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1276,7 +1276,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1285,7 +1285,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1303,7 +1303,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentCollection.mdx
+23 -23
View File
@@ -49,7 +49,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of the payment sessions created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -258,7 +258,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
{
"name": "status",
"type": "`string`",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -277,7 +277,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -393,7 +393,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -402,7 +402,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -458,7 +458,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -557,7 +557,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -575,7 +575,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -620,7 +620,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -649,7 +649,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "status",
"type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)",
"type": "[PaymentCollectionStatus](../enums/PaymentCollectionStatus.mdx)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
@@ -704,7 +704,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "type",
"type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)",
"type": "[ORDER_EDIT](../enums/PaymentCollectionType.mdx#order_edit)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A payment provider represents a payment service installed in the Medusa backend,
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/PaymentSession.mdx
+18 -18
View File
@@ -22,7 +22,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_session",
"type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_address",
"type": "``null`` \\| [`Address`](Address.mdx)",
"type": "``null`` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -390,7 +390,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "type",
"type": "[`CartType`](../enums/CartType.mdx)",
"type": "[CartType](../enums/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -428,7 +428,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
{
"name": "status",
"type": "`string`",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/PriceList.mdx
+12 -12
View File
@@ -22,7 +22,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_list",
"type": "``null`` \\| [`PriceList`](PriceList.mdx)",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -284,7 +284,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -322,7 +322,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "status",
"type": "[`PriceListStatus`](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -350,7 +350,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "type",
"type": "[`PriceListType`](../enums/PriceListType.mdx)",
"type": "[PriceListType](../enums/PriceListType.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
www/apps/docs/content/references/entities/classes/Product.mdx
+43 -43
View File
@@ -13,7 +13,7 @@ A product is a saleable item that holds general information such as name or desc
<ParameterTypes parameters={[
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -22,7 +22,7 @@ A product is a saleable item that holds general information such as name or desc
"children": [
{
"name": "category_children",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "is_active",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -76,7 +76,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "is_internal",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -94,7 +94,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "parent_category",
"type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -331,7 +331,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -422,7 +422,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -440,7 +440,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -540,7 +540,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -575,7 +575,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -602,7 +602,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -611,8 +611,8 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -640,7 +640,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -702,7 +702,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -711,8 +711,8 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -731,7 +731,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -784,7 +784,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -793,7 +793,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -822,7 +822,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -877,7 +877,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -912,7 +912,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -959,7 +959,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -994,7 +994,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -1050,7 +1050,7 @@ A product is a saleable item that holds general information such as name or desc
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -1121,7 +1121,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1166,7 +1166,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1184,7 +1184,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1202,7 +1202,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -1211,7 +1211,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductCategory.mdx
+22 -22
View File
@@ -13,7 +13,7 @@ A product category can be used to categorize products into a hierarchy of catego
<ParameterTypes parameters={[
{
"name": "category_children",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ A product category can be used to categorize products into a hierarchy of catego
"children": [
{
"name": "category_children",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_active",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -75,7 +75,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_internal",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -93,7 +93,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_active",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -203,7 +203,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_internal",
"type": "[`Boolean`](../index.mdx#boolean)",
"type": "[Boolean](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -221,7 +221,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A product category can be used to categorize products into a hierarchy of catego
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -482,7 +482,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductCollection.mdx
+14 -14
View File
@@ -49,7 +49,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A Product Collection allows grouping together products for promotional purposes.
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -301,7 +301,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductOption.mdx
+18 -18
View File
@@ -40,7 +40,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Product Option defines properties that may vary between different variants of
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -292,7 +292,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -402,7 +402,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx
+12 -12
View File
@@ -40,7 +40,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ An option value is one of the possible values of a Product Option. Product Varia
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -247,7 +247,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTag.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ A Product Tag can be added to Products for easy filtering and grouping.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx
+20 -20
View File
@@ -22,7 +22,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ This represents the association between a tax rate and a product to indicate tha
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -274,7 +274,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -375,7 +375,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tax_rate",
"type": "[`TaxRate`](TaxRate.mdx)",
"type": "[TaxRate](TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductType.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ A Product Type can be added to Products for filtering and reporting purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx
+9 -9
View File
@@ -22,7 +22,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -66,7 +66,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -113,7 +113,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "tax_rate",
"type": "[`TaxRate`](TaxRate.mdx)",
"type": "[TaxRate](TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -148,7 +148,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariant.mdx
+27 -27
View File
@@ -14,7 +14,7 @@ A Product Variant represents a Product with a specific set of Product Option con
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -85,7 +85,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "price_list",
"type": "``null`` \\| [`PriceList`](PriceList.mdx)",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -455,7 +455,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A Product Variant represents a Product with a specific set of Product Option con
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -502,7 +502,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -637,7 +637,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -655,7 +655,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -673,7 +673,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -691,7 +691,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -700,7 +700,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -709,7 +709,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -727,7 +727,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -754,7 +754,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -781,7 +781,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx
+7 -7
View File
@@ -67,7 +67,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -147,7 +147,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -228,7 +228,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Refund.mdx
+34 -34
View File
@@ -49,7 +49,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order this refund was created for.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A refund represents an amount of money transfered back to the customer for a giv
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -255,7 +255,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -381,7 +381,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -417,7 +417,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -426,7 +426,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -444,7 +444,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -453,7 +453,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -462,7 +462,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -480,7 +480,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -498,7 +498,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -525,7 +525,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -543,7 +543,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the refund.",
"optional": false,
"defaultValue": "",
@@ -643,7 +643,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -670,7 +670,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -688,7 +688,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -715,7 +715,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -724,7 +724,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -751,7 +751,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
Loaded 100 of 2224 files, more files were not shown because too many files have changed in this diff. Show more