Skip to main content

Interface: Transaction

Represents a transaction.

Properties​

addressValidationStatus?​

optional addressValidationStatus?: AddressValidationStatus

callbackUrl?​

optional callbackUrl?: string

URL to redirect to when a workflow is finished.

completed?​

optional completed?: boolean

createdAt?​

optional createdAt?: string

currentStakeholder?​

optional currentStakeholder?: Stakeholder

The stakeholder of the currently logged in user, if applicable.

optional customLogoLink?: string

URL to a partner-specific logo intended to display during the workflow experience.

designExternalVariants?​

optional designExternalVariants?: DesignExternalVariant[]

An array of objects containing information on additional products to add to the cart. Typically only available when being passed to DesignCreationMessage

designName?​

optional designName?: string

User-supplied name for the associated design.

externalCartProductId?​

optional externalCartProductId?: string

The external product id representing the product related to the transaction. This value can hold any type of transaction such as design and standard products.

externalCartProductVariantId?​

optional externalCartProductVariantId?: string

The external product variant id representing the product related to the transaction. This value can hold any type of transaction such as design and standard products.

externalDesignProductId?​

optional externalDesignProductId?: string

Deprecated​

use externalCartProductId or designExternalVariants[x].externalProductId instead of this moving forward.

externalDesignProductVariantId?​

optional externalDesignProductVariantId?: string

Deprecated​

use externalCartProductVariantId or designExternalVariants[x].externalProductVariantId instead of this moving forward

hasAuthenticatedActions?​

optional hasAuthenticatedActions?: boolean

Whether any share actions for this Transaction require the user to be authenticated as a stakeholder

id​

id: string

A unique identifier for this transaction. Useful for reloading and modifying state of the transaction.

integrationProduct?​

optional integrationProduct?: IntegrationProductResource

The integration product related to this lineitem.

integrationProductId?​

optional integrationProductId?: string | null

The ID of the integration product that this transaction belongs to.

isOrdered?​

optional isOrdered?: boolean

Whether this transaction has previously been ordered.

lastSyncedAt?​

optional lastSyncedAt?: string

lineItem?​

optional lineItem?: LineItem

Deprecated​

use isOrdered to check whether transaction has been ordered instead.

marketplaceThemeInstallConfiguration?​

optional marketplaceThemeInstallConfiguration?: ThemeInstallConfigurationGraphQl

parentTransaction?​

optional parentTransaction?: Transaction

optional previewImageLink?: string

priceModifierTotal?​

optional priceModifierTotal?: number

printFileName1?​

optional printFileName1?: string

printFileName2?​

optional printFileName2?: string

printFileName3?​

optional printFileName3?: string

printFileName4?​

optional printFileName4?: string

printFileName5?​

optional printFileName5?: string

printFileUrl1?​

optional printFileUrl1?: string

printFileUrl2?​

optional printFileUrl2?: string

printFileUrl3?​

optional printFileUrl3?: string

printFileUrl4?​

optional printFileUrl4?: string

printFileUrl5?​

optional printFileUrl5?: string

product?​

optional product?: Product

Product that this transaction belongs to.

productId?​

optional productId?: string

The ID of the product that this transaction belongs to.

quantity?​

optional quantity?: number

The amount of this transaction that was, or will be, ordered

recipient?​

optional recipient?: Recipient

optional restApiIntegrationLink?: string

URL to the corresponding integration in the REST API.

stakeholders?​

optional stakeholders?: Stakeholder[]

The users who have access to this transaction.

transactionOwnerId?​

optional transactionOwnerId?: string

Temporary ID that grants write permission to the transaction.

transactionShareActions?​

optional transactionShareActions?: ShareAction[]

A list of actions that have been associated to this transaction. To be used by the client to interact further post design.

optional workflowFooterLogoLink?: string

URL to a logo intended to display at the periphery of the workflow experience.

workflowId?​

optional workflowId?: string

The workflow associated with this transaction.

workflowState?​

optional workflowState?: string

The current state of the design.

optional workflowViewerLink?: string

URL to open the transaction in the workflow viewer.

optional workflowViewerReadOnlyLink?: string