APIs

The API for interacting with addresses.

The API for interacting with web pixels.

The API for interacting with the announcement bar.

The API for interacting with cart and checkout attributes.

The API for interacting with the buyer identity.

The API for interacting with the buyer journey.

Instructions used to create the checkout.

The API for interacting with the cart lines.

The API for interacting with the token of a checkout.

The API for interacting with the cost of a checkout.

The API for interacting with a customer's privacy consent. It is similar to the Customer Privacy API in storefront.

The APIs for interacting with delivery and shipping options. >

The API for interacting with discounts.

The API for interacting with the metadata of an extension.

The API for interacting with gift cards.

The APIs for localizing your extension.

The API for interacting with localized fields.

The API for interacting with metafields.

The API for interacting with the note applied to checkout.

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

The API for interacting with the payment options.

The API for interacting with session tokens.

The API for interacting with merchant settings.

The API for interacting with shop.

The API for interacting with local storage.

Querying the Storefront API.

The API for interacting with the extension’s UI.

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 object. Other targets may only have access to the 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.

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 object. Other targets may only have access to the 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.

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.