add requireLogin for CA order status api

Shopify · Jan 23, 2024 · 21cb320 · 21cb320
1 parent a1a9a88
commit 21cb320
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.changeset/nine-points-deny.md b/.changeset/nine-points-deny.md
@@ -0,0 +1,6 @@
+---
+'@shopify/ui-extensions': minor
+'@shopify/ui-extensions-react': minor
+---
+
+add requireLogin for CA order status api
diff --git a/packages/ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts b/packages/ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts
@@ -347,6 +347,11 @@ export interface OrderStatusApi<Target extends ExtensionTarget> {
    * @example 'unstable'
    */
   version: Version;
+
+  /**
+   * The requireLogin() method triggers login if the customer is viewing pre-authenticated Order Status Page.
+   */
+  requireLogin: () => Promise<void>;
 }
 
 export interface OrderStatusBuyerIdentity {