[{"value":"checkoutToken: string | undefiend","id":"checkouttoken-string--undefiend","hLevel":2,"level":1},{"value":"cartToken: string | undefined","id":"carttoken-string--undefined","hLevel":2,"level":1},{"value":"useCheckoutToken(): string | undefined","id":"usecheckouttoken-string--undefined","hLevel":2,"level":1},{"value":"useCartToken(): string | undefined","id":"usecarttoken-string--undefined","hLevel":2,"level":1}]

Token

The APIs for obtaining information about cart and checkout tokens.

`checkoutToken: string | undefiend`

CAUTION

This API can only be used on the checkout page.

The unique identifier for the current checkout.

render("Checkout::Dynamic::Render", (props) => {
  const { checkoutToken } = props;
  const top = (
    <>
      {checkoutToken && checkoutToken.includes("test") ? (
        <Banner title="Thank you for your visit" />
      ) : null}
    </>
  );
  return top;
});

`cartToken: string | undefined`

CAUTION

This API can only be used on the checkout page.

The unique identifier for the cart associated with the checkout. May be undefined.

render("Checkout::Dynamic::Render", (props) => {
  const { cartToken } = props;
  const top = (
    <>
      {cartToken && cartToken.includes("test") ? (
      <Banner title="Thank you for your visit" />
    ) : null}
    </>
  );
  return top;
});

`useCheckoutToken(): string | undefined`

CAUTION

This API can only be used on the checkout page.

Returns the unique identifier for the checkout.

render("Checkout::Dynamic::Render", (props) => {
  const checkoutToken = useCheckoutToken();
  const top = (
    <>
      {checkoutToken && checkoutToken.includes("test") ? (
        <Banner title="Thank you for your visit" />
      ) : null}
    </>
  );
  return top;
});

`useCartToken(): string | undefined`

CAUTION

This API can only be used on the checkout page.

Returns the unique identifier for the cart associated with the checkout. May be undefined.

render("Checkout::Dynamic::Render", (props) => {
  const cartToken = useCartToken();
  const top = (
    <>
      {cartToken && cartToken.includes("test") ? (
        <Banner title="Thank you for your visit" />
      ) : null}
    </>
  );
  return top;
});