@builtbystack/sq-shopify-theme-sdk 0.0.34 → 0.0.36

package/README.md

@@ -457,6 +457,38 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 ***
 
+#### getPurchasingCustomerRetailOrders()
+
+> **getPurchasingCustomerRetailOrders**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`PurchasingCustomerRetailOrders`](#type-aliasespurchasingcustomerretailordersmd)\>
+
+getPurchasingCustomerRetailOrders は顧客の店舗受取注文一覧を取得します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得する注文数の上限
+
+• **after?**: `string`
+
+ページネーション用のカーソル
+
+• **isReverse?**: `boolean`
+
+並び順を逆にするかどうか
+
+• **sortKeys?**: `RetailOrderSortKey`
+
+ソートキー
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerRetailOrders`](#type-aliasespurchasingcustomerretailordersmd)\>
+
+顧客の店舗受取注文一覧、または顧客が存在しない場合はnull
+
+***
+
 #### getPurchasingCustomerSMS()
 
 > **getPurchasingCustomerSMS**(): `Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
@@ -684,6 +716,7 @@ LocationType はロケーションの種別を表す
 - [MileOrder](#type-aliasesmileordermd)
 - [MileOrders](#type-aliasesmileordersmd)
 - [Miles](#type-aliasesmilesmd)
+- [Money](#type-aliasesmoneymd)
 - [PageInfo](#type-aliasespageinfomd)
 - [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
 - [PointCampaignOrderRuleTargetCustomerRank](#type-aliasespointcampaignorderruletargetcustomerrankmd)
@@ -699,8 +732,11 @@ LocationType はロケーションの種別を表す
 - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
 - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
 - [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
+- [PurchasingCustomerRetailOrder](#type-aliasespurchasingcustomerretailordermd)
+- [PurchasingCustomerRetailOrders](#type-aliasespurchasingcustomerretailordersmd)
 - [PurchasingCustomerSMS](#type-aliasespurchasingcustomersmsmd)
 - [PurchasingCustomerSharing](#type-aliasespurchasingcustomersharingmd)
+- [RetailLocation](#type-aliasesretaillocationmd)
 - [Tenant](#type-aliasestenantmd)
 
 # Type Aliases
@@ -1188,7 +1224,7 @@ location は在庫のLocationを表す。
 
 > **LocationFilter**: `object`
 
-LocationType はロケーションのフィルタリング条件を表現するオブジェクト
+LocationType はロケーションのフィルタリング条件
 
 ### Type declaration
 
@@ -1524,6 +1560,35 @@ Miles は SDK から取得できるマイルの情報を表す。
 Miles は保有マイルを表す。
 
 
+<a name="type-aliasesmoneymd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Money
+
+## Type Alias: Money
+
+> **Money**: `object`
+
+Money は金額と通貨コードを表す
+
+### Type declaration
+
+#### amount
+
+> **amount**: `number`
+
+amount は金額を表す
+
+#### currencyCode
+
+> **currencyCode**: [`CurrencyCode`](#enumerationscurrencycodemd)
+
+currencyCode は通貨コードを表す
+
+
 <a name="type-aliasespageinfomd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -2136,6 +2201,184 @@ PurchasingCustomerMetafield は購入者のカスタムメタフィールドを
 > **value**: `string`
 
 
+<a name="type-aliasespurchasingcustomerretailordermd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerRetailOrder
+
+## Type Alias: PurchasingCustomerRetailOrder
+
+> **PurchasingCustomerRetailOrder**: `object`
+
+PurchasingCustomerRetailOrder は、顧客の店舗受取注文に関する情報を表す。
+
+### Type declaration
+
+#### cancelledAt
+
+> **cancelledAt**: `Date` \| `null`
+
+cancelledAt は注文のキャンセル日時（キャンセルされていない場合はnull）
+
+#### createdAt
+
+> **createdAt**: `Date`
+
+createdAt は注文が作成された日時
+
+#### currentPointApplicationPrice
+
+> **currentPointApplicationPrice**: [`Money`](#type-aliasesmoneymd)
+
+currentPointApplicationPrice は現在の利用ポイント金額
+
+#### currentSubtotalPrice
+
+> **currentSubtotalPrice**: [`Money`](#type-aliasesmoneymd)
+
+currentSubtotalPrice は注文作成時の注文明細の合計金額から商品割引の金額を差し引き返金を考慮した価格
+
+#### currentTotalQuantity
+
+> **currentTotalQuantity**: `number`
+
+currentTotalQuantity は返金を考慮した商品の総数量
+
+#### currentTotalTaxPrice
+
+> **currentTotalTaxPrice**: [`Money`](#type-aliasesmoneymd)
+
+currentTotalTaxPrice は現在の注文の合計税金額
+
+#### fulfilledAt
+
+> **fulfilledAt**: `Date` \| `null`
+
+fulfilledAt は注文の出荷日時（未出荷の場合はnull）
+
+#### id
+
+> **id**: `string`
+
+id は注文の一意識別子
+
+#### isCancelled
+
+> **isCancelled**: `boolean`
+
+isCancelled は注文がキャンセル済みかどうかを表すフラグ
+
+#### managementCode
+
+> **managementCode**: `string`
+
+managementCode は注文の管理コード
+
+#### paymentStatus
+
+> **paymentStatus**: `string`
+
+paymentStatus は注文の決済ステータス
+
+#### pointApplicationPrice
+
+> **pointApplicationPrice**: [`Money`](#type-aliasesmoneymd)
+
+pointApplicationPrice は利用ポイント金額
+
+#### purchasedAt
+
+> **purchasedAt**: `Date`
+
+purchasedAt は注文が購入された日時
+
+#### retailLocation
+
+> **retailLocation**: [`RetailLocation`](#type-aliasesretaillocationmd)
+
+retailLocation はこの注文が発生した店舗ロケーション
+
+#### source
+
+> **source**: `string`
+
+source は注文の発生元
+
+#### subtotalPrice
+
+> **subtotalPrice**: [`Money`](#type-aliasesmoneymd)
+
+subtotalPrice は注文の小計
+
+#### tags
+
+> **tags**: `string`[]
+
+tags は注文に付与されているタグの一覧
+
+#### totalOrderDiscountPrice
+
+> **totalOrderDiscountPrice**: [`Money`](#type-aliasesmoneymd)
+
+totalOrderDiscountPrice は注文レベルと注文明細レベルの割引の合計金額
+
+#### totalPrice
+
+> **totalPrice**: [`Money`](#type-aliasesmoneymd)
+
+totalPrice は注文の合計金額
+
+#### totalQuantity
+
+> **totalQuantity**: `number`
+
+totalQuantity は注文時の注文明細の総数量
+
+#### totalTaxPrice
+
+> **totalTaxPrice**: [`Money`](#type-aliasesmoneymd)
+
+totalTaxPrice は注文作成時の送料明細の税の合計金額
+
+#### updatedAt
+
+> **updatedAt**: `Date`
+
+updatedAt は注文が最後に更新された日時
+
+
+<a name="type-aliasespurchasingcustomerretailordersmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerRetailOrders
+
+## Type Alias: PurchasingCustomerRetailOrders
+
+> **PurchasingCustomerRetailOrders**: `object`
+
+PurchasingCustomerRetailOrders は顧客の店舗受取注文一覧を表す
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`PurchasingCustomerRetailOrder`](#type-aliasespurchasingcustomerretailordermd)[]
+
+nodes は店舗受取注文の配列
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+pageInfo はページネーション情報
+
+
 <a name="type-aliasespurchasingcustomersmsmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -2192,6 +2435,41 @@ PurchasingCustomerSMS は、顧客のSMS認証情報を表す。
 > **purchasingCustomers**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)[]
 
 
+<a name="type-aliasesretaillocationmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / RetailLocation
+
+## Type Alias: RetailLocation
+
+> **RetailLocation**: `object`
+
+RetailLocation は店舗のロケーション情報を表す。
+
+### Type declaration
+
+#### displayName
+
+> **displayName**: `string`
+
+店舗ロケーションの表示名（顧客向けの名称）
+
+#### id
+
+> **id**: `string`
+
+店舗ロケーションの一意識別子
+
+#### name
+
+> **name**: `string`
+
+店舗ロケーションの内部名称
+
+
 <a name="type-aliasestenantmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

package/dist/sq-shopify-theme-sdk.d.ts

@@ -209,7 +209,7 @@ export declare type LocationAvailability = {
 };
 
 /**
- * LocationType はロケーションのフィルタリング条件を表現するオブジェクト
+ * LocationType はロケーションのフィルタリング条件
  */
 export declare type LocationFilter = {
     /**
@@ -384,6 +384,20 @@ export declare type Miles = {
     miles: number;
 };
 
+/**
+ * Money は金額と通貨コードを表す
+ */
+export declare type Money = {
+    /**
+     * amount は金額を表す
+     */
+    amount: number;
+    /**
+     * currencyCode は通貨コードを表す
+     */
+    currencyCode: CurrencyCode;
+};
+
 /**
  * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
  */
@@ -662,6 +676,114 @@ export declare type PurchasingCustomerMetafield = {
     value: string;
 };
 
+/**
+ * PurchasingCustomerRetailOrder は、顧客の店舗受取注文に関する情報を表す。
+ */
+export declare type PurchasingCustomerRetailOrder = {
+    /**
+     * id は注文の一意識別子
+     */
+    id: string;
+    /**
+     * managementCode は注文の管理コード
+     */
+    managementCode: string;
+    /**
+     * source は注文の発生元
+     */
+    source: string;
+    /**
+     * purchasedAt は注文が購入された日時
+     */
+    purchasedAt: Date;
+    /**
+     * fulfilledAt は注文の出荷日時（未出荷の場合はnull）
+     */
+    fulfilledAt: Date | null;
+    /**
+     * isCancelled は注文がキャンセル済みかどうかを表すフラグ
+     */
+    isCancelled: boolean;
+    /**
+     * cancelledAt は注文のキャンセル日時（キャンセルされていない場合はnull）
+     */
+    cancelledAt: Date | null;
+    /**
+     * tags は注文に付与されているタグの一覧
+     */
+    tags: string[];
+    /**
+     * paymentStatus は注文の決済ステータス
+     */
+    paymentStatus: string;
+    /**
+     * retailLocation はこの注文が発生した店舗ロケーション
+     */
+    retailLocation: RetailLocation;
+    /**
+     * totalQuantity は注文時の注文明細の総数量
+     */
+    totalQuantity: number;
+    /**
+     * currentTotalQuantity は返金を考慮した商品の総数量
+     */
+    currentTotalQuantity: number;
+    /**
+     * pointApplicationPrice は利用ポイント金額
+     */
+    pointApplicationPrice: Money;
+    /**
+     * currentPointApplicationPrice は現在の利用ポイント金額
+     */
+    currentPointApplicationPrice: Money;
+    /**
+     * totalOrderDiscountPrice は注文レベルと注文明細レベルの割引の合計金額
+     */
+    totalOrderDiscountPrice: Money;
+    /**
+     * subtotalPrice は注文の小計
+     */
+    subtotalPrice: Money;
+    /**
+     * totalTaxPrice は注文作成時の送料明細の税の合計金額
+     */
+    totalTaxPrice: Money;
+    /**
+     * currentTotalTaxPrice は現在の注文の合計税金額
+     */
+    currentTotalTaxPrice: Money;
+    /**
+     * currentSubtotalPrice は注文作成時の注文明細の合計金額から商品割引の金額を差し引き返金を考慮した価格
+     */
+    currentSubtotalPrice: Money;
+    /**
+     * totalPrice は注文の合計金額
+     */
+    totalPrice: Money;
+    /**
+     * createdAt は注文が作成された日時
+     */
+    createdAt: Date;
+    /**
+     * updatedAt は注文が最後に更新された日時
+     */
+    updatedAt: Date;
+};
+
+/**
+ * PurchasingCustomerRetailOrders は顧客の店舗受取注文一覧を表す
+ */
+export declare type PurchasingCustomerRetailOrders = {
+    /**
+     * nodes は店舗受取注文の配列
+     */
+    nodes: PurchasingCustomerRetailOrder[];
+    /**
+     * pageInfo はページネーション情報
+     */
+    pageInfo: PageInfo;
+};
+
 export declare type PurchasingCustomerSharing = {
     id: string;
     purchasingCustomers: PurchasingCustomer[];
@@ -682,6 +804,30 @@ export declare type PurchasingCustomerSMS = {
     smsVerifiedPhone: string;
 };
 
+/**
+ * RetailLocation は店舗のロケーション情報を表す。
+ */
+export declare type RetailLocation = {
+    /**
+     * 店舗ロケーションの一意識別子
+     */
+    id: string;
+    /**
+     * 店舗ロケーションの内部名称
+     */
+    name: string;
+    /**
+     * 店舗ロケーションの表示名（顧客向けの名称）
+     */
+    displayName: string;
+};
+
+/** 実店舗での注文のソート順を表す列挙型 */
+declare enum RetailOrderSortKey {
+    CreatedAt = "CREATED_AT",
+    PurchasedAt = "PURCHASED_AT"
+}
+
 export declare class SDK {
     private api;
     constructor(apiURL: string);
@@ -808,6 +954,15 @@ export declare class SDK {
      * getPurchasingCustomerSMS は顧客のSMS認証情報を返します。
      */
     getPurchasingCustomerSMS(): Promise<PurchasingCustomerSMS | null>;
+    /**
+     * getPurchasingCustomerRetailOrders は顧客の店舗受取注文一覧を取得します。
+     * @param first 取得する注文数の上限
+     * @param after ページネーション用のカーソル
+     * @param isReverse 並び順を逆にするかどうか
+     * @param sortKeys ソートキー
+     * @returns 顧客の店舗受取注文一覧、または顧客が存在しない場合はnull
+     */
+    getPurchasingCustomerRetailOrders(first?: number, after?: string, isReverse?: boolean, sortKeys?: RetailOrderSortKey): Promise<PurchasingCustomerRetailOrders | null>;
     /**
      * mileItemExchange は指定したマイル商品を交換します。
      *