@builtbystack/sq-shopify-theme-sdk 0.0.20 → 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -105,12 +105,20 @@ getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報
105
105
 
106
106
  #### getLocations()
107
107
 
108
- > **getLocations**(`first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
108
+ > **getLocations**(`tag`?, `provinceCodes`?, `first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
109
109
 
110
110
  getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
111
111
 
112
112
  ##### Parameters
113
113
 
114
+ • **tag?**: `string`
115
+
116
+ 取得したいLocationのタグ。
117
+
118
+ • **provinceCodes?**: `string`[]
119
+
120
+ 取得したいLocationの都道府県コード。
121
+
114
122
  • **first?**: `number`
115
123
 
116
124
  取得してくる個数。デフォルトは250。
@@ -667,6 +675,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
667
675
 
668
676
  > **phone**: `string`
669
677
 
678
+ #### tags
679
+
680
+ > **tags**: `string`[]
681
+
670
682
 
671
683
  <a name="type-aliaseslocationavailabilitiesmd"></a>
672
684
 
@@ -999,6 +1011,12 @@ Product は商品情報を表す。
999
1011
 
1000
1012
  > **id**: `string`
1001
1013
 
1014
+ #### isLocalPickupAvailable
1015
+
1016
+ > **isLocalPickupAvailable**: `boolean`
1017
+
1018
+ 商品の店舗受取が可能な場合にtrueが返る
1019
+
1002
1020
  #### title
1003
1021
 
1004
1022
  > **title**: `string`
@@ -1036,14 +1054,26 @@ ProductVariant は商品のバリエーションを表す。
1036
1054
 
1037
1055
  > **inventoryItem**: [`InventoryItem`](#type-aliasesinventoryitemmd)
1038
1056
 
1057
+ 在庫情報
1058
+
1039
1059
  #### isBackOrderEnable
1040
1060
 
1041
1061
  > **isBackOrderEnable**: `boolean`
1042
1062
 
1063
+ 予約販売が設定されている場合にtrueが返る
1064
+
1065
+ #### isLocalPickupAvailable
1066
+
1067
+ > **isLocalPickupAvailable**: `boolean`
1068
+
1069
+ 商品の店舗受取が可能な場合にtrueが返る
1070
+
1043
1071
  #### title
1044
1072
 
1045
1073
  > **title**: `string`
1046
1074
 
1075
+ 商品バリエーションのタイトル
1076
+
1047
1077
 
1048
1078
  <a name="type-aliasesproductvariantsmd"></a>
1049
1079
 
@@ -120,6 +120,7 @@ declare type Location_2 = {
120
120
  name: string;
121
121
  phone: string;
122
122
  mapURL?: string;
123
+ tags: string[];
123
124
  address?: Address;
124
125
  };
125
126
  export { Location_2 as Location }
@@ -273,6 +274,10 @@ export declare type Product = {
273
274
  * 商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
274
275
  */
275
276
  hasBackOrderProductVariants: boolean;
277
+ /**
278
+ * 商品の店舗受取が可能な場合にtrueが返る
279
+ */
280
+ isLocalPickupAvailable: boolean;
276
281
  /**
277
282
  * 商品のバリエーション一覧
278
283
  */
@@ -284,8 +289,21 @@ export declare type Product = {
284
289
  */
285
290
  export declare type ProductVariant = {
286
291
  id: string;
292
+ /**
293
+ * 商品バリエーションのタイトル
294
+ */
287
295
  title: string;
296
+ /**
297
+ * 予約販売が設定されている場合にtrueが返る
298
+ */
288
299
  isBackOrderEnable: boolean;
300
+ /**
301
+ * 商品の店舗受取が可能な場合にtrueが返る
302
+ */
303
+ isLocalPickupAvailable: boolean;
304
+ /**
305
+ * 在庫情報
306
+ */
289
307
  inventoryItem: InventoryItem;
290
308
  };
291
309
 
@@ -390,11 +408,13 @@ export declare class SDK {
390
408
  /**
391
409
  * getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
392
410
  *
411
+ * @param {string} [tag] 取得したいLocationのタグ。
412
+ * @param {string[]} [provinceCodes] 取得したいLocationの都道府県コード。
393
413
  * @param {number} [first] 取得してくる個数。デフォルトは250。
394
414
  * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
395
415
  * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
396
416
  */
397
- getLocations(first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
417
+ getLocations(tag?: string, provinceCodes?: string[], first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
398
418
  /**
399
419
  * getPurchasingCustomerDiscounts は購入者の割引情報を返します。
400
420
  *