export interface StandardApi { /** * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event. */ analytics: Analytics; /** * Gift Cards that have been applied to the checkout. */ appliedGiftCards: StatefulRemoteSubscribable; /** * The cart instructions used to create the checkout and possibly limit extension capabilities. * * These instructions should be checked prior to performing any actions that may 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: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. * See the [update guide](/docs/api/checkout-ui-extensions/instructions-update) for more information. * */ instructions: StatefulRemoteSubscribable; /** * The metafields requested in the * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) * file. These metafields are updated when there's a change in the merchandise items * being purchased by the customer. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). * * > Tip: * > Metafields on an [app reserved namespace](/docs/apps/build/custom-data/reserved-prefixes) cannot be accessed by Checkout UI extensions. */ appMetafields: StatefulRemoteSubscribable; /** * The custom attributes left by the customer to the merchant, either in their cart or during checkout. */ attributes: StatefulRemoteSubscribable; /** * All available payment options. */ availablePaymentOptions: StatefulRemoteSubscribable; /** * Information about the buyer that is interacting with the checkout. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ buyerIdentity?: BuyerIdentity; /** * Provides details on the buyer's progression through the checkout. * * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) * examples for more information. */ buyerJourney: BuyerJourney; /** * Settings applied to the buyer's checkout. */ checkoutSettings: StatefulRemoteSubscribable; /** * A stable ID that represents the current checkout. * * Matches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object). */ checkoutToken: StatefulRemoteSubscribable; /** * Details on the costs the buyer will pay for this checkout. */ cost: CartCost; /** * A list of delivery groups containing information about the delivery of the items the customer intends to purchase. */ deliveryGroups: StatefulRemoteSubscribable; /** * A list of discount codes currently applied to the checkout. */ discountCodes: StatefulRemoteSubscribable; /** * Discounts that have been applied to the entire cart. */ discountAllocations: StatefulRemoteSubscribable; /** * The meta information about the extension. */ extension: Extension; /** * The identifier that specifies where in Shopify’s UI your code is being * injected. This will be one of the targets you have included in your * extension’s configuration file. * * @example 'purchase.checkout.block.render' * @see /docs/api/checkout-ui-extensions/2024-10/extension-targets-overview * @see /docs/apps/app-extensions/configuration#targets * * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead. */ extensionPoint: Target; /** * Utilities for translating content and formatting values according to the current * [`localization`](/docs/api/checkout-ui-extensions/apis/localization) * of the checkout. * * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) * for more information. */ i18n: I18n; /** * A list of lines containing information about the items the customer intends to purchase. */ lines: StatefulRemoteSubscribable; /** * The details about the location, language, and currency of the customer. For utilities to easily * format and translate content based on these details, you can use the * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) * object instead. */ localization: Localization; /** * The metafields that apply to the current checkout. * * Metafields are stored locally on the client and are applied to the order object after the checkout completes. * * These metafields are shared by all extensions running on checkout, and * persist for as long as the customer is working on this checkout. * * Once the order is created, you can query these metafields using the * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01) * * > Tip: * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later. */ metafields: StatefulRemoteSubscribable; /** * A note left by the customer to the merchant, either in their cart or during checkout. */ note: StatefulRemoteSubscribable; /** * The method used to query the Storefront GraphQL API with a prefetched token. * * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information. */ query: >( query: string, options?: {variables?: Variables; version?: StorefrontApiVersion}, ) => Promise<{data?: Data; errors?: GraphQLError[]}>; /** * Payment options selected by the buyer. */ selectedPaymentOptions: StatefulRemoteSubscribable; /** * The session token providing a set of claims as a signed JSON Web Token (JWT). * * The token has a TTL of 5 minutes. * * If the previous token expires, this value will reflect a new session token with a new signature and expiry. * * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information. */ sessionToken: SessionToken; /** * The settings matching the settings definition written in the * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. * * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information. * * > Note: When an extension is being installed in the editor, the settings will be empty until * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings. */ settings: StatefulRemoteSubscribable; /** * The proposed customer shipping address. During the information step, the address * updates when the field is committed (on change) rather than every keystroke. * An address value is only present if delivery is required. Otherwise, the * subscribable value is undefined. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ shippingAddress?: StatefulRemoteSubscribable; /** * The proposed customer billing address. The address updates when the field is * committed (on change) rather than every keystroke. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ billingAddress?: StatefulRemoteSubscribable; /** The shop where the checkout is taking place. */ shop: Shop; /** * The key-value storage for the extension. * * It uses `localStorage` and should persist across the customer's current checkout session. * * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout. * * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, * each activated extension target had its own storage. */ storage: Storage; /** * Methods to interact with the extension’s UI. */ ui: Ui; /** * The renderer version being used for the extension. * * @example 'unstable' */ version: Version; /** * Customer privacy consent settings and a flag denoting if consent has previously been collected. */ customerPrivacy: StatefulRemoteSubscribable; /** * Allows setting and updating customer privacy consent settings and tracking consent metafields. * * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/2024-10/configuration#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). */ applyTrackingConsentChange: ApplyTrackingConsentChangeType; }