APIs

This API object is provided to extensions registered for the purchase.cart-line-item.line-components.render, purchase.checkout.cart-line-item.render-after, purchase.thank-you.cart-line-item.render-after, and customer-account.order-status.cart-line-item.render-after extension targets. It extends the StandardApi and provides the target cart line item associated with the extension.

This API object is provided to extensions registered for the extension targets that appear exclusively pre-purchase. It extends the StandardApi and provides the write apis for the checkout data.

A target represents where your checkout UI extension will appear. You register for targets in your configuration file, and you include a JavaScript function that will run at that location in checkout. The API for each extension target is passed as an argument to your function. While all targets inherit the StandardApi, not all of them share the same properties and methods. For example, the purchase.checkout.cart-line-item.render-after target has access to the CheckoutApi to modify a checkout, but the purchase.thank-you.cart-line-item.render-after target does not.

This API object is provided to extensions registered for the extension targets that appear exclusively on the Order status page. It extends the StandardApi and provides access to an order object.

This API object is provided to extensions registered for the purchase.checkout.pickup-location-list.render-before or purchase.checkout.pickup-location-list.render-after extension targets. It extends the StandardApi and provides a isLocationFormVisible boolean to indicate whether the customer location input form is currently rendered and shown to the buyer.

This API object is provided to extensions registered for the purchase.checkout.pickup-point-list.render-before or purchase.checkout.pickup-point-list.render-after extension targets. It extends the StandardApi and provides a isLocationFormVisible boolean to indicate whether the customer location input form is currently rendered and shown to the buyer.

This API object is provided to extensions registered for the purchase.checkout.shipping-option-item.render-after or purchase.checkout.shipping-option-item.details.render extension targets. It extends the StandardApi, provides a target object with information about the shipping method the extension is attached to, and a isTargetSelected boolean indicating whether the shipping method is currently selected in the UI.

This base API object is provided to all extension targets.