Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 3.7 KB

File metadata and controls

32 lines (25 loc) · 3.7 KB

CartItem

Properties

Name Type Description Notes
name String Name of item. [optional]
sku String Stock keeping unit of item.
quantity Long Number of units of this item. Due to cart item flattening, if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of per-item effects triggered from your campaigns.
returnedQuantity Long Number of returned items, calculated internally based on returns of this item. [optional]
remainingQuantity Long Remaining quantity of the item, calculated internally based on returns of this item. [optional]
price BigDecimal Price of the item in the currency defined by your Application. This field is required if this item is not part of a catalog. If it is part of a catalog, setting a price here overrides the price from the catalog. [optional]
category String Type, group or model of the item. [optional]
product Product [optional]
weight BigDecimal Weight of item in grams. [optional]
height BigDecimal Height of item in mm. [optional]
width BigDecimal Width of item in mm. [optional]
length BigDecimal Length of item in mm. [optional]
position BigDecimal Position of the Cart Item in the Cart (calculated internally). [optional]
attributes Object Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to this cart item. Custom cart item attributes must be created in the Campaign Manager before you set them with this property. Note: Any previously defined attributes that you do not include in the array will be removed. [optional]
additionalCosts Map<String, AdditionalCost> Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See Managing additional costs. [optional]
catalogItemID Long The catalog item ID. [optional]
selectedPriceType String The selected price type for this cart item (e.g. the price for members only). [optional]
adjustmentReferenceId UUID The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. [optional]
adjustmentEffectiveFrom OffsetDateTime The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. [optional]
adjustmentEffectiveUntil OffsetDateTime The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. [optional]
prices Map<String, PriceDetail> A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. [optional]