purchase.
A static extension target that renders on every line item, inside the details under the line item properties element.
This extension target will not be rendered if the line item is a custom line item belonging to a draft order invoice.
Anchor to cartlineitemapiCartLineItemApi
The API object provided to this and other cart-line-item extension targets.
The cart line the extension is attached to. Until version 2023-04, this property was a .
Anchor to checkoutapiCheckoutApi
The API object provided to this and other purchase.checkout extension targets.
Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the attributes property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the lines property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the property.
> See security considerations if your extension retrieves discount codes through a network call.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the property.
> See security considerations if your extension retrieves gift card codes through a network call.
This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the metafields property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the note property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Requires access to protected customer data.
Anchor to standardapiStandardApi
The base API object provided to this and other purchase.checkout and purchase.thank-you extension targets.
The methods for interacting with Web Pixels, such as emitting an event.
Gift Cards that have been applied to the checkout.
Allows setting and updating customer privacy consent settings and tracking consent metafields.
Requires the capability to be set to true.
Requires access to protected customer data.
The metafields requested in the shopify.extension.toml file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.
App owned metafields are supported and are returned using the $app format. The fully qualified reserved namespace format such as app--{your-app-id}[--{optional-namespace}] is not supported. See app owned metafields for more information.
Requires access to protected customer data.
The custom attributes left by the customer to the merchant, either in their cart or during checkout.
All available payment options.
Provides details on the buyer's progression through the checkout.
Refer to buyer journey examples for more information.
Settings applied to the buyer's checkout.
A stable ID that represents the current checkout.
Matches the token field in the WebPixel checkout payload and the field in the REST Admin API Order resource.
Details on the costs the buyer will pay for this checkout.
Customer privacy consent settings and a flag denoting if consent has previously been collected.
A list of delivery groups containing information about the delivery of the items the customer intends to purchase.
Discounts that have been applied to the entire cart.
A list of discount codes currently applied to the checkout.
The meta information about the extension.
Utilities for translating content and formatting values according to the current localization of the checkout.
Refer to localization examples for more information.
The cart instructions used to create the checkout and possibly limit extension capabilities.
These instructions should be checked prior to performing any actions that may be affected by them.
For example, if you intend to add a discount code via the method, check to ensure it's supported in this checkout.
As of version 2024-07, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the update guide for more information.
A list of lines containing information about the items the customer intends to purchase.
The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the i18n object instead.
The metafields that apply to the current checkout.
Metafields are stored locally on the client and are applied to the order object after the checkout completes.
These metafields are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.
Once the order is created, you can query these metafields using the GraphQL Admin API
> Cart metafields are only available on carts created via the Storefront API version 2023-04 or later.
A note left by the customer to the merchant, either in their cart or during checkout.
The method used to query the Storefront GraphQL API with a prefetched token.
Refer to Storefront API access examples for more information.
Payment options selected by the buyer.
The session token providing a set of claims as a signed JSON Web Token (JWT).
The token has a TTL of 5 minutes.
If the previous token expires, this value will reflect a new session token with a new signature and expiry.
Refer to session token examples for more information.
The settings matching the settings definition written in the shopify.extension.toml file.
Refer to settings examples for more information.
When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.
The shop where the checkout is taking place.
The key-value storage for the extension.
It uses and should persist across the customer's current checkout session.
Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.
Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage.
Methods to interact with the extension’s UI.
The renderer version being used for the extension.
The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.
Requires access to protected customer data.
Information about the buyer that is interacting with the checkout.
Requires access to protected customer data.
The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.
The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.
Requires access to protected customer data.
The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.
Deprecated as of version 2023-07, use extension.target instead.
