new module:models/ShippingItem()
Constructs a new ShippingItem.
Document representing a shipping item.
- Source:
Members
(inner) adjusted_tax :Number
The tax of the product item after adjustments applying.
Type:
- Number
- Source:
(inner) base_price :Number
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.
Type:
- Number
- Source:
(inner) item_id :String
The item identifier. Use this to identify an item when updating the item quantity or creating a custom price adjustment for an item.
Type:
- String
- Source:
(inner) item_text :String
The text describing the item in more detail.
Type:
- String
- Source:
(inner) price :Number
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.
Type:
- Number
- Source:
(inner) price_adjustments :Array.<module:models/PriceAdjustment>
Array of price adjustments. Can be empty.
Type:
- Array.<module:models/PriceAdjustment>
- Source:
(inner) price_after_item_discount :Number
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.
Type:
- Number
- Source:
(inner) shipment_id :String
The identifier of the shipment to which this item belongs.
Type:
- String
- Source:
(inner) tax :Number
The tax of the product item before adjustments applying.
Type:
- Number
- Source:
(inner) tax_basis :Number
The price used to calculate the tax for this product item.
Type:
- Number
- Source:
(inner) tax_class_id :String
The tax class ID for the product item or null if no tax class ID is associated with the product item.
Type:
- String
- Source:
(inner) tax_rate :Number
The tax rate, which is the decimal tax rate to be applied to the product represented by this item.
Type:
- Number
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ShippingItem}
Constructs a ShippingItem from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/ShippingItem | Optional instance to populate. |
- Source:
Returns:
The populated ShippingItem instance.