useExtensionApi

Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties. For example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout. For a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets). > Caution: This is deprecated, use `useApi` instead.

Accessing Properties

import {
  reactExtension,
  Text,
  useExtensionApi,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  const {shop} = useExtensionApi();
  return <Text>Shop name: {shop.name}</Text>;
}

UseExtensionApiGeneratedType

Returns: ApiForRenderExtension<Target>

export function useExtensionApi< Target extends RenderExtensionTarget = RenderExtensionTarget, >(): ApiForRenderExtension<Target> { return useApi(); }

ApiForRenderExtension

For a given rendering extension target, returns the type of the API that the extension will receive at runtime. This API type is the second argument to the callback for that extension target. The first callback for all of the rendering extension targets each receive a `RemoteRoot` object.

ApiForRenderExtension<Target>

useExtensionApi

Accessing Properties