Class ProductShippingLineItem
Represents a specific line item in a shipment. A ProductShippingLineItem defines lineitem-specific shipping costs.
| Constant | Description |
|---|---|
| Reserved constant. |
| Property | Description |
|---|---|
adjustedGrossPrice: Money (read-only) | Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments. |
adjustedNetPrice: Money (read-only) | Returns the net price of the product shipping line item after applying all product-shipping-level adjustments. |
adjustedPrice: Money (read-only) | Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. |
adjustedTax: Money (read-only) | Returns the tax of the unit after applying adjustments, in the purchase currency. |
priceAdjustments: Collection (read-only) | Returns an iterator of price adjustments that have been applied to this product shipping line item. |
productLineItem: ProductLineItem (read-only) | Returns the parent product line item this shipping line item belongs to. |
| quantity: Quantity | Returns the quantity of the shipping cost. |
shipment: Shipment (read-only) | Returns the shipment this shipping line item belongs to. |
| surcharge: Boolean | Returns the 'surcharge' flag. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAdjustedGrossPrice() | Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments. |
| getAdjustedNetPrice() | Returns the net price of the product shipping line item after applying all product-shipping-level adjustments. |
| getAdjustedPrice() | Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. |
| getAdjustedTax() | Returns the tax of the unit after applying adjustments, in the purchase currency. |
| getPriceAdjustments() | Returns an iterator of price adjustments that have been applied to this product shipping line item. |
| getProductLineItem() | Returns the parent product line item this shipping line item belongs to. |
| getQuantity() | Returns the quantity of the shipping cost. |
| getShipment() | Returns the shipment this shipping line item belongs to. |
| isSurcharge() | Returns the 'surcharge' flag. |
| setPriceValue(Number) | Sets price attributes of the line item based on the purchase currency, taxation policy and line item quantity. The method sets the 'basePrice' attribute of the line item. |
| setQuantity(Quantity) | Sets the quantity of the shipping cost. |
| setSurcharge(Boolean) | Sets the 'surcharge' flag. |
getBasePrice, getGrossPrice, getLineItemCtnr, getLineItemText, getNetPrice, getPrice, getPriceValue, getTax, getTaxBasis, getTaxClassID, getTaxRate, setBasePrice, setGrossPrice, setLineItemText, setNetPrice, setPriceValue, setTax, setTaxClassID, setTaxRate, updatePrice, updateTax, updateTax, updateTaxAmount
getCreationDate, getLastModified, getUUID
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
PRODUCT_SHIPPING_ID: String = "PRODUCT_SHIPPING"Reserved constant.
Deprecated:
this reserved constant is deprecated.
- adjustedGrossPrice: Money
(read-only) Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments.
See Also:
- adjustedNetPrice: Money
(read-only) Returns the net price of the product shipping line item after applying all product-shipping-level adjustments.
See Also:
- adjustedPrice: Money
(read-only) Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice()). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice()).
See Also:
- adjustedTax: Money
(read-only) Returns the tax of the unit after applying adjustments, in the purchase currency.
- priceAdjustments: Collection
(read-only) Returns an iterator of price adjustments that have been applied to this product shipping line item.
- productLineItem: ProductLineItem
(read-only) Returns the parent product line item this shipping line item belongs to.
- quantity: Quantity
Returns the quantity of the shipping cost.
- shipment: Shipment
(read-only) Returns the shipment this shipping line item belongs to.
- surcharge: Boolean
Returns the 'surcharge' flag.
- getAdjustedGrossPrice(): Money
Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments.
Returns:
- gross price after applying product-shipping-level adjustments
See Also:
- getAdjustedNetPrice(): Money
Returns the net price of the product shipping line item after applying all product-shipping-level adjustments.
Returns:
- net price after applying product-shipping-level adjustments
See Also:
- getAdjustedPrice(): Money
Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice()). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice()).
Returns:
- Adjusted net or gross price
See Also:
- getAdjustedTax(): Money
Returns the tax of the unit after applying adjustments, in the purchase currency.
Returns:
- the tax of the unit after applying adjustments, in the purchase currency.
- getPriceAdjustments(): Collection
Returns an iterator of price adjustments that have been applied to this product shipping line item.
Returns:
- a collection of price adjustments that have been applied to this product shipping line item.
- getProductLineItem(): ProductLineItem
Returns the parent product line item this shipping line item belongs to.
Returns:
- the product line item
- getQuantity(): Quantity
Returns the quantity of the shipping cost.
Returns:
- the shipping quantity
- getShipment(): Shipment
Returns the shipment this shipping line item belongs to.
Returns:
- the shipment
- isSurcharge(): Boolean
Returns the 'surcharge' flag.
Returns:
- true if this is a surcharge shipping cost, false if fixed shipping cost
- setPriceValue(value: Number): void
Sets price attributes of the line item based on the purchase currency, taxation policy and line item quantity.
The method sets the 'basePrice' attribute of the line item. Additionally, it sets the 'netPrice' attribute of the line item if the current taxation policy is 'net', and the 'grossPrice' attribute, if the current taxation policy is 'gross'. The 'netPrice'/'grossPrice' attributes are set by multiplying the specified price value with the line item quantity.
If null is specified as value, the price attributes are reset to Money.NA.
Parameters:
- value - Price value or null
- setQuantity(quantity: Quantity): void
Sets the quantity of the shipping cost.
Parameters:
- quantity - the shipping quantity
- setSurcharge(flag: Boolean): void
Sets the 'surcharge' flag.
Parameters:
- flag - true if this is a surcharge shipping cost, false if this is a fixed shipping cost.