Types

BundleEvent

Name	Type	Description
bundle	Bundle	The bundle that the event is associated with.
data	BundleEventData	The data associated with the event.
event	BundleEventType	The type of event that occurred.

BundleEventData

A union type that represents the different types of data that can be associated with a bundle event.

This is a representation of the following types: ConditionalGlobalPropertiesChangedEventData | WorkflowExperienceHoverEventData

BundleEventType

An enum that represents the different types of events that can be associated with a bundle.

Value	Data Type	Description
"conditional-global-properties-changed"	ConditionalGlobalPropertiesChangedEventData	The global properties have changed.
"workflow-experience-hover-enter"	WorkflowExperienceHoverEventData	The user has started hovered over a workflow experience.
"workflow-experience-hover-exit"	WorkflowExperienceHoverEventData	The user has stopped hovering over a workflow experience.

BundleStakeholderInput

Name	Type	Description
customerDetails	CustomerDetailsInput	The details of the stakeholder.
stakeholderType	StakeholderType	The type of stakeholder. Controls the access level of the customer.

ConditionalGlobalPropertiesChangedEventData

Name	Type	Description
globalProperties	[GlobalPropertyHandle]	The new global properties.

CustomerDetailsInput

Name	Type	Description
emailAddress	string	The email address of the stakeholder.
firstName	string?	The first name of the stakeholder.
lastName	string?	The last name of the stakeholder.
phoneNumber	string?	The phone number of the stakeholder.

GetWorkflowOptions

A union type that represents the different ways you can initialize a workflow experience.

This is a representation of the following types: GetWorkflowFromExternalProductOptions | GetWorkflowFromIntegrationProductOptions | GetWorkflowFromTransactionOptions

GetWorkflowFromExternalProductOptions

This will allow you to use your own system's ID's to initialize the experience.

Name	Type	Description
bulk	boolean?	Optional: If set to true, the experience will be initialized in bulk mode.
externalIntegrationId	string	The ID of your external integration. This is usually the domain name of your store.
externalProductId	string	The ID of the product on your external system.
graphql	GetWorkflowGraphqlOptions?	Options related to the GraphQL request.
type	string	This must be set to "external".
workflowId	string	The ID of the workflow to request an experience for.
workflowState	string?	Optional: Serialized JSON string of the workflow state to initialize the experience with.

GetWorkflowFromIntegrationProductOptions

This is the most common way to initialize a new workflow experience. This will initialize the experience with a product from your integration.

Name	Type	Description
bulk	boolean?	Optional: If set to true, the experience will be initialized in bulk mode.
graphql	GetWorkflowGraphqlOptions?	Options related to the GraphQL request.
integrationProductId	string	The product's integration ID. This can be found on the integration page, under the "Products" section.
type	string	This must be set to "integration".
workflowId	string	The ID of the workflow to request an experience for.
workflowState	string?	Optional: Serialized JSON string of the workflow state to initialize the experience with.

GetWorkflowFromTransactionOptions

This is used to initialize the experience from a transaction. This will allow you to re-open a workflow experience for a transaction that has already been created.

Name	Type	Description
graphql	GetWorkflowGraphqlOptions?	Options related to the GraphQL request.
readOnly	boolean?	Optional: If set to true, the experience will be initialized in read-only mode.
transactionId	string	The ID of the transaction to request an experience for.
type	string	This must be set to "transaction".
workflowState	string?	Optional: Serialized JSON string of the workflow state to initialize the experience with.

GetWorkflowGraphqlOptions

Options related to the getWorkflow GraphQL request.

Name	Type	Description
assets	GetWorkflowGraphqlAssetsOptions?	Options related to assets in the GraphQL request.

GetWorkflowGraphqlAssetsOptions

Options related to assets in the getWorkflow GraphQL request.

Name	Type	Description
metadata	boolean?	Whether to include asset metadata in the GraphQL request.

StakeholderType

An enum that represents the type of stakeholder a customer is.

Name	Value	Description
Owner	"Owner"	An owner of the entity. Has full access to the entity.
Approver	"Approver"	An approver of the entity. Can approve or reject the entity.
Editor	"Editor"	An editor of the entity. Can edit the entity.
Viewer	"Viewer"	A viewer of the entity. Can view the entity.

TransformCollection

Name	Type	Description
id	string	The ID of the transform collection.
name	string	The name of the transform collection.
transforms	TransformCollectionTransform[]	The transforms that are part of this collection.

TransformCollectionTransform

Name	Type	Description
id	string	The ID of the transform. Note that this is user-defined and not auto-generated.
name	string	The name of the transform.
position	Vector3	The position of the transform.
rotation	Vector3	The rotation of the transform.
scale	Vector3	The scale of the transform.

Vector3

Name	Type	Description
x	number	The X axis.
y	number	The Y axis.
z	number	The Z axis.

WorkflowExperienceHoverEventData

Name	Type	Description
workflowExperience	WorkflowExperience	The workflow experience that this event is associated with.