# Action Extension API

This API is available to all action extension types. Refer to the [tutorial](https://shopify.dev/docs/apps/admin/admin-actions-and-blocks/build-an-admin-action) for more information. Note that the [`AdminAction`](https://shopify.dev/docs/api/admin-extensions/components/other/adminaction) component is required to build Admin action extensions.

## ActionExtensionApi

### ActionExtensionApi

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### close

value: `() => void`

Closes the extension. Calling this method is equivalent to the merchant clicking the "x" in the corner of the overlay.

### data

value: `Data`

Information about the currently viewed or selected items.

### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### Auth

### idToken

value: `() => Promise<string>`

Retrieves a Shopify OpenID Connect ID token for the current user.

### Data

### selected

value: `{ id: string; }[]`

Information about the currently viewed or selected items.

### ExtensionTargets

### admin.abandoned-checkout-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the abandoned checkout page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.abandoned-checkout-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the abandoned checkout details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.catalog-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.catalog-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the catalog details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.catalog-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.catalog-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the catalog details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.collection-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.collection-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the collection details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.collection-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.collection-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the collection details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.collection-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.collection-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the collection index page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.company-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.company-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the company details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.company-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.company-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the company details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.company-location-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.company-location-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the company location details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customer-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.customer-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the customer details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customer-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.customer-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the customer details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customer-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.customer-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the customer index page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customer-index.selection-action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.customer-index.selection-action.render'>,
    AllComponents
  >`

Renders an admin action extension in the customer index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customer-segment-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.customer-segment-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the customer segment details page. Open this extension from the "Use segment" button.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.customers.segmentation-templates.render

value: `RenderExtension<
    CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.render'>,
    CustomerSegmentTemplateComponent
  >`

Renders a [`CustomerSegmentTemplate`](https://shopify.dev/docs/api/admin-extensions/components/customersegmenttemplate) in the [customer segment editor](https://help.shopify.com/en/manual/customers/customer-segmentation/customer-segments).

### admin.discount-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.discount-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the discount details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.discount-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.discount-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the discount index page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.draft-order-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.draft-order-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the draft order details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.draft-order-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.draft-order-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the draft order details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.draft-order-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.draft-order-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the draft orders page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.draft-order-index.selection-action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,
    AllComponents
  >`

Renders an admin action extension in the draft order page when multiple resources are selected. Open this extension from the "3-dot" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.gift-card-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.gift-card-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the gift card details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.gift-card-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.gift-card-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the gift card details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.order-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the order details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.order-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the order details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-details.print-action.render

value: `RenderExtension<
    PrintActionExtensionApi<'admin.order-details.print-action.render'>,
    AllComponents
  >`

Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-fulfilled-card.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the order fulfilled card. Open this extension from the "3-dot" menu inside the order fulfilled card. Note: This extension will only be visible on orders which were fulfilled by your app.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.order-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the order index page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-index.selection-action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.order-index.selection-action.render'>,
    AllComponents
  >`

Renders an admin action extension in the order index page when multiple resources are selected. Open this extension from the "More Actions"  menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.order-index.selection-print-action.render

value: `RenderExtension<
    PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,
    AllComponents
  >`

Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.product-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the product details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.product-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the product details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-details.configuration.render

value: `RenderExtension<
    ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,
    ProductConfigurationComponents
  >`

Renders Product Configuration on product details and product variant details

See the [tutorial](https://shopify.dev/docs/apps/selling-strategies/bundles/product-config) for more information

### admin.product-details.print-action.render

value: `RenderExtension<
    PrintActionExtensionApi<'admin.product-details.print-action.render'>,
    AllComponents
  >`

Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-details.reorder.render

value: `RenderExtension<
    BlockExtensionApi<'admin.product-details.reorder.render'>,
    AllComponents
  >`

Renders an admin block in the product details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-index.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.product-index.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the product index page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-index.selection-action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.product-index.selection-action.render'>,
    AllComponents
  >`

Renders an admin action extension in the product index page when multiple resources are selected. Open this extension from the "More Actions"  menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-index.selection-print-action.render

value: `RenderExtension<
    PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,
    AllComponents
  >`

Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-variant-details.action.render

value: `RenderExtension<
    ActionExtensionApi<'admin.product-variant-details.action.render'>,
    AllComponents
  >`

Renders an admin action extension in the product variant details page. Open this extension from the "More Actions" menu.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-variant-details.block.render

value: `RenderExtension<
    BlockExtensionApi<'admin.product-variant-details.block.render'>,
    AllComponents
  >`

Renders an admin block in the product variant details page.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.product-variant-details.configuration.render

value: `RenderExtension<
    ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,
    ProductConfigurationComponents
  >`

Renders Product Configuration on product details and product variant details

See the [tutorial](https://shopify.dev/docs/apps/selling-strategies/bundles/product-config) for more information

### admin.settings.internal-order-routing-rule.render

value: `RenderExtension<
    OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,
    AllComponents | OrderRoutingComponents
  >`

Renders Order Routing Rule Configuration on order routing settings.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### admin.settings.order-routing-rule.render

value: `RenderExtension<
    OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,
    AllComponents
  >`


### admin.settings.validation.render

value: `RenderExtension<
    ValidationSettingsApi<'admin.settings.validation.render'>,
    AllComponents
  >`

Renders Validation Settings within a given validation's add and edit views.

See the [list of available components](https://shopify.dev/docs/api/admin-extensions/components).

### Playground

value: `RenderExtension<StandardApi<'Playground'>, AllComponents>`


### BlockExtensionApi

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `Data`

Information about the currently viewed or selected items.

### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### navigation

value: `Navigation`

Provides methods to navigate to other features in the Admin. Currently, only navigation from an admin block to an admin action extension *on the same resource page* is supported. For example, you can navigate from an admin block on the product details page (`admin.product-details.block.render`) to an admin action on the product details page (`admin.product-details.action.render`).

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### resourcePicker

value: `ResourcePickerApi`

Renders the [Resource Picker](https://shopify.dev/docs/api/app-bridge-library/apis/resource-picker), allowing users to select a resource for the extension to use as part of its flow.

### I18n

### formatCurrency

value: `(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string`

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.

### formatDate

value: `(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string`

Returns a localized date value.

This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options.

### formatNumber

value: `(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string`

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.

### translate

value: `I18nTranslate`

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.

### Intents

### launchUrl

value: `string | URL`

The URL that was used to launch the intent.

### Navigation

### navigate

value: `(url: string | URL) => void`

Navigate to a specific route.

### ResourcePickerApi

#### Returns: Promise<SelectPayload<ResourcePickerOptions['type']> | undefined>

#### Params:

- options: ResourcePickerOptions
export type ResourcePickerApi = (
  options: ResourcePickerOptions,
) => Promise<SelectPayload<ResourcePickerOptions['type']> | undefined>;


### ResourcePickerOptions

### action

value: `'add' | 'select'`

The action verb appears in the title and as the primary action of the Resource Picker.

### filter

value: `Filters`

Filters for what resource to show.

### multiple

value: `boolean | number`

Whether to allow selecting multiple items of a specific type or not. If a number is provided, then limit the selections to a maximum of that number of items. When type is Product, the user may still select multiple variants of a single product, even if multiple is false.

### query

value: `string`

GraphQL initial search query for filtering resources available in the picker. See [search syntax](https://shopify.dev/docs/api/usage/search-syntax) for more information. This is displayed in the search bar when the picker is opened and can be edited by users. For most use cases, you should use the `filter.query` option instead which doesn't show the query in the UI.

### selectionIds

value: `BaseResource[]`

Resources that should be preselected when the picker is opened.

### type

value: `'product' | 'variant' | 'collection'`

The type of resource you want to pick.

### Filters

### archived

value: `boolean | undefined`

Whether to show [archived products](https://help.shopify.com/en/manual/products/details?shpxid=70af7d87-E0F2-4973-8B09-B972AAF0ADFD#product-availability). Only applies to the Product resource type picker. Setting this to undefined will show a badge on draft products.

### draft

value: `boolean | undefined`

Whether to show [draft products](https://help.shopify.com/en/manual/products/details?shpxid=70af7d87-E0F2-4973-8B09-B972AAF0ADFD#product-availability). Only applies to the Product resource type picker. Setting this to undefined will show a badge on draft products.

### hidden

value: `boolean`

Whether to show hidden resources, referring to products that are not published on any sales channels.

### query

value: `string`

GraphQL initial search query for filtering resources available in the picker. See [search syntax](https://shopify.dev/docs/api/usage/search-syntax) for more information. This is not displayed in the search bar when the picker is opened.

### variants

value: `boolean`

Whether to show product variants. Only applies to the Product resource type picker.

### BaseResource

### id

value: `string`

in GraphQL id format, ie 'gid://shopify/Product/1'

### variants

value: `Resource[]`


### Resource

### id

value: `string`

in GraphQL id format, ie 'gid://shopify/Product/1'

### CustomerSegmentTemplateApi

### __enabledFeatures

value: `"b2bEnabled"[]`


### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### PrintActionExtensionApi

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `Data`

Information about the currently viewed or selected items.

### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### ProductDetailsConfigurationApi

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `{ product: Product; app: { launchUrl: string; applicationUrl: string; }; }`


### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### Product

### handle

value: `string`


### hasOnlyDefaultVariant

value: `boolean`


### id

value: `string`


### onlineStoreUrl

value: `string`


### options

value: `{ id: string; name: string; position: number; values: string[]; }[]`


### productCategory

value: `string`


### productComponents

value: `ProductComponent[]`


### productType

value: `string`


### status

value: `'ACTIVE' | 'ARCHIVED' | 'DRAFT'`


### title

value: `string`


### totalInventory

value: `number`


### totalVariants

value: `number`


### ProductComponent

### componentVariantsCount

value: `number`


### featuredImage

value: `{
    id?: string | null;
    url?: string | null;
    altText?: string | null;
  } | null`


### id

value: `string`


### nonComponentVariantsCount

value: `number`


### productUrl

value: `string`


### title

value: `string`


### totalVariants

value: `number`


### Image

### altText

value: `string`


### id

value: `string`


### originalSrc

value: `string`


### ProductVariantDetailsConfigurationApi

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `{ variant: ProductVariant; app: { launchUrl: string; applicationUrl: string; }; }`


### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### ProductVariant

### barcode

value: `string`


### compareAtPrice

value: `string`


### displayName

value: `string`


### id

value: `string`


### price

value: `string`


### productVariantComponents

value: `ProductVariantComponent[]`


### selectedOptions

value: `{ name: string; value: string; }[]`


### sku

value: `string`


### taxable

value: `boolean`


### taxCode

value: `string`


### title

value: `string`


### weight

value: `number`


### ProductVariantComponent

### displayName

value: `string`


### id

value: `string`


### image

value: `{
    id?: string | null;
    url?: string | null;
    altText?: string | null;
  } | null`


### productVariantUrl

value: `string`


### selectedOptions

value: `{ name: string; value: string; }[]`


### sku

value: `string`


### title

value: `string`


### OrderRoutingRuleApi

### applyMetafieldsChange

value: `ApplyMetafieldsChange`


### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `Data`


### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### ApplyMetafieldsChange

#### Returns: void

#### Params:

- changes: MetafieldsChange[]
export type ApplyMetafieldsChange = (changes: MetafieldsChange[]) => void;


### MetafieldUpdateChange

### key

value: `string`


### namespace

value: `string`


### type

value: `"updateMetafield"`


### value

value: `string | number`


### valueType

value: `SupportedDefinitionType`


### MetafieldRemoveChange

### key

value: `string`


### namespace

value: `string`


### type

value: `"removeMetafield"`


### InternalLocationListProps

### locationGroups

value: `LocationGroup[]`

An array of location groups.

### onCreateGroup

value: `(id: string) => void`

Callback when a new group is created. It receives the id of the new group as a parameter.

### onDeleteGroup

value: `(id: string) => void`

Callback when a location group is deleted. It receives the id of the group as a parameter.

### onMoveGroup

value: `(oldIndex: number, newIndex: number) => void`

Callback when a location group is moved. It receives the old index and the new index as parameters.

### onMoveTag

value: `(tagId: number, oldGroupIndex: number, newGroupIndex: number) => void`

Callback when a tag is moved from one group to another. It receives the id of the tag, the old group index, and the new group index as parameters.

### onRenameGroup

value: `(id: string, name: string) => void`

Callback when a location group is renamed. It receives the id of the group and the new name as parameters.

### LocationGroup

### id

value: `string`

A unique identifier for the location group.

### label

value: `string`

The label for the location group.

### locations

value: `Location[]`

An array of locations within the group.

### Location

### id

value: `string`

A unique identifier for the location.

### name

value: `string`

The name of the location.

### ValidationSettingsApi

### applyMetafieldChange

value: `ApplyMetafieldChange`

Applies a change to the validation settings.

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### data

value: `ValidationData`


### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### ApplyMetafieldChange

#### Returns: Promise<MetafieldChangeResult>

#### Params:

- change: MetafieldChange
export type ApplyMetafieldChange = (
  change: MetafieldChange,
) => Promise<MetafieldChangeResult>;


### MetafieldChangeSuccess

### type

value: `"success"`


### MetafieldChangeResultError

### message

value: `string`


### type

value: `"error"`


### ValidationData

The object that exposes the validation with its settings.

### shopifyFunction

value: `ShopifyFunction`


### validation

value: `Validation`


### ShopifyFunction

### id

value: `string`

the validation function's unique identifier

### Validation

### id

value: `string`

the validation's gid when active in a shop

### metafields

value: `Metafield[]`

the metafields owned by the validation

### Metafield

### description

value: `string`


### id

value: `string`


### key

value: `string`


### namespace

value: `string`


### type

value: `string`


### value

value: `string`


### StandardApi

The following APIs are provided to all extension targets.

### auth

value: `Auth`

Provides methods for authenticating calls to an app backend.

### extension

value: `{ target: ExtensionTarget; }`

The identifier of the running extension target.

### i18n

value: `I18n`

Utilities for translating content according to the current localization of the admin. More info - /docs/apps/checkout/best-practices/localizing-ui-extensions

### intents

value: `Intents`

Provides information to the receiver the of an intent.

### query

value: `<Data = unknown, Variables = { [key: string]: unknown; }>(query: string, options?: { variables?: Variables; version?: Omit<ApiVersion, "2023-04">; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>`

Used to query the Admin GraphQL API

### GraphQLError

GraphQL error returned by the Shopify Admin API.

### locations

value: `{ line: number; column: string; }`


### message

value: `string`