Skip to main content

Localization (Order Status API)
API

The API for localizing your extension.

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

required

Details about the location, language, and currency of the buyer. For utilities to easily format and translate content based on these details, you can use the i18n object instead.

Was this section helpful?

Returns the currency of the checkout.

Currency

isoCode

The ISO-4217 code for this currency.

Was this section helpful?

Anchor to useExtensionLanguage
useExtensionLanguage()

Returns the buyer's language, as supported by the extension.

Language

isoCode
string

The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.

Was this section helpful?

Returns the current language of the checkout, and automatically re-renders your component if the language changes.

Language

isoCode
string

The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.

Was this section helpful?

Anchor to useLocalizationCountry
useLocalizationCountry()

Returns the country of the checkout, and automatically re-renders your component if the country changes.

| undefined
Was this section helpful?

Returns the time zone of the checkout, and automatically re-renders your component if the time zone changes.

"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_
Was this section helpful?

Anchor to useLocalizationMarket
useLocalizationMarket()

Returns the market of the checkout, and automatically re-renders your component if it changes.

| undefined
Was this section helpful?