QuoteProduct

A quote product represents a line item in a quote. A quote product can either be a standard product or a configured product.

Most properties in quote product objects are read-only, except for the name and description properties, which can be modified via naming rules.


Properties

Name Type Description
id number The id of the quote product. Note that this is not the id of the product or configurator itself, but a unique identifier for this specific instance of it as it exists within the quote.
idQuote number The id of the quote this quote product belongs to.
idProduct number The id of the product or configurator this product belongs to.
isConfigured boolean True if this represents a configurator, false if it represents a standard product.
price number The full price for the product.
cost number The full cost for the product.
qty number
discountPercentage number
configuredProduct ConfiguredProduct If the quoteProduct is a configured product, this is a handle to the data from the configuredProduct such as the fields, or if it has any errors or warnings.
priceObject PriceObject Only used for configurators. Represents the all pricing details as applied in the pricing rule for the configurator.
createdDate text
modifiedDate text
createdBy number The user who added this product to the quote. May be different from the quote's creator.
modifiedBy number The user who last modified this product.
files QuoteProductFile[] An array of files attached to this specific quote product.
name text The name of the quote product. Can be changed via naming rules.
description text A longer description for the quote product. Can be changed via naming rules.
shortDescription text Can be changed via naming rules.
sku text Can be changed via naming rules.
mfgPartNumber text Can be changed via naming rules.
manufacturer text
unitOfMeasure text
maxQty number
minQty number
allowFractionalQty boolean
maxDiscountPercentage number
imagePath text The URL to the image that represents the product as it is displayed in the quote.
Was this article helpful?