APIs
Addresses
The API for interacting with addresses.
Analytics
The API for interacting with web pixels.
Attributes
The API for interacting with cart and checkout attributes.
Buyer Identity
The API for interacting with the buyer identity.
Buyer Journey
The API for interacting with the buyer journey.
Cart Instructions
Instructions used to create the checkout.
Cart Lines
The API for interacting with the cart lines.
Checkout Token
The API for interacting with the token of a checkout.
Cost
The API for interacting with the cost of a checkout.
Customer Privacy
The API for interacting with a customer's privacy consent. It is similar to the Customer Privacy API in storefront.
Delivery
The APIs for interacting with delivery and shipping options. >
Discounts
The API for interacting with discounts.
Extension
The API for interacting with the metadata of an extension.
Gift Cards
The API for interacting with gift cards.
Localization
The APIs for localizing your extension.
Localized Fields
The API for interacting with localized fields.
Metafields
The API for interacting with metafields.
Note
The API for interacting with the note applied to checkout.
Order
The API for interacting with the order confirmation, available on the Thank You page.
Payments
The API for interacting with the payment options.
Session Token
The API for interacting with session tokens.
Settings
The API for interacting with merchant settings.
Shop
The API for interacting with shop.
Storage
The API for interacting with local storage.
Storefront API
Querying the Storefront API.
UI
The API for interacting with the extension’s UI.
use
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.
use
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.
use
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.