Home > @poq/sdk-sfcc > ProductItem
Document representing a product item.
Signature:
export declare class ProductItem extends BaseModel<ProductItem>
Extends: BaseModel<ProductItem
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the ProductItem class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| adjustedTax? | number | (Optional) The tax of the product item after adjustments applying. | |
| basePrice? | number | (Optional) The base price for the line item, which is the price of the unit before applying adjustments, in the purchase currency. The base price may be net or gross of tax depending on the configured taxation policy. | |
| bonusDiscountLineItemId? | string | (Optional) The id of the bonus discount line item this bonus product relates to. | |
| bonusProductLineItem? | boolean | (Optional) A flag indicating whether the product item is a bonus. | |
| bundledProductItems? | Array<ProductItem> | (Optional) The array of bundled product items. Can be empty. | |
| cBonusProductLineItemUUID? | string | (Optional) This represents the UUID of the product line item that holds the qualifying product. | |
| cFromStoreId? | string | (Optional) Links the store to the product line item for grouping shipments in the checkout process. | |
| cPreOrderUUID? | string | (Optional) this custom attribute captures the original product line item uuid before it is part of an placed order | |
| gift? | boolean | (Optional) Returns true if the item is a gift. | |
| giftMessage? | string | (Optional) The gift message. | |
| inventoryId? | string | (Optional) The inventory list id associated with this item. | |
| itemId? | string | (Optional) The item identifier. Use this to identify an item when updating the item quantity or creating a custom price adjustment for an item. | |
| itemText? | string | (Optional) The text describing the item in more detail. | |
| optionItems? | Array<OptionItem> | (Optional) The array of option items. This array can be empty. | |
| price? | number | (Optional) The price of the line item before applying any adjustments. If the line item is based on net pricing then the net price is returned. If the line item is based on gross pricing then the gross price is returned. | |
| priceAdjustments? | Array<PriceAdjustment> | (Optional) Array of price adjustments. Can be empty. | |
| priceAfterItemDiscount? | number | (Optional) The price of the product line item after applying all product-level adjustments. For net pricing the adjusted net price is returned. For gross pricing, the adjusted gross price is returned. | |
| priceAfterOrderDiscount? | number | (Optional) The price of this product line item after considering all dependent price adjustments and prorating all order-level price adjustments. For net pricing the net price is returned. For gross pricing, the gross price is returned. | |
| productId? | string | (Optional) | |
| productListItem? | ProductListItemReference | (Optional) | |
| productName? | string | (Optional) The name of the product. | |
| quantity | number | The quantity of the products represented by this item. | |
| shipmentId? | string | (Optional) The id of the shipment which includes the product item. | |
| shippingItemId? | string | (Optional) The reference to the related shipping item if it exists. This is the case if for example when a surcharge is defined for individual products using a particular a shipping method. | |
| tax? | number | (Optional) The tax of the product item before adjustments applying. | |
| taxBasis? | number | (Optional) The price used to calculate the tax for this product item. | |
| taxClassId? | string | (Optional) The tax class ID for the product item or null if no tax class ID is associated with the product item. | |
| taxRate? | number | (Optional) The tax rate, which is the decimal tax rate to be applied to the product represented by this item. |