Addresses

The API for interacting with addresses.

View Addresses

Analytics

The API for interacting with web pixels.

View Analytics

Attributes

The API for interacting with cart and checkout attributes.

View Attributes

Buyer Identity

The API for interacting with the buyer identity.

View Buyer Identity

Buyer Journey

The API for interacting with the buyer journey.

View Buyer Journey

Cart Instructions

Instructions used to create the checkout.

View Cart Instructions

Cart Lines

The API for interacting with the cart lines.

View Cart Lines

Checkout Token

The API for interacting with the token of a checkout.

View Checkout Token

Cost

The API for interacting with the cost of a checkout.

View Cost

Customer Privacy

The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).

View Customer Privacy

Delivery

The APIs for interacting with delivery and shipping options. > > Tip: Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.

View Delivery

Discounts

The API for interacting with discounts.

View Discounts

Extension

The API for interacting with the metadata of an extension.

View Extension

Gift Cards

The API for interacting with gift cards.

View Gift Cards

Localization

The APIs for localizing your extension.

View Localization

Metafields

The API for interacting with metafields.

View Metafields

Note

The API for interacting with the note applied to checkout.

View Note

Order

The API for interacting with the order confirmation, available on the **Thank You** page.

View Order

Payments

The API for interacting with the payment options.

View Payments

Storefront API

Querying the Storefront API.

View Storefront API

Session Token

The API for interacting with session tokens.

View Session Token

Settings

The API for interacting with merchant settings.

View Settings

Shop

The API for interacting with shop.

View Shop

Storage

The API for interacting with local storage.

View Storage

UI

The API for interacting with the extension’s UI.

View UI

useApi()

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).

View useApi()

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.

View useExtensionApi()

useSubscription()

Subscribes to the special wrapper type that all “changeable” values in the checkout use. This hook extracts the most recent value from that object, and subscribes to update the value when changes occur in the checkout. > Note: > You generally shouldn’t need to use this directly, as there are dedicated hooks > for accessing the current value of each individual resource in the checkout.

View useSubscription()