[{"value":"lines: CheckoutLine[]","id":"lines-checkoutline","hLevel":2,"level":1},{"value":"applyCheckoutLinesChange: (change: CheckoutLineChange) => Promise<CheckoutLineChangeResult>","id":"applycheckoutlineschange-change-checkoutlinechange--promisecheckoutlinechangeresult","hLevel":2,"level":1},{"value":"useCheckoutLineTarget(): CheckoutLine | undefined","id":"usecheckoutlinetarget-checkoutline--undefined","hLevel":2,"level":1},{"value":"useApplyCheckoutLinesChange(): ApplyCheckoutLineChange","id":"useapplycheckoutlineschange-applycheckoutlinechange","hLevel":2,"level":1}]

Checkout Line

The APIs for managing checkout line item data.

`lines: CheckoutLine[]`

linesCheckoutLine[]

A list of information about line items.

idstring

The line item ID.

variantIdstring

The SKU associated with the line item.

quantitystring

The number of the products.

costCheckoutLineCost

The line item price information.

properties Property[]

A list of line item properties.

discountAllocationsDiscountAllocation[]

A list of information about the discounts applied to the line item.

discountApplicationDiscountApplication

The discount application information for the line item.

merchandiseMerchandise

Product information.

render("Checkout::Dynamic::Render", (props) => {
  const { lines } = props;
  console.log(lines);
});

`applyCheckoutLinesChange: (change: CheckoutLineChange) => Promise<CheckoutLineChangeResult>`

CAUTION

This API can only be used on the checkout page.

applyCheckoutLinesChange(change: CheckoutLineChange) => Promise<CheckoutLineChangeResult>

Updates the information about the line items.

render("Checkout::Dynamic::Render", (props) => {
  const { applyCheckoutLinesChange } = props;
  applyCheckoutLinesChange({
    type: "removeCheckoutLine",
    lineItemIds: ["test"],
  });
});

`useCheckoutLineTarget(): CheckoutLine | undefined`

CAUTION

Applicable only to the checkout line extension point Checkout::CheckoutLineDetails::RenderAfter.

Returns the current line item information.

render("Checkout::Dynamic::Render", (props) => {
  const target = useCheckoutLineTarget()
  console.log(target)
});

`useApplyCheckoutLinesChange(): ApplyCheckoutLineChange`

CAUTION

This API can only be used on the checkout page.

Returns applyCheckoutLinesChange.

render("Checkout::Dynamic::Render", (props) => {
  const applyCheckoutLinesChange = useApplyCheckoutLinesChange();
  applyCheckoutLinesChange({
    type: "removeCheckoutLine",
    lineItemIds: ["test"],
  });
});