Readonly
actionOptional
Readonly
addedDate and time (UTC) the Product Variant is added to the Cart. If not set, it defaults to the current date and time.
Optional for backwards compatibility reasons.
Optional
Readonly
customCustom Fields for the Line Item.
Optional
Readonly
distributionUsed to select a Product Price.
The Channel must have the ProductDistribution
ChannelRoleEnum.
If the Cart is bound to a Store with distributionChannels
set, the Channel must match one of the Store's distribution channels.
Optional
Readonly
externalSets the LineItem price
value, and the priceMode
to ExternalPrice
LineItemPriceMode.
Optional
Readonly
externalSets the external Tax Rate for the Line Item, if the Cart has the External
TaxMode and Single
ShippingMode. If the Cart has Multiple
ShippingMode, the Tax Rate is accepted but ignored.
Optional
Readonly
externalSets the LineItem price
and totalPrice
values, and the priceMode
to ExternalTotal
LineItemPriceMode.
Optional
Readonly
inventoryInventory mode specific to the Line Item only, and valid for the entire quantity
of the Line Item.
Set only if the inventory mode should be different from the inventoryMode
specified on the Cart.
Optional
Readonly
keyUser-defined unique identifier of the LineItem.
Optional
Readonly
perSets the external Tax Rates for individual Shipping Methods, if the Cart has the External
TaxMode and Multiple
ShippingMode.
Optional
Readonly
productid
of the published Product.
Either the `productId` and `variantId`, or `sku` must be provided.
Optional
Readonly
quantityQuantity of the Product Variant to add to the Cart.
Optional
Readonly
shippingContainer for Line Item-specific addresses.
Optional
Readonly
skuSKU of the ProductVariant.
Either the `productId` and `variantId`, or `sku` must be provided.
Optional
Readonly
supplyUsed to identify Inventory entries that must be reserved.
The Channel must have the InventorySupply
ChannelRoleEnum.
Optional
Readonly
variantid
of the ProductVariant in the Product.
If not provided, the Master Variant is used.
Either the `productId` and `variantId`, or `sku` must be provided.
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased. If LineItem
shippingDetails
is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. A new Line Item is added when theexternalPrice
orexternalTotalPrice
is set in this update action. The LineItem price is set as described in Line Item price selection.