export interface OrderStatusApi { /** * Methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event. */ analytics: Analytics; /** * Gift Cards that have been applied to the order. */ appliedGiftCards: StatefulRemoteSubscribable; /** * The metafields requested in the * [`shopify.ui.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). */ appMetafields: StatefulRemoteSubscribable; /** * Custom attributes left by the customer to the merchant, either in their cart or during checkout. */ attributes: StatefulRemoteSubscribable; /** * Information about the buyer that is interacting with the order. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ buyerIdentity?: OrderStatusBuyerIdentity; /** * Settings applied to the buyer's checkout. */ checkoutSettings: StatefulRemoteSubscribable; /** * Details on the costs of the purchase for the buyer. */ cost: CartCost; /** * A list of discount codes applied to the purchase. */ discountCodes: StatefulRemoteSubscribable; /** * Discounts that have been applied to the entire cart. */ discountAllocations: StatefulRemoteSubscribable; /** * 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 'customer-account.order-status.block.render' * @see /docs/api/checkout-ui-extensions/unstable/extension-targets-overview * @see /docs/apps/app-extensions/configuration#targets * * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead. */ extensionPoint: Target; /** * A list of lines containing information about the items the customer intends to purchase. */ lines: StatefulRemoteSubscribable; /** * 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`](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-i18n) * object instead. */ localization: OrderStatusLocalization; /** * The metafields that apply to the current order. The actual resource * on which these metafields exist depends on the source of the order: * * - If the source is an order, then the metafields are on the order. * * - If the source is a draft order, then the initial value of metafields are * from the draft order, and any new metafields you write are applied * to the order created by the checkout. * * - For all other sources, the metafields are only stored locally on the * client creating the checkout, and are applied to the order that * results from checkout. * * 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) */ metafields: StatefulRemoteSubscribable; /** * A note left by the customer to the merchant, either in their cart or during checkout. */ note: StatefulRemoteSubscribable; /** * Information about the order that was placed. */ order: StatefulRemoteSubscribable; /** * id that represents the checkout used to create the order. * * Matches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) * and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object). */ checkoutToken: StatefulRemoteSubscribable; /** * The buyer shipping address used for the order. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ shippingAddress?: StatefulRemoteSubscribable; /** * The buyer billing address used for the order. * * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). */ billingAddress?: StatefulRemoteSubscribable; /** Shop where the purchase took place. */ shop: Shop; /** * The renderer version being used for the extension. * * @example 'unstable' */ version: Version; /** * The requireLogin() method triggers login if the customer is viewing pre-authenticated Order status page. */ requireLogin: () => Promise; /** * The authentication state of Order status page. */ authenticationState: StatefulRemoteSubscribable; }