Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Choose a version:

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

Requires access to protected customer data for some properties.

A static extension target that renders below the order details section of the Order Status page.

Caution

Use the @shopify/ui-extensions/customer-account or @shopify/ui-extensions-react/customer-account surfaces when targeting order status targets. Importing from the checkout surface is deprecated as of version 2023-10.

Support

Components (63)

APIs (28)

Anchor to orderstatusapiOrderStatusApi

The API object provided to this and other customer-account.order-status extension targets.

Anchor to appliedGiftCards appliedGiftCards StatefulRemoteSubscribable<[]> required: Gift cards that have been applied to the order. Each entry includes the amount used and the remaining balance.
Anchor to appMetafields appMetafields StatefulRemoteSubscribable<[]> required: 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.

Requires access to protected customer data.
Anchor to attributes attributes StatefulRemoteSubscribable<[] | undefined> required: Custom key-value pairs that the buyer attached to the order during cart or checkout, commonly used for special instructions or order customization.
Anchor to authenticationState authenticationState StatefulRemoteSubscribable<> required: The buyer's current authentication state on the Order status page. The value is either 'fully_authenticated' (the buyer is logged in) or 'pre_authenticated' (the buyer is viewing through a tokenized link).
Anchor to checkoutSettings checkoutSettings StatefulRemoteSubscribable<> required: The merchant's checkout configuration that was active when the buyer placed the order, including the order type, payment terms, and shipping address settings.
Anchor to checkoutToken checkoutToken StatefulRemoteSubscribable< | undefined> required: The token that represents the checkout session used to create this order.

Matches the token field in the WebPixel checkout payload and the checkout_token field in the Admin REST API Order resource.
Anchor to cost cost required: The cost breakdown for the order, including subtotal, shipping, tax, and total amounts.
Anchor to discountAllocations discountAllocations StatefulRemoteSubscribable<[]> required: The order-level discount allocations, including code-based, automatic, and custom discounts. Each allocation includes the discounted amount and the discount source.
Anchor to discountCodes discountCodes StatefulRemoteSubscribable<[]> required: The discount codes that the buyer applied to the order at checkout.
Anchor to extension extension <Target> required: Information about the running extension, including its editor context, extension point, script URL, and localization settings.
Anchor to lines lines StatefulRemoteSubscribable<[]> required: The line items in the order, including product details, quantities, costs, and any applied discounts.
Anchor to localization localization required: Details about the buyer's location, language, and currency on the Order status page. For utilities to format and translate content based on these details, use the i18n object from the Localization API instead.
Anchor to metafields metafields StatefulRemoteSubscribable<[]> required: The metafields that apply to the current order. These metafields are shared by all extensions running on the Order status page and persist for the duration of the buyer's session.

Once the order is created, you can query these metafields using the GraphQL Admin API.
Anchor to note note StatefulRemoteSubscribable<string | undefined> required: A free-form text note that the buyer left for the merchant during cart or checkout, commonly used for special delivery instructions or order requests.
Anchor to order order StatefulRemoteSubscribable< | undefined> required: Information about the placed order, including its ID, display name, confirmation number, and timestamps.
Anchor to requireLogin requireLogin () => Promise<void> required: Triggers a login prompt if the buyer is viewing a pre-authenticated Order status page. Returns a promise that resolves when the login prompt is dismissed or completed.
Anchor to shop shop required: The shop where the order was placed, including its name, ID, storefront URL, and myshopify.com domain.
Anchor to version version required: The API version being used for the extension.
Anchor to billingAddress billingAddress StatefulRemoteSubscribable< | undefined>: The billing address associated with the buyer's payment method.
Anchor to buyerIdentity buyerIdentity: Information about the buyer who placed the order, including their customer account, email, phone, and B2B company details.
Anchor to shippingAddress shippingAddress StatefulRemoteSubscribable< | undefined>: The shipping address that the buyer provided for the order.
Anchor to extensionPoint extensionPoint Target required: 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
Deprecated as of version 2023-07, use extension.target instead.

AppliedGiftCard

amountUsed
The amount of the gift card that was applied to this order.
```
Money
```
balance
The remaining balance on the gift card after the applied amount is deducted.
```
Money
```
lastCharacters
The last four characters of the gift card code, used to identify the card without exposing the full code.
```
string
```

Money

amount
The decimal money amount, such as `29.99`.
```
number
```
currencyCode
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
```
CurrencyCode
```

CurrencyCode

'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

AppMetafieldEntry

A metafield associated with a resource on the order. Each entry contains both the metafield data and a reference to the resource that owns it.

metafield
The metafield data, including its key, namespace, value, and type.
```
AppMetafield
```
target
The resource that owns the metafield.
```
AppMetafieldEntryTarget
```

AppMetafield

Represents a custom metadata field attached to a resource, requested through the [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/latest#configuration) file.

key
The unique identifier for the metafield within its namespace.
```
string
```
namespace
A container that groups related metafields. Must be between 2 and 255 characters in length.
```
string
```
type
The metafield's content type as defined in the [metafield definition](/docs/apps/build/custom-data/metafields), such as `single_line_text_field` or `number_integer`.
```
string
```
value
The metafield's value. The data type depends on the `valueType`: booleans, numbers, and strings are returned in their respective types, while JSON strings are returned as strings.
```
string | number | boolean
```
valueType
The metafield’s value type, which determines how the `value` is interpreted: - `'boolean'`: A true or false value. - `'float'`: A decimal number. - `'integer'`: A whole number. - `'json_string'`: A JSON-encoded string. - `'string'`: A plain text string.
```
'boolean' | 'float' | 'integer' | 'json_string' | 'string'
```

AppMetafieldEntryTarget

The resource that owns the metafield.

id
The globally-unique identifier of the resource that owns the metafield.
```
string
```
type
The type of resource that owns the metafield: - `'customer'`: A customer resource. - `'product'`: A product resource. - `'shop'`: The shop resource. - `'variant'`: A product variant resource. - `'company'`: A B2B company resource. - `'companyLocation'`: A B2B company location resource. - `'cart'`: The cart resource. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company`, or `companyLocation`.
```
| 'customer'
    | 'product'
    | 'shop'
    | 'variant'
    | 'company'
    | 'companyLocation'
    | 'cart'
```

Attribute

key
The attribute name. Keys are unique within the attribute list.
```
string
```
value
The attribute value as a string.
```
string
```

AuthenticationState

The buyer’s authentication state on the **Order status** page: - `'fully_authenticated'`: The buyer has logged in to their customer account. - `'pre_authenticated'`: The buyer accessed the page through a tokenized link without logging in.

'fully_authenticated' | 'pre_authenticated'

MailingAddress

{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). Most properties require level 2 access. The `company` property requires level 1 access.

address1
The first line of the street address, including the street number and name.
```
string
```
address2
The second line of the street address, such as apartment number, suite, or unit.
```
string
```
city
The city, town, or village name.
```
string
```
company
The company or organization name associated with the address.
```
string
```
countryCode
The [ISO 3166-1 Alpha-2](https://www.iso.org/iso-3166-country-codes.html) country code.
```
CountryCode
```
firstName
The buyer's given name.
```
string
```
lastName
The buyer's family name.
```
string
```
name
The buyer's full name, typically the first and last name combined.
```
string
```
phone
The phone number associated with the address.
```
string
```
provinceCode
The buyer's province, state, or region code.
```
string
```
zip
The postal code or ZIP code.
```
string
```

CountryCode

'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'

OrderStatusBuyerIdentity

{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.

customer
The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.
```
StatefulRemoteSubscribable<OrderStatusCustomer | undefined>
```
email
The buyer's email address associated with the order. The value is `undefined` if the app doesn't have access to customer data.
```
StatefulRemoteSubscribable<string | undefined>
```
phone
The buyer's phone number associated with the order. The value is `undefined` if the app doesn't have access to customer data.
```
StatefulRemoteSubscribable<string | undefined>
```
purchasingCompany
The company and company location that the B2B customer is purchasing on behalf of. The value is `undefined` if the buyer isn't a B2B customer.
```
StatefulRemoteSubscribable<
    OrderStatusPurchasingCompany | undefined
  >
```

OrderStatusCustomer

The customer associated with the order. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `id`, `image`, `acceptsMarketing`, and `storeCreditAccounts` properties require level 1 access. The `email`, `phone`, `fullName`, `firstName`, and `lastName` properties require level 2 access.

acceptsMarketing
Whether the customer has opted in to receive marketing communications from the merchant.
```
boolean
```
email
The customer's email address.
```
string
```
firstName
The customer's first name.
```
string
```
fullName
The customer's full name, combining first and last name.
```
string
```
id
A globally-unique identifier for the customer.
```
string
```
image
The customer's profile image, such as a Gravatar.
```
ImageDetails
```
lastName
The customer's last name.
```
string
```
phone
The customer's phone number.
```
string
```
storeCreditAccounts
The store credit accounts owned by the customer that can be applied during checkout.
```
StoreCreditAccount[]
```

ImageDetails

altText
The alternative text for the image, used for accessibility and displayed when the image can't be loaded.
```
string
```
url
The fully-qualified URL of the image.
```
string
```

OrderStatusPurchasingCompany

The B2B company and location that the business customer is purchasing on behalf of. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

company
The company that the B2B customer belongs to.
```
OrderStatusCompany
```
location
The company location that the B2B customer is purchasing for.
```
OrderStatusCompanyLocation
```

OrderStatusCompany

{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

externalId
A custom external identifier for the company, set by the merchant. Useful for syncing with external systems.
```
string
```
id
A globally-unique identifier for the company.
```
string
```
name
The display name of the company.
```
string
```

OrderStatusCompanyLocation

{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

externalId
A custom external identifier for the company location, set by the merchant. Useful for syncing with external systems.
```
string
```
id
A globally-unique identifier for the company location.
```
string
```
name
The display name of the company location.
```
string
```

CheckoutSettings

The merchant's checkout configuration that was active when the buyer placed the order.

orderSubmission
The type of order created when the buyer completes checkout: - `'DRAFT_ORDER'`: A draft order that requires merchant approval before processing. - `'ORDER'`: A standard order that’s processed immediately.
```
'DRAFT_ORDER' | 'ORDER'
```
paymentTermsTemplate
The merchant-configured payment terms for the order, such as net 30 or net 60 terms. Only present for B2B orders with deferred payment.
```
PaymentTermsTemplate
```
shippingAddress
Configuration for the shipping address behavior, including whether the buyer can edit it.
```
ShippingAddressSettings
```

PaymentTermsTemplate

A payment terms template that defines when payment is due for the order, commonly used in B2B transactions.

dueDate
The due date for net payment terms as an ISO 8601 formatted string (`YYYY-MM-DDTHH:mm:ss.sssZ`).
```
string
```
dueInDays
The number of days between the order date and the payment due date for net payment terms.
```
number
```
id
A globally-unique identifier for the payment terms template.
```
string
```
name
The name of the payment terms translated to the buyer's current language.
```
string
```

ShippingAddressSettings

Configuration for the shipping address on the checkout.

isEditable
Whether the buyer was allowed to edit the shipping address during checkout.
```
boolean
```

CheckoutToken

A string token that uniquely identifies the checkout session used to create this order.

string

CartCost

subtotalAmount
The subtotal cost of all line items in the order before shipping, taxes, and discounts.
```
StatefulRemoteSubscribable<Money>
```
totalAmount
The total amount the buyer paid for the order, including all line items, shipping, taxes, and discounts.
```
StatefulRemoteSubscribable<Money>
```
totalShippingAmount
The total shipping cost for the order, including any shipping discounts. Returns `undefined` if shipping hasn't been calculated.
```
StatefulRemoteSubscribable<Money | undefined>
```
totalTaxAmount
The total tax amount for the order, including taxes on products and shipping. Returns `undefined` if taxes haven't been calculated.
```
StatefulRemoteSubscribable<Money | undefined>
```

CartDiscountAllocation

A discount allocation applied to the order or a line item. There are three types: - `CartCodeDiscountAllocation`: A discount applied via a code entered by the buyer. - `CartAutomaticDiscountAllocation`: An automatic discount applied by Shopify based on merchant-configured rules. - `CartCustomDiscountAllocation`: A custom discount applied by a Shopify Script or discount function.

CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation

CartCodeDiscountAllocation

code
The discount code that the buyer entered at checkout.
```
string
```
discountedAmount
The monetary amount deducted from the order by this discount allocation.
```
Money
```
type
The type of discount allocation. Always `'code'` for code-based discounts.
```
"code"
```

CartAutomaticDiscountAllocation

discountedAmount
The monetary amount deducted from the order by this discount allocation.
```
Money
```
title
The merchant-defined title of the automatic discount, such as "Buy 2 Get 1 Free".
```
string
```
type
The type of discount allocation. Always `'automatic'` for automatic discounts.
```
"automatic"
```

CartCustomDiscountAllocation

discountedAmount
The monetary amount deducted from the order by this discount allocation.
```
Money
```
title
The title of the custom discount applied by a Shopify Script or discount function.
```
string
```
type
The type of discount allocation. Always `'custom'` for custom discounts.
```
"custom"
```

CartDiscountCode

code
The discount code string entered by the buyer at checkout.
```
string
```

Extension

Metadata about the extension, including its target, version, and editor context. For configuration details, see [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/2025-07#configuration).

apiVersion
The API version that was set in the extension config file.
```
ApiVersion
```
capabilities
The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/2025-07#configuration) file. * [`api_access`](/docs/api/customer-account-ui-extensions/2025-07#configuration): the extension can access the Storefront API. * [`network_access`](/docs/api/customer-account-ui-extensions/2025-07#configuration): the extension can make external network calls. * [`block_progress`](/docs/api/customer-account-ui-extensions/2025-07#configuration): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.
```
StatefulRemoteSubscribable<Capability[]>
```
editor
Information about the editor where the extension is being rendered. The value is undefined if the extension isn’t rendering in an editor.
```
Editor
```
rendered
Whether your extension is currently rendered to the screen. Shopify may render your extension before it's visible in the UI to pre-render content. Your extension may also continue running after the buyer navigates away so it's immediately available if they return.
```
StatefulRemoteSubscribable<boolean>
```
scriptUrl
The URL of the JavaScript file that powers this extension target.
```
string
```
target
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. For available targets, see the [extension targets overview](/docs/api/customer-account-ui-extensions/2025-07/extension-targets-overview). For configuration details, see [extension targets](/docs/apps/app-extensions/configuration#targets).
```
Target
```
version
The published version of the running extension. For unpublished extensions, the value is `undefined`.
```
string
```

ApiVersion

The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features, and can change without notice because it's not subject to versioning guarantees.

'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable'

Capability

The capabilities an extension has access to. * `api_access`: The extension can access the Storefront API. * `network_access`: The extension can make external network calls. * `block_progress`: The extension can block a buyer's progress and the merchant has allowed this blocking behavior. * `collect_buyer_consent.sms_marketing`: The extension can collect buyer consent for SMS marketing. * `collect_buyer_consent.customer_privacy`: The extension can register buyer consent decisions that will be honored on Shopify-managed services. * `iframe.sources`: The extension can embed an external URL in an iframe.

'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'

Editor

Information about the editor where the extension is being rendered.

type
Indicates whether the extension is rendering in the checkout editor.
```
"checkout"
```

CartLine

attributes
Custom key-value pairs attached to this line item, such as engraving text or gift messages.
```
Attribute[]
```
cost
The cost breakdown for this line item, including the total amount after discounts.
```
CartLineCost
```
discountAllocations
The discounts allocated to this line item, including code-based, automatic, and custom discounts.
```
CartDiscountAllocation[]
```
id
A unique identifier for the cart line. This ID isn't guaranteed to be stable across operations.
```
string
```
lineComponents
The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Returns an empty array if the line item isn't a bundle.
```
CartBundleLineComponent[]
```
merchandise
The product variant being purchased in this line item.
```
Merchandise
```
quantity
The quantity of the merchandise being purchased.
```
number
```

CartLineCost

totalAmount
The total amount for the line item after all discounts have been applied.
```
Money
```

CartBundleLineComponent

attributes
Custom key-value pairs attached to this bundle component.
```
Attribute[]
```
cost
The cost breakdown for this bundle component.
```
CartLineCost
```
id
A unique identifier for the bundle line component. This ID isn't stable and may change if line items are modified.
```
string
```
merchandise
The product variant included in this bundle component.
```
Merchandise
```
quantity
The quantity of this product variant within the bundle.
```
number
```
type
Always `'bundle'` for bundle line components.
```
"bundle"
```

Merchandise

id
A globally-unique identifier for the product variant.
```
string
```
image
The image associated with this product variant. Falls back to the product's featured image if no variant-specific image is available.
```
ImageDetails
```
product
The parent product that this variant belongs to.
```
Product
```
requiresShipping
Whether this product variant requires physical shipping.
```
boolean
```
selectedOptions
The product options selected for this variant, such as size and color.
```
SelectedOption[]
```
sellingPlan
The selling plan associated with this line item, such as a subscription or pre-order plan.
```
SellingPlan
```
sku
The product variant's stock keeping unit (SKU), used for inventory tracking.
```
string
```
subtitle
A secondary title for the product variant, typically showing selected option values.
```
string
```
title
The product variant’s title.
```
string
```
type
Always `'variant'` for product variant merchandise.
```
"variant"
```

Product

id
A globally-unique identifier for the product.
```
string
```
productType
A product classification used for filtering and organization, set by the merchant in the Shopify admin.
```
string
```
vendor
The product’s vendor name.
```
string
```

SelectedOption

name
The name of the product option, such as "Size" or "Color".
```
string
```
value
The selected value for the option, such as "Large" or "Blue".
```
string
```

SellingPlan

id
A globally-unique identifier for the selling plan.
```
string
```
recurringDeliveries
Whether purchasing the selling plan will result in multiple deliveries.
```
boolean
```

OrderStatusLocalization

country
The country context of the order. This value carries over from the storefront context and may update if the buyer changes their shipping country. The value is `undefined` if unknown.
```
StatefulRemoteSubscribable<Country | undefined>
```
currency
The currency that the buyer sees for money amounts on the **Order status** page.
```
StatefulRemoteSubscribable<Currency>
```
extensionLanguage
This is the buyer's language, as supported by the extension. If the buyer's actual language is not supported by the extension, this is the fallback locale used for translations. For example, if the buyer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension doesn’t provide French translations at all, this value is the default locale for your extension (that is, the one matching your .default.json file).
```
StatefulRemoteSubscribable<Language>
```
language
The language the buyer sees on the **Order status** page.
```
StatefulRemoteSubscribable<Language>
```
market
The [market](/docs/apps/build/markets) context of the order. This value carries over from the storefront context and may update if the buyer changes their shipping country. The value is `undefined` if unknown.
```
StatefulRemoteSubscribable<Market | undefined>
```
timezone
The buyer’s time zone, based on their browser settings or IP address.
```
StatefulRemoteSubscribable<Timezone>
```

Country

A buyer's country, identified by its ISO country code.

isoCode
The ISO-3166-1 code for this country.
```
CountryCode
```

Currency

isoCode
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code, such as `USD` or `EUR`.
```
CurrencyCode
```

Language

Represents the buyer's language as a [BCP-47 standard](https://en.wikipedia.org/wiki/IETF_language_tag) language tag.

isoCode
The [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tag. May include a dash followed by an [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) region subtag.
```
string
```

Market

handle
The human-readable, shop-scoped identifier for the market. This handle is unique within the shop but isn't globally unique.
```
string
```
id
A globally-unique identifier for a Shopify [market](/docs/apps/build/markets).
```
string
```

Timezone

'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'

Metafield

Represents a custom metadata field attached to a resource. Metafields let you store additional structured data on Shopify resources like orders and products.

key
The unique identifier for the metafield within its namespace. Must be between 3 and 30 characters in length (inclusive).
```
string
```
namespace
A container for a group of metafields. Namespaces distinguish your app's metafields from those created by other apps. Must be between 2 and 20 characters in length (inclusive).
```
string
```
value
The metafield's value. The data type depends on the `valueType`: integers are returned as numbers, while strings and JSON strings are returned as strings.
```
string | number
```
valueType
The metafield’s value type, which determines how the `value` is interpreted: - `'integer'`: A whole number. - `'string'`: A plain text string. - `'json_string'`: A JSON-encoded string.
```
'integer' | 'string' | 'json_string'
```

Order

Details about the placed order, including its identifier, display name, and processing timestamps.

cancelledAt
The date and time when the order was cancelled, in ISO 8601 format. Returns `undefined` if the order hasn't been cancelled.
```
string
```
confirmationNumber
A randomly generated alpha-numeric confirmation code for the order. Always present for orders created in 2024 and later; may be absent for older orders.
```
string
```
id
A globally-unique identifier for the order.
```
string
```
name
The merchant-facing order number that appears in the Shopify admin and on the order confirmation page.
```
string
```
processedAt
The date and time when the order was processed, in ISO 8601 format. Processing happens after checkout completes and indicates the order is available in the Shopify admin.
```
string
```

Shop

id
A globally-unique identifier for the shop.
```
string
```
myshopifyDomain
The shop's `myshopify.com` domain. This is a stable identifier that doesn't change when the merchant updates their custom domain.
```
string
```
name
The merchant's store name as configured in the Shopify admin.
```
string
```
storefrontUrl
The primary storefront URL for the shop. This reflects the merchant's custom domain if one is configured.
```
string
```

Version

The API version string for the extension, such as `'2025-07'`.

string

Anchor to standardapiStandardApi

The base API object provided to this and other customer-account extension targets.

Anchor to analytics analytics required: Methods for interacting with web pixels, such as publishing analytics events.

Note
Requires a connected third-party domain for your customer account pages.
Note: Requires a <a href="https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account">connected third-party domain</a> for your customer account pages.
Anchor to applyTrackingConsentChange applyTrackingConsentChange required: Applies changes to the buyer's tracking consent preferences and consent metafields.

Note
Requires the customer_privacy capability to be set to true.
Note: Requires the <a href="/docs/api/customer-account-ui-extensions/2025-07#configuration#collect-buyer-consent"><code><span class="PreventFireFoxApplyingGapToWBR">customer<wbr/>_privacy</span></code> capability</a> to be set to <code>true</code>.
Requires access to protected customer data.
Anchor to authenticatedAccount authenticatedAccount required: The authenticated customer's account information, including their customer ID and B2B company details.
Anchor to customerPrivacy customerPrivacy StatefulRemoteSubscribable<> required: The buyer's current privacy consent settings, including consent flags, allowed processing activities, and region information.
Anchor to extension extension required: Metadata about the extension, including its target, version, and editor context. For configuration details, see shopify.extension.toml.
Anchor to i18n i18n required: Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Supports both the buyer's locale and the extension's fallback locale.
Anchor to localization localization required: The buyer's language, country, and locale context. For formatting utilities, use the i18n object instead.
Anchor to navigation navigation required: Methods for navigating within the customer account, including URL-based navigation and history management.
Anchor to query query <Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: ; }) => Promise<{ data?: Data; errors?: []; }> required: Queries the Storefront GraphQL API using a prefetched token. Requires the api_access capability in your extension configuration.
Anchor to sessionToken sessionToken required: Provides access to session tokens for verifying requests from your extension to your app's backend. Session tokens are signed JSON Web Tokens (JWTs) that contain information about the current session. For more details, see the Session Token API.
Anchor to settings settings StatefulRemoteSubscribable<> required: The merchant-configured settings for this extension. Settings are empty until the merchant configures them, and values update in real time as the merchant saves changes.
Anchor to storage storage required: Key-value storage that persists across customer sessions. Data is scoped to your app and shared across all extension targets.
Anchor to ui ui required: Triggers platform-level UI interactions, such as displaying toast notifications. Use this to show success or error messages in response to customer actions.
Anchor to version version Version required: The API version your extension is running against. This is the version specified in your shopify.extension.toml file.
Anchor to extensionPoint extensionPoint Target required: 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. For available targets, see the extension targets overview. For configuration details, see extension targets.

Deprecated
Deprecated as of version 2023-07, use extension.target instead.

Analytics

Methods for interacting with [web pixels](/docs/apps/build/marketing-analytics/pixels), including publishing analytics events and capturing visitor identity data.

publish
Publishes analytics events to [web pixels](/docs/apps/build/marketing-analytics/pixels). Events are forwarded to all subscribed pixels.
```
(name: string, data: Record<string, unknown>) => Promise<boolean>
```
visitor
Captures visitor identity data (email or phone) for analytics and marketing attribution.
```
(data: { email?: string; phone?: string; }) => Promise<VisitorResult>
```

VisitorResult

Represents a visitor result.

VisitorSuccess | VisitorError

VisitorSuccess

Represents a successful visitor result.

type
Indicates the visitor information was successfully validated and submitted.
```
"success"
```

VisitorError

Represents an unsuccessful visitor result.

message
A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer.
```
string
```
type
Indicates the visitor information was invalid and wasn't submitted, such as using an incorrect data type or missing a required property.
```
"error"
```

ApplyTrackingConsentChangeType

visitorConsent
```
VisitorConsentChange
```

Promise<TrackingConsentChangeResult>

Promise<TrackingConsentChangeResult>

VisitorConsentChange

analytics
Whether the visitor consents to analytics tracking that measures how they interact with the site.
```
boolean
```
marketing
Whether the visitor consents to ads and marketing communications based on their interests.
```
boolean
```
metafields
Tracking consent metafield data to be saved. If the value is `null`, the metafield will be deleted.
```
TrackingConsentMetafieldChange[]
```
preferences
Whether the visitor consents to storing preferences, such as country or language, to personalize their experience.
```
boolean
```
saleOfData
Whether the visitor opts out of data sharing or sale of their personal data.
```
boolean
```
type
The type of consent change. Always `'changeVisitorConsent'`.
```
"changeVisitorConsent"
```

TrackingConsentMetafieldChange

key
The name of the metafield. It must be between 3 and 30 characters in length (inclusive).
```
string
```
value
The information to be stored as metadata. If the value is `null`, the metafield will be deleted.
```
string | null
```

TrackingConsentChangeResult

TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError

TrackingConsentChangeResultSuccess

The result returned when a tracking consent preference update succeeds.

type
Always `'success'`, indicating the consent change was applied.
```
"success"
```

TrackingConsentChangeResultError

The result returned when a tracking consent preference update fails, including an error message.

message
A message that explains the error. This message is useful for debugging. It isn’t localized, and therefore shouldn’t be presented directly to the buyer.
```
string
```
type
Always `'error'`, indicating the consent change failed.
```
"error"
```

AuthenticatedAccount

customer
The authenticated customer's account information, including their globally-unique ID.
```
StatefulRemoteSubscribable<Customer | undefined>
```
purchasingCompany
The B2B company information for the authenticated business customer. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer.
```
StatefulRemoteSubscribable<PurchasingCompany | undefined>
```

Customer

The authenticated customer's account information. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

id
A globally-unique identifier for the customer.
```
string
```

PurchasingCompany

company
The company that the authenticated B2B customer belongs to.
```
Company
```
location
The company location that the authenticated B2B customer is purchasing for.
```
CompanyLocation
```

Company

id
A globally-unique identifier for the company.
```
string
```

CompanyLocation

id
A globally-unique identifier for the company location.
```
string
```

CustomerPrivacy

allowedProcessing
Flags indicating which data processing activities are allowed, based on the visitor's consent, merchant configuration, and the visitor's location.
```
AllowedProcessing
```
metafields
Custom key-value pairs that store additional tracking consent preferences, such as granular opt-in choices for analytics or marketing categories. The array is empty when no consent metafields have been set.
```
TrackingConsentMetafield[]
```
region
The visitor's geolocation data, used to determine whether region-specific consent controls should be displayed.
```
CustomerPrivacyRegion
```
saleOfDataRegion
Whether the visitor is in a region that requires explicit opt-out controls for the sale of personal data.
```
boolean
```
shouldShowBanner
Whether a consent banner should display when the page loads. Determined by the visitor's current consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner), and the visitor's location.
```
boolean
```
visitorConsent
The visitor's explicit consent choices for analytics, marketing, preferences, and sale of data. Each flag is `true` (granted), `false` (denied), or `undefined` (no decision yet).
```
VisitorConsent
```

AllowedProcessing

analytics
Whether the app can collect analytics about how the buyer interacted with the shop.
```
boolean
```
marketing
Whether the app can use the buyer's data for marketing, attribution, and targeted advertising.
```
boolean
```
preferences
Whether the app can store the buyer's preferences, such as language, currency, and size.
```
boolean
```
saleOfData
Whether the buyer has opted out of data sharing with third parties for behavioral advertising.
```
boolean
```

TrackingConsentMetafield

key
The name of the metafield. It must be between 3 and 30 characters in length (inclusive).
```
string
```
value
The stored consent preference value, such as a consent level or a stringified JSON object with granular settings.
```
string
```

CustomerPrivacyRegion

countryCode
The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CountryCode
```
provinceCode
The buyer's province code, such as state, province, prefecture, or region. Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2). {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

VisitorConsent

analytics
Whether the visitor consents to analytics tracking that measures how they interact with the site.
```
boolean
```
marketing
Whether the visitor consents to ads and marketing communications based on their interests.
```
boolean
```
preferences
Whether the visitor consents to storing preferences, such as country or language, to personalize their experience.
```
boolean
```
saleOfData
Whether the visitor opts out of data sharing or sale of their personal data.
```
boolean
```

I18n

Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Supports both the buyer's locale and the extension's fallback locale.

formatCurrency
Returns a localized currency string. This function behaves like the standard [`Intl.NumberFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) with a style of `currency` applied. Uses the buyer's locale by default.
```
(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string
```
formatDate
Returns a localized date string. This function behaves like the standard [`Intl.DateTimeFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) and uses the buyer's locale by default. Formatting [options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options) can be passed in as options.
```
(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string
```
formatNumber
Returns a localized number string. This function behaves like the standard [`Intl.NumberFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) with a style of `decimal` applied. Uses the buyer's locale by default.
```
(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string
```
translate
Returns translated content in the buyer's locale, as supported by the extension. - `options.count` is a special numeric value used in pluralization. - The other option keys and values are treated as replacements for interpolation. - If the replacements are all primitives, then `translate()` returns a single string. - If replacements contain UI components, then `translate()` returns an array of elements.
```
I18nTranslate
```

I18nTranslate

The signature for the `i18n.translate()` function. Returns translated content matching a key in a locale file, with support for pluralization and interpolation.

Localization

The buyer’s language, country, and locale context in the customer account. Use this to adapt content to the buyer’s region and language preferences.

country
The buyer's country context in the customer account, as a `StatefulRemoteSubscribable` that updates if the buyer changes their country. The value is `undefined` if the country is unknown.
```
StatefulRemoteSubscribable<Country | undefined>
```
extensionLanguage
The buyer's language, as supported by the extension. If the buyer's actual language is not supported by the extension, this is the fallback locale used for translations. For example, if the buyer's language is `fr-CA` but your extension only supports translations for `fr`, then the `isoCode` for this language is `fr`. If your extension doesn't provide French translations at all, this value is the default locale for your extension (that is, the one matching your `.default.json` file).
```
StatefulRemoteSubscribable<Language>
```
language
The language the buyer sees in the customer account pages.
```
StatefulRemoteSubscribable<Language>
```

StandardExtensionNavigation

Provides URL-based navigation within the customer account. Supports navigation to customer account pages and [custom protocols](/docs/api/customer-account-ui-extensions/2025-07/apis/navigation).

navigate
Navigates to a specific URL within the customer account, updating the history entries list.
```
NavigateFunction
```

NavigateFunction

A function that performs navigation to a specific URL within the customer account.

StorefrontApiVersion

The supported Storefront API versions. Pass one of these values to `query()` to target a specific API version when querying the Storefront GraphQL API.

'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable'

GraphQLError

An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.

extensions
Additional error metadata including the request ID and error code.
```
{ requestId: string; code: string; }
```
message
A human-readable description of the error.
```
string
```

SessionToken

Provides access to session tokens for verifying requests from your extension to your app's backend. Session tokens are signed [JSON Web Tokens (JWTs)](https://jwt.io/) that contain information about the current session. For more details, see the [Session Token API](/docs/api/customer-account-ui-extensions/2025-07/apis/session-token).

get
Requests a session token that hasn't expired. Call this method every time you need to make a request to your backend to get a valid token. Returns cached tokens when possible, so you don't need to store tokens yourself.
```
() => Promise<string>
```

ExtensionSettings

The merchant-defined setting values for the extension, as configured in the [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/2025-07#configuration) file.

[key: string]
```
string | number | boolean | undefined
```

Storage

Key-value storage that persists across customer sessions. Data is scoped to your app and shared across all extension targets.

delete
Deletes the stored data for the given key.
```
(key: string) => Promise<void>
```
read
Reads and returns a stored value by key. The stored data is deserialized from JSON and returned as its original type. Returns `null` if no data exists for the given key.
```
<T = unknown>(key: string) => Promise<T>
```
write
Writes data for the given key. The data must be serializable to JSON.
```
(key: string, data: any) => Promise<void>
```

Ui

Triggers platform-level UI interactions from your extension, such as displaying toast notifications. Use the UI API to show success or error messages in response to customer actions.

forceDataRefresh
Refresh data so the surrounding information on the page is updated. The `content` string will appear in a toast message after refresh, to confirm the action was successful. To request access to this API: 1. Go to your partner dashboard and click **Apps**. 2. Select the app you need to request access for. 3. Click **API access**. 4. Under **Access force data refresh**, click **Request access**.
```
(content: string) => Promise<void>
```
overlay
An overlay is a contextual element on top of the main interface that provides additional information or functionality.
```
{ close(overlayId: string): void; }
```
toast
The Toast API displays a non-disruptive message that displays at the bottom of the interface to provide quick, at-a-glance feedback on the outcome of an action. How to use: - Use toasts to confirm successful actions. - Aim for two words. - Use noun + past tense verb format. For example, \`Changes saved\`. For errors, or information that needs to persist on the page, use a [banner](/docs/api/customer-account-ui-extensions/2025-07/components/feedback/banner) component.
```
{ show(content: string): void; }
```

Examples

import {

reactExtension,

Banner,

useOrder,

} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(

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

() => <Extension />,

);

function Extension() {

const order = useOrder();

if (order) {

return (

Please include your order ID ({order.id})

in support requests

</Banner>

);

}

return null;

}