Choose a version:

useApi()

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 might only have access to a basic set of API properties about the checkout.

For a full list of the API available to each extension target, see the ExtensionTargets type.

Note

As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global shopify object.

Anchor to useApi
useApi(
_target
)

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.

Note

> As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global shopify object.

Anchor to useApi-parametersParameters

Anchor to _target _target extends keyof

Anchor to useApi-returnsReturns

< extends = >

Target

selectedSuggestion
```
AddressAutocompleteSuggestion
```

AddressAutocompleteSuggestion

formattedAddress
The address object used to auto-populate the remaining address fields. If this value is returned for every suggestion, then the `purchase.address-autocomplete.format-suggestion` extension target is not needed.
```
AutocompleteAddress
```
id
A textual identifier that uniquely identifies an autocomplete suggestion or address. This identifier may be used to search for a formatted address.
```
string
```
label
The address suggestion text presented to the buyer in the list of autocomplete suggestions. This text is shown to the buyer as-is. No attempts will be made to parse it.
```
string
```
matchedSubstrings
A list of substrings that matched the original search query. If `matchedSubstrings` are provided, then they will be used to highlight the substrings of the suggestions that matched the original search query.
```
MatchedSubstring[]
```

AutocompleteAddress

An address object used to auto-populate the address form fields. All fields are optional

address1
The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
address2
The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
city
The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
company
The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
countryCode
The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CountryCode
```
latitude
The latitude coordinates of the buyer. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
number
```
longitude
The longitude coordinates of the buyer. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
number
```
provinceCode
The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
zip
The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
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'

MatchedSubstring

length
The length of the matched substring in the suggestion label text.
```
number
```
offset
The start location of the matched substring in the suggestion label text.
```
number
```

RenderExtensionTargets

A UI extension will register for one or more extension targets using `shopify.extend()`. An extension target in a UI extension is a plain JavaScript function. This function receives some API for interacting with the application, and is expected to return a value in a specific shape. The input arguments and the output type are different for each extension target.

Checkout::Actions::RenderBefore
A static extension target that is rendered immediately before any actions within each step.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,
    AnyCheckoutComponent
  >
```
Checkout::CartLineDetails::RenderAfter
A static extension target that renders on every line item, inside the details under the line item properties element.
```
RenderExtension<
    CheckoutApi &
      CartLineItemApi &
      StandardApi<'Checkout::CartLineDetails::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::CartLineDetails::RenderLineComponents
A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.
```
RenderExtension<
    CartLineItemApi &
      StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,
    AnyCheckoutComponent
  >
```

Checkout::CartLines::RenderAfter

A static extension target that is rendered after all line items.

RenderExtension<
    CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,
    AnyCheckoutComponent
  >

Checkout::Contact::RenderAfter
A static extension target that is rendered immediately after the contact form element.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::CustomerInformation::RenderAfter
A static extension target that is rendered after a purchase below the customer information.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::DeliveryAddress::RenderBefore
A static extension target that is rendered between the shipping address header and shipping address form elements.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,
    AnyCheckoutComponent
  >
```
Checkout::Dynamic::Render
A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,
    AnyCheckoutComponent
  >
```
Checkout::GiftCard::Render
A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.
```
RenderExtension<
    RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,
    AnyCheckoutComponentExcept<'Image' | 'Banner'>
  >
```
Checkout::PaymentMethod::HostedFields::RenderAfter
A static extension target that renders after the hosted fields of a credit card payment method. for a credit card payment method when selected by the buyer.
```
RenderExtension<
    PaymentOptionItemApi &
      CheckoutApi &
      StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,
    AnyCheckoutComponentExcept<'Image' | 'Banner'>
  >
```

Checkout::PaymentMethod::Render

A static extension target that renders the form fields for a payment method when selected by the buyer.

RenderExtension<
    PaymentOptionItemApi &
      CheckoutApi &
      StandardApi<'Checkout::PaymentMethod::Render'>,
    AnyCheckoutComponentExcept<'Image' | 'Banner'>
  >

Checkout::PaymentMethod::RenderRequiredAction
A static extension target that renders a form modal when a buyer selects the custom onsite payment method.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,
    AnyCheckoutComponent
  >
```

Checkout::PickupLocations::RenderAfter

A static extension target that is rendered after pickup location options.

RenderExtension<
    PickupLocationListApi &
      CheckoutApi &
      StandardApi<'Checkout::PickupLocations::RenderAfter'>,
    AnyCheckoutComponent
  >

Checkout::PickupLocations::RenderBefore

A static extension target that is rendered before pickup location options.

RenderExtension<
    PickupLocationListApi &
      CheckoutApi &
      StandardApi<'Checkout::PickupLocations::RenderBefore'>,
    AnyCheckoutComponent
  >

Checkout::PickupPoints::RenderAfter

A static extension target that is rendered immediately after the pickup points.

RenderExtension<
    PickupPointListApi &
      CheckoutApi &
      StandardApi<'Checkout::PickupPoints::RenderAfter'>,
    AnyCheckoutComponent
  >

Checkout::PickupPoints::RenderBefore

A static extension target that is rendered immediately before the pickup points.

RenderExtension<
    PickupPointListApi &
      CheckoutApi &
      StandardApi<'Checkout::PickupPoints::RenderBefore'>,
    AnyCheckoutComponent
  >

Checkout::Reductions::RenderAfter
A static extension target that is rendered in the order summary, after the discount form and discount tag elements.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::Reductions::RenderBefore
A static extension target that is rendered in the order summary, before the discount form element.
```
RenderExtension<
    CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,
    AnyCheckoutComponent
  >
```
Checkout::ShippingMethodDetails::RenderAfter
A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.
```
RenderExtension<
    ShippingOptionItemApi &
      CheckoutApi &
      StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::ShippingMethodDetails::RenderExpanded
A static extension target that is rendered under the shipping method within the shipping method option list, for each option.
```
RenderExtension<
    ShippingOptionItemApi &
      CheckoutApi &
      StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,
    AnyCheckoutComponent
  >
```

Checkout::ShippingMethods::RenderAfter

A static extension target that is rendered after the shipping method options.

RenderExtension<
    ShippingOptionListApi &
      CheckoutApi &
      StandardApi<'Checkout::ShippingMethods::RenderAfter'>,
    AnyCheckoutComponent
  >

Checkout::ShippingMethods::RenderBefore

A static extension target that is rendered between the shipping method header and shipping method options.

RenderExtension<
    ShippingOptionListApi &
      CheckoutApi &
      StandardApi<'Checkout::ShippingMethods::RenderBefore'>,
    AnyCheckoutComponent
  >

Checkout::ThankYou::CartLineDetails::RenderAfter
A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.
```
RenderExtension<
    OrderConfirmationApi &
      CartLineItemApi &
      StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,
    AnyCheckoutComponent
  >
```

Checkout::ThankYou::CartLines::RenderAfter

A static extension target that is rendered after all line items on the **Thank you** page.

RenderExtension<
    OrderConfirmationApi &
      StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,
    AnyCheckoutComponent
  >

Checkout::ThankYou::CustomerInformation::RenderAfter
A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.
```
RenderExtension<
    OrderConfirmationApi &
      StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,
    AnyCheckoutComponent
  >
```
Checkout::ThankYou::Dynamic::Render
A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
```
RenderExtension<
    OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,
    AnyCheckoutComponent
  >
```
purchase.cart-line-item.line-components.render
A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.
```
RenderExtension<
    CartLineItemApi &
      StandardApi<'purchase.cart-line-item.line-components.render'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.actions.render-before
A static extension target that is rendered immediately before any actions within each step.
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.block.render
A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.block.render'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.cart-line-item.render-after
A static extension target that renders on every line item, inside the details under the line item properties element.
```
RenderExtension<
    CheckoutApi &
      CartLineItemApi &
      StandardApi<'purchase.checkout.cart-line-item.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.cart-line-list.render-after

A static extension target that is rendered after all line items.

RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.chat.render
A static extension target that is rendered on top of the checkout page as an overlay. It is positioned in the bottom right corner of the screen.
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,
    AllowedComponents<'Chat'>
  >
```
purchase.checkout.contact.render-after
A static extension target that is rendered immediately after the contact form element.
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.delivery-address.render-after

A static extension target that is rendered after the shipping address form elements.

RenderExtension<
    CheckoutApi &
      StandardApi<'purchase.checkout.delivery-address.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.delivery-address.render-before
A static extension target that is rendered between the shipping address header and shipping address form elements.
```
RenderExtension<
    CheckoutApi &
      StandardApi<'purchase.checkout.delivery-address.render-before'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.footer.render-after

A static extension target that is rendered below the footer.

RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.gift-card.render
A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.
```
RenderExtension<
    RedeemableApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.gift-card.render'>,
    AnyCheckoutComponentExcept<'Image' | 'Banner'>
  >
```

purchase.checkout.header.render-after

A static extension target that is rendered below the header.

RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.payment-method-list.render-after

A static extension target that renders below the list of payment methods.

RenderExtension<
    CheckoutApi &
      StandardApi<'purchase.checkout.payment-method-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.payment-method-list.render-before
A static extension target that renders between the payment heading and payment method list.
```
RenderExtension<
    CheckoutApi &
      StandardApi<'purchase.checkout.payment-method-list.render-before'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.payment-option-item.action-required.render
A static extension target that renders a form modal when a buyer selects the custom onsite payment method.
```
RenderExtension<
    CheckoutApi &
      StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.payment-option-item.details.render

A static extension target that renders the form fields for a payment method when selected by the buyer.

RenderExtension<
    PaymentOptionItemApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.payment-option-item.details.render'>,
    AnyCheckoutComponentExcept<'Image' | 'Banner'>
  >

purchase.checkout.payment-option-item.hosted-fields.render-after

A static extension target that renders after the hosted fields of a credit card payment method.

RenderExtension<
    PaymentOptionItemApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.pickup-location-list.render-after

A static extension target that is rendered after pickup location options.

RenderExtension<
    PickupLocationListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.pickup-location-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.pickup-location-list.render-before

A static extension target that is rendered before pickup location options.

RenderExtension<
    PickupLocationListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.pickup-location-list.render-before'>,
    AnyCheckoutComponent
  >

purchase.checkout.pickup-location-option-item.render-after
A static extension target that is rendered after the pickup location details within the local pickup option list, for each option.
```
RenderExtension<
    PickupLocationItemApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.pickup-point-list.render-after

A static extension target that is rendered immediately after the pickup points.

RenderExtension<
    PickupPointListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.pickup-point-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.pickup-point-list.render-before

A static extension target that is rendered immediately before the pickup points.

RenderExtension<
    PickupPointListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.pickup-point-list.render-before'>,
    AnyCheckoutComponent
  >

purchase.checkout.reductions.render-after
A static extension target that is rendered in the order summary, after the discount form and discount tag elements.
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.reductions.render-before
A static extension target that is rendered in the order summary, before the discount form element.
```
RenderExtension<
    CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.shipping-option-item.details.render
A static extension target that is rendered under the shipping method within the shipping method option list, for each option.
```
RenderExtension<
    ShippingOptionItemApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.shipping-option-item.details.render'>,
    AnyCheckoutComponent
  >
```
purchase.checkout.shipping-option-item.render-after
A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.
```
RenderExtension<
    ShippingOptionItemApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.shipping-option-item.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.checkout.shipping-option-list.render-after

A static extension target that is rendered after the shipping method options.

RenderExtension<
    ShippingOptionListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.shipping-option-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.checkout.shipping-option-list.render-before

A static extension target that is rendered between the shipping method header and shipping method options.

RenderExtension<
    ShippingOptionListApi &
      CheckoutApi &
      StandardApi<'purchase.checkout.shipping-option-list.render-before'>,
    AnyCheckoutComponent
  >

purchase.thank-you.announcement.render
A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.
```
RenderExtension<
    OrderConfirmationApi &
      StandardApi<'purchase.thank-you.announcement.render'>,
    AnyThankYouComponent
  >
```
purchase.thank-you.block.render
A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
```
RenderExtension<
    OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,
    AnyCheckoutComponent
  >
```
purchase.thank-you.cart-line-item.render-after
A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.
```
RenderExtension<
    OrderConfirmationApi &
      CartLineItemApi &
      StandardApi<'purchase.thank-you.cart-line-item.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.thank-you.cart-line-list.render-after

A static extension target that is rendered after all line items on the **Thank you** page.

RenderExtension<
    OrderConfirmationApi &
      StandardApi<'purchase.thank-you.cart-line-list.render-after'>,
    AnyCheckoutComponent
  >

purchase.thank-you.chat.render
A static extension target that is rendered on top of the **Thank you page** as an overlay. It is positioned in the bottom right corner of the screen.
```
RenderExtension<
    OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,
    AllowedComponents<'Chat'>
  >
```
purchase.thank-you.customer-information.render-after
A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.
```
RenderExtension<
    OrderConfirmationApi &
      StandardApi<'purchase.thank-you.customer-information.render-after'>,
    AnyCheckoutComponent
  >
```

purchase.thank-you.footer.render-after

A static extension target that is rendered below the footer on the **Thank you** page.

RenderExtension<
    OrderConfirmationApi &
      StandardApi<'purchase.thank-you.footer.render-after'>,
    AnyCheckoutComponent
  >

purchase.thank-you.header.render-after

A static extension target that is rendered below the header on the **Thank you** page.

RenderExtension<
    OrderConfirmationApi &
      StandardApi<'purchase.thank-you.header.render-after'>,
    AnyCheckoutComponent
  >

RenderExtension

Defines the structure of a render extension, which displays UI in the Shopify admin.

api
The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.
```
Api
```
components
The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.
```
ComponentsSet
```
output
The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.
```
void | Promise<void>
```

CheckoutApi

Methods for modifying the checkout, including cart lines, discount codes, gift cards, metafields, notes, attributes, and the shipping address. Each method returns a promise that resolves with a result indicating success or failure.

applyAttributeChange
Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/latest/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: AttributeChange) => Promise<AttributeChangeResult>
```
applyCartLinesChange
Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/latest/apis/cart-lines#properties-propertydetail-lines) property updates with the new state. Accepts a single change per call. To make multiple changes, call this method separately for each one. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: CartLineChange) => Promise<CartLineChangeResult>
```
applyDiscountCodeChange
Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/latest/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state. > Caution: > See [security considerations](/docs/api/checkout-ui-extensions/latest/configuration#network-access) if your extension retrieves discount codes through a network call. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: DiscountCodeChange) => Promise<DiscountCodeChangeResult>
```
applyGiftCardChange
Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/latest/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state. Unlike other write operations, gift card changes aren't gated by a cart instruction flag. > Caution: > See [security considerations](/docs/api/checkout-ui-extensions/latest/configuration#network-access) if your extension retrieves gift card codes through a network call. > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: GiftCardChange) => Promise<GiftCardChangeResult>
```
applyMetafieldChange
Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/latest/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change. Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: MetafieldChange) => Promise<MetafieldChangeResult>
```
applyNoteChange
Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/latest/apis/note#properties-propertydetail-note) property updates to reflect the change. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
```
(change: NoteChange) => Promise<NoteChangeResult>
```
applyShippingAddressChange
Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change. > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
(change: ShippingAddressUpdateChange) => Promise<ShippingAddressChangeResult>
```
experimentalIsShopAppStyle
```
boolean
```

AttributeChange

The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.

AttributeUpdateChange | AttributeRemoveChange

AttributeUpdateChange

Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.

key
The key of the attribute to add or update. If an attribute with this key already exists, then its value is replaced.
```
string
```
type
Identifies this as an attribute update or creation. Set this when creating a change to add or replace an attribute value.
```
'updateAttribute'
```
value
The new value for the attribute.
```
string
```

AttributeRemoveChange

Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.

key
The key of the attribute to remove.
```
string
```
type
Identifies this as an attribute removal. Set this when creating a change to delete an attribute by key.
```
'removeAttribute'
```

AttributeChangeResult

The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.

AttributeChangeResultSuccess | AttributeChangeResultError

AttributeChangeResultSuccess

The result of a successful attribute change. The `type` property is `'success'`.

type
Indicates that the attribute change was applied successfully.
```
'success'
```

AttributeChangeResultError

The result of a failed attribute change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.
```
string
```
type
Indicates that the attribute change couldn't be applied. Check the `message` property for details.
```
'error'
```

CartLineChange

The input for `applyCartLinesChange()`. Use the `type` property to specify the operation. - `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart. - `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item. - `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.

CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange

CartLineAddChange

Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.

attributes
Custom key-value attributes to attach to the new line item.
```
Attribute[]
```
merchandiseId
The globally-unique identifier of the product variant to add.
```
string
```
parent
The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle.
```
{lineId: string} | {merchandiseId: string}
```
quantity
The number of items to add. Must be a positive integer.
```
number
```
sellingPlanId
The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.
```
string
```
type
Identifies this as a line item addition. Set this when creating a change to add a new product to the cart.
```
'addCartLine'
```

Attribute

key
The identifier for the attribute. Each key must be unique within the set of attributes on the cart or checkout. If you call `applyAttributeChange()` with a key that already exists, then the existing value is replaced.
```
string
```
value
The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides. Attribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.
```
string
```

CartLineRemoveChange

Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.

id
The unique identifier of the cart line to remove. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.
```
string
```
quantity
The number of items to remove from this line.
```
number
```
type
Identifies this as a line item removal. Set this when creating a change to remove a product from the cart.
```
'removeCartLine'
```

CartLineUpdateChange

Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.

attributes
The new custom key-value attributes for this line item. Replaces all existing attributes when provided.
```
Attribute[]
```
id
The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.
```
string
```
merchandiseId
The new product variant to swap in for this line item. Only provide this if you want to change the variant.
```
string
```
parent
The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items.
```
{lineId: string} | {merchandiseId: string}
```
quantity
The new quantity for this line item. Only provide this if you want to change the quantity.
```
number
```
sellingPlanId
The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.
```
SellingPlan['id'] | null
```
type
Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes.
```
'updateCartLine'
```

SellingPlan

A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.

id
A globally-unique identifier for the selling plan in the format `gid://shopify/SellingPlan/<id>`. Use this to reference the specific selling plan associated with a line item.
```
string
```
recurringDeliveries
Whether purchasing through this selling plan results in multiple deliveries. `true` for subscription plans with recurring fulfillment, `false` for one-time pre-orders or try-before-you-buy plans.
```
boolean
```

CartLineChangeResult

The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.

CartLineChangeResultSuccess | CartLineChangeResultError

CartLineChangeResultSuccess

The result of a successful cart line change. The `type` property is `'success'`.

type
Indicates that the cart line change was applied successfully.
```
'success'
```

CartLineChangeResultError

The result of a failed cart line change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer. Render your own localized error text rather than displaying this message to the buyer.
```
string
```
type
Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.
```
'error'
```

DiscountCodeChange

The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.

DiscountCodeAddChange | DiscountCodeRemoveChange

DiscountCodeAddChange

Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.

code
The discount code to apply. Codes are case-insensitive.
```
string
```
type
Identifies this as a discount code addition. Set this when creating a change to apply a discount code to the checkout.
```
'addDiscountCode'
```

DiscountCodeRemoveChange

Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.

code
The discount code to remove. Codes are case-insensitive.
```
string
```
type
Identifies this as a discount code removal. Set this when creating a change to remove a discount code from the checkout.
```
'removeDiscountCode'
```

DiscountCodeChangeResult

The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.

DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError

DiscountCodeChangeResultSuccess

The result of a successful discount code change. The `type` property is `'success'`.

type
Indicates that the discount code change was applied successfully.
```
'success'
```

DiscountCodeChangeResultError

The result of a failed discount code change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.
```
string
```
type
Indicates that the discount code change couldn't be applied. Check the `message` property for details.
```
'error'
```

GiftCardChange

The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.

GiftCardAddChange | GiftCardRemoveChange

GiftCardAddChange

Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.

code
The full gift card code to apply to the checkout.
```
string
```
type
Identifies this as a gift card addition. Set this when creating a change to apply a gift card to the checkout.
```
'addGiftCard'
```

GiftCardRemoveChange

Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.

code
The gift card code to remove. You can pass either the full code or just the last four characters.
```
string
```
type
Identifies this as a gift card removal. Set this when creating a change to remove a gift card from the checkout.
```
'removeGiftCard'
```

GiftCardChangeResult

The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.

GiftCardChangeResultSuccess | GiftCardChangeResultError

GiftCardChangeResultSuccess

The result of a successful gift card change. The `type` property is `'success'`.

type
Indicates that the gift card change was applied successfully.
```
'success'
```

GiftCardChangeResultError

The result of a failed gift card change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer. Render your own localized error text rather than displaying this message to the buyer.
```
string
```
type
Indicates that the gift card change couldn't be applied. Check the `message` property for details.
```
'error'
```

MetafieldChange

The input for `applyMetafieldChange()`. Use the `type` property to specify the operation. - `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields). - `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.

MetafieldRemoveCartChange | MetafieldUpdateCartChange

MetafieldRemoveCartChange

Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.

key
The name of the metafield to remove.
```
string
```
namespace
The namespace of the metafield to remove.
```
string
```
type
Identifies this as a cart metafield removal. Set this when creating a change to delete an existing metafield by key and namespace.
```
'removeCartMetafield'
```

MetafieldUpdateCartChange

Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.

metafield
The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced.
```
{ key: string; namespace?: string; value: string; type: string; }
```
type
Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value.
```
'updateCartMetafield'
```

MetafieldChangeResult

The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.

MetafieldChangeResultSuccess | MetafieldChangeResultError

MetafieldChangeResultSuccess

The result of a successful metafield change. The `type` property is `'success'`.

type
Indicates that the metafield change was applied successfully.
```
'success'
```

MetafieldChangeResultError

The result of a failed metafield change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer. Render your own localized error text rather than displaying this message to the buyer.
```
string
```
type
Indicates that the metafield change couldn't be applied. Check the `message` property for details.
```
'error'
```

NoteChange

The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.

NoteRemoveChange | NoteUpdateChange

NoteRemoveChange

Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.

type
Identifies this as a note removal. Set this when creating a change to clear the buyer's note.
```
'removeNote'
```

NoteUpdateChange

Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.

note
The text to set as the buyer's note. This replaces any existing note entirely rather than appending to it.
```
string
```
type
Identifies this as a note update. Set this when creating a change to set or replace the buyer's note.
```
'updateNote'
```

NoteChangeResult

The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.

NoteChangeResultSuccess | NoteChangeResultError

NoteChangeResultSuccess

The result of a successful note change. The `type` property is `'success'`.

type
Indicates that the note change was applied successfully.
```
'success'
```

NoteChangeResultError

The result of a failed note change. Check the `message` property for details about what went wrong.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer. Render your own localized error text rather than displaying this message to the buyer.
```
string
```
type
Indicates that the note change couldn't be applied. Check the `message` property for details.
```
'error'
```

ShippingAddressUpdateChange

Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.

address
Fields to update in the shipping address. You only need to provide values for the fields you want to update. Any fields you don't list keep their current values.
```
Partial<ShippingAddress>
```
type
Identifies this as a shipping address update. This is the only supported change type for `applyShippingAddressChange()`.
```
'updateShippingAddress'
```

ShippingAddress

address1
The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
address2
The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
city
The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
company
The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
countryCode
The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CountryCode
```
firstName
The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
lastName
The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
oneTimeUse
Controls whether the address is saved to the buyer's account. When `true`, the address won't be saved and is only used for this checkout. When `false` or `undefined`, the address might be saved to the buyer's account for future use.
```
boolean
```
phone
The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
provinceCode
The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
zip
The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

ShippingAddressChangeResult

The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.

ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError

ShippingAddressChangeResultSuccess

The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.

errors
Always `null` for a successful address change. Present so that you can check `result.errors` without narrowing the union type first.
```
null
```
type
Indicates that the shipping address change was applied successfully.
```
'success'
```

ShippingAddressChangeResultError

The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.

errors
The list of field-level errors that prevented the address change. Each entry identifies which address field failed and why.
```
ShippingAddressChangeFieldError[]
```
type
Indicates that the shipping address change couldn't be applied. Check the `errors` array for field-level details.
```
'error'
```

ShippingAddressChangeFieldError

An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.

field
The `MailingAddress` field that caused the error, such as `'countryCode'` or `'zip'`. The value is `undefined` if the error isn't specific to a single field.
```
keyof MailingAddress
```
message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.
```
string
```

MailingAddress

address1
The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
address2
The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
city
The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
company
The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
countryCode
The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CountryCode
```
firstName
The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
lastName
The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
phone
The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
provinceCode
The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
zip
The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

StandardApi

analytics
Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.
```
Analytics
```
appliedGiftCards
The gift cards that have been applied to the checkout. Each entry includes the last four characters of the gift card code, the amount used at checkout, and the card's remaining balance.
```
SubscribableSignalLike<AppliedGiftCard[]>
```
applyTrackingConsentChange
Enables setting and updating customer privacy consent settings and tracking consent metafields. > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
ApplyTrackingConsentChangeType
```
appMetafields
The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/latest/configuration) 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}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<AppMetafieldEntry[]>
```
attributes
The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.
```
SubscribableSignalLike<Attribute[]>
```
availablePaymentOptions
All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region. The set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available.
```
SubscribableSignalLike<PaymentOption[]>
```
billingAddress
The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<MailingAddress | undefined>
```
buyerIdentity
Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
BuyerIdentity
```
buyerJourney
Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.
```
BuyerJourney
```
checkoutSettings
Settings applied to the buyer's checkout.
```
SubscribableSignalLike<CheckoutSettings>
```
checkoutToken
A stable ID that represents the current checkout. The value is `undefined` when the checkout hasn't been created on the server yet. Use this to correlate checkout sessions across your extension, web pixels, and backend systems. This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object). Can be `undefined`. Handle the `undefined` state before using the value.
```
SubscribableSignalLike<CheckoutToken | undefined>
```
cost
The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.
```
CartCost
```
customerPrivacy
Customer privacy consent settings and a flag denoting if consent has previously been collected.
```
SubscribableSignalLike<CustomerPrivacy>
```
deliveryGroups
The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items. Empty until the buyer enters enough address information for Shopify to calculate shipping rates.
```
SubscribableSignalLike<DeliveryGroup[]>
```
discountAllocations
The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.
```
SubscribableSignalLike<CartDiscountAllocation[]>
```
discountCodes
The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.
```
SubscribableSignalLike<CartDiscountCode[]>
```
extension
Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running.
```
Extension<Target>
```
extensionPoint
The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.
```
Target
```
i18n
Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/latest/apis/localization) to build fully localized extensions.
```
I18n
```
instructions
The cart instructions used to create the checkout and possibly limit extension capabilities. These instructions should be checked before performing any actions that might be affected by them. For example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout. > Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/latest/apis/cart-instructions#examples) > for more information.
```
SubscribableSignalLike<CartInstructions>
```
lines
The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.
```
SubscribableSignalLike<CartLine[]>
```
localization
The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/latest/apis/localization#properties-propertydetail-i18n) object instead.
```
Localization
```
localizedFields
Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.
```
SubscribableSignalLike<LocalizedField[]>
```
note
A note left by the customer to the merchant, either in their cart or during checkout. The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.
```
SubscribableSignalLike<string | undefined>
```

query

The method used to query the Storefront GraphQL API with a prefetched token.

<Data = unknown, Variables = Record<string, unknown>>(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>

selectedPaymentOptions
The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card). Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available.
```
SubscribableSignalLike<SelectedPaymentOption[]>
```
sessionToken
The session token providing a set of claims as a signed JSON Web Token (JWT). The token has a TTL of five minutes. If the previous token expires, this value reflects a new session token with a new signature and expiry. Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).
```
SessionToken
```
settings
The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/latest/configuration) file. Refer to [settings examples](/docs/api/checkout-ui-extensions/latest/apis/settings#examples) for more information. > Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.
```
SubscribableSignalLike<ExtensionSettings>
```
shippingAddress
The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<ShippingAddress | undefined>
```
shop
The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.
```
Shop
```
storage
Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension. > Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout.
```
Storage
```
version
The renderer version being used for the extension.
```
Version
```

Analytics

Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.

publish
Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched. The Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event.
```
(name: string, data: Record<string, unknown>) => Promise<boolean>
```
visitor
Submits buyer contact details for attribution and analytics purposes.
```
(data: { email?: string; phone?: string; }) => Promise<VisitorResult>
```

VisitorResult

Represents a visitor result.

VisitorSuccess | VisitorError

VisitorSuccess

Represents a successful visitor result.

type
Indicates that the visitor information was validated and submitted.
```
'success'
```

VisitorError

Represents an unsuccessful visitor result.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.
```
string
```
type
Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property.
```
'error'
```

SubscribableSignalLike

Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern. This interface extends `ReadonlySignalLike` with deprecated fields that are still supported for backwards compatibility.

current
The current value of the signal. Equivalent to `.value`, accessing this property subscribes to changes when used in a reactive context.
```
T
```
destroy
Cleans up the subscription and releases any resources held by this signal. After calling `destroy()`, the signal stops receiving updates from the main thread.
```
() => Promise<void>
```
subscribe
Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.
```
(fn: (value: T) => void) => () => void
```
value
The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.
```
T
```

AppliedGiftCard

amountUsed
The amount of the applied gift card that's used when the checkout is completed. This might be less than `balance` if the order total is lower than the card's remaining balance.
```
Money
```
balance
The current balance of the applied gift card before checkout completion. This reflects the full remaining value on the card, not just the amount being applied to this order.
```
Money
```
lastCharacters
The last four characters of the applied gift card's code. The full code isn't exposed for security reasons. Use this value to display which card is applied.
```
string
```

Money

amount
The decimal amount of the price. For example, `29.99` represents twenty-nine dollars and ninety-nine cents.
```
number
```
currencyCode
The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
```
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'

ApplyTrackingConsentChangeType

visitorConsent
```
VisitorConsentChange
```

returns

Promise<TrackingConsentChangeResult>

VisitorConsentChange

analytics
The visitor's consent for analytics tracking. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
marketing
The visitor's consent for marketing and targeted advertising. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
metafields
Tracking consent metafield data to be saved. If the value is `null`, the metafield is deleted.
```
TrackingConsentMetafieldChange[]
```
preferences
The visitor's consent for storing preferences such as language and currency. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
saleOfData
The visitor's consent for the sale or sharing of their personal data with third parties. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
type
Identifies this as a visitor consent change. This is the only supported change type for `applyTrackingConsentChange()`.
```
'changeVisitorConsent'
```

TrackingConsentMetafieldChange

key
The identifier for the tracking consent metafield to update.
```
string
```
value
The new value to store in the metafield. Set to `null` to delete the metafield. Consent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield.
```
string | null
```

TrackingConsentChangeResult

TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError

TrackingConsentChangeResultSuccess

The returned result of a successful tracking consent preference update.

type
Indicates that the tracking consent update was applied successfully.
```
'success'
```

TrackingConsentChangeResultError

The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.

message
A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.
```
string
```
type
Indicates that the tracking consent update couldn't be applied. Check the `message` property for details.
```
'error'
```

AppMetafieldEntry

An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.

metafield
The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource.
```
AppMetafield
```
target
The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID. {% 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`.
```
AppMetafieldEntryTarget
```

AppMetafield

Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.

key
The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`.
```
string
```
namespace
The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps. App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.
```
string
```
type
The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category.
```
string
```
value
The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data.
```
string
```
valueType
The metafield's information type. - `'boolean'`: A true or false value. - `'float'`: A decimal number value. - `'integer'`: A whole number value. - `'json_string'`: A JSON-encoded string value. - `'string'`: A plain text value.
```
'boolean' | 'float' | 'integer' | 'json_string' | 'string'
```

AppMetafieldEntryTarget

The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.

id
The globally-unique identifier of the Shopify resource, in [GID](/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](/docs/api/storefront).
```
string
```
type
The kind of Shopify resource this metafield belongs to: - `'customer'`: The customer who placed the order. - `'product'`: A product in the merchant's catalog. - `'shop'`: The merchant's shop. - `'shopUser'`: A staff member or collaborator account on the shop. - `'variant'`: A specific variant of a product. - `'company'`: A [B2B](/docs/apps/build/b2b) company associated with the order. - `'companyLocation'`: A location belonging to a [B2B](/docs/apps/build/b2b) company. - `'cart'`: The cart associated with the checkout. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.
```
| 'customer'
    | 'product'
    | 'shop'
    | 'shopUser'
    | 'variant'
    | 'company'
    | 'companyLocation'
    | 'cart'
```

PaymentOption

A payment option presented to the buyer.

handle
A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop.
```
string
```
type
The type of the payment option. Shops can be configured to support many different payment options. Some options are available only to buyers in specific regions. | Type | Description | |---|---| | `creditCard` | A vaulted or manually entered credit card. | | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. | | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market | | `manualPayment` | A manual payment option such as an in-person retail transaction. | | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. | | `other` | Another type of payment not defined here. | | `paymentOnDelivery` | A payment collected on delivery. | | `redeemable` | A redeemable payment option such as a gift card or store credit. | | `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. | | `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. |
```
| 'creditCard'
    | 'deferred'
    | 'local'
    | 'manualPayment'
    | 'offsite'
    | 'other'
    | 'paymentOnDelivery'
    | 'redeemable'
    | 'wallet'
    | 'customOnsite'
```

BuyerIdentity

Information about the buyer who is completing the checkout. {% 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, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<Customer | undefined>
```
email
The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<string | undefined>
```
phone
The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<string | undefined>
```
purchasingCompany
The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<PurchasingCompany | undefined>
```

Customer

Information about a customer who has previously purchased from this shop. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

acceptsEmailMarketing
Whether the customer has opted in to email marketing. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
boolean
```
acceptsMarketing
Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.
```
boolean
```
acceptsSmsMarketing
Whether the customer has opted in to SMS marketing. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
boolean
```
email
The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
firstName
The customer's first name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
fullName
The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
An identifier for the customer in the format `gid://shopify/Customer/<id>`. This value is unique per shop. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
image
The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
ImageDetails
```
lastName
The customer's last name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
ordersCount
The number of orders the customer has previously placed with this shop. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
number
```
phone
The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
storeCreditAccounts
The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
StoreCreditAccount[]
```

ImageDetails

altText
The alternative text for the image, used for accessibility. The value is `undefined` if the merchant hasn't provided alt text.
```
string
```
url
The fully-qualified URL of the image. Use this to render the product or variant image in your extension.
```
string
```

PurchasingCompany

The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.

company
The company the B2B customer belongs to. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
Company
```
location
The specific company location associated with this B2B purchase. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CompanyLocation
```

Company

externalId
A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
A globally-unique identifier for the company in the format `gid://shopify/Company/<id>`. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The company's display name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

CompanyLocation

externalId
A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/<id>`. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The display name of the company location. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

BuyerJourney

Provides details on the buyer's progression through the checkout.

activeStep
The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined.
```
SubscribableSignalLike<BuyerJourneyStepReference | undefined>
```
completed
Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow.
```
SubscribableSignalLike<boolean>
```
intercept
Installs a function for intercepting and preventing progress on checkout. This returns a promise that resolves to a teardown function. Calling the teardown function removes the interceptor. To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/latest/configuration#block-progress) capability in your extension's configuration. If you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension. If the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor).
```
(interceptor: Interceptor) => Promise<() => void>
```
steps
All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration.
```
SubscribableSignalLike<BuyerJourneyStep[]>
```

BuyerJourneyStepReference

What step of checkout the buyer is currently on.

handle
The handle identifying which step the buyer is on, such as `'information'`, `'shipping'`, or `'payment'`. See `BuyerJourneyStepHandle` for all values.
```
BuyerJourneyStepHandle
```

BuyerJourneyStepHandle

| handle | Description | |---|---| | `cart` | The cart page. | | `checkout` | A one-page checkout, including Shop Pay. | | `information` | The contact information step of a three-page checkout. | | `shipping` | The shipping step of a three-page checkout. | | `payment` | The payment step of a three-page checkout. | | `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. | | `thank-you` | The page displayed after the purchase, thanking the buyer. | | `unknown` | An unknown step in the buyer journey. |

'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'

Interceptor

A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: 'your reason here', errors?: ValidationError[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level, or rendering the errors in your extension.

interceptorProps
```
InterceptorProps
```

returns

InterceptorRequest | Promise<InterceptorRequest>

InterceptorProps

canBlockProgress
Whether the interceptor can block the buyer's progress through checkout. When `true`, the merchant has granted your extension the `block_progress` capability. When `false`, you can still validate but can't prevent the buyer from continuing.
```
boolean
```

InterceptorRequest

InterceptorRequestAllow | InterceptorRequestBlock

InterceptorRequestAllow

behavior
Indicates that the interceptor allows the buyer's journey to continue.
```
'allow'
```
perform
This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once. Runs after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.
```
(result: InterceptorResult) => void | Promise<void>
```

InterceptorResult

InterceptorResultAllow | InterceptorResultBlock

InterceptorResultAllow

behavior
Indicates that the buyer was allowed to progress through checkout.
```
'allow'
```

InterceptorResultBlock

behavior
Indicates that some part of the checkout UI intercepted and prevented the buyer's progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step.
```
'block'
```

InterceptorRequestBlock

behavior
Indicates that the interceptor blocks the buyer's journey from continuing.
```
'block'
```
errors
Used to pass errors to the checkout UI, outside your extension's UI boundaries.
```
ValidationError[]
```
perform
This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once. Runs after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.
```
(result: InterceptorResult) => void | Promise<void>
```
reason
The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics.
```
string
```

ValidationError

A validation error object that is returned when an operation fails.

code
A code identifier for the error.
```
string
```
issues
Field-level validation issues
```
{ message: string; path: string[]; }[]
```
message
A message describing the error.
```
string
```
type
```
'error'
```

BuyerJourneyStep

disabled
Whether this step is disabled. When `true`, the buyer hasn't reached this step yet and can't navigate to it. When `false`, the step is accessible. For example, if the buyer hasn't reached the `shipping` step yet, then `shipping` is disabled.
```
boolean
```
handle
The handle that uniquely identifies the buyer journey step, such as `'information'`, `'shipping'`, or `'payment'`.
```
BuyerJourneyStepHandle
```
label
The localized label of the buyer journey step, suitable for rendering in navigation UI.
```
string
```
to
The URL of the buyer journey step, using the `shopify:` protocol.
```
string
```

CheckoutSettings

Settings describing the behavior of the buyer's checkout.

orderSubmission
The type of order created when the buyer completes checkout. - `'DRAFT_ORDER'`: The checkout creates a draft order that the merchant must manually confirm before fulfillment. Common for B2B checkouts with deferred payment terms. - `'ORDER'`: The checkout creates a confirmed order immediately upon completion.
```
'DRAFT_ORDER' | 'ORDER'
```
paymentTermsTemplate
The payment terms configured by the merchant for B2B orders, such as net-30 or net-60. The value is `undefined` if no payment terms are configured.
```
PaymentTermsTemplate
```
shippingAddress
Settings that control how the shipping address behaves during checkout, such as whether the buyer can edit the address.
```
ShippingAddressSettings
```

PaymentTermsTemplate

A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include "Net 30" (due in 30 days) or "Due on receipt".

dueDate
The due date for payment in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ss.sssZ`). The value is `undefined` if the payment terms don't have a fixed due date.
```
string
```
dueInDays
The number of days the buyer has to pay after the order is placed, such as `30` for "Net 30" terms. The value is `undefined` if the payment terms aren't net-based.
```
number
```
id
A globally-unique identifier for the payment terms template in the format `gid://shopify/PaymentTermsTemplate/<id>`.
```
string
```
name
The name of the payment terms translated to the buyer's current language, such as "Net 30" or "Due on receipt".
```
string
```

ShippingAddressSettings

Settings describing the behavior of the shipping address.

isEditable
Whether the buyer is allowed to edit the shipping address during checkout. When `false`, the shipping address is locked and can't be changed, which is common for B2B orders with a predefined ship-to address.
```
boolean
```

CheckoutToken

string

CartCost

subtotalAmount
The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.
```
SubscribableSignalLike<Money>
```
totalAmount
The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.
```
SubscribableSignalLike<Money>
```
totalShippingAmount
The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step. `undefined` until the buyer selects a shipping method (typically after the information step).
```
SubscribableSignalLike<Money | undefined>
```
totalTaxAmount
The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet. `undefined` when taxes haven't been calculated or aren't available for the buyer's region.
```
SubscribableSignalLike<Money | undefined>
```

CustomerPrivacy

allowedProcessing
Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location.
```
AllowedProcessing
```
metafields
The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories.
```
TrackingConsentMetafield[]
```
region
The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations.
```
CustomerPrivacyRegion
```
saleOfDataRegion
Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations.
```
boolean
```
shouldShowBanner
Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner. This is determined by the visitor's current privacy 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) settings, and the region in which the visitor is located.
```
boolean
```
visitorConsent
The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet).
```
VisitorConsent
```

AllowedProcessing

analytics
Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred. Whether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`.
```
boolean
```
marketing
Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences. Whether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection.
```
boolean
```
preferences
Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices. Whether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data.
```
boolean
```
saleOfData
Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data. Whether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties.
```
boolean
```

TrackingConsentMetafield

key
The identifier for the tracking consent metafield, such as `'analyticsType'` or `'marketingType'`.
```
string
```
value
The value stored in the tracking consent metafield, such as `'granular'` or a stringified JSON object.
```
string
```

CustomerPrivacyRegion

countryCode
The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed. {% 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, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected. {% 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
The visitor's consent for analytics tracking. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
marketing
The visitor's consent for marketing and targeted advertising. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
preferences
The visitor's consent for storing preferences such as language and currency. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```
saleOfData
The visitor's consent for the sale or sharing of their personal data with third parties. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.
```
boolean
```

DeliveryGroup

A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.

deliveryOptions
The delivery options available for this group, including shipping, pickup point, and pickup location options. The buyer selects one of these to determine how their items are delivered.
```
DeliveryOption[]
```
groupType
Whether this group contains items for a one-time purchase or a subscription. Subscription delivery groups might have different shipping options. See `DeliveryGroupType` for possible values.
```
DeliveryGroupType
```
id
A unique identifier for the delivery group. The value is `undefined` if the underlying delivery line doesn't have an ID assigned.
```
string
```
isDeliveryRequired
Whether physical delivery is required for the items in this group. Digital-only groups don't require delivery.
```
boolean
```
selectedDeliveryOption
The delivery option the buyer has selected for this group. The value is `undefined` if the buyer hasn't selected a delivery option yet. Contains a `handle` you can match against `deliveryOptions` entries.
```
DeliveryOptionReference
```
targetedCartLines
The cart lines that belong to this delivery group. Each reference contains the cart line's `id`, which you can match against `lines` to get the full cart line details.
```
CartLineReference[]
```

DeliveryOption

A delivery option available to the buyer. Use the `type` property to determine which kind of option it is: - `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant. - `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up. - `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.

ShippingOption | PickupPointOption | PickupLocationOption

ShippingOption

Represents a delivery option that's a shipping option.

carrier
Information about the carrier providing this shipping option, including the carrier's display name.
```
ShippingOptionCarrier
```
code
The carrier service code or rate identifier for this delivery option.
```
string
```
cost
The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings.
```
Money
```
costAfterDiscounts
The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping.
```
Money
```
deliveryEstimate
The estimated delivery time for this shipping option. Use the `timeInTransit` range to display an estimated arrival window to the buyer.
```
DeliveryEstimate
```
description
Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.
```
string
```
handle
The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries.
```
string
```
metafields
Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option.
```
Metafield[]
```
title
The merchant-facing or carrier-provided display name for the delivery option, such as "Standard Shipping" or "Express".
```
string
```
type
Identifies the delivery method. `'shipping'` means items are shipped by a carrier. `'local'` means the merchant handles delivery themselves, for example same-day local delivery.
```
'shipping' | 'local'
```

ShippingOptionCarrier

name
The display name of the shipping carrier, such as "Canada Post" or "UPS". The value is `undefined` if the carrier name isn't available.
```
string
```

DeliveryEstimate

timeInTransit
The estimated time in transit for the delivery, expressed as a range in seconds. Undefined when the carrier doesn't provide an estimate. When present, either the lower or upper bound of the range might still be omitted.
```
NumberRange
```

NumberRange

lower
The lower bound of the range. Undefined if only an upper bound is provided.
```
number
```
upper
The upper bound of the range. Undefined if only a lower bound is provided.
```
number
```

Metafield

Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.

key
The name of the metafield.
```
string
```
namespace
A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
```
string
```
value
The information to be stored as metadata.
```
string | number
```
valueType
The metafield's information type. - `'integer'`: A whole number value. - `'string'`: A plain text value. - `'json_string'`: A JSON-encoded string value.
```
'integer' | 'string' | 'json_string'
```

PickupPointOption

carrier
Information about the carrier that ships items to this pickup point, including the carrier's name and code.
```
PickupPointCarrier
```
code
The carrier service code or rate identifier for this delivery option.
```
string
```
cost
The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings.
```
Money
```
costAfterDiscounts
The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping.
```
Money
```
description
Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.
```
string
```
handle
The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries.
```
string
```
location
The physical location where the buyer picks up their order, including the address and display name of the collection point.
```
PickupPointLocation
```
metafields
Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option.
```
Metafield[]
```
title
The merchant-facing or carrier-provided display name for the delivery option, such as "Standard Shipping" or "Express".
```
string
```
type
Identifies this as a pickup point option, where items are shipped to a third-party collection point for the buyer to pick up.
```
'pickupPoint'
```

PickupPointCarrier

code
The carrier's unique identifier code, used to distinguish between different carriers that deliver to pickup points.
```
string
```
name
The display name of the carrier that delivers to this pickup point.
```
string
```

PickupPointLocation

address
The physical address of the pickup point.
```
MailingAddress
```
handle
The unique identifier of the pickup point.
```
string
```
name
The display name of the pickup point, such as the name of the locker or collection point.
```
string
```

PickupLocationOption

code
The carrier service code or rate identifier for this delivery option.
```
string
```
description
Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.
```
string
```
handle
The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries.
```
string
```
location
The merchant's store or warehouse where the buyer picks up their order, including the address and display name.
```
PickupLocation
```
metafields
Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option.
```
Metafield[]
```
title
The merchant-facing or carrier-provided display name for the delivery option, such as "Standard Shipping" or "Express".
```
string
```
type
Identifies this as a pickup location option, where the buyer picks up items directly from a merchant's store or warehouse.
```
'pickup'
```

PickupLocation

address
The physical address of the pickup location.
```
MailingAddress
```
name
The merchant-defined display name of the pickup location, such as a store name or warehouse label.
```
string
```

DeliveryGroupType

The possible types of a delivery group. - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase. - `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.

'oneTimePurchase' | 'subscription'

DeliveryOptionReference

A reference to the delivery option selected by the buyer for a delivery group.

handle
The unique identifier of the referenced delivery option. Match this against `DeliveryOption.handle` from the `deliveryOptions` array to get the full option details.
```
string
```

CartLineReference

A reference to a cart line within a delivery group, identified by the cart line's ID.

id
The unique identifier of the referenced cart line. Match this against `CartLine.id` from the `lines` property to get the full line item details.
```
string
```

CartDiscountAllocation

A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered: - `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered. - `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules. - `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).

CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation

CartCodeDiscountAllocation

code
The discount code string that the buyer entered during checkout, such as `"SAVE10"` or `"FREESHIP"`.
```
string
```
discountedAmount
The monetary value that was deducted from the line item or order total by this discount allocation.
```
Money
```
type
Identifies this as a code-based discount, triggered by a discount code the buyer entered at checkout.
```
'code'
```

CartAutomaticDiscountAllocation

discountedAmount
The monetary value that was deducted from the line item or order total by this discount allocation.
```
Money
```
title
The merchant-defined title of the automatic discount as displayed to the buyer, such as "Summer Sale 10% Off".
```
string
```
type
Identifies this as an automatic discount, applied based on merchant-configured rules without a code.
```
'automatic'
```

CartCustomDiscountAllocation

discountedAmount
The monetary value that was deducted from the line item or order total by this discount allocation.
```
Money
```
title
The title of the custom discount, typically applied by a [Shopify Function](/docs/api/functions/latest/discount).
```
string
```
type
Identifies this as a custom discount applied by a [Shopify Function](/docs/api/functions/latest/discount).
```
'custom'
```

CartDiscountCode

code
The discount code string entered by the buyer during checkout or applied programmatically, such as `"SAVE10"` or `"FREESHIP"`. Use this to display which discount codes were applied.
```
string
```

Extension

Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.

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/checkout-ui-extensions/latest/configuration) file.
```
SubscribableSignalLike<Capability[]>
```
editor
Information about the editor where the extension is being rendered. If the value is undefined, then the extension isn't running in an editor.
```
Editor
```
rendered
A Boolean to show whether your extension is currently rendered to the screen. Shopify might render your extension before it's visible in the UI, typically to pre-render extensions that appear on a later step of the checkout. Your extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back.
```
SubscribableSignalLike<boolean>
```
scriptUrl
The URL to the script that started the extension target.
```
string
```
target
The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.
```
Target
```
version
The published version of the running extension target. For unpublished extensions, the value is `undefined`. Don't use this property as a stable identifier in development environments. It becomes available only after the extension is published.
```
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 but may change without notice.

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

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 environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.

type
Indicates whether the extension is rendering in the [checkout editor](/docs/apps/checkout). Always `'checkout'`.
```
'checkout'
```

I18n

Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.

formatCurrency
Returns a localized currency value. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default.
```
(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string
```
formatDate
Returns a localized date value. 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. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It 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

Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.

CartInstructions

attributes
Whether the extension can update custom attributes using `applyAttributeChange()`.
```
AttributesCartInstructions
```
delivery
Whether the extension can modify the shipping address using `applyShippingAddressChange()`.
```
DeliveryCartInstructions
```
discounts
Whether the extension can add or remove discount codes using `applyDiscountCodeChange()`.
```
DiscountsCartInstructions
```
lines
Whether the extension can add, remove, or update cart lines using `applyCartLinesChange()`.
```
CartLinesCartInstructions
```
metafields
Whether the extension can add, update, or delete cart metafields using `applyMetafieldChange()`.
```
MetafieldsCartInstructions
```
notes
Whether the extension can update the order note using `applyNoteChange()`.
```
NotesCartInstructions
```

AttributesCartInstructions

canUpdateAttributes
Whether attributes can be updated using `applyAttributeChange()`. When `false`, the checkout configuration doesn't allow attribute changes. Even when `true`, calls to `applyAttributeChange()` can still fail during accelerated checkout (Apple Pay, Google Pay).
```
boolean
```

DeliveryCartInstructions

canSelectCustomAddress
Whether the shipping address can be modified using `applyShippingAddressChange()`. When `false`, the buyer is using an accelerated checkout flow (Apple Pay, Google Pay) where the address can't be changed.
```
boolean
```

DiscountsCartInstructions

canUpdateDiscountCodes
Whether discount codes can be updated using `applyDiscountCodeChange()`. When `false`, the checkout configuration doesn't allow discount code changes. Even when `true`, calls to `applyDiscountCodeChange()` can still fail during accelerated checkout (Apple Pay, Google Pay).
```
boolean
```

CartLinesCartInstructions

canAddCartLine
Whether new cart lines can be added using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow adding lines (for example, draft orders). Even when `true`, calls can still fail during accelerated checkout (Apple Pay, Google Pay).
```
boolean
```
canRemoveCartLine
Whether cart lines can be removed using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow removing lines. Even when `true`, calls can still fail during accelerated checkout.
```
boolean
```
canUpdateCartLine
Whether cart lines can be updated using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow updating lines. Even when `true`, calls can still fail during accelerated checkout.
```
boolean
```

MetafieldsCartInstructions

canDeleteCartMetafield
Whether the extension can delete cart metafields using `applyMetafieldChange()`.
```
boolean
```
canSetCartMetafields
Whether the extension can add or update cart metafields using `applyMetafieldChange()`.
```
boolean
```

NotesCartInstructions

canUpdateNote
Whether the order note can be updated using `applyNoteChange()`. When `false`, the checkout configuration doesn't allow note changes. Even when `true`, calls to `applyNoteChange()` can still fail during accelerated checkout (Apple Pay, Google Pay).
```
boolean
```

CartLine

attributes
Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values.
```
Attribute[]
```
cost
The cost breakdown for this line item, including the total price after any line-level discounts have been applied.
```
CartLineCost
```
discountAllocations
Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered.
```
CartDiscountAllocation[]
```
id
A unique identifier for the cart line in the format `gid://shopify/CartLine/<id>`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object.
```
string
```
lineComponents
The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle.
```
CartBundleLineComponent[]
```
merchandise
The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options.
```
Merchandise
```
parentRelationship
The parent line item that this line belongs to, or `null` if this is a top-level line item. Used to identify lines added as children of a bundle or other grouped product.
```
CartLineParentRelationship | null
```
quantity
The number of units of this merchandise that the buyer purchased.
```
number
```

CartLineCost

totalAmount
The total price the buyer pays for this line item after all line-level discounts have been applied, but before order-level discounts, taxes, and shipping.
```
Money
```

CartBundleLineComponent

An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.

attributes
Custom key-value pairs attached to this bundle component, such as personalization options specific to this item within the bundle.
```
Attribute[]
```
cost
The cost breakdown for this bundle component, including the total amount after any per-item discounts.
```
CartLineCost
```
id
A unique identifier for this component within the bundle, in the format `gid://shopify/CartLineComponent/<id>`. This ID isn't stable and might change after any operation that updates the line items.
```
string
```
merchandise
The product variant included in this bundle component. Use this to display product details for individual items within a bundle.
```
Merchandise
```
quantity
The number of units of this component included in the bundle.
```
number
```
type
Identifies this as a bundle line component. This is currently the only component type.
```
'bundle'
```

Merchandise

id
A globally-unique identifier for the product variant in the format `gid://shopify/ProductVariant/<id>`.
```
string
```
image
The image associated with the product variant. Falls back to the product image if the variant doesn't have its own. The value is `undefined` if neither the variant nor the product has an image.
```
ImageDetails
```
product
The parent product that this variant belongs to. Use this to access the product's ID, vendor, and type.
```
Product
```
requiresShipping
Whether this product variant requires physical shipping. When `true`, the buyer must provide a shipping address. Returns `false` for digital products, gift cards, and services.
```
boolean
```
selectedOptions
The product options applied to this variant, such as size, color, or material. Each entry contains the option name and the selected value.
```
SelectedOption[]
```
sellingPlan
The [selling plan](/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.
```
SellingPlan
```
sku
The stock keeping unit (SKU) assigned to this variant by the merchant, used for inventory tracking. The value is `undefined` if no SKU has been set.
```
string
```
subtitle
A secondary description for the variant that provides additional context, such as a color or size combination. The value is `undefined` if no subtitle is available.
```
string
```
title
The display title of the product variant, such as "Small" or "Red / Large". This is the variant-specific label, not the parent product title.
```
string
```
type
Identifies the merchandise as a product variant. This is currently the only merchandise type in checkout.
```
'variant'
```

Product

id
A globally-unique identifier for the product in the format `gid://shopify/Product/<id>`.
```
string
```
productType
A merchant-defined categorization for the product, such as "Accessories" or "Clothing". Commonly used for filtering and organizing products in a storefront.
```
string
```
vendor
The name of the product's vendor or manufacturer, as set by the merchant in Shopify admin.
```
string
```

SelectedOption

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

CartLineParentRelationship

parent
The parent cart line that a cart line is associated with.
```
{ id: string; }
```

Localization

The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.

country
The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown. Derived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address.
```
SubscribableSignalLike<Country | undefined>
```
currency
The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.
```
SubscribableSignalLike<Currency>
```
extensionLanguage
The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.
```
SubscribableSignalLike<Language>
```
language
The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.
```
SubscribableSignalLike<Language>
```
market
The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.
```
SubscribableSignalLike<Market | undefined>
```
timezone
The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.
```
SubscribableSignalLike<Timezone>
```

Country

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

isoCode
The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
```
CountryCode
```

Currency

isoCode
The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format, such as `'USD'`, `'EUR'`, or `'CAD'`.
```
CurrencyCode
```

Language

isoCode
The [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tag that identifies the language. This is a standardized code that might include a base language and an optional region subtag separated by a dash. For example, `'en'` represents English and `'en-US'` represents English as used in the United States. The region subtag follows the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard.
```
string
```

Market

A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.

handle
The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](/docs/apps/build/markets).
```
string
```
id
A globally-unique identifier for the market in the format `gid://shopify/Market/<id>`.
```
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'

LocalizedField

key
The identifier for the localized field, indicating the type of information collected (for example, a tax credential or shipping credential for a specific country).
```
LocalizedFieldKey
```
title
The localized display label for the field, suitable for rendering in the UI.
```
string
```
value
The current value entered by the buyer for this field.
```
string
```

LocalizedFieldKey

A union of keys for the localized fields that are required by certain countries.

'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'

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' | '2025-07' | '2025-10'

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
```

SelectedPaymentOption

A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.

handle
A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop.
```
string
```
type
The type of the payment option. Shops can be configured to support many different payment options. Some options are available only to buyers in specific regions. | Type | Description | |---|---| | `creditCard` | A vaulted or manually entered credit card. | | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. | | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market | | `manualPayment` | A manual payment option such as an in-person retail transaction. | | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. | | `other` | Another type of payment not defined here. | | `paymentOnDelivery` | A payment collected on delivery. | | `redeemable` | A redeemable payment option such as a gift card or store credit. | | `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. | | `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. |
```
| 'creditCard'
    | 'deferred'
    | 'local'
    | 'manualPayment'
    | 'offsite'
    | 'other'
    | 'paymentOnDelivery'
    | 'redeemable'
    | 'wallet'
    | 'customOnsite'
```

SessionToken

Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration. The `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.

get
Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method returns cached tokens when possible, so you don't need to worry about storing these tokens yourself.
```
() => Promise<string>
```

ExtensionSettings

The merchant-defined setting values for the extension.

Shop

Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.

id
A globally-unique identifier for the shop in the format `gid://shopify/Shop/<id>`.
```
string
```
myshopifyDomain
The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.
```
string
```
name
The display name of the shop as configured by the merchant in Shopify admin.
```
string
```
storefrontUrl
The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.
```
string
```

Storage

Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.

delete
Deletes a previously stored value by key.
```
(key: string) => Promise<void>
```
read
Read and return a stored value by key. The stored data is deserialized from JSON and returned as its original type. Returns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key.
```
<T = unknown>(key: string) => Promise<T>
```
write
Write stored data for this key. The data must be serializable to JSON.
```
(key: string, data: any) => Promise<void>
```

Version

string

AnyCheckoutComponent

The list of supported components. As of October 1st, 2025, this is a subset of the components that will be available in the 2025-10 stable release.

'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'

CartLineItemApi

target
The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes. Available only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties. > Note: Until version `2023-04`, this property was a `ReadonlySignalLike<PresentmentCartLine>`.
```
SubscribableSignalLike<CartLine>
```

AllowedComponents

Allowed

PickupLocationListApi

isLocationFormVisible
Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup locations.
```
SubscribableSignalLike<boolean>
```

PickupLocationItemApi

isTargetSelected
Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location. Available only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.
```
SubscribableSignalLike<boolean>
```
target
The pickup location that this extension is attached to. Use this to read the location's name, address, and other details. Available only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.
```
SubscribableSignalLike<PickupLocationOption>
```

PickupPointListApi

isLocationFormVisible
Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place.
```
SubscribableSignalLike<boolean>
```

ShippingOptionItemApi

isTargetSelected
Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option. Available only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.
```
SubscribableSignalLike<boolean>
```
renderMode
The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.
```
ShippingOptionItemRenderMode
```
target
The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details. Available only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.
```
SubscribableSignalLike<ShippingOption>
```

ShippingOptionItemRenderMode

The render mode of a shipping option.

overlay
Whether the shipping option is rendered in an overlay. When `true`, the extension appears in a modal or sheet on top of the checkout page. When `false`, the extension renders inline within the shipping options list.
```
boolean
```

ShippingOptionListApi

deliverySelectionGroups
The list of delivery selection groups available to the buyer, which let buyers choose between grouped delivery options. The value is `undefined` when no selection groups are available.
```
SubscribableSignalLike<
    DeliverySelectionGroup[] | undefined
  >
```
target
The delivery group list that this extension is attached to. Use this to access all delivery groups and their options. The value is `undefined` when there aren't any delivery groups for the given type.
```
SubscribableSignalLike<DeliveryGroupList | undefined>
```

DeliverySelectionGroup

A named group of delivery options that the buyer can select as a unit.

associatedDeliveryOptions
The delivery options that belong to this selection group. Each reference's `handle` matches a delivery option handle in the associated delivery group.
```
DeliveryOptionReference[]
```
cost
The combined cost of all delivery options in this group before discounts.
```
Money
```
costAfterDiscounts
The combined cost of all delivery options in this group after discounts have been applied. This is what the buyer actually pays.
```
Money
```
handle
A unique identifier for this selection group.
```
string
```
selected
Whether the buyer has selected this delivery selection group. When `true`, the associated delivery options are active. When `false`, the buyer has selected a different group.
```
boolean
```
title
The localized display title of this selection group, suitable for rendering in the checkout UI.
```
string
```

DeliveryGroupList

A collection of delivery groups that share the same group type.

deliveryGroups
The delivery groups in this list. Each group contains cart lines and available delivery options for those items.
```
DeliveryGroup[]
```
groupType
The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`. - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase. - `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.
```
DeliveryGroupType
```

OrderConfirmationApi

orderConfirmation
The order details available after the buyer completes checkout, including the order ID, order number, and whether it's the buyer's first purchase.
```
SubscribableSignalLike<OrderConfirmation>
```

OrderConfirmation

isFirstOrder
Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.
```
boolean
```
number
A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number. Optional. Might not be present for orders created before 2024.
```
string
```
order
```
{ id: string; }
```

AnyThankYouComponent

'Abbreviation' | 'Announcement' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'

ApiForExtension

For a given extension target, returns the type of the API that the extension will receive at runtime.

ApiForExtension<Target>

RenderExtensionTarget

A union type containing all of the extension targets that follow the pattern of accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core) and an additional `api` argument, and using those arguments to render UI.

keyof RenderExtensionTargets

Examples

Preact

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

export default function extension() {

render(<Extension />, document.body);

}

function Extension() {

// As of version 2025-10, you no longer need the `useApi` hook.

// The full API object is accessible via the global `shopify` object.

return (

<s-text>

Shop name: {shopify.shop.name}

</s-text>

);

}