customer-account.order-status.customer-information.render-after

Target

Gift Cards that have been applied to the order.

The metafields requested in the shopify.ui.extension.toml file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.

Requires access to protected customer data.

Custom attributes left by the customer to the merchant, either in their cart or during checkout.

The authentication state of Order status page.

Settings applied to the buyer's checkout.

id that represents the checkout used to create the order.

Matches the token field in the WebPixel checkout payload and the checkout_token field in the Admin REST API Order resource.

Details on the costs of the purchase for the buyer.

Discounts that have been applied to the entire cart.

A list of discount codes applied to the purchase.

Meta information about the extension.

A list of lines containing information about the items the customer intends to purchase.

Details about the location, language, and currency of the buyer. 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 order. The actual resource on which these metafields exist depends on the source of the order:

• If the source is an order, then the metafields are on the order.

• If the source is a draft order, then the initial value of metafields are from the draft order, and any new metafields you write are applied to the order created by the checkout.

• For all other sources, the metafields are only stored locally on the client creating the checkout, and are applied to the order that results from checkout.

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

A note left by the customer to the merchant, either in their cart or during checkout.

Information about the order that was placed.

The requireLogin() method triggers login if the customer is viewing pre-authenticated Order status page.

Shop where the purchase took place.

The renderer version being used for the extension.

The buyer billing address used for the order.

Requires access to protected customer data.

Information about the buyer that is interacting with the order.

Requires access to protected customer data.

The buyer shipping address used for the order.

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.

Methods for interacting with Web Pixels, such as emitting an event.

Allows setting and updating customer privacy consent settings and tracking consent metafields.

Requires access to protected customer data.

Information about the authenticated account.

Customer privacy consent settings and a flag denoting if consent has previously been collected.

Meta information about the extension.

Utilities for translating content and formatting values according to the current localization of the user.

Details about the language of the buyer.

Used to query the Storefront GraphQL API with a prefetched token.

See storefront api access examples for more information.

Provides access to session tokens, which can be used to verify token claims on your app's server.

See session token examples for more information.

The settings matching the settings definition written in the shopify.ui.extension.toml file.

See settings examples for more information.

Key-value storage for the extension target.

Methods to interact with the extension's UI.

The renderer version being used for the extension.

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.