Module sdk-full/models/store-workflow

Index

Type aliases

Type aliases

StoreWorkflowRunData

StoreWorkflowRunData: StoreWorkflowRunResult

StoreWorkflowRunOptions

StoreWorkflowRunOptions: { checkoutId?: string; customerAccessToken?: string; input?: Record<string, unknown>; recaptchaToken?: string }

Type declaration

Optional checkoutId?: string

The checkout id. Defaults to the current cart.
Optional customerAccessToken?: string

The customer access token. Defaults to the logged-in customer.
Optional input?: Record<string, unknown>

Custom inputs declared by the workflow, e.g. { produtoId: 123 }.
Optional recaptchaToken?: string

The google recaptcha token.

StoreWorkflowRunResult

StoreWorkflowRunResult: { output: unknown; runId: string; status: StoreWorkflowRunStatus }

Type declaration

output: unknown

The workflow output, already parsed from JSON. Its shape is defined by the store's own workflow: it can be an object, a list, a string, a number or null. Text that is not JSON comes back as the text itself.
runId: string

The run identifier, for debugging and support.
status: StoreWorkflowRunStatus

The run status as reported by the workflow engine.

StoreWorkflowRunStatus

StoreWorkflowRunStatus: "QUEUED" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELLED"

The status of a store workflow run.

Generated using TypeDoc