commerce-kit 0.65.0 → 0.66.0

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.
@@ -2902,6 +2902,9 @@ type APIProductsBrowseQueryParams = {
2902
2902
  orderDirection?: "asc" | "desc" | undefined;
2903
2903
  currency?: string | undefined;
2904
2904
  lang?: string | undefined;
2905
+ filter?: string | undefined;
2906
+ include?: "metafields" | undefined;
2907
+ metafields?: "all" | "public" | undefined;
2905
2908
  };
2906
2909
  type APIProductFiltersResult = {
2907
2910
  priceBounds: {
@@ -2924,6 +2927,26 @@ type APIProductFiltersResult = {
2924
2927
  name: string;
2925
2928
  slug: string;
2926
2929
  }[];
2930
+ metafields?: {
2931
+ field: string;
2932
+ ownerType: "variant" | "product";
2933
+ namespace: string;
2934
+ key: string;
2935
+ name: string;
2936
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
2937
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
2938
+ options?: {
2939
+ key: string;
2940
+ label: string;
2941
+ }[] | undefined;
2942
+ range?: {
2943
+ min: string;
2944
+ max: string;
2945
+ } | undefined;
2946
+ }[] | undefined;
2947
+ };
2948
+ type APIProductFiltersQueryParams = {
2949
+ lang?: string | undefined;
2927
2950
  };
2928
2951
  type APIProductGetByIdResult = {
2929
2952
  id: string;
@@ -4154,6 +4177,7 @@ type APIProductGetByIdParams = {
4154
4177
  type APIProductGetByIdQueryParams = {
4155
4178
  lang?: string;
4156
4179
  currency?: string;
4180
+ metafields?: "public" | "all";
4157
4181
  };
4158
4182
  type APICartGetResult = {
4159
4183
  id: string;
@@ -9886,6 +9910,7 @@ type APIOrdersBrowseResult = Omit<{
9886
9910
  type: "fixed";
9887
9911
  dueAt: string;
9888
9912
  } | null | undefined;
9913
+ paymentCollectedAt?: string | null | undefined;
9889
9914
  note?: string | null | undefined;
9890
9915
  poNumber?: string | null | undefined;
9891
9916
  };
@@ -9899,6 +9924,7 @@ type APIOrdersBrowseResult = Omit<{
9899
9924
  campaign: string | null;
9900
9925
  referrerHost: string | null;
9901
9926
  ts: number;
9927
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
9902
9928
  };
9903
9929
  lastTouch: {
9904
9930
  source: string | null;
@@ -9906,6 +9932,7 @@ type APIOrdersBrowseResult = Omit<{
9906
9932
  campaign: string | null;
9907
9933
  referrerHost: string | null;
9908
9934
  ts: number;
9935
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
9909
9936
  };
9910
9937
  } | null;
9911
9938
  externalId: string | null;
@@ -10540,6 +10567,7 @@ type APIOrdersBrowseResult = Omit<{
10540
10567
  type: "fixed";
10541
10568
  dueAt: string;
10542
10569
  } | null | undefined;
10570
+ paymentCollectedAt?: string | null | undefined;
10543
10571
  note?: string | null | undefined;
10544
10572
  poNumber?: string | null | undefined;
10545
10573
  };
@@ -11136,6 +11164,7 @@ type APIOrdersBrowseResult = Omit<{
11136
11164
  type: "fixed";
11137
11165
  dueAt: string;
11138
11166
  } | null | undefined;
11167
+ paymentCollectedAt?: string | null | undefined;
11139
11168
  note?: string | null | undefined;
11140
11169
  poNumber?: string | null | undefined;
11141
11170
  };
@@ -11149,6 +11178,7 @@ type APIOrdersBrowseResult = Omit<{
11149
11178
  campaign: string | null;
11150
11179
  referrerHost: string | null;
11151
11180
  ts: number;
11181
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
11152
11182
  };
11153
11183
  lastTouch: {
11154
11184
  source: string | null;
@@ -11156,6 +11186,7 @@ type APIOrdersBrowseResult = Omit<{
11156
11186
  campaign: string | null;
11157
11187
  referrerHost: string | null;
11158
11188
  ts: number;
11189
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
11159
11190
  };
11160
11191
  } | null;
11161
11192
  externalId: string | null;
@@ -11790,6 +11821,7 @@ type APIOrdersBrowseResult = Omit<{
11790
11821
  type: "fixed";
11791
11822
  dueAt: string;
11792
11823
  } | null | undefined;
11824
+ paymentCollectedAt?: string | null | undefined;
11793
11825
  note?: string | null | undefined;
11794
11826
  poNumber?: string | null | undefined;
11795
11827
  };
@@ -13043,6 +13075,7 @@ type APIOrdersBrowseResult = Omit<{
13043
13075
  type: "fixed";
13044
13076
  dueAt: string;
13045
13077
  } | null | undefined;
13078
+ paymentCollectedAt?: string | null | undefined;
13046
13079
  note?: string | null | undefined;
13047
13080
  poNumber?: string | null | undefined;
13048
13081
  };
@@ -13070,6 +13103,7 @@ type APIOrderGetByIdResult = Omit<{
13070
13103
  campaign: string | null;
13071
13104
  referrerHost: string | null;
13072
13105
  ts: number;
13106
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
13073
13107
  };
13074
13108
  lastTouch: {
13075
13109
  source: string | null;
@@ -13077,6 +13111,7 @@ type APIOrderGetByIdResult = Omit<{
13077
13111
  campaign: string | null;
13078
13112
  referrerHost: string | null;
13079
13113
  ts: number;
13114
+ clickIdType?: "gclid" | "gbraid" | "wbraid" | "msclkid" | "ttclid" | "fbclid" | undefined;
13080
13115
  };
13081
13116
  } | null;
13082
13117
  lookup: number;
@@ -13661,6 +13696,7 @@ type APIOrderGetByIdResult = Omit<{
13661
13696
  type: "fixed";
13662
13697
  dueAt: string;
13663
13698
  } | null | undefined;
13699
+ paymentCollectedAt?: string | null | undefined;
13664
13700
  note?: string | null | undefined;
13665
13701
  poNumber?: string | null | undefined;
13666
13702
  };
@@ -14327,6 +14363,7 @@ type APIOrderGetByIdResult = Omit<{
14327
14363
  type: "fixed";
14328
14364
  dueAt: string;
14329
14365
  } | null | undefined;
14366
+ paymentCollectedAt?: string | null | undefined;
14330
14367
  note?: string | null | undefined;
14331
14368
  poNumber?: string | null | undefined;
14332
14369
  };
@@ -15576,6 +15613,7 @@ type APIOrderGetByIdResult = Omit<{
15576
15613
  type: "fixed";
15577
15614
  dueAt: string;
15578
15615
  } | null | undefined;
15616
+ paymentCollectedAt?: string | null | undefined;
15579
15617
  note?: string | null | undefined;
15580
15618
  poNumber?: string | null | undefined;
15581
15619
  };
@@ -15799,6 +15837,20 @@ type APICollectionsBrowseResult = Omit<{
15799
15837
  slug: string;
15800
15838
  active: boolean;
15801
15839
  description: JSONContent | null;
15840
+ metafieldRules: ({
15841
+ field: string;
15842
+ op: "range";
15843
+ min?: string | undefined;
15844
+ max?: string | undefined;
15845
+ } | {
15846
+ field: string;
15847
+ op: "in";
15848
+ values: string[];
15849
+ } | {
15850
+ field: string;
15851
+ op: "is";
15852
+ value: boolean;
15853
+ })[] | null;
15802
15854
  group: string | null;
15803
15855
  productCollections: {
15804
15856
  productId: string;
@@ -15820,6 +15872,20 @@ type APICollectionsBrowseResult = Omit<{
15820
15872
  slug: string;
15821
15873
  active: boolean;
15822
15874
  description: JSONContent | null;
15875
+ metafieldRules: ({
15876
+ field: string;
15877
+ op: "range";
15878
+ min?: string | undefined;
15879
+ max?: string | undefined;
15880
+ } | {
15881
+ field: string;
15882
+ op: "in";
15883
+ values: string[];
15884
+ } | {
15885
+ field: string;
15886
+ op: "is";
15887
+ value: boolean;
15888
+ })[] | null;
15823
15889
  group: string | null;
15824
15890
  productCollections: {
15825
15891
  productId: string;
@@ -15873,6 +15939,20 @@ type APICollectionGetByIdResult = ({
15873
15939
  type: "newest";
15874
15940
  days?: number | null | undefined;
15875
15941
  };
15942
+ metafieldRules: ({
15943
+ field: string;
15944
+ op: "range";
15945
+ min?: string | undefined;
15946
+ max?: string | undefined;
15947
+ } | {
15948
+ field: string;
15949
+ op: "in";
15950
+ values: string[];
15951
+ } | {
15952
+ field: string;
15953
+ op: "is";
15954
+ value: boolean;
15955
+ })[] | null;
15876
15956
  group: string | null;
15877
15957
  productCollections: {
15878
15958
  position: string | null;
@@ -15937,6 +16017,20 @@ type APICollectionGetByIdResult = ({
15937
16017
  type: "newest";
15938
16018
  days?: number | null | undefined;
15939
16019
  };
16020
+ metafieldRules: ({
16021
+ field: string;
16022
+ op: "range";
16023
+ min?: string | undefined;
16024
+ max?: string | undefined;
16025
+ } | {
16026
+ field: string;
16027
+ op: "in";
16028
+ values: string[];
16029
+ } | {
16030
+ field: string;
16031
+ op: "is";
16032
+ value: boolean;
16033
+ })[] | null;
15940
16034
  group: string | null;
15941
16035
  productCollections: {
15942
16036
  position: string | null;
@@ -16065,6 +16159,8 @@ type APIMeStore = {
16065
16159
  showPolicyLinks?: boolean | null | undefined;
16066
16160
  hideExpressWallets?: boolean | null | undefined;
16067
16161
  couponNote?: string | null | undefined;
16162
+ showCustomsNotice?: boolean | null | undefined;
16163
+ customsNotice?: string | null | undefined;
16068
16164
  fontFamily?: "default" | "roboto" | "poppins" | "inter" | "merriweather" | "montserrat" | "nunito" | "inconsolata" | "ibmPlexSans" | "cardo" | "spaceMono" | "buenard" | "titanOne" | "bartok" | "robotoSlab" | "playwritePl" | "jetBrainsMono" | null | undefined;
16069
16165
  colors?: {
16070
16166
  buttonBackground?: string | null | undefined;
@@ -16570,6 +16666,7 @@ type APIVariantUpdateBody = {
16570
16666
  value: string;
16571
16667
  checked?: boolean | null;
16572
16668
  }>;
16669
+ metafields?: APIMetafieldValueInput[];
16573
16670
  };
16574
16671
  type APIVariantUpdateResult = {
16575
16672
  id: string;
@@ -16596,6 +16693,7 @@ type APIVariantCreateBody = {
16596
16693
  value: string;
16597
16694
  checked?: boolean | null;
16598
16695
  }>;
16696
+ metafields?: APIMetafieldValueInput[];
16599
16697
  };
16600
16698
  type APIVariantCreateResult = {
16601
16699
  id: string;
@@ -16651,6 +16749,7 @@ type APIProductCreateBody = {
16651
16749
  images?: string[];
16652
16750
  category?: string;
16653
16751
  quantity?: number;
16752
+ metafields?: APIMetafieldValueInput[];
16654
16753
  variants?: Array<{
16655
16754
  options: Record<string, string>;
16656
16755
  sku?: string;
@@ -16670,6 +16769,7 @@ type APIProductCreateBody = {
16670
16769
  value: string;
16671
16770
  checked?: boolean | null;
16672
16771
  }>;
16772
+ metafields?: APIMetafieldValueInput[];
16673
16773
  }>;
16674
16774
  };
16675
16775
  type APIProductCreateResult = {
@@ -16695,6 +16795,7 @@ type APIProductUpdateBody = {
16695
16795
  content?: Record<string, unknown>;
16696
16796
  images?: string[];
16697
16797
  status?: "active" | "draft";
16798
+ metafields?: APIMetafieldValueInput[];
16698
16799
  };
16699
16800
  type APIProductUpdateQueryParams = {
16700
16801
  lang?: string;
@@ -16881,6 +16982,20 @@ type APICollectionCreateBody = {
16881
16982
  slug?: string | undefined;
16882
16983
  description?: string | undefined;
16883
16984
  image?: string | undefined;
16985
+ metafieldRules?: ({
16986
+ field: string;
16987
+ op: "range";
16988
+ min?: string | undefined;
16989
+ max?: string | undefined;
16990
+ } | {
16991
+ field: string;
16992
+ op: "in";
16993
+ values: string[];
16994
+ } | {
16995
+ field: string;
16996
+ op: "is";
16997
+ value: boolean;
16998
+ })[] | null | undefined;
16884
16999
  group?: string | undefined;
16885
17000
  };
16886
17001
  type APICollectionCreateResult = {
@@ -16892,6 +17007,20 @@ type APICollectionCreateResult = {
16892
17007
  slug: string;
16893
17008
  active: boolean;
16894
17009
  description: JSONContent | null;
17010
+ metafieldRules: ({
17011
+ field: string;
17012
+ op: "range";
17013
+ min?: string | undefined;
17014
+ max?: string | undefined;
17015
+ } | {
17016
+ field: string;
17017
+ op: "in";
17018
+ values: string[];
17019
+ } | {
17020
+ field: string;
17021
+ op: "is";
17022
+ value: boolean;
17023
+ })[] | null;
16895
17024
  group: string | null;
16896
17025
  productCollections: {
16897
17026
  productId: string;
@@ -16922,6 +17051,20 @@ type APICollectionUpdateBody = {
16922
17051
  type: "newest";
16923
17052
  days?: number | null | undefined;
16924
17053
  } | undefined;
17054
+ metafieldRules?: ({
17055
+ field: string;
17056
+ op: "range";
17057
+ min?: string | undefined;
17058
+ max?: string | undefined;
17059
+ } | {
17060
+ field: string;
17061
+ op: "in";
17062
+ values: string[];
17063
+ } | {
17064
+ field: string;
17065
+ op: "is";
17066
+ value: boolean;
17067
+ })[] | null | undefined;
16925
17068
  active?: boolean | undefined;
16926
17069
  group?: string | null | undefined;
16927
17070
  };
@@ -16955,6 +17098,20 @@ type APICollectionUpdateResult = {
16955
17098
  type: "newest";
16956
17099
  days?: number | null | undefined;
16957
17100
  };
17101
+ metafieldRules: ({
17102
+ field: string;
17103
+ op: "range";
17104
+ min?: string | undefined;
17105
+ max?: string | undefined;
17106
+ } | {
17107
+ field: string;
17108
+ op: "in";
17109
+ values: string[];
17110
+ } | {
17111
+ field: string;
17112
+ op: "is";
17113
+ value: boolean;
17114
+ })[] | null;
16958
17115
  group: string | null;
16959
17116
  productCollections: {
16960
17117
  position: string | null;
@@ -17642,5 +17799,372 @@ type APIProductBatchResult = {
17642
17799
  type APICartDeleteResult = {
17643
17800
  success: boolean;
17644
17801
  };
17802
+ type APIMetafieldValueInput = {
17803
+ key: string;
17804
+ namespace?: string | undefined;
17805
+ value?: unknown;
17806
+ hidden?: boolean | undefined;
17807
+ position?: number | undefined;
17808
+ };
17809
+ type APIMetafieldDefinition = {
17810
+ id: string;
17811
+ ownerType: "variant" | "product";
17812
+ namespace: string;
17813
+ key: string;
17814
+ name: string;
17815
+ description: string | null;
17816
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
17817
+ translatable: boolean;
17818
+ storefrontVisible: boolean;
17819
+ filterable: boolean;
17820
+ position: number;
17821
+ options?: {
17822
+ key: string;
17823
+ label: string;
17824
+ archived?: true;
17825
+ }[] | undefined;
17826
+ measurementKind?: "length" | "weight" | "volume" | undefined;
17827
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17828
+ validations?: {
17829
+ min?: string | undefined;
17830
+ max?: string | undefined;
17831
+ maxLength?: number | undefined;
17832
+ maxItems?: number | undefined;
17833
+ } | undefined;
17834
+ archivedAt: string | null;
17835
+ usage?: {
17836
+ values: number;
17837
+ translations?: number;
17838
+ } | undefined;
17839
+ };
17840
+ type APIMetafieldDefinitionParams = {
17841
+ idOrKey: string;
17842
+ };
17843
+ type APIMetafieldDefinitionsBrowseQueryParams = {
17844
+ ownerType?: "variant" | "product" | undefined;
17845
+ includeArchived?: "true" | "false" | undefined;
17846
+ lang?: string | undefined;
17847
+ metafields?: "all" | "public" | undefined;
17848
+ };
17849
+ type APIMetafieldDefinitionsBrowseResult = {
17850
+ data: APIMetafieldDefinition[];
17851
+ meta: {
17852
+ count: number;
17853
+ };
17854
+ };
17855
+ type APIMetafieldDefinitionGetQueryParams = {
17856
+ lang?: string | undefined;
17857
+ metafields?: "all" | "public" | undefined;
17858
+ };
17859
+ type APIMetafieldDefinitionGetResult = {
17860
+ id: string;
17861
+ ownerType: "variant" | "product";
17862
+ namespace: string;
17863
+ key: string;
17864
+ name: string;
17865
+ description: string | null;
17866
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
17867
+ translatable: boolean;
17868
+ storefrontVisible: boolean;
17869
+ filterable: boolean;
17870
+ position: number;
17871
+ options?: {
17872
+ key: string;
17873
+ label: string;
17874
+ archived?: true;
17875
+ }[] | undefined;
17876
+ measurementKind?: "length" | "weight" | "volume" | undefined;
17877
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17878
+ validations?: {
17879
+ min?: string | undefined;
17880
+ max?: string | undefined;
17881
+ maxLength?: number | undefined;
17882
+ maxItems?: number | undefined;
17883
+ } | undefined;
17884
+ archivedAt: string | null;
17885
+ usage?: {
17886
+ values: number;
17887
+ translations?: number;
17888
+ } | undefined;
17889
+ };
17890
+ type APIMetafieldDefinitionCreateBody = {
17891
+ ownerType: "variant" | "product";
17892
+ name: string;
17893
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
17894
+ namespace?: string | undefined;
17895
+ key?: string | undefined;
17896
+ description?: string | null | undefined;
17897
+ translatable?: boolean | undefined;
17898
+ storefrontVisible?: boolean | undefined;
17899
+ filterable?: boolean | undefined;
17900
+ position?: number | undefined;
17901
+ options?: {
17902
+ label: string;
17903
+ key?: string | undefined;
17904
+ archived?: boolean | undefined;
17905
+ }[] | undefined;
17906
+ measurementKind?: "length" | "weight" | "volume" | undefined;
17907
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17908
+ validations?: {
17909
+ min?: string | undefined;
17910
+ max?: string | undefined;
17911
+ maxLength?: number | undefined;
17912
+ maxItems?: number | undefined;
17913
+ } | undefined;
17914
+ };
17915
+ type APIMetafieldDefinitionCreateResult = {
17916
+ id: string;
17917
+ ownerType: "variant" | "product";
17918
+ namespace: string;
17919
+ key: string;
17920
+ name: string;
17921
+ description: string | null;
17922
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
17923
+ translatable: boolean;
17924
+ storefrontVisible: boolean;
17925
+ filterable: boolean;
17926
+ position: number;
17927
+ options?: {
17928
+ key: string;
17929
+ label: string;
17930
+ archived?: true;
17931
+ }[] | undefined;
17932
+ measurementKind?: "length" | "weight" | "volume" | undefined;
17933
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17934
+ validations?: {
17935
+ min?: string | undefined;
17936
+ max?: string | undefined;
17937
+ maxLength?: number | undefined;
17938
+ maxItems?: number | undefined;
17939
+ } | undefined;
17940
+ archivedAt: string | null;
17941
+ usage?: {
17942
+ values: number;
17943
+ translations?: number;
17944
+ } | undefined;
17945
+ };
17946
+ type APIMetafieldDefinitionUpdateBody = {
17947
+ name?: string | undefined;
17948
+ description?: string | null | undefined;
17949
+ translatable?: boolean | undefined;
17950
+ storefrontVisible?: boolean | undefined;
17951
+ filterable?: boolean | undefined;
17952
+ position?: number | undefined;
17953
+ options?: {
17954
+ label: string;
17955
+ key?: string | undefined;
17956
+ archived?: boolean | undefined;
17957
+ }[] | undefined;
17958
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17959
+ validations?: {
17960
+ min?: string | undefined;
17961
+ max?: string | undefined;
17962
+ maxLength?: number | undefined;
17963
+ maxItems?: number | undefined;
17964
+ } | undefined;
17965
+ };
17966
+ type APIMetafieldDefinitionUpdateResult = {
17967
+ id: string;
17968
+ ownerType: "variant" | "product";
17969
+ namespace: string;
17970
+ key: string;
17971
+ name: string;
17972
+ description: string | null;
17973
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
17974
+ translatable: boolean;
17975
+ storefrontVisible: boolean;
17976
+ filterable: boolean;
17977
+ position: number;
17978
+ options?: {
17979
+ key: string;
17980
+ label: string;
17981
+ archived?: true;
17982
+ }[] | undefined;
17983
+ measurementKind?: "length" | "weight" | "volume" | undefined;
17984
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
17985
+ validations?: {
17986
+ min?: string | undefined;
17987
+ max?: string | undefined;
17988
+ maxLength?: number | undefined;
17989
+ maxItems?: number | undefined;
17990
+ } | undefined;
17991
+ archivedAt: string | null;
17992
+ usage?: {
17993
+ values: number;
17994
+ translations?: number;
17995
+ } | undefined;
17996
+ };
17997
+ type APIMetafieldDefinitionArchiveResult = {
17998
+ id: string;
17999
+ ownerType: "variant" | "product";
18000
+ namespace: string;
18001
+ key: string;
18002
+ name: string;
18003
+ description: string | null;
18004
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
18005
+ translatable: boolean;
18006
+ storefrontVisible: boolean;
18007
+ filterable: boolean;
18008
+ position: number;
18009
+ options?: {
18010
+ key: string;
18011
+ label: string;
18012
+ archived?: true;
18013
+ }[] | undefined;
18014
+ measurementKind?: "length" | "weight" | "volume" | undefined;
18015
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
18016
+ validations?: {
18017
+ min?: string | undefined;
18018
+ max?: string | undefined;
18019
+ maxLength?: number | undefined;
18020
+ maxItems?: number | undefined;
18021
+ } | undefined;
18022
+ archivedAt: string | null;
18023
+ usage?: {
18024
+ values: number;
18025
+ translations?: number;
18026
+ } | undefined;
18027
+ };
18028
+ type APIMetafieldDefinitionRestoreResult = {
18029
+ id: string;
18030
+ ownerType: "variant" | "product";
18031
+ namespace: string;
18032
+ key: string;
18033
+ name: string;
18034
+ description: string | null;
18035
+ type: "boolean" | "date" | "integer" | "decimal" | "url" | "color" | "single_line_text" | "multi_line_text" | "rich_text" | "date_time" | "measurement" | "choice" | "list_single_line_text" | "list_choice";
18036
+ translatable: boolean;
18037
+ storefrontVisible: boolean;
18038
+ filterable: boolean;
18039
+ position: number;
18040
+ options?: {
18041
+ key: string;
18042
+ label: string;
18043
+ archived?: true;
18044
+ }[] | undefined;
18045
+ measurementKind?: "length" | "weight" | "volume" | undefined;
18046
+ unit?: "in" | "mm" | "cm" | "m" | "ft" | "mg" | "g" | "kg" | "oz" | "lb" | "ml" | "cl" | "l" | "fl_oz" | undefined;
18047
+ validations?: {
18048
+ min?: string | undefined;
18049
+ max?: string | undefined;
18050
+ maxLength?: number | undefined;
18051
+ maxItems?: number | undefined;
18052
+ } | undefined;
18053
+ archivedAt: string | null;
18054
+ usage?: {
18055
+ values: number;
18056
+ translations?: number;
18057
+ } | undefined;
18058
+ } & {
18059
+ filterSwitchedOff: boolean;
18060
+ };
18061
+ type APIMetafieldDefinitionDeleteBody = {
18062
+ confirm: string;
18063
+ expectedValueCount: number;
18064
+ };
18065
+ type APIMetafieldDefinitionDeleteResult = {
18066
+ ok: true;
18067
+ id: string;
18068
+ field: string;
18069
+ deleted: {
18070
+ values: number;
18071
+ translations: number;
18072
+ };
18073
+ };
18074
+ type APIMetafieldDefinitionConversionPreviewResult = {
18075
+ definition: APIMetafieldDefinition;
18076
+ targetType: "choice" | "list_choice";
18077
+ distinct: Array<{
18078
+ value: string;
18079
+ count: number;
18080
+ }>;
18081
+ suggestedGroups: Array<{
18082
+ label: string;
18083
+ members: string[];
18084
+ }>;
18085
+ overLimit: boolean;
18086
+ planHash: string;
18087
+ };
18088
+ type APIMetafieldDefinitionConvertBody = {
18089
+ groups: {
18090
+ label: string;
18091
+ members: string[];
18092
+ }[];
18093
+ planHash: string;
18094
+ };
18095
+ type APIMetafieldDefinitionConvertResult = {
18096
+ definition: APIMetafieldDefinition;
18097
+ converted: number;
18098
+ };
18099
+ type APIMetafieldDefinitionTranslationParams = {
18100
+ idOrKey: string;
18101
+ locale: string;
18102
+ };
18103
+ type APIMetafieldDefinitionTranslationPutBody = {
18104
+ name?: string | null | undefined;
18105
+ description?: string | null | undefined;
18106
+ optionLabels?: Record<string, string> | null | undefined;
18107
+ };
18108
+ type APIMetafieldDefinitionTranslationPutResult = {
18109
+ ok: true;
18110
+ definitionId: string;
18111
+ locale: string;
18112
+ deleted: boolean;
18113
+ };
18114
+ type APIMetafieldTranslationsPutBody = {
18115
+ values: {
18116
+ key: string;
18117
+ value: unknown;
18118
+ namespace?: string | undefined;
18119
+ }[];
18120
+ origin?: "human" | "machine" | undefined;
18121
+ };
18122
+ type APIProductMetafieldTranslationsPutParams = {
18123
+ idOrSlug: string;
18124
+ locale: string;
18125
+ };
18126
+ type APIProductMetafieldTranslationsPutResult = {
18127
+ ok: true;
18128
+ productId: string;
18129
+ locale: string;
18130
+ written: number;
18131
+ deleted: number;
18132
+ skipped: number;
18133
+ };
18134
+ type APIVariantMetafieldTranslationsPutParams = {
18135
+ idOrSku: string;
18136
+ locale: string;
18137
+ };
18138
+ type APIVariantMetafieldTranslationsPutResult = {
18139
+ ok: true;
18140
+ variantId: string;
18141
+ productId: string;
18142
+ locale: string;
18143
+ written: number;
18144
+ deleted: number;
18145
+ skipped: number;
18146
+ };
18147
+ type APIMetafieldsTranslateMissingBody = {
18148
+ locales?: ("en-US" | "fr-FR" | "it-IT" | "vi-VN" | "pl-PL" | "es-ES" | "de-DE")[] | undefined;
18149
+ productIds?: string[] | undefined;
18150
+ };
18151
+ type APIMetafieldsTranslateMissingResult = {
18152
+ locales: string[];
18153
+ written: {
18154
+ ownerType: "variant" | "product";
18155
+ ownerId: string;
18156
+ namespace: string;
18157
+ key: string;
18158
+ locale: "en-US" | "fr-FR" | "it-IT" | "vi-VN" | "pl-PL" | "es-ES" | "de-DE";
18159
+ value: unknown;
18160
+ }[];
18161
+ skipped: number;
18162
+ failed: number;
18163
+ } | {
18164
+ runId: string | null;
18165
+ locales: string[];
18166
+ counts: Partial<Record<string, number>>;
18167
+ total: number;
18168
+ };
17645
18169
 
17646
- export type { APIBlogCategoriesBrowseQueryParams, APIBlogCategoriesBrowseResult, APIBlogCategoryCreateBody, APIBlogCategoryCreateResult, APIBlogCategoryDeleteResult, APIBlogCategoryGetByIdParams, APIBlogCategoryGetByIdResult, APIBlogCategoryUpdateBody, APIBlogCategoryUpdateResult, APIBrandAssignProductsBody, APIBrandAssignProductsResult, APIBrandCreateBody, APIBrandCreateResult, APIBrandDeleteResult, APIBrandGetByIdParams, APIBrandGetByIdResult, APIBrandUpdateBody, APIBrandUpdateResult, APIBrandsBrowseQueryParams, APIBrandsBrowseResult, APICartAddBody, APICartAddResult, APICartCouponApplyBody, APICartCouponApplyResult, APICartCouponRemoveResult, APICartCreateBody, APICartCreateResult, APICartDeleteResult, APICartGetResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoriesBrowseQueryParams, APICategoriesBrowseResult, APICategoryCreateBody, APICategoryCreateResult, APICategoryDeleteResult, APICategoryGetByIdParams, APICategoryGetByIdQueryParams, APICategoryGetByIdResult, APICategoryUpdateBody, APICategoryUpdateQueryParams, APICategoryUpdateResult, APICollectionCreateBody, APICollectionCreateResult, APICollectionDeleteResult, APICollectionGetByIdParams, APICollectionGetByIdQueryParams, APICollectionGetByIdResult, APICollectionUpdateBody, APICollectionUpdateResult, APICollectionsBrowseQueryParams, APICollectionsBrowseResult, APIContactMessageCreateBody, APIContactMessageCreateResult, APICouponCreateBody, APICouponCreateResult, APICouponDeleteResult, APICouponGetByIdParams, APICouponGetByIdResult, APICouponUpdateBody, APICouponUpdateResult, APICouponsBrowseQueryParams, APICouponsBrowseResult, APICustomerAddressCreateBody, APICustomerAddressCreateResult, APICustomerGetByIdParams, APICustomerGetByIdResult, APICustomerOrdersBrowseQueryParams, APICustomerOrdersBrowseResult, APICustomerUpdateBody, APICustomerUpdateResult, APICustomersBrowseQueryParams, APICustomersBrowseResult, APIEventAttendeesBrowseResult, APIEventCreateBody, APIEventCreateResult, APIEventGetByIdParams, APIEventGetByIdResult, APIEventUpdateBody, APIEventUpdateResult, APIEventsBrowseQueryParams, APIEventsBrowseResult, APIInstaviewImagesBrowseParams, APIInstaviewImagesBrowseQueryParams, APIInstaviewImagesBrowseResult, APIInventoryAdjustBody, APIInventoryAdjustResult, APIInventoryBrowseQueryParams, APIInventoryBrowseResult, APILegalPageCreateBody, APILegalPageCreateQueryParams, APILegalPageCreateResult, APILegalPageGetByPathParams, APILegalPageGetByPathQueryParams, APILegalPageGetByPathResult, APILegalPageUpdateBody, APILegalPageUpdateQueryParams, APILegalPageUpdateResult, APILegalPagesBrowseQueryParams, APILegalPagesBrowseResult, APIMeGetResult, APIMeStore, APIOrderGetByIdParams, APIOrderGetByIdResult, APIOrderRefundGetParams, APIOrderRefundGetResult, APIOrderRefundsBrowseQueryParams, APIOrderRefundsBrowseResult, APIOrderRefundsParams, APIOrderUpdateBody, APIOrderUpdateResult, APIOrdersBrowseQueryParams, APIOrdersBrowseResult, APIPostCommentCreateBody, APIPostCommentCreateResult, APIPostCommentsBrowseQueryParams, APIPostCommentsBrowseResult, APIPostCreateBody, APIPostCreateResult, APIPostDeleteResult, APIPostGetByIdParams, APIPostGetByIdResult, APIPostUpdateBody, APIPostUpdateResult, APIPostsBrowseQueryParams, APIPostsBrowseResult, APIProductBatchBody, APIProductBatchResult, APIProductCreateBody, APIProductCreateResult, APIProductDeleteQueryParams, APIProductDeleteResult, APIProductFiltersResult, APIProductGetByIdParams, APIProductGetByIdQueryParams, APIProductGetByIdResult, APIProductReviewCreateBody, APIProductReviewCreateResult, APIProductReviewsBrowseQueryParams, APIProductReviewsBrowseResult, APIProductUpdateBody, APIProductUpdateQueryParams, APIProductUpdateResult, APIProductsBrowseQueryParams, APIProductsBrowseResult, APISearchQueryParams, APISearchResult, APIShipment, APISocialsGetResult, APISubscriberCreateBody, APISubscriberCreateResult, APISubscriberDeleteResult, APISupportCase, APISupportCaseCreateBody, APISupportCaseCreateResult, APISupportCaseGetParams, APISupportCaseGetResult, APISupportCaseMessage, APISupportCaseMessageCreateBody, APISupportCaseMessageCreateResult, APISupportCaseUpdateBody, APISupportCaseUpdateResult, APISupportCasesBrowseQueryParams, APISupportCasesBrowseResult, APITicketAttendeeGetParams, APITicketAttendeeGetResult, APITicketsGetParams, APITicketsGetQueryParams, APITicketsGetResult, APITicketsUpdateBody, APITicketsUpdateResult, APIVariantCreateBody, APIVariantCreateResult, APIVariantGetByIdParams, APIVariantGetByIdQueryParams, APIVariantGetByIdResult, APIVariantUpdateBody, APIVariantUpdateResult, JSONContent };
18170
+ export type { APIBlogCategoriesBrowseQueryParams, APIBlogCategoriesBrowseResult, APIBlogCategoryCreateBody, APIBlogCategoryCreateResult, APIBlogCategoryDeleteResult, APIBlogCategoryGetByIdParams, APIBlogCategoryGetByIdResult, APIBlogCategoryUpdateBody, APIBlogCategoryUpdateResult, APIBrandAssignProductsBody, APIBrandAssignProductsResult, APIBrandCreateBody, APIBrandCreateResult, APIBrandDeleteResult, APIBrandGetByIdParams, APIBrandGetByIdResult, APIBrandUpdateBody, APIBrandUpdateResult, APIBrandsBrowseQueryParams, APIBrandsBrowseResult, APICartAddBody, APICartAddResult, APICartCouponApplyBody, APICartCouponApplyResult, APICartCouponRemoveResult, APICartCreateBody, APICartCreateResult, APICartDeleteResult, APICartGetResult, APICartRemoveItemQueryParams, APICartRemoveItemResult, APICategoriesBrowseQueryParams, APICategoriesBrowseResult, APICategoryCreateBody, APICategoryCreateResult, APICategoryDeleteResult, APICategoryGetByIdParams, APICategoryGetByIdQueryParams, APICategoryGetByIdResult, APICategoryUpdateBody, APICategoryUpdateQueryParams, APICategoryUpdateResult, APICollectionCreateBody, APICollectionCreateResult, APICollectionDeleteResult, APICollectionGetByIdParams, APICollectionGetByIdQueryParams, APICollectionGetByIdResult, APICollectionUpdateBody, APICollectionUpdateResult, APICollectionsBrowseQueryParams, APICollectionsBrowseResult, APIContactMessageCreateBody, APIContactMessageCreateResult, APICouponCreateBody, APICouponCreateResult, APICouponDeleteResult, APICouponGetByIdParams, APICouponGetByIdResult, APICouponUpdateBody, APICouponUpdateResult, APICouponsBrowseQueryParams, APICouponsBrowseResult, APICustomerAddressCreateBody, APICustomerAddressCreateResult, APICustomerGetByIdParams, APICustomerGetByIdResult, APICustomerOrdersBrowseQueryParams, APICustomerOrdersBrowseResult, APICustomerUpdateBody, APICustomerUpdateResult, APICustomersBrowseQueryParams, APICustomersBrowseResult, APIEventAttendeesBrowseResult, APIEventCreateBody, APIEventCreateResult, APIEventGetByIdParams, APIEventGetByIdResult, APIEventUpdateBody, APIEventUpdateResult, APIEventsBrowseQueryParams, APIEventsBrowseResult, APIInstaviewImagesBrowseParams, APIInstaviewImagesBrowseQueryParams, APIInstaviewImagesBrowseResult, APIInventoryAdjustBody, APIInventoryAdjustResult, APIInventoryBrowseQueryParams, APIInventoryBrowseResult, APILegalPageCreateBody, APILegalPageCreateQueryParams, APILegalPageCreateResult, APILegalPageGetByPathParams, APILegalPageGetByPathQueryParams, APILegalPageGetByPathResult, APILegalPageUpdateBody, APILegalPageUpdateQueryParams, APILegalPageUpdateResult, APILegalPagesBrowseQueryParams, APILegalPagesBrowseResult, APIMeGetResult, APIMeStore, APIMetafieldDefinition, APIMetafieldDefinitionArchiveResult, APIMetafieldDefinitionConversionPreviewResult, APIMetafieldDefinitionConvertBody, APIMetafieldDefinitionConvertResult, APIMetafieldDefinitionCreateBody, APIMetafieldDefinitionCreateResult, APIMetafieldDefinitionDeleteBody, APIMetafieldDefinitionDeleteResult, APIMetafieldDefinitionGetQueryParams, APIMetafieldDefinitionGetResult, APIMetafieldDefinitionParams, APIMetafieldDefinitionRestoreResult, APIMetafieldDefinitionTranslationParams, APIMetafieldDefinitionTranslationPutBody, APIMetafieldDefinitionTranslationPutResult, APIMetafieldDefinitionUpdateBody, APIMetafieldDefinitionUpdateResult, APIMetafieldDefinitionsBrowseQueryParams, APIMetafieldDefinitionsBrowseResult, APIMetafieldTranslationsPutBody, APIMetafieldValueInput, APIMetafieldsTranslateMissingBody, APIMetafieldsTranslateMissingResult, APIOrderGetByIdParams, APIOrderGetByIdResult, APIOrderRefundGetParams, APIOrderRefundGetResult, APIOrderRefundsBrowseQueryParams, APIOrderRefundsBrowseResult, APIOrderRefundsParams, APIOrderUpdateBody, APIOrderUpdateResult, APIOrdersBrowseQueryParams, APIOrdersBrowseResult, APIPostCommentCreateBody, APIPostCommentCreateResult, APIPostCommentsBrowseQueryParams, APIPostCommentsBrowseResult, APIPostCreateBody, APIPostCreateResult, APIPostDeleteResult, APIPostGetByIdParams, APIPostGetByIdResult, APIPostUpdateBody, APIPostUpdateResult, APIPostsBrowseQueryParams, APIPostsBrowseResult, APIProductBatchBody, APIProductBatchResult, APIProductCreateBody, APIProductCreateResult, APIProductDeleteQueryParams, APIProductDeleteResult, APIProductFiltersQueryParams, APIProductFiltersResult, APIProductGetByIdParams, APIProductGetByIdQueryParams, APIProductGetByIdResult, APIProductMetafieldTranslationsPutParams, APIProductMetafieldTranslationsPutResult, APIProductReviewCreateBody, APIProductReviewCreateResult, APIProductReviewsBrowseQueryParams, APIProductReviewsBrowseResult, APIProductUpdateBody, APIProductUpdateQueryParams, APIProductUpdateResult, APIProductsBrowseQueryParams, APIProductsBrowseResult, APISearchQueryParams, APISearchResult, APIShipment, APISocialsGetResult, APISubscriberCreateBody, APISubscriberCreateResult, APISubscriberDeleteResult, APISupportCase, APISupportCaseCreateBody, APISupportCaseCreateResult, APISupportCaseGetParams, APISupportCaseGetResult, APISupportCaseMessage, APISupportCaseMessageCreateBody, APISupportCaseMessageCreateResult, APISupportCaseUpdateBody, APISupportCaseUpdateResult, APISupportCasesBrowseQueryParams, APISupportCasesBrowseResult, APITicketAttendeeGetParams, APITicketAttendeeGetResult, APITicketsGetParams, APITicketsGetQueryParams, APITicketsGetResult, APITicketsUpdateBody, APITicketsUpdateResult, APIVariantCreateBody, APIVariantCreateResult, APIVariantGetByIdParams, APIVariantGetByIdQueryParams, APIVariantGetByIdResult, APIVariantMetafieldTranslationsPutParams, APIVariantMetafieldTranslationsPutResult, APIVariantUpdateBody, APIVariantUpdateResult, JSONContent };