Skip to main content

Interface: Product

Properties​

autoprint​

autoprint: boolean

Whether a line item for this product is delivered as soon as the order is received.

basePrice?​

optional basePrice?: number

The base price of this product in sub units. Essentially the cost of the product without any customisations applied.

canQuickprint?​

optional canQuickprint?: boolean

Whether this product can be quickprinted.

conversionConfiguration?​

optional conversionConfiguration?: ConversionConfiguration

Configuration for conversion. Optional.

description?​

optional description?: string

A description of the Product, written in Markdown.

enabled​

enabled: boolean

If true, the product should be displayed in the client as if it is available. Should be displayed as if it is unavailable otherwise.

id​

id: string

The internal identifier for this product.

imageUrl?​

optional imageUrl?: string

A URL to the image asset associated with this product.

integrationProducts?​

optional integrationProducts?: IntegrationProductResource[]

minimumOrderQuantity?​

optional minimumOrderQuantity?: number

modelUrl?​

optional modelUrl?: string

A resource url for a 3D model used to represent this product in the 3d editor. If not available we assume the product doesn't support 3D.

name​

name: string

The human friendly name of the product.

overlayImageUrl?​

optional overlayImageUrl?: string

A URL for the image used as an overlay on any workflows that incorporate a product overlay step.

partner?​

optional partner?: Partner

partnerId?​

optional partnerId?: string

ID of the partner owner.

preloadImageUrl?​

optional preloadImageUrl?: string

When specified, represents a pre-rendered image of this product to be displayed to customers while the 3D preview is loading.

priceBreaks?​

optional priceBreaks?: ProductPriceBreak[]

Price breaks for this product when dealing with quantity.

productImages?​

optional productImages?: ProductImage[]

productTags?​

optional productTags?: ProductTag[]

profanities?​

optional profanities?: object[]

Words which can't be used in a workflow for this product.

createdAt​

createdAt: string

id​

id: string

userId​

userId: string

word​

word: string

promptForCustomerDetails?​

optional promptForCustomerDetails?: boolean

When set the store owner has configured this product to prompt for customer details. In hosted experience, we'll offer to collect this information from the customer. In bespoke UIs created using the Core SDK you will need to check this flag and request the data accordingly. See attachCustomerDetails on the WorkflowExperience for how to supply us with the details you collect.

quickprintMaxLength?​

optional quickprintMaxLength?: number

The max characters that can be typed for quickprint.

quickprintModuleName?​

optional quickprintModuleName?: string

The name of the module to use for quickprint.

sku?​

optional sku?: string

The SKU of the product in the merchant's store.

skuCode?​

optional skuCode?: string

The Spiff SKU code for the product.

weight?​

optional weight?: number

The weight of this product.

workflows?​

optional workflows?: ProductWorkflow[]

Workflows which have been assigned to this product.