commerce-kit 0.59.0 → 0.60.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.
Files changed (2) hide show
  1. package/dist/api-types.d.ts +3237 -617
  2. package/package.json +1 -1
@@ -21,6 +21,8 @@ type APIProductsBrowseResult = Omit<{
21
21
  summary: string | null;
22
22
  images: string[];
23
23
  badge: unknown;
24
+ subscriptionMode: "optional" | "only" | "rolling";
25
+ subscriptionAddonDiscountPercent: number | null;
24
26
  bundleDiscountPercentage: string | null;
25
27
  bundlePriceMode: "fixed" | "amount" | "percent";
26
28
  bundleFixedPriceAmount: string | null;
@@ -290,6 +292,8 @@ type APIProductsBrowseResult = Omit<{
290
292
  summary: string | null;
291
293
  images: string[];
292
294
  badge: unknown;
295
+ subscriptionMode: "optional" | "only" | "rolling";
296
+ subscriptionAddonDiscountPercent: number | null;
293
297
  bundleDiscountPercentage: string | null;
294
298
  bundlePriceMode: "fixed" | "amount" | "percent";
295
299
  bundleFixedPriceAmount: string | null;
@@ -559,6 +563,8 @@ type APIProductsBrowseResult = Omit<{
559
563
  summary: string | null;
560
564
  images: string[];
561
565
  badge: unknown;
566
+ subscriptionMode: "optional" | "only" | "rolling";
567
+ subscriptionAddonDiscountPercent: number | null;
562
568
  bundleDiscountPercentage: string | null;
563
569
  bundlePriceMode: "fixed" | "amount" | "percent";
564
570
  bundleFixedPriceAmount: string | null;
@@ -828,6 +834,8 @@ type APIProductsBrowseResult = Omit<{
828
834
  summary: string | null;
829
835
  images: string[];
830
836
  badge: unknown;
837
+ subscriptionMode: "optional" | "only" | "rolling";
838
+ subscriptionAddonDiscountPercent: number | null;
831
839
  bundleDiscountPercentage: string | null;
832
840
  bundlePriceMode: "fixed" | "amount" | "percent";
833
841
  bundleFixedPriceAmount: string | null;
@@ -1099,6 +1107,8 @@ type APIProductsBrowseResult = Omit<{
1099
1107
  summary: string | null;
1100
1108
  images: string[];
1101
1109
  badge: unknown;
1110
+ subscriptionMode: "optional" | "only" | "rolling";
1111
+ subscriptionAddonDiscountPercent: number | null;
1102
1112
  bundleDiscountPercentage: string | null;
1103
1113
  bundlePriceMode: "fixed" | "amount" | "percent";
1104
1114
  bundleFixedPriceAmount: string | null;
@@ -1377,6 +1387,8 @@ type APIProductsBrowseResult = Omit<{
1377
1387
  summary: string | null;
1378
1388
  images: string[];
1379
1389
  badge: unknown;
1390
+ subscriptionMode: "optional" | "only" | "rolling";
1391
+ subscriptionAddonDiscountPercent: number | null;
1380
1392
  bundleDiscountPercentage: string | null;
1381
1393
  bundlePriceMode: "fixed" | "amount" | "percent";
1382
1394
  bundleFixedPriceAmount: string | null;
@@ -2772,6 +2784,8 @@ type APIProductGetByIdResult = {
2772
2784
  summary: string | null;
2773
2785
  images: string[];
2774
2786
  badge: unknown;
2787
+ subscriptionMode: "optional" | "only" | "rolling";
2788
+ subscriptionAddonDiscountPercent: number | null;
2775
2789
  bundleDiscountPercentage: string | null;
2776
2790
  bundlePriceMode: "fixed" | "amount" | "percent";
2777
2791
  bundleFixedPriceAmount: string | null;
@@ -3750,25 +3764,111 @@ type APIProductGetByIdResult = {
3750
3764
  fixedQuantity: number;
3751
3765
  maxQuantity: number | null;
3752
3766
  variant: {
3753
- id: string;
3754
- price: string;
3755
- sku: string | null;
3756
- stock: number | null;
3757
- images: string[];
3758
- productName: string;
3759
- productSlug: string;
3760
- productImages: string[];
3761
- productStatus: "published" | "draft" | "hidden";
3762
- sellable: boolean;
3763
- options: {
3764
- type: string;
3765
- value: string;
3766
- colorValue: string | null;
3767
- }[];
3767
+ [K in keyof {
3768
+ id: string;
3769
+ price: string;
3770
+ sku: string | null;
3771
+ stock: number | null;
3772
+ images: string[];
3773
+ productName: string;
3774
+ productSlug: string;
3775
+ productImages: string[];
3776
+ taxRate: {
3777
+ id: string;
3778
+ name: string;
3779
+ rate: number;
3780
+ label: string | null;
3781
+ } | null;
3782
+ productStatus: "published" | "draft" | "hidden";
3783
+ sellable: boolean;
3784
+ options: {
3785
+ type: string;
3786
+ value: string;
3787
+ colorValue: string | null;
3788
+ }[];
3789
+ }]: K extends "prices" ? Array<({
3790
+ id: string;
3791
+ price: string;
3792
+ sku: string | null;
3793
+ stock: number | null;
3794
+ images: string[];
3795
+ productName: string;
3796
+ productSlug: string;
3797
+ productImages: string[];
3798
+ taxRate: {
3799
+ id: string;
3800
+ name: string;
3801
+ rate: number;
3802
+ label: string | null;
3803
+ } | null;
3804
+ productStatus: "published" | "draft" | "hidden";
3805
+ sellable: boolean;
3806
+ options: {
3807
+ type: string;
3808
+ value: string;
3809
+ colorValue: string | null;
3810
+ }[];
3811
+ }[K] extends readonly (infer TElement)[] ? TElement : never) & {
3812
+ /** `price` converted to gross with the owning product's tax rate. */
3813
+ priceGross: string;
3814
+ /** `calculatedPrice` converted to gross; null when there is no calculated price. */
3815
+ calculatedPriceGross: string | null;
3816
+ }> : {
3817
+ id: string;
3818
+ price: string;
3819
+ sku: string | null;
3820
+ stock: number | null;
3821
+ images: string[];
3822
+ productName: string;
3823
+ productSlug: string;
3824
+ productImages: string[];
3825
+ taxRate: {
3826
+ id: string;
3827
+ name: string;
3828
+ rate: number;
3829
+ label: string | null;
3830
+ } | null;
3831
+ productStatus: "published" | "draft" | "hidden";
3832
+ sellable: boolean;
3833
+ options: {
3834
+ type: string;
3835
+ value: string;
3836
+ colorValue: string | null;
3837
+ }[];
3838
+ }[K];
3839
+ } & {
3840
+ /** `price` (the effective net price) converted to gross with the product's tax rate. */
3841
+ priceGross: string;
3842
+ } & {
3843
+ [K in Extract<keyof {
3844
+ id: string;
3845
+ price: string;
3846
+ sku: string | null;
3847
+ stock: number | null;
3848
+ images: string[];
3849
+ productName: string;
3850
+ productSlug: string;
3851
+ productImages: string[];
3852
+ taxRate: {
3853
+ id: string;
3854
+ name: string;
3855
+ rate: number;
3856
+ label: string | null;
3857
+ } | null;
3858
+ productStatus: "published" | "draft" | "hidden";
3859
+ sellable: boolean;
3860
+ options: {
3861
+ type: string;
3862
+ value: string;
3863
+ colorValue: string | null;
3864
+ }[];
3865
+ }, "calculatedPrice" | "originalPrice" | "prePromotionPrice" | "omnibusPrice"> as `${K}Gross`]: string | null;
3768
3866
  };
3769
3867
  }[];
3770
3868
  }[];
3771
3869
  };
3870
+ bundleFixedPriceAmountGross: string | null;
3871
+ bundleAmountOffAmountGross: string | null;
3772
3872
  };
3773
3873
  type APIProductGetByIdParams = {
3774
3874
  idOrSlug: string;
@@ -4080,6 +4180,8 @@ type APICartGetResult = {
4080
4180
  summary: string | null;
4081
4181
  images: string[];
4082
4182
  badge: unknown;
4183
+ subscriptionMode: "optional" | "only" | "rolling";
4184
+ subscriptionAddonDiscountPercent: number | null;
4083
4185
  bundleDiscountPercentage: string | null;
4084
4186
  bundlePriceMode: "fixed" | "amount" | "percent";
4085
4187
  bundleFixedPriceAmount: string | null;
@@ -4316,6 +4418,8 @@ type APICartGetResult = {
4316
4418
  summary: string | null;
4317
4419
  images: string[];
4318
4420
  badge: unknown;
4421
+ subscriptionMode: "optional" | "only" | "rolling";
4422
+ subscriptionAddonDiscountPercent: number | null;
4319
4423
  bundleDiscountPercentage: string | null;
4320
4424
  bundlePriceMode: "fixed" | "amount" | "percent";
4321
4425
  bundleFixedPriceAmount: string | null;
@@ -4492,6 +4596,8 @@ type APICartGetResult = {
4492
4596
  summary: string | null;
4493
4597
  images: string[];
4494
4598
  badge: unknown;
4599
+ subscriptionMode: "optional" | "only" | "rolling";
4600
+ subscriptionAddonDiscountPercent: number | null;
4495
4601
  bundleDiscountPercentage: string | null;
4496
4602
  bundlePriceMode: "fixed" | "amount" | "percent";
4497
4603
  bundleFixedPriceAmount: string | null;
@@ -4673,6 +4779,8 @@ type APICartGetResult = {
4673
4779
  summary: string | null;
4674
4780
  images: string[];
4675
4781
  badge: unknown;
4782
+ subscriptionMode: "optional" | "only" | "rolling";
4783
+ subscriptionAddonDiscountPercent: number | null;
4676
4784
  bundleDiscountPercentage: string | null;
4677
4785
  bundlePriceMode: "fixed" | "amount" | "percent";
4678
4786
  bundleFixedPriceAmount: string | null;
@@ -4854,6 +4962,8 @@ type APICartGetResult = {
4854
4962
  summary: string | null;
4855
4963
  images: string[];
4856
4964
  badge: unknown;
4965
+ subscriptionMode: "optional" | "only" | "rolling";
4966
+ subscriptionAddonDiscountPercent: number | null;
4857
4967
  bundleDiscountPercentage: string | null;
4858
4968
  bundlePriceMode: "fixed" | "amount" | "percent";
4859
4969
  bundleFixedPriceAmount: string | null;
@@ -4983,6 +5093,8 @@ type APICartGetResult = {
4983
5093
  tax: number;
4984
5094
  ratePercent: number;
4985
5095
  }> | null;
5096
+ freeShippingThreshold: number | null;
5097
+ freeShippingUnlocked: boolean | null;
4986
5098
  };
4987
5099
  type APICartAddBody = unknown;
4988
5100
  type APICartAddResult = unknown;
@@ -5303,6 +5415,8 @@ type APICartCreateResult = {
5303
5415
  summary: string | null;
5304
5416
  images: string[];
5305
5417
  badge: unknown;
5418
+ subscriptionMode: "optional" | "only" | "rolling";
5419
+ subscriptionAddonDiscountPercent: number | null;
5306
5420
  bundleDiscountPercentage: string | null;
5307
5421
  bundlePriceMode: "fixed" | "amount" | "percent";
5308
5422
  bundleFixedPriceAmount: string | null;
@@ -5539,6 +5653,8 @@ type APICartCreateResult = {
5539
5653
  summary: string | null;
5540
5654
  images: string[];
5541
5655
  badge: unknown;
5656
+ subscriptionMode: "optional" | "only" | "rolling";
5657
+ subscriptionAddonDiscountPercent: number | null;
5542
5658
  bundleDiscountPercentage: string | null;
5543
5659
  bundlePriceMode: "fixed" | "amount" | "percent";
5544
5660
  bundleFixedPriceAmount: string | null;
@@ -5715,6 +5831,8 @@ type APICartCreateResult = {
5715
5831
  summary: string | null;
5716
5832
  images: string[];
5717
5833
  badge: unknown;
5834
+ subscriptionMode: "optional" | "only" | "rolling";
5835
+ subscriptionAddonDiscountPercent: number | null;
5718
5836
  bundleDiscountPercentage: string | null;
5719
5837
  bundlePriceMode: "fixed" | "amount" | "percent";
5720
5838
  bundleFixedPriceAmount: string | null;
@@ -5896,6 +6014,8 @@ type APICartCreateResult = {
5896
6014
  summary: string | null;
5897
6015
  images: string[];
5898
6016
  badge: unknown;
6017
+ subscriptionMode: "optional" | "only" | "rolling";
6018
+ subscriptionAddonDiscountPercent: number | null;
5899
6019
  bundleDiscountPercentage: string | null;
5900
6020
  bundlePriceMode: "fixed" | "amount" | "percent";
5901
6021
  bundleFixedPriceAmount: string | null;
@@ -6077,6 +6197,8 @@ type APICartCreateResult = {
6077
6197
  summary: string | null;
6078
6198
  images: string[];
6079
6199
  badge: unknown;
6200
+ subscriptionMode: "optional" | "only" | "rolling";
6201
+ subscriptionAddonDiscountPercent: number | null;
6080
6202
  bundleDiscountPercentage: string | null;
6081
6203
  bundlePriceMode: "fixed" | "amount" | "percent";
6082
6204
  bundleFixedPriceAmount: string | null;
@@ -6206,6 +6328,8 @@ type APICartCreateResult = {
6206
6328
  tax: number;
6207
6329
  ratePercent: number;
6208
6330
  }> | null;
6331
+ freeShippingThreshold: number | null;
6332
+ freeShippingUnlocked: boolean | null;
6209
6333
  } | null | undefined;
6210
6334
  type APICartRemoveItemResult = {
6211
6335
  id: string;
@@ -6510,6 +6634,8 @@ type APICartRemoveItemResult = {
6510
6634
  summary: string | null;
6511
6635
  images: string[];
6512
6636
  badge: unknown;
6637
+ subscriptionMode: "optional" | "only" | "rolling";
6638
+ subscriptionAddonDiscountPercent: number | null;
6513
6639
  bundleDiscountPercentage: string | null;
6514
6640
  bundlePriceMode: "fixed" | "amount" | "percent";
6515
6641
  bundleFixedPriceAmount: string | null;
@@ -6746,6 +6872,8 @@ type APICartRemoveItemResult = {
6746
6872
  summary: string | null;
6747
6873
  images: string[];
6748
6874
  badge: unknown;
6875
+ subscriptionMode: "optional" | "only" | "rolling";
6876
+ subscriptionAddonDiscountPercent: number | null;
6749
6877
  bundleDiscountPercentage: string | null;
6750
6878
  bundlePriceMode: "fixed" | "amount" | "percent";
6751
6879
  bundleFixedPriceAmount: string | null;
@@ -6922,6 +7050,8 @@ type APICartRemoveItemResult = {
6922
7050
  summary: string | null;
6923
7051
  images: string[];
6924
7052
  badge: unknown;
7053
+ subscriptionMode: "optional" | "only" | "rolling";
7054
+ subscriptionAddonDiscountPercent: number | null;
6925
7055
  bundleDiscountPercentage: string | null;
6926
7056
  bundlePriceMode: "fixed" | "amount" | "percent";
6927
7057
  bundleFixedPriceAmount: string | null;
@@ -7103,6 +7233,8 @@ type APICartRemoveItemResult = {
7103
7233
  summary: string | null;
7104
7234
  images: string[];
7105
7235
  badge: unknown;
7236
+ subscriptionMode: "optional" | "only" | "rolling";
7237
+ subscriptionAddonDiscountPercent: number | null;
7106
7238
  bundleDiscountPercentage: string | null;
7107
7239
  bundlePriceMode: "fixed" | "amount" | "percent";
7108
7240
  bundleFixedPriceAmount: string | null;
@@ -7284,6 +7416,8 @@ type APICartRemoveItemResult = {
7284
7416
  summary: string | null;
7285
7417
  images: string[];
7286
7418
  badge: unknown;
7419
+ subscriptionMode: "optional" | "only" | "rolling";
7420
+ subscriptionAddonDiscountPercent: number | null;
7287
7421
  bundleDiscountPercentage: string | null;
7288
7422
  bundlePriceMode: "fixed" | "amount" | "percent";
7289
7423
  bundleFixedPriceAmount: string | null;
@@ -7413,6 +7547,8 @@ type APICartRemoveItemResult = {
7413
7547
  tax: number;
7414
7548
  ratePercent: number;
7415
7549
  }> | null;
7550
+ freeShippingThreshold: number | null;
7551
+ freeShippingUnlocked: boolean | null;
7416
7552
  } | null | undefined;
7417
7553
  type APICartRemoveItemQueryParams = {
7418
7554
  subscriptionPlanId?: string | undefined;
@@ -7723,6 +7859,8 @@ type APICartCouponApplyResult = {
7723
7859
  summary: string | null;
7724
7860
  images: string[];
7725
7861
  badge: unknown;
7862
+ subscriptionMode: "optional" | "only" | "rolling";
7863
+ subscriptionAddonDiscountPercent: number | null;
7726
7864
  bundleDiscountPercentage: string | null;
7727
7865
  bundlePriceMode: "fixed" | "amount" | "percent";
7728
7866
  bundleFixedPriceAmount: string | null;
@@ -7959,6 +8097,8 @@ type APICartCouponApplyResult = {
7959
8097
  summary: string | null;
7960
8098
  images: string[];
7961
8099
  badge: unknown;
8100
+ subscriptionMode: "optional" | "only" | "rolling";
8101
+ subscriptionAddonDiscountPercent: number | null;
7962
8102
  bundleDiscountPercentage: string | null;
7963
8103
  bundlePriceMode: "fixed" | "amount" | "percent";
7964
8104
  bundleFixedPriceAmount: string | null;
@@ -8135,6 +8275,8 @@ type APICartCouponApplyResult = {
8135
8275
  summary: string | null;
8136
8276
  images: string[];
8137
8277
  badge: unknown;
8278
+ subscriptionMode: "optional" | "only" | "rolling";
8279
+ subscriptionAddonDiscountPercent: number | null;
8138
8280
  bundleDiscountPercentage: string | null;
8139
8281
  bundlePriceMode: "fixed" | "amount" | "percent";
8140
8282
  bundleFixedPriceAmount: string | null;
@@ -8316,6 +8458,8 @@ type APICartCouponApplyResult = {
8316
8458
  summary: string | null;
8317
8459
  images: string[];
8318
8460
  badge: unknown;
8461
+ subscriptionMode: "optional" | "only" | "rolling";
8462
+ subscriptionAddonDiscountPercent: number | null;
8319
8463
  bundleDiscountPercentage: string | null;
8320
8464
  bundlePriceMode: "fixed" | "amount" | "percent";
8321
8465
  bundleFixedPriceAmount: string | null;
@@ -8497,6 +8641,8 @@ type APICartCouponApplyResult = {
8497
8641
  summary: string | null;
8498
8642
  images: string[];
8499
8643
  badge: unknown;
8644
+ subscriptionMode: "optional" | "only" | "rolling";
8645
+ subscriptionAddonDiscountPercent: number | null;
8500
8646
  bundleDiscountPercentage: string | null;
8501
8647
  bundlePriceMode: "fixed" | "amount" | "percent";
8502
8648
  bundleFixedPriceAmount: string | null;
@@ -8626,6 +8772,8 @@ type APICartCouponApplyResult = {
8626
8772
  tax: number;
8627
8773
  ratePercent: number;
8628
8774
  }> | null;
8775
+ freeShippingThreshold: number | null;
8776
+ freeShippingUnlocked: boolean | null;
8629
8777
  } | null | undefined;
8630
8778
  type APICartCouponRemoveResult = {
8631
8779
  ok: boolean;
@@ -8995,6 +9143,8 @@ type APIOrdersBrowseResult = Omit<{
8995
9143
  } | null | undefined;
8996
9144
  } | null;
8997
9145
  type: "set" | "product" | "bundle";
9146
+ subscriptionMode: "optional" | "only" | "rolling";
9147
+ subscriptionAddonDiscountPercent: number | null;
8998
9148
  bundleDiscountPercentage: string | null;
8999
9149
  bundlePriceMode: "fixed" | "amount" | "percent";
9000
9150
  bundleFixedPriceAmount: string | null;
@@ -9153,6 +9303,25 @@ type APIOrdersBrowseResult = Omit<{
9153
9303
  storeId: string;
9154
9304
  updatedAt: string;
9155
9305
  } | null;
9306
+ rollingCycle: {
9307
+ id: string;
9308
+ title: string;
9309
+ startsAt: string;
9310
+ items: {
9311
+ productVariantId: string;
9312
+ productId: string;
9313
+ name: string;
9314
+ variantLabel: string | null;
9315
+ sku: string | null;
9316
+ image: string | null;
9317
+ quantity: number;
9318
+ }[];
9319
+ } | null;
9320
+ subscriptionAddon: {
9321
+ addonId: string;
9322
+ discountPercent: number;
9323
+ listPrice: string;
9324
+ } | null;
9156
9325
  slotId: string | null;
9157
9326
  attendees: {
9158
9327
  name: string;
@@ -9514,6 +9683,8 @@ type APIOrdersBrowseResult = Omit<{
9514
9683
  } | null | undefined;
9515
9684
  } | null;
9516
9685
  type: "set" | "product" | "bundle";
9686
+ subscriptionMode: "optional" | "only" | "rolling";
9687
+ subscriptionAddonDiscountPercent: number | null;
9517
9688
  bundleDiscountPercentage: string | null;
9518
9689
  bundlePriceMode: "fixed" | "amount" | "percent";
9519
9690
  bundleFixedPriceAmount: string | null;
@@ -9672,6 +9843,25 @@ type APIOrdersBrowseResult = Omit<{
9672
9843
  storeId: string;
9673
9844
  updatedAt: string;
9674
9845
  } | null;
9846
+ rollingCycle: {
9847
+ id: string;
9848
+ title: string;
9849
+ startsAt: string;
9850
+ items: {
9851
+ productVariantId: string;
9852
+ productId: string;
9853
+ name: string;
9854
+ variantLabel: string | null;
9855
+ sku: string | null;
9856
+ image: string | null;
9857
+ quantity: number;
9858
+ }[];
9859
+ } | null;
9860
+ subscriptionAddon: {
9861
+ addonId: string;
9862
+ discountPercent: number;
9863
+ listPrice: string;
9864
+ } | null;
9675
9865
  slotId: string | null;
9676
9866
  attendees: {
9677
9867
  name: string;
@@ -9867,7 +10057,7 @@ type APIOrdersBrowseResult = Omit<{
9867
10057
  count: number;
9868
10058
  };
9869
10059
  }, "data"> & {
9870
- data: Array<{
10060
+ data: Array<Omit<{
9871
10061
  data: ({
9872
10062
  createdAt: string;
9873
10063
  updatedAt: string;
@@ -10014,6 +10204,8 @@ type APIOrdersBrowseResult = Omit<{
10014
10204
  } | null | undefined;
10015
10205
  } | null;
10016
10206
  type: "set" | "product" | "bundle";
10207
+ subscriptionMode: "optional" | "only" | "rolling";
10208
+ subscriptionAddonDiscountPercent: number | null;
10017
10209
  bundleDiscountPercentage: string | null;
10018
10210
  bundlePriceMode: "fixed" | "amount" | "percent";
10019
10211
  bundleFixedPriceAmount: string | null;
@@ -10172,6 +10364,25 @@ type APIOrdersBrowseResult = Omit<{
10172
10364
  storeId: string;
10173
10365
  updatedAt: string;
10174
10366
  } | null;
10367
+ rollingCycle: {
10368
+ id: string;
10369
+ title: string;
10370
+ startsAt: string;
10371
+ items: {
10372
+ productVariantId: string;
10373
+ productId: string;
10374
+ name: string;
10375
+ variantLabel: string | null;
10376
+ sku: string | null;
10377
+ image: string | null;
10378
+ quantity: number;
10379
+ }[];
10380
+ } | null;
10381
+ subscriptionAddon: {
10382
+ addonId: string;
10383
+ discountPercent: number;
10384
+ listPrice: string;
10385
+ } | null;
10175
10386
  slotId: string | null;
10176
10387
  attendees: {
10177
10388
  name: string;
@@ -10533,6 +10744,8 @@ type APIOrdersBrowseResult = Omit<{
10533
10744
  } | null | undefined;
10534
10745
  } | null;
10535
10746
  type: "set" | "product" | "bundle";
10747
+ subscriptionMode: "optional" | "only" | "rolling";
10748
+ subscriptionAddonDiscountPercent: number | null;
10536
10749
  bundleDiscountPercentage: string | null;
10537
10750
  bundlePriceMode: "fixed" | "amount" | "percent";
10538
10751
  bundleFixedPriceAmount: string | null;
@@ -10691,6 +10904,25 @@ type APIOrdersBrowseResult = Omit<{
10691
10904
  storeId: string;
10692
10905
  updatedAt: string;
10693
10906
  } | null;
10907
+ rollingCycle: {
10908
+ id: string;
10909
+ title: string;
10910
+ startsAt: string;
10911
+ items: {
10912
+ productVariantId: string;
10913
+ productId: string;
10914
+ name: string;
10915
+ variantLabel: string | null;
10916
+ sku: string | null;
10917
+ image: string | null;
10918
+ quantity: number;
10919
+ }[];
10920
+ } | null;
10921
+ subscriptionAddon: {
10922
+ addonId: string;
10923
+ discountPercent: number;
10924
+ listPrice: string;
10925
+ } | null;
10694
10926
  slotId: string | null;
10695
10927
  attendees: {
10696
10928
  name: string;
@@ -10885,385 +11117,2128 @@ type APIOrdersBrowseResult = Omit<{
10885
11117
  meta: {
10886
11118
  count: number;
10887
11119
  };
10888
- }["data"][number] & {
10889
- shipment: APIShipment | null;
10890
- }>;
10891
- };
10892
- type APIOrdersBrowseQueryParams = {
10893
- offset?: number | undefined;
10894
- limit?: number | undefined;
10895
- };
10896
- type APIOrderGetByIdResult = Omit<{
10897
- id: string;
10898
- createdAt: string;
10899
- updatedAt: string;
10900
- storeId: string;
10901
- status: "completed" | "cancelled" | "paid" | "created" | "processing" | "shipped" | "refunded" | "partially_refunded" | "reserved";
10902
- environment: "live" | "test";
10903
- source: string | null;
10904
- externalId: string | null;
10905
- customerId: string | null;
10906
- attribution: {
10907
- firstTouch: {
10908
- source: string | null;
10909
- medium: string | null;
10910
- campaign: string | null;
10911
- referrerHost: string | null;
10912
- ts: number;
10913
- };
10914
- lastTouch: {
10915
- source: string | null;
10916
- medium: string | null;
10917
- campaign: string | null;
10918
- referrerHost: string | null;
10919
- ts: number;
10920
- };
10921
- } | null;
10922
- lookup: number;
10923
- cartId: string | null;
10924
- orderData: {
10925
- id: string;
10926
- storeId: string;
10927
- shippingId: string | null;
10928
- shipping: {
11120
+ }["data"][number], "orderData"> & {
11121
+ orderData: {
10929
11122
  id: string;
10930
11123
  storeId: string;
10931
- name: string;
10932
- price: string;
10933
- freeShippingThreshold: string | null;
10934
- minShippingTime: number | null;
10935
- maxShippingTime: number | null;
10936
- description: string | null;
10937
- addonId: string | null;
10938
- shippingAddon: {
10939
- type: "shipping" | "products" | "analytics" | "invoicing" | "orders";
10940
- storeId: string;
11124
+ shippingId: string | null;
11125
+ shipping: ({
10941
11126
  id: string;
11127
+ storeId: string;
10942
11128
  name: string;
10943
- createdAt: string;
10944
- updatedAt: string;
10945
- } | null;
10946
- type: "courier" | "parcel" | "pickup_point" | "in_store";
10947
- addonData: {
10948
- id: number;
10949
- name: string;
10950
- service: "dpd" | "fedex" | "ups" | "gls" | "poczta" | "inpost" | "orlen" | "dhl";
10951
- } | {
10952
- carrier: "inpost";
10953
- name: string;
10954
- service: "inpost";
10955
- } | {
10956
- carrier: "gls";
10957
- name: string;
10958
- service: "gls";
10959
- } | null;
10960
- deliverySlots: unknown;
10961
- shippingTaxRate: {
10962
- shippingId: string;
10963
- taxRateId: string;
10964
- taxRate: {
10965
- id: string;
11129
+ price: string;
11130
+ freeShippingThreshold: string | null;
11131
+ minShippingTime: number | null;
11132
+ maxShippingTime: number | null;
11133
+ description: string | null;
11134
+ addonId: string | null;
11135
+ shippingAddon: {
11136
+ type: "shipping" | "products" | "analytics" | "invoicing" | "orders";
10966
11137
  storeId: string;
11138
+ id: string;
10967
11139
  name: string;
10968
- rate: string;
10969
- label: string | null;
10970
11140
  createdAt: string;
10971
11141
  updatedAt: string;
10972
- };
11142
+ } | null;
11143
+ type: "courier" | "parcel" | "pickup_point" | "in_store";
11144
+ addonData: {
11145
+ id: number;
11146
+ name: string;
11147
+ service: "dpd" | "fedex" | "ups" | "gls" | "poczta" | "inpost" | "orlen" | "dhl";
11148
+ } | {
11149
+ carrier: "inpost";
11150
+ name: string;
11151
+ service: "inpost";
11152
+ } | {
11153
+ carrier: "gls";
11154
+ name: string;
11155
+ service: "gls";
11156
+ } | null;
11157
+ deliverySlots: unknown;
11158
+ shippingTaxRate: {
11159
+ shippingId: string;
11160
+ taxRateId: string;
11161
+ taxRate: {
11162
+ id: string;
11163
+ storeId: string;
11164
+ name: string;
11165
+ rate: string;
11166
+ label: string | null;
11167
+ createdAt: string;
11168
+ updatedAt: string;
11169
+ };
11170
+ createdAt: string;
11171
+ updatedAt: string;
11172
+ } | null;
11173
+ position: number | null;
10973
11174
  createdAt: string;
10974
11175
  updatedAt: string;
10975
- } | null;
10976
- position: number | null;
10977
- createdAt: string;
10978
- updatedAt: string;
10979
- countries: string[] | null;
10980
- } | null;
10981
- createdAt: string;
10982
- lineItems: {
10983
- id: string;
10984
- cartId: string;
10985
- quantity: number;
10986
- unitCost: string | null;
11176
+ countries: string[] | null;
11177
+ } & {
11178
+ priceGross: string;
11179
+ }) | null;
10987
11180
  createdAt: string;
10988
- updatedAt: string;
10989
- productVariant: {
11181
+ lineItems: {
10990
11182
  id: string;
10991
- sku: string | null;
10992
- barcode: string | null;
10993
- description: string | null;
10994
- price: string;
10995
- calculatedPrice: string | null;
10996
- prePromotionPrice: string | null;
10997
- preVolumePricingPrice: string | null;
10998
- stock: number | null;
10999
- depth: number | null;
11000
- width: number | null;
11001
- height: number | null;
11002
- weight: number | null;
11003
- images: string[];
11004
- digital: string[] | null;
11005
- shippable: boolean;
11006
- externalId: string | null;
11007
- product: {
11008
- id: string;
11009
- name: string;
11010
- slug: string;
11011
- status: "published" | "draft" | "hidden" | null;
11012
- images: string[];
11013
- badge: {
11014
- content?: string | undefined;
11015
- backgroundColor?: string | undefined;
11016
- textColor?: string | undefined;
11017
- } | null;
11018
- storeId: string;
11019
- categoryId: string | null;
11020
- brandId: string | null;
11021
- summary: string | null;
11022
- content: any;
11023
- createdAt: string;
11024
- updatedAt: string;
11025
- productTaxRate: {
11026
- productId: string;
11027
- taxRateId: string;
11028
- taxRate: {
11183
+ cartId: string;
11184
+ quantity: number;
11185
+ unitCost: string | null;
11186
+ createdAt: string;
11187
+ updatedAt: string;
11188
+ productVariant: {
11189
+ [K in keyof ({
11190
+ id: string;
11191
+ sku: string | null;
11192
+ barcode: string | null;
11193
+ description: string | null;
11194
+ price: string;
11195
+ calculatedPrice: string | null;
11196
+ prePromotionPrice: string | null;
11197
+ preVolumePricingPrice: string | null;
11198
+ stock: number | null;
11199
+ depth: number | null;
11200
+ width: number | null;
11201
+ height: number | null;
11202
+ weight: number | null;
11203
+ images: string[];
11204
+ digital: string[] | null;
11205
+ shippable: boolean;
11206
+ externalId: string | null;
11207
+ product: {
11029
11208
  id: string;
11030
- storeId: string;
11031
11209
  name: string;
11032
- rate: string;
11033
- label: string | null;
11210
+ slug: string;
11211
+ status: "published" | "draft" | "hidden" | null;
11212
+ images: string[];
11213
+ badge: {
11214
+ content?: string | undefined;
11215
+ backgroundColor?: string | undefined;
11216
+ textColor?: string | undefined;
11217
+ } | null;
11218
+ storeId: string;
11219
+ categoryId: string | null;
11220
+ brandId: string | null;
11221
+ summary: string | null;
11222
+ content: any;
11034
11223
  createdAt: string;
11035
11224
  updatedAt: string;
11225
+ productTaxRate: {
11226
+ productId: string;
11227
+ taxRateId: string;
11228
+ taxRate: {
11229
+ id: string;
11230
+ storeId: string;
11231
+ name: string;
11232
+ rate: string;
11233
+ label: string | null;
11234
+ createdAt: string;
11235
+ updatedAt: string;
11236
+ };
11237
+ createdAt: string;
11238
+ updatedAt: string;
11239
+ } | null;
11240
+ flags: {
11241
+ gold?: boolean | null | undefined;
11242
+ event?: {
11243
+ enabled: boolean;
11244
+ startsAt?: string | null | undefined;
11245
+ location?: string | null | undefined;
11246
+ capacity?: number | null | undefined;
11247
+ guestLabel?: string | null | undefined;
11248
+ guest?: string | null | undefined;
11249
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11250
+ salesPaused?: boolean | null | undefined;
11251
+ } | null | undefined;
11252
+ scheduledPublishAt?: string | null | undefined;
11253
+ gpsr?: {
11254
+ safetyInformation?: {
11255
+ type: "NO_SAFETY_INFORMATION";
11256
+ } | {
11257
+ type: "TEXT";
11258
+ description: string;
11259
+ } | null | undefined;
11260
+ } | null | undefined;
11261
+ } | null;
11262
+ type: "set" | "product" | "bundle";
11263
+ subscriptionMode: "optional" | "only" | "rolling";
11264
+ subscriptionAddonDiscountPercent: number | null;
11265
+ bundleDiscountPercentage: string | null;
11266
+ bundlePriceMode: "fixed" | "amount" | "percent";
11267
+ bundleFixedPriceAmount: string | null;
11268
+ bundleAmountOffAmount: string | null;
11269
+ productCollections: {
11270
+ collection: {
11271
+ createdAt: string;
11272
+ description: any;
11273
+ id: string;
11274
+ image: string | null;
11275
+ name: string;
11276
+ slug: string;
11277
+ storeId: string;
11278
+ updatedAt: string;
11279
+ filter: {
11280
+ type: "manual";
11281
+ } | {
11282
+ type: "dynamicPrice";
11283
+ min?: number | null | undefined;
11284
+ max?: number | null | undefined;
11285
+ } | {
11286
+ type: "variantValues";
11287
+ values: Record<string, string[]>;
11288
+ } | {
11289
+ type: "newest";
11290
+ days?: number | null | undefined;
11291
+ };
11292
+ active: boolean;
11293
+ seo?: {
11294
+ title?: string | null | undefined;
11295
+ description?: string | null | undefined;
11296
+ canonical?: string | null | undefined;
11297
+ } | null | undefined;
11298
+ };
11299
+ collectionId: string;
11300
+ position: string | null;
11301
+ productId: string;
11302
+ }[];
11303
+ bundleGroups: {
11304
+ id: string;
11305
+ minQuantity: number;
11306
+ maxQuantity: number | null;
11307
+ allowDuplicates: boolean;
11308
+ }[];
11309
+ bundleProducts: {
11310
+ bundleId: string;
11311
+ variantId: string;
11312
+ groupId: string | null;
11313
+ quantity: number;
11314
+ position: number;
11315
+ forced: boolean;
11316
+ defaultSelected: boolean;
11317
+ maxQuantity: number | null;
11318
+ createdAt: string;
11319
+ updatedAt: string;
11320
+ variant: {
11321
+ id: string;
11322
+ sku: string | null;
11323
+ barcode: string | null;
11324
+ description: string | null;
11325
+ price: string;
11326
+ shippable: boolean;
11327
+ calculatedPrice: string | null;
11328
+ stock: number | null;
11329
+ depth: number | null;
11330
+ width: number | null;
11331
+ height: number | null;
11332
+ weight: number | null;
11333
+ images: string[];
11334
+ digital: string[] | null;
11335
+ externalId: string | null;
11336
+ product: {
11337
+ id: string;
11338
+ name: string;
11339
+ slug: string;
11340
+ images: string[];
11341
+ productTaxRate: {
11342
+ taxRate: {
11343
+ rate: string;
11344
+ label: string | null;
11345
+ };
11346
+ } | null;
11347
+ };
11348
+ createdAt: string;
11349
+ productId: string;
11350
+ updatedAt: string;
11351
+ attributes: {
11352
+ checked: boolean | null;
11353
+ key: string;
11354
+ value: string;
11355
+ }[] | null;
11356
+ storeId: string;
11357
+ originalPrice?: string | null | undefined;
11358
+ } & {
11359
+ originalPrice: string;
11360
+ };
11361
+ }[];
11362
+ setProduct: {
11363
+ selectionCount: number;
11364
+ allowDuplicates: boolean;
11365
+ discountPercentage: string;
11366
+ } | null;
11367
+ seo: {
11368
+ title?: string | null | undefined;
11369
+ description?: string | null | undefined;
11370
+ canonical?: string | null | undefined;
11371
+ } | null;
11372
+ stripeTaxCode: string | null;
11373
+ active?: boolean | null | undefined;
11036
11374
  };
11037
11375
  createdAt: string;
11376
+ productId: string;
11038
11377
  updatedAt: string;
11039
- } | null;
11040
- flags: {
11041
- gold?: boolean | null | undefined;
11042
- event?: {
11043
- enabled: boolean;
11044
- startsAt?: string | null | undefined;
11045
- location?: string | null | undefined;
11046
- capacity?: number | null | undefined;
11047
- guestLabel?: string | null | undefined;
11048
- guest?: string | null | undefined;
11049
- attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11050
- salesPaused?: boolean | null | undefined;
11051
- } | null | undefined;
11052
- scheduledPublishAt?: string | null | undefined;
11053
- gpsr?: {
11054
- safetyInformation?: {
11055
- type: "NO_SAFETY_INFORMATION";
11056
- } | {
11057
- type: "TEXT";
11058
- description: string;
11059
- } | null | undefined;
11060
- } | null | undefined;
11061
- } | null;
11062
- type: "set" | "product" | "bundle";
11063
- bundleDiscountPercentage: string | null;
11064
- bundlePriceMode: "fixed" | "amount" | "percent";
11065
- bundleFixedPriceAmount: string | null;
11066
- bundleAmountOffAmount: string | null;
11067
- productCollections: {
11068
- collection: {
11378
+ combinations: {
11069
11379
  createdAt: string;
11070
- description: any;
11071
- id: string;
11072
- image: string | null;
11073
- name: string;
11074
- slug: string;
11075
- storeId: string;
11076
11380
  updatedAt: string;
11077
- filter: {
11078
- type: "manual";
11079
- } | {
11080
- type: "dynamicPrice";
11081
- min?: number | null | undefined;
11082
- max?: number | null | undefined;
11083
- } | {
11084
- type: "variantValues";
11085
- values: Record<string, string[]>;
11086
- } | {
11087
- type: "newest";
11088
- days?: number | null | undefined;
11381
+ productVariantId: string;
11382
+ variantValueId: string;
11383
+ variantValue: {
11384
+ id: string;
11385
+ value: string;
11386
+ variantType: {
11387
+ id: string;
11388
+ label: string;
11389
+ productId?: string | null | undefined;
11390
+ createdAt?: string | null | undefined;
11391
+ updatedAt?: string | null | undefined;
11392
+ };
11393
+ variantTypeId?: string | null | undefined;
11089
11394
  };
11090
- active: boolean;
11091
- seo?: {
11395
+ }[];
11396
+ attributes: {
11397
+ checked: boolean | null;
11398
+ key: string;
11399
+ value: string;
11400
+ }[] | null;
11401
+ storeId: string;
11402
+ originalPrice?: string | null | undefined;
11403
+ } & {
11404
+ originalPrice: string;
11405
+ })]: K extends "prices" ? Array<(({
11406
+ id: string;
11407
+ sku: string | null;
11408
+ barcode: string | null;
11409
+ description: string | null;
11410
+ price: string;
11411
+ calculatedPrice: string | null;
11412
+ prePromotionPrice: string | null;
11413
+ preVolumePricingPrice: string | null;
11414
+ stock: number | null;
11415
+ depth: number | null;
11416
+ width: number | null;
11417
+ height: number | null;
11418
+ weight: number | null;
11419
+ images: string[];
11420
+ digital: string[] | null;
11421
+ shippable: boolean;
11422
+ externalId: string | null;
11423
+ product: {
11424
+ id: string;
11425
+ name: string;
11426
+ slug: string;
11427
+ status: "published" | "draft" | "hidden" | null;
11428
+ images: string[];
11429
+ badge: {
11430
+ content?: string | undefined;
11431
+ backgroundColor?: string | undefined;
11432
+ textColor?: string | undefined;
11433
+ } | null;
11434
+ storeId: string;
11435
+ categoryId: string | null;
11436
+ brandId: string | null;
11437
+ summary: string | null;
11438
+ content: any;
11439
+ createdAt: string;
11440
+ updatedAt: string;
11441
+ productTaxRate: {
11442
+ productId: string;
11443
+ taxRateId: string;
11444
+ taxRate: {
11445
+ id: string;
11446
+ storeId: string;
11447
+ name: string;
11448
+ rate: string;
11449
+ label: string | null;
11450
+ createdAt: string;
11451
+ updatedAt: string;
11452
+ };
11453
+ createdAt: string;
11454
+ updatedAt: string;
11455
+ } | null;
11456
+ flags: {
11457
+ gold?: boolean | null | undefined;
11458
+ event?: {
11459
+ enabled: boolean;
11460
+ startsAt?: string | null | undefined;
11461
+ location?: string | null | undefined;
11462
+ capacity?: number | null | undefined;
11463
+ guestLabel?: string | null | undefined;
11464
+ guest?: string | null | undefined;
11465
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11466
+ salesPaused?: boolean | null | undefined;
11467
+ } | null | undefined;
11468
+ scheduledPublishAt?: string | null | undefined;
11469
+ gpsr?: {
11470
+ safetyInformation?: {
11471
+ type: "NO_SAFETY_INFORMATION";
11472
+ } | {
11473
+ type: "TEXT";
11474
+ description: string;
11475
+ } | null | undefined;
11476
+ } | null | undefined;
11477
+ } | null;
11478
+ type: "set" | "product" | "bundle";
11479
+ subscriptionMode: "optional" | "only" | "rolling";
11480
+ subscriptionAddonDiscountPercent: number | null;
11481
+ bundleDiscountPercentage: string | null;
11482
+ bundlePriceMode: "fixed" | "amount" | "percent";
11483
+ bundleFixedPriceAmount: string | null;
11484
+ bundleAmountOffAmount: string | null;
11485
+ productCollections: {
11486
+ collection: {
11487
+ createdAt: string;
11488
+ description: any;
11489
+ id: string;
11490
+ image: string | null;
11491
+ name: string;
11492
+ slug: string;
11493
+ storeId: string;
11494
+ updatedAt: string;
11495
+ filter: {
11496
+ type: "manual";
11497
+ } | {
11498
+ type: "dynamicPrice";
11499
+ min?: number | null | undefined;
11500
+ max?: number | null | undefined;
11501
+ } | {
11502
+ type: "variantValues";
11503
+ values: Record<string, string[]>;
11504
+ } | {
11505
+ type: "newest";
11506
+ days?: number | null | undefined;
11507
+ };
11508
+ active: boolean;
11509
+ seo?: {
11510
+ title?: string | null | undefined;
11511
+ description?: string | null | undefined;
11512
+ canonical?: string | null | undefined;
11513
+ } | null | undefined;
11514
+ };
11515
+ collectionId: string;
11516
+ position: string | null;
11517
+ productId: string;
11518
+ }[];
11519
+ bundleGroups: {
11520
+ id: string;
11521
+ minQuantity: number;
11522
+ maxQuantity: number | null;
11523
+ allowDuplicates: boolean;
11524
+ }[];
11525
+ bundleProducts: {
11526
+ bundleId: string;
11527
+ variantId: string;
11528
+ groupId: string | null;
11529
+ quantity: number;
11530
+ position: number;
11531
+ forced: boolean;
11532
+ defaultSelected: boolean;
11533
+ maxQuantity: number | null;
11534
+ createdAt: string;
11535
+ updatedAt: string;
11536
+ variant: {
11537
+ id: string;
11538
+ sku: string | null;
11539
+ barcode: string | null;
11540
+ description: string | null;
11541
+ price: string;
11542
+ shippable: boolean;
11543
+ calculatedPrice: string | null;
11544
+ stock: number | null;
11545
+ depth: number | null;
11546
+ width: number | null;
11547
+ height: number | null;
11548
+ weight: number | null;
11549
+ images: string[];
11550
+ digital: string[] | null;
11551
+ externalId: string | null;
11552
+ product: {
11553
+ id: string;
11554
+ name: string;
11555
+ slug: string;
11556
+ images: string[];
11557
+ productTaxRate: {
11558
+ taxRate: {
11559
+ rate: string;
11560
+ label: string | null;
11561
+ };
11562
+ } | null;
11563
+ };
11564
+ createdAt: string;
11565
+ productId: string;
11566
+ updatedAt: string;
11567
+ attributes: {
11568
+ checked: boolean | null;
11569
+ key: string;
11570
+ value: string;
11571
+ }[] | null;
11572
+ storeId: string;
11573
+ originalPrice?: string | null | undefined;
11574
+ } & {
11575
+ originalPrice: string;
11576
+ };
11577
+ }[];
11578
+ setProduct: {
11579
+ selectionCount: number;
11580
+ allowDuplicates: boolean;
11581
+ discountPercentage: string;
11582
+ } | null;
11583
+ seo: {
11092
11584
  title?: string | null | undefined;
11093
11585
  description?: string | null | undefined;
11094
11586
  canonical?: string | null | undefined;
11095
- } | null | undefined;
11587
+ } | null;
11588
+ stripeTaxCode: string | null;
11589
+ active?: boolean | null | undefined;
11096
11590
  };
11097
- collectionId: string;
11098
- position: string | null;
11099
- productId: string;
11100
- }[];
11101
- bundleGroups: {
11102
- id: string;
11103
- minQuantity: number;
11104
- maxQuantity: number | null;
11105
- allowDuplicates: boolean;
11106
- }[];
11107
- bundleProducts: {
11108
- bundleId: string;
11109
- variantId: string;
11110
- groupId: string | null;
11111
- quantity: number;
11112
- position: number;
11113
- forced: boolean;
11114
- defaultSelected: boolean;
11115
- maxQuantity: number | null;
11116
11591
  createdAt: string;
11592
+ productId: string;
11117
11593
  updatedAt: string;
11118
- variant: {
11119
- id: string;
11120
- sku: string | null;
11121
- barcode: string | null;
11122
- description: string | null;
11123
- price: string;
11124
- shippable: boolean;
11125
- calculatedPrice: string | null;
11126
- stock: number | null;
11127
- depth: number | null;
11128
- width: number | null;
11129
- height: number | null;
11130
- weight: number | null;
11131
- images: string[];
11132
- digital: string[] | null;
11133
- externalId: string | null;
11134
- product: {
11135
- id: string;
11136
- name: string;
11137
- slug: string;
11138
- images: string[];
11139
- productTaxRate: {
11140
- taxRate: {
11141
- rate: string;
11142
- label: string | null;
11143
- };
11144
- } | null;
11145
- };
11594
+ combinations: {
11146
11595
  createdAt: string;
11147
- productId: string;
11148
11596
  updatedAt: string;
11149
- attributes: {
11150
- checked: boolean | null;
11151
- key: string;
11597
+ productVariantId: string;
11598
+ variantValueId: string;
11599
+ variantValue: {
11600
+ id: string;
11152
11601
  value: string;
11153
- }[] | null;
11154
- storeId: string;
11155
- originalPrice?: string | null | undefined;
11156
- } & {
11157
- originalPrice: string;
11158
- };
11159
- }[];
11160
- setProduct: {
11161
- selectionCount: number;
11162
- allowDuplicates: boolean;
11163
- discountPercentage: string;
11164
- } | null;
11165
- seo: {
11166
- title?: string | null | undefined;
11167
- description?: string | null | undefined;
11168
- canonical?: string | null | undefined;
11169
- } | null;
11170
- stripeTaxCode: string | null;
11171
- active?: boolean | null | undefined;
11172
- };
11173
- createdAt: string;
11174
- productId: string;
11175
- updatedAt: string;
11176
- combinations: {
11177
- createdAt: string;
11178
- updatedAt: string;
11179
- productVariantId: string;
11180
- variantValueId: string;
11181
- variantValue: {
11182
- id: string;
11183
- value: string;
11184
- variantType: {
11185
- id: string;
11186
- label: string;
11187
- productId?: string | null | undefined;
11188
- createdAt?: string | null | undefined;
11189
- updatedAt?: string | null | undefined;
11190
- };
11191
- variantTypeId?: string | null | undefined;
11192
- };
11193
- }[];
11194
- attributes: {
11195
- checked: boolean | null;
11196
- key: string;
11197
- value: string;
11198
- }[] | null;
11199
- storeId: string;
11200
- originalPrice?: string | null | undefined;
11201
- } & {
11202
- originalPrice: string;
11203
- };
11204
- productVariantId: string;
11205
- preVolumePricingPrice: string | null;
11206
- subscriptionPlanId: string | null;
11207
- subscriptionPlan: {
11208
- id: string;
11209
- name: string;
11210
- cadence: "month" | "week";
11211
- interval: number;
11212
- discountPercent: number;
11213
- description: string | null;
11214
- benefits: string | null;
11215
- active: boolean;
11216
- createdAt: string;
11217
- position: number;
11218
- storeId: string;
11219
- updatedAt: string;
11220
- } | null;
11221
- slotId: string | null;
11222
- attendees: {
11223
- name: string;
11224
- email: string | null;
11225
- phone: string | null;
11226
- dietary: string | null;
11227
- notes: string | null;
11228
- }[] | null;
11229
- setSelections: {
11230
- id: string;
11231
- lineItemId: string;
11232
- selectedVariantId: string;
11233
- quantity: number;
11234
- position: number;
11235
- createdAt: string;
11236
- updatedAt: string;
11237
- selectedVariant: {
11238
- id: string;
11239
- price: string;
11240
- product: {
11602
+ variantType: {
11603
+ id: string;
11604
+ label: string;
11605
+ productId?: string | null | undefined;
11606
+ createdAt?: string | null | undefined;
11607
+ updatedAt?: string | null | undefined;
11608
+ };
11609
+ variantTypeId?: string | null | undefined;
11610
+ };
11611
+ }[];
11612
+ attributes: {
11613
+ checked: boolean | null;
11614
+ key: string;
11615
+ value: string;
11616
+ }[] | null;
11617
+ storeId: string;
11618
+ originalPrice?: string | null | undefined;
11619
+ } & {
11620
+ originalPrice: string;
11621
+ })[K] extends readonly (infer TElement)[] ? TElement : never) & {
11622
+ /** `price` converted to gross with the owning product's tax rate. */
11623
+ priceGross: string;
11624
+ /** `calculatedPrice` converted to gross; null when there is no calculated price. */
11625
+ calculatedPriceGross: string | null;
11626
+ }> : ({
11241
11627
  id: string;
11242
- name: string;
11243
- };
11244
- combinations: {
11245
- createdAt: string;
11246
- updatedAt: string;
11247
- productVariantId: string;
11248
- variantValueId: string;
11249
- variantValue: {
11628
+ sku: string | null;
11629
+ barcode: string | null;
11630
+ description: string | null;
11631
+ price: string;
11632
+ calculatedPrice: string | null;
11633
+ prePromotionPrice: string | null;
11634
+ preVolumePricingPrice: string | null;
11635
+ stock: number | null;
11636
+ depth: number | null;
11637
+ width: number | null;
11638
+ height: number | null;
11639
+ weight: number | null;
11640
+ images: string[];
11641
+ digital: string[] | null;
11642
+ shippable: boolean;
11643
+ externalId: string | null;
11644
+ product: {
11250
11645
  id: string;
11251
- value: string;
11252
- variantType: {
11646
+ name: string;
11647
+ slug: string;
11648
+ status: "published" | "draft" | "hidden" | null;
11649
+ images: string[];
11650
+ badge: {
11651
+ content?: string | undefined;
11652
+ backgroundColor?: string | undefined;
11653
+ textColor?: string | undefined;
11654
+ } | null;
11655
+ storeId: string;
11656
+ categoryId: string | null;
11657
+ brandId: string | null;
11658
+ summary: string | null;
11659
+ content: any;
11660
+ createdAt: string;
11661
+ updatedAt: string;
11662
+ productTaxRate: {
11663
+ productId: string;
11664
+ taxRateId: string;
11665
+ taxRate: {
11666
+ id: string;
11667
+ storeId: string;
11668
+ name: string;
11669
+ rate: string;
11670
+ label: string | null;
11671
+ createdAt: string;
11672
+ updatedAt: string;
11673
+ };
11674
+ createdAt: string;
11675
+ updatedAt: string;
11676
+ } | null;
11677
+ flags: {
11678
+ gold?: boolean | null | undefined;
11679
+ event?: {
11680
+ enabled: boolean;
11681
+ startsAt?: string | null | undefined;
11682
+ location?: string | null | undefined;
11683
+ capacity?: number | null | undefined;
11684
+ guestLabel?: string | null | undefined;
11685
+ guest?: string | null | undefined;
11686
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11687
+ salesPaused?: boolean | null | undefined;
11688
+ } | null | undefined;
11689
+ scheduledPublishAt?: string | null | undefined;
11690
+ gpsr?: {
11691
+ safetyInformation?: {
11692
+ type: "NO_SAFETY_INFORMATION";
11693
+ } | {
11694
+ type: "TEXT";
11695
+ description: string;
11696
+ } | null | undefined;
11697
+ } | null | undefined;
11698
+ } | null;
11699
+ type: "set" | "product" | "bundle";
11700
+ subscriptionMode: "optional" | "only" | "rolling";
11701
+ subscriptionAddonDiscountPercent: number | null;
11702
+ bundleDiscountPercentage: string | null;
11703
+ bundlePriceMode: "fixed" | "amount" | "percent";
11704
+ bundleFixedPriceAmount: string | null;
11705
+ bundleAmountOffAmount: string | null;
11706
+ productCollections: {
11707
+ collection: {
11708
+ createdAt: string;
11709
+ description: any;
11710
+ id: string;
11711
+ image: string | null;
11712
+ name: string;
11713
+ slug: string;
11714
+ storeId: string;
11715
+ updatedAt: string;
11716
+ filter: {
11717
+ type: "manual";
11718
+ } | {
11719
+ type: "dynamicPrice";
11720
+ min?: number | null | undefined;
11721
+ max?: number | null | undefined;
11722
+ } | {
11723
+ type: "variantValues";
11724
+ values: Record<string, string[]>;
11725
+ } | {
11726
+ type: "newest";
11727
+ days?: number | null | undefined;
11728
+ };
11729
+ active: boolean;
11730
+ seo?: {
11731
+ title?: string | null | undefined;
11732
+ description?: string | null | undefined;
11733
+ canonical?: string | null | undefined;
11734
+ } | null | undefined;
11735
+ };
11736
+ collectionId: string;
11737
+ position: string | null;
11738
+ productId: string;
11739
+ }[];
11740
+ bundleGroups: {
11253
11741
  id: string;
11254
- label: string;
11255
- productId?: string | null | undefined;
11256
- createdAt?: string | null | undefined;
11257
- updatedAt?: string | null | undefined;
11258
- };
11259
- variantTypeId?: string | null | undefined;
11260
- };
11261
- }[];
11262
- };
11263
- }[];
11264
- }[];
11265
- updatedAt: string;
11266
- couponId: string | null;
11742
+ minQuantity: number;
11743
+ maxQuantity: number | null;
11744
+ allowDuplicates: boolean;
11745
+ }[];
11746
+ bundleProducts: {
11747
+ bundleId: string;
11748
+ variantId: string;
11749
+ groupId: string | null;
11750
+ quantity: number;
11751
+ position: number;
11752
+ forced: boolean;
11753
+ defaultSelected: boolean;
11754
+ maxQuantity: number | null;
11755
+ createdAt: string;
11756
+ updatedAt: string;
11757
+ variant: {
11758
+ id: string;
11759
+ sku: string | null;
11760
+ barcode: string | null;
11761
+ description: string | null;
11762
+ price: string;
11763
+ shippable: boolean;
11764
+ calculatedPrice: string | null;
11765
+ stock: number | null;
11766
+ depth: number | null;
11767
+ width: number | null;
11768
+ height: number | null;
11769
+ weight: number | null;
11770
+ images: string[];
11771
+ digital: string[] | null;
11772
+ externalId: string | null;
11773
+ product: {
11774
+ id: string;
11775
+ name: string;
11776
+ slug: string;
11777
+ images: string[];
11778
+ productTaxRate: {
11779
+ taxRate: {
11780
+ rate: string;
11781
+ label: string | null;
11782
+ };
11783
+ } | null;
11784
+ };
11785
+ createdAt: string;
11786
+ productId: string;
11787
+ updatedAt: string;
11788
+ attributes: {
11789
+ checked: boolean | null;
11790
+ key: string;
11791
+ value: string;
11792
+ }[] | null;
11793
+ storeId: string;
11794
+ originalPrice?: string | null | undefined;
11795
+ } & {
11796
+ originalPrice: string;
11797
+ };
11798
+ }[];
11799
+ setProduct: {
11800
+ selectionCount: number;
11801
+ allowDuplicates: boolean;
11802
+ discountPercentage: string;
11803
+ } | null;
11804
+ seo: {
11805
+ title?: string | null | undefined;
11806
+ description?: string | null | undefined;
11807
+ canonical?: string | null | undefined;
11808
+ } | null;
11809
+ stripeTaxCode: string | null;
11810
+ active?: boolean | null | undefined;
11811
+ };
11812
+ createdAt: string;
11813
+ productId: string;
11814
+ updatedAt: string;
11815
+ combinations: {
11816
+ createdAt: string;
11817
+ updatedAt: string;
11818
+ productVariantId: string;
11819
+ variantValueId: string;
11820
+ variantValue: {
11821
+ id: string;
11822
+ value: string;
11823
+ variantType: {
11824
+ id: string;
11825
+ label: string;
11826
+ productId?: string | null | undefined;
11827
+ createdAt?: string | null | undefined;
11828
+ updatedAt?: string | null | undefined;
11829
+ };
11830
+ variantTypeId?: string | null | undefined;
11831
+ };
11832
+ }[];
11833
+ attributes: {
11834
+ checked: boolean | null;
11835
+ key: string;
11836
+ value: string;
11837
+ }[] | null;
11838
+ storeId: string;
11839
+ originalPrice?: string | null | undefined;
11840
+ } & {
11841
+ originalPrice: string;
11842
+ })[K];
11843
+ } & {
11844
+ /** `price` (the effective net price) converted to gross with the product's tax rate. */
11845
+ priceGross: string;
11846
+ } & {
11847
+ [K in Extract<keyof ({
11848
+ id: string;
11849
+ sku: string | null;
11850
+ barcode: string | null;
11851
+ description: string | null;
11852
+ price: string;
11853
+ calculatedPrice: string | null;
11854
+ prePromotionPrice: string | null;
11855
+ preVolumePricingPrice: string | null;
11856
+ stock: number | null;
11857
+ depth: number | null;
11858
+ width: number | null;
11859
+ height: number | null;
11860
+ weight: number | null;
11861
+ images: string[];
11862
+ digital: string[] | null;
11863
+ shippable: boolean;
11864
+ externalId: string | null;
11865
+ product: {
11866
+ id: string;
11867
+ name: string;
11868
+ slug: string;
11869
+ status: "published" | "draft" | "hidden" | null;
11870
+ images: string[];
11871
+ badge: {
11872
+ content?: string | undefined;
11873
+ backgroundColor?: string | undefined;
11874
+ textColor?: string | undefined;
11875
+ } | null;
11876
+ storeId: string;
11877
+ categoryId: string | null;
11878
+ brandId: string | null;
11879
+ summary: string | null;
11880
+ content: any;
11881
+ createdAt: string;
11882
+ updatedAt: string;
11883
+ productTaxRate: {
11884
+ productId: string;
11885
+ taxRateId: string;
11886
+ taxRate: {
11887
+ id: string;
11888
+ storeId: string;
11889
+ name: string;
11890
+ rate: string;
11891
+ label: string | null;
11892
+ createdAt: string;
11893
+ updatedAt: string;
11894
+ };
11895
+ createdAt: string;
11896
+ updatedAt: string;
11897
+ } | null;
11898
+ flags: {
11899
+ gold?: boolean | null | undefined;
11900
+ event?: {
11901
+ enabled: boolean;
11902
+ startsAt?: string | null | undefined;
11903
+ location?: string | null | undefined;
11904
+ capacity?: number | null | undefined;
11905
+ guestLabel?: string | null | undefined;
11906
+ guest?: string | null | undefined;
11907
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11908
+ salesPaused?: boolean | null | undefined;
11909
+ } | null | undefined;
11910
+ scheduledPublishAt?: string | null | undefined;
11911
+ gpsr?: {
11912
+ safetyInformation?: {
11913
+ type: "NO_SAFETY_INFORMATION";
11914
+ } | {
11915
+ type: "TEXT";
11916
+ description: string;
11917
+ } | null | undefined;
11918
+ } | null | undefined;
11919
+ } | null;
11920
+ type: "set" | "product" | "bundle";
11921
+ subscriptionMode: "optional" | "only" | "rolling";
11922
+ subscriptionAddonDiscountPercent: number | null;
11923
+ bundleDiscountPercentage: string | null;
11924
+ bundlePriceMode: "fixed" | "amount" | "percent";
11925
+ bundleFixedPriceAmount: string | null;
11926
+ bundleAmountOffAmount: string | null;
11927
+ productCollections: {
11928
+ collection: {
11929
+ createdAt: string;
11930
+ description: any;
11931
+ id: string;
11932
+ image: string | null;
11933
+ name: string;
11934
+ slug: string;
11935
+ storeId: string;
11936
+ updatedAt: string;
11937
+ filter: {
11938
+ type: "manual";
11939
+ } | {
11940
+ type: "dynamicPrice";
11941
+ min?: number | null | undefined;
11942
+ max?: number | null | undefined;
11943
+ } | {
11944
+ type: "variantValues";
11945
+ values: Record<string, string[]>;
11946
+ } | {
11947
+ type: "newest";
11948
+ days?: number | null | undefined;
11949
+ };
11950
+ active: boolean;
11951
+ seo?: {
11952
+ title?: string | null | undefined;
11953
+ description?: string | null | undefined;
11954
+ canonical?: string | null | undefined;
11955
+ } | null | undefined;
11956
+ };
11957
+ collectionId: string;
11958
+ position: string | null;
11959
+ productId: string;
11960
+ }[];
11961
+ bundleGroups: {
11962
+ id: string;
11963
+ minQuantity: number;
11964
+ maxQuantity: number | null;
11965
+ allowDuplicates: boolean;
11966
+ }[];
11967
+ bundleProducts: {
11968
+ bundleId: string;
11969
+ variantId: string;
11970
+ groupId: string | null;
11971
+ quantity: number;
11972
+ position: number;
11973
+ forced: boolean;
11974
+ defaultSelected: boolean;
11975
+ maxQuantity: number | null;
11976
+ createdAt: string;
11977
+ updatedAt: string;
11978
+ variant: {
11979
+ id: string;
11980
+ sku: string | null;
11981
+ barcode: string | null;
11982
+ description: string | null;
11983
+ price: string;
11984
+ shippable: boolean;
11985
+ calculatedPrice: string | null;
11986
+ stock: number | null;
11987
+ depth: number | null;
11988
+ width: number | null;
11989
+ height: number | null;
11990
+ weight: number | null;
11991
+ images: string[];
11992
+ digital: string[] | null;
11993
+ externalId: string | null;
11994
+ product: {
11995
+ id: string;
11996
+ name: string;
11997
+ slug: string;
11998
+ images: string[];
11999
+ productTaxRate: {
12000
+ taxRate: {
12001
+ rate: string;
12002
+ label: string | null;
12003
+ };
12004
+ } | null;
12005
+ };
12006
+ createdAt: string;
12007
+ productId: string;
12008
+ updatedAt: string;
12009
+ attributes: {
12010
+ checked: boolean | null;
12011
+ key: string;
12012
+ value: string;
12013
+ }[] | null;
12014
+ storeId: string;
12015
+ originalPrice?: string | null | undefined;
12016
+ } & {
12017
+ originalPrice: string;
12018
+ };
12019
+ }[];
12020
+ setProduct: {
12021
+ selectionCount: number;
12022
+ allowDuplicates: boolean;
12023
+ discountPercentage: string;
12024
+ } | null;
12025
+ seo: {
12026
+ title?: string | null | undefined;
12027
+ description?: string | null | undefined;
12028
+ canonical?: string | null | undefined;
12029
+ } | null;
12030
+ stripeTaxCode: string | null;
12031
+ active?: boolean | null | undefined;
12032
+ };
12033
+ createdAt: string;
12034
+ productId: string;
12035
+ updatedAt: string;
12036
+ combinations: {
12037
+ createdAt: string;
12038
+ updatedAt: string;
12039
+ productVariantId: string;
12040
+ variantValueId: string;
12041
+ variantValue: {
12042
+ id: string;
12043
+ value: string;
12044
+ variantType: {
12045
+ id: string;
12046
+ label: string;
12047
+ productId?: string | null | undefined;
12048
+ createdAt?: string | null | undefined;
12049
+ updatedAt?: string | null | undefined;
12050
+ };
12051
+ variantTypeId?: string | null | undefined;
12052
+ };
12053
+ }[];
12054
+ attributes: {
12055
+ checked: boolean | null;
12056
+ key: string;
12057
+ value: string;
12058
+ }[] | null;
12059
+ storeId: string;
12060
+ originalPrice?: string | null | undefined;
12061
+ } & {
12062
+ originalPrice: string;
12063
+ }), "calculatedPrice" | "originalPrice" | "prePromotionPrice" | "omnibusPrice"> as `${K}Gross`]: string | null;
12064
+ };
12065
+ productVariantId: string;
12066
+ preVolumePricingPrice: string | null;
12067
+ subscriptionPlanId: string | null;
12068
+ subscriptionPlan: {
12069
+ id: string;
12070
+ name: string;
12071
+ cadence: "month" | "week";
12072
+ interval: number;
12073
+ discountPercent: number;
12074
+ description: string | null;
12075
+ benefits: string | null;
12076
+ active: boolean;
12077
+ createdAt: string;
12078
+ position: number;
12079
+ storeId: string;
12080
+ updatedAt: string;
12081
+ } | null;
12082
+ rollingCycle: {
12083
+ id: string;
12084
+ title: string;
12085
+ startsAt: string;
12086
+ items: {
12087
+ productVariantId: string;
12088
+ productId: string;
12089
+ name: string;
12090
+ variantLabel: string | null;
12091
+ sku: string | null;
12092
+ image: string | null;
12093
+ quantity: number;
12094
+ }[];
12095
+ } | null;
12096
+ subscriptionAddon: {
12097
+ addonId: string;
12098
+ discountPercent: number;
12099
+ listPrice: string;
12100
+ } | null;
12101
+ slotId: string | null;
12102
+ attendees: {
12103
+ name: string;
12104
+ email: string | null;
12105
+ phone: string | null;
12106
+ dietary: string | null;
12107
+ notes: string | null;
12108
+ }[] | null;
12109
+ setSelections: {
12110
+ id: string;
12111
+ lineItemId: string;
12112
+ selectedVariantId: string;
12113
+ quantity: number;
12114
+ position: number;
12115
+ createdAt: string;
12116
+ updatedAt: string;
12117
+ selectedVariant: {
12118
+ id: string;
12119
+ price: string;
12120
+ product: {
12121
+ id: string;
12122
+ name: string;
12123
+ };
12124
+ combinations: {
12125
+ createdAt: string;
12126
+ updatedAt: string;
12127
+ productVariantId: string;
12128
+ variantValueId: string;
12129
+ variantValue: {
12130
+ id: string;
12131
+ value: string;
12132
+ variantType: {
12133
+ id: string;
12134
+ label: string;
12135
+ productId?: string | null | undefined;
12136
+ createdAt?: string | null | undefined;
12137
+ updatedAt?: string | null | undefined;
12138
+ };
12139
+ variantTypeId?: string | null | undefined;
12140
+ };
12141
+ }[];
12142
+ };
12143
+ }[];
12144
+ }[];
12145
+ updatedAt: string;
12146
+ couponId: string | null;
12147
+ coupon: {
12148
+ type: "fixed" | "percentage";
12149
+ value: string;
12150
+ code: string;
12151
+ startDate: string | null;
12152
+ endDate: string | null;
12153
+ minProductCount: number | null;
12154
+ maxProductCount: number | null;
12155
+ } | null;
12156
+ billingAddress: {
12157
+ id: string;
12158
+ type: "shipping" | "billing" | "merchant";
12159
+ company: string | null;
12160
+ name: string | null;
12161
+ city: string | null;
12162
+ line1: string | null;
12163
+ line2: string | null;
12164
+ postalCode: string | null;
12165
+ state: string | null;
12166
+ country: string | null;
12167
+ phone: string | null;
12168
+ taxId: string | null;
12169
+ createdAt: string;
12170
+ updatedAt: string;
12171
+ } | null;
12172
+ shippingAddress: {
12173
+ id: string;
12174
+ type: "shipping" | "billing" | "merchant";
12175
+ company: string | null;
12176
+ name: string | null;
12177
+ city: string | null;
12178
+ line1: string | null;
12179
+ line2: string | null;
12180
+ postalCode: string | null;
12181
+ state: string | null;
12182
+ country: string | null;
12183
+ phone: string | null;
12184
+ taxId: string | null;
12185
+ createdAt: string;
12186
+ updatedAt: string;
12187
+ } | null;
12188
+ billingAddressId: string | null;
12189
+ shippingAddressId: string | null;
12190
+ stripePaymentIntentId: string | null;
12191
+ checkoutSessionId: string | null;
12192
+ customerId: string | null;
12193
+ customer: {
12194
+ id: string;
12195
+ email: string | null;
12196
+ storeId: string;
12197
+ createdAt: string;
12198
+ updatedAt: string;
12199
+ userId: string | null;
12200
+ stripeCustomerId: string | null;
12201
+ user: {
12202
+ id: string;
12203
+ name: string;
12204
+ email: string;
12205
+ } | null;
12206
+ couponId: string | null;
12207
+ coupon: {
12208
+ type: "fixed" | "percentage";
12209
+ value: string;
12210
+ code: string;
12211
+ startDate: string | null;
12212
+ endDate: string | null;
12213
+ minProductCount: number | null;
12214
+ maxProductCount: number | null;
12215
+ } | null;
12216
+ } | null;
12217
+ addonData: {
12218
+ [x: string]: unknown;
12219
+ } | null;
12220
+ deliverySlot: unknown;
12221
+ ucpSessionStatus: "incomplete" | "ready_for_complete" | "requires_escalation" | "complete_in_progress" | "completed" | "canceled" | null;
12222
+ ucpMetadata: {
12223
+ buyerEmail?: string | undefined;
12224
+ buyerName?: string | undefined;
12225
+ buyerPhone?: string | undefined;
12226
+ agentId?: string | undefined;
12227
+ externalReference?: string | undefined;
12228
+ escalationReason?: string | undefined;
12229
+ } | null;
12230
+ acpSessionStatus: "completed" | "canceled" | "not_ready_for_payment" | "ready_for_payment" | null;
12231
+ acpMetadata: {
12232
+ buyerEmail?: string | undefined;
12233
+ buyerName?: string | undefined;
12234
+ buyerPhone?: string | undefined;
12235
+ agentId?: string | undefined;
12236
+ externalReference?: string | undefined;
12237
+ idempotencyKey?: string | undefined;
12238
+ } | null;
12239
+ inventory: {
12240
+ committedAt: string;
12241
+ lines: {
12242
+ variantId: string;
12243
+ quantity: number;
12244
+ }[];
12245
+ } | null;
12246
+ reservation: {
12247
+ expiredAt: string | null;
12248
+ transferDeclaredAt: string | null;
12249
+ } | null;
12250
+ freeShippingThreshold: number | null;
12251
+ totalNet: number | null;
12252
+ subtotalNet: number | null;
12253
+ totalGross: number | null;
12254
+ subtotalGross: number | null;
12255
+ shippingGross: number | null;
12256
+ total: number | null;
12257
+ subtotal: number | null;
12258
+ totalTax: number | null;
12259
+ taxBreakdown: Record<string, {
12260
+ taxRate: {
12261
+ id: string;
12262
+ storeId: string;
12263
+ name: string;
12264
+ rate: string;
12265
+ label: string | null;
12266
+ createdAt: string;
12267
+ updatedAt: string;
12268
+ };
12269
+ tax: number | null;
12270
+ }> | null;
12271
+ stripeTaxData: {
12272
+ amountTax: number;
12273
+ breakdown?: {
12274
+ amount: number;
12275
+ rate: {
12276
+ displayName: string;
12277
+ percentage: number;
12278
+ jurisdiction?: string | null | undefined;
12279
+ };
12280
+ }[] | null | undefined;
12281
+ } | null;
12282
+ currency: string | null;
12283
+ checkoutConsents: {
12284
+ id: string;
12285
+ content: unknown;
12286
+ required: boolean;
12287
+ accepted: boolean;
12288
+ type: "general" | "newsletter";
12289
+ }[] | null;
12290
+ };
12291
+ shipment: APIShipment | null;
12292
+ }>;
12293
+ };
12294
+ type APIOrdersBrowseQueryParams = {
12295
+ offset?: number | undefined;
12296
+ limit?: number | undefined;
12297
+ };
12298
+ type APIOrderGetByIdResult = Omit<{
12299
+ id: string;
12300
+ createdAt: string;
12301
+ updatedAt: string;
12302
+ storeId: string;
12303
+ status: "completed" | "cancelled" | "paid" | "created" | "processing" | "shipped" | "refunded" | "partially_refunded" | "reserved";
12304
+ environment: "live" | "test";
12305
+ source: string | null;
12306
+ externalId: string | null;
12307
+ customerId: string | null;
12308
+ attribution: {
12309
+ firstTouch: {
12310
+ source: string | null;
12311
+ medium: string | null;
12312
+ campaign: string | null;
12313
+ referrerHost: string | null;
12314
+ ts: number;
12315
+ };
12316
+ lastTouch: {
12317
+ source: string | null;
12318
+ medium: string | null;
12319
+ campaign: string | null;
12320
+ referrerHost: string | null;
12321
+ ts: number;
12322
+ };
12323
+ } | null;
12324
+ lookup: number;
12325
+ cartId: string | null;
12326
+ orderData: {
12327
+ id: string;
12328
+ storeId: string;
12329
+ shippingId: string | null;
12330
+ shipping: {
12331
+ id: string;
12332
+ storeId: string;
12333
+ name: string;
12334
+ price: string;
12335
+ freeShippingThreshold: string | null;
12336
+ minShippingTime: number | null;
12337
+ maxShippingTime: number | null;
12338
+ description: string | null;
12339
+ addonId: string | null;
12340
+ shippingAddon: {
12341
+ type: "shipping" | "products" | "analytics" | "invoicing" | "orders";
12342
+ storeId: string;
12343
+ id: string;
12344
+ name: string;
12345
+ createdAt: string;
12346
+ updatedAt: string;
12347
+ } | null;
12348
+ type: "courier" | "parcel" | "pickup_point" | "in_store";
12349
+ addonData: {
12350
+ id: number;
12351
+ name: string;
12352
+ service: "dpd" | "fedex" | "ups" | "gls" | "poczta" | "inpost" | "orlen" | "dhl";
12353
+ } | {
12354
+ carrier: "inpost";
12355
+ name: string;
12356
+ service: "inpost";
12357
+ } | {
12358
+ carrier: "gls";
12359
+ name: string;
12360
+ service: "gls";
12361
+ } | null;
12362
+ deliverySlots: unknown;
12363
+ shippingTaxRate: {
12364
+ shippingId: string;
12365
+ taxRateId: string;
12366
+ taxRate: {
12367
+ id: string;
12368
+ storeId: string;
12369
+ name: string;
12370
+ rate: string;
12371
+ label: string | null;
12372
+ createdAt: string;
12373
+ updatedAt: string;
12374
+ };
12375
+ createdAt: string;
12376
+ updatedAt: string;
12377
+ } | null;
12378
+ position: number | null;
12379
+ createdAt: string;
12380
+ updatedAt: string;
12381
+ countries: string[] | null;
12382
+ } | null;
12383
+ createdAt: string;
12384
+ lineItems: {
12385
+ id: string;
12386
+ cartId: string;
12387
+ quantity: number;
12388
+ unitCost: string | null;
12389
+ createdAt: string;
12390
+ updatedAt: string;
12391
+ productVariant: {
12392
+ id: string;
12393
+ sku: string | null;
12394
+ barcode: string | null;
12395
+ description: string | null;
12396
+ price: string;
12397
+ calculatedPrice: string | null;
12398
+ prePromotionPrice: string | null;
12399
+ preVolumePricingPrice: string | null;
12400
+ stock: number | null;
12401
+ depth: number | null;
12402
+ width: number | null;
12403
+ height: number | null;
12404
+ weight: number | null;
12405
+ images: string[];
12406
+ digital: string[] | null;
12407
+ shippable: boolean;
12408
+ externalId: string | null;
12409
+ product: {
12410
+ id: string;
12411
+ name: string;
12412
+ slug: string;
12413
+ status: "published" | "draft" | "hidden" | null;
12414
+ images: string[];
12415
+ badge: {
12416
+ content?: string | undefined;
12417
+ backgroundColor?: string | undefined;
12418
+ textColor?: string | undefined;
12419
+ } | null;
12420
+ storeId: string;
12421
+ categoryId: string | null;
12422
+ brandId: string | null;
12423
+ summary: string | null;
12424
+ content: any;
12425
+ createdAt: string;
12426
+ updatedAt: string;
12427
+ productTaxRate: {
12428
+ productId: string;
12429
+ taxRateId: string;
12430
+ taxRate: {
12431
+ id: string;
12432
+ storeId: string;
12433
+ name: string;
12434
+ rate: string;
12435
+ label: string | null;
12436
+ createdAt: string;
12437
+ updatedAt: string;
12438
+ };
12439
+ createdAt: string;
12440
+ updatedAt: string;
12441
+ } | null;
12442
+ flags: {
12443
+ gold?: boolean | null | undefined;
12444
+ event?: {
12445
+ enabled: boolean;
12446
+ startsAt?: string | null | undefined;
12447
+ location?: string | null | undefined;
12448
+ capacity?: number | null | undefined;
12449
+ guestLabel?: string | null | undefined;
12450
+ guest?: string | null | undefined;
12451
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
12452
+ salesPaused?: boolean | null | undefined;
12453
+ } | null | undefined;
12454
+ scheduledPublishAt?: string | null | undefined;
12455
+ gpsr?: {
12456
+ safetyInformation?: {
12457
+ type: "NO_SAFETY_INFORMATION";
12458
+ } | {
12459
+ type: "TEXT";
12460
+ description: string;
12461
+ } | null | undefined;
12462
+ } | null | undefined;
12463
+ } | null;
12464
+ type: "set" | "product" | "bundle";
12465
+ subscriptionMode: "optional" | "only" | "rolling";
12466
+ subscriptionAddonDiscountPercent: number | null;
12467
+ bundleDiscountPercentage: string | null;
12468
+ bundlePriceMode: "fixed" | "amount" | "percent";
12469
+ bundleFixedPriceAmount: string | null;
12470
+ bundleAmountOffAmount: string | null;
12471
+ productCollections: {
12472
+ collection: {
12473
+ createdAt: string;
12474
+ description: any;
12475
+ id: string;
12476
+ image: string | null;
12477
+ name: string;
12478
+ slug: string;
12479
+ storeId: string;
12480
+ updatedAt: string;
12481
+ filter: {
12482
+ type: "manual";
12483
+ } | {
12484
+ type: "dynamicPrice";
12485
+ min?: number | null | undefined;
12486
+ max?: number | null | undefined;
12487
+ } | {
12488
+ type: "variantValues";
12489
+ values: Record<string, string[]>;
12490
+ } | {
12491
+ type: "newest";
12492
+ days?: number | null | undefined;
12493
+ };
12494
+ active: boolean;
12495
+ seo?: {
12496
+ title?: string | null | undefined;
12497
+ description?: string | null | undefined;
12498
+ canonical?: string | null | undefined;
12499
+ } | null | undefined;
12500
+ };
12501
+ collectionId: string;
12502
+ position: string | null;
12503
+ productId: string;
12504
+ }[];
12505
+ bundleGroups: {
12506
+ id: string;
12507
+ minQuantity: number;
12508
+ maxQuantity: number | null;
12509
+ allowDuplicates: boolean;
12510
+ }[];
12511
+ bundleProducts: {
12512
+ bundleId: string;
12513
+ variantId: string;
12514
+ groupId: string | null;
12515
+ quantity: number;
12516
+ position: number;
12517
+ forced: boolean;
12518
+ defaultSelected: boolean;
12519
+ maxQuantity: number | null;
12520
+ createdAt: string;
12521
+ updatedAt: string;
12522
+ variant: {
12523
+ id: string;
12524
+ sku: string | null;
12525
+ barcode: string | null;
12526
+ description: string | null;
12527
+ price: string;
12528
+ shippable: boolean;
12529
+ calculatedPrice: string | null;
12530
+ stock: number | null;
12531
+ depth: number | null;
12532
+ width: number | null;
12533
+ height: number | null;
12534
+ weight: number | null;
12535
+ images: string[];
12536
+ digital: string[] | null;
12537
+ externalId: string | null;
12538
+ product: {
12539
+ id: string;
12540
+ name: string;
12541
+ slug: string;
12542
+ images: string[];
12543
+ productTaxRate: {
12544
+ taxRate: {
12545
+ rate: string;
12546
+ label: string | null;
12547
+ };
12548
+ } | null;
12549
+ };
12550
+ createdAt: string;
12551
+ productId: string;
12552
+ updatedAt: string;
12553
+ attributes: {
12554
+ checked: boolean | null;
12555
+ key: string;
12556
+ value: string;
12557
+ }[] | null;
12558
+ storeId: string;
12559
+ originalPrice?: string | null | undefined;
12560
+ } & {
12561
+ originalPrice: string;
12562
+ };
12563
+ }[];
12564
+ setProduct: {
12565
+ selectionCount: number;
12566
+ allowDuplicates: boolean;
12567
+ discountPercentage: string;
12568
+ } | null;
12569
+ seo: {
12570
+ title?: string | null | undefined;
12571
+ description?: string | null | undefined;
12572
+ canonical?: string | null | undefined;
12573
+ } | null;
12574
+ stripeTaxCode: string | null;
12575
+ active?: boolean | null | undefined;
12576
+ };
12577
+ createdAt: string;
12578
+ productId: string;
12579
+ updatedAt: string;
12580
+ combinations: {
12581
+ createdAt: string;
12582
+ updatedAt: string;
12583
+ productVariantId: string;
12584
+ variantValueId: string;
12585
+ variantValue: {
12586
+ id: string;
12587
+ value: string;
12588
+ variantType: {
12589
+ id: string;
12590
+ label: string;
12591
+ productId?: string | null | undefined;
12592
+ createdAt?: string | null | undefined;
12593
+ updatedAt?: string | null | undefined;
12594
+ };
12595
+ variantTypeId?: string | null | undefined;
12596
+ };
12597
+ }[];
12598
+ attributes: {
12599
+ checked: boolean | null;
12600
+ key: string;
12601
+ value: string;
12602
+ }[] | null;
12603
+ storeId: string;
12604
+ originalPrice?: string | null | undefined;
12605
+ } & {
12606
+ originalPrice: string;
12607
+ };
12608
+ productVariantId: string;
12609
+ preVolumePricingPrice: string | null;
12610
+ subscriptionPlanId: string | null;
12611
+ subscriptionPlan: {
12612
+ id: string;
12613
+ name: string;
12614
+ cadence: "month" | "week";
12615
+ interval: number;
12616
+ discountPercent: number;
12617
+ description: string | null;
12618
+ benefits: string | null;
12619
+ active: boolean;
12620
+ createdAt: string;
12621
+ position: number;
12622
+ storeId: string;
12623
+ updatedAt: string;
12624
+ } | null;
12625
+ rollingCycle: {
12626
+ id: string;
12627
+ title: string;
12628
+ startsAt: string;
12629
+ items: {
12630
+ productVariantId: string;
12631
+ productId: string;
12632
+ name: string;
12633
+ variantLabel: string | null;
12634
+ sku: string | null;
12635
+ image: string | null;
12636
+ quantity: number;
12637
+ }[];
12638
+ } | null;
12639
+ subscriptionAddon: {
12640
+ addonId: string;
12641
+ discountPercent: number;
12642
+ listPrice: string;
12643
+ } | null;
12644
+ slotId: string | null;
12645
+ attendees: {
12646
+ name: string;
12647
+ email: string | null;
12648
+ phone: string | null;
12649
+ dietary: string | null;
12650
+ notes: string | null;
12651
+ }[] | null;
12652
+ setSelections: {
12653
+ id: string;
12654
+ lineItemId: string;
12655
+ selectedVariantId: string;
12656
+ quantity: number;
12657
+ position: number;
12658
+ createdAt: string;
12659
+ updatedAt: string;
12660
+ selectedVariant: {
12661
+ id: string;
12662
+ price: string;
12663
+ product: {
12664
+ id: string;
12665
+ name: string;
12666
+ };
12667
+ combinations: {
12668
+ createdAt: string;
12669
+ updatedAt: string;
12670
+ productVariantId: string;
12671
+ variantValueId: string;
12672
+ variantValue: {
12673
+ id: string;
12674
+ value: string;
12675
+ variantType: {
12676
+ id: string;
12677
+ label: string;
12678
+ productId?: string | null | undefined;
12679
+ createdAt?: string | null | undefined;
12680
+ updatedAt?: string | null | undefined;
12681
+ };
12682
+ variantTypeId?: string | null | undefined;
12683
+ };
12684
+ }[];
12685
+ };
12686
+ }[];
12687
+ }[];
12688
+ updatedAt: string;
12689
+ couponId: string | null;
12690
+ coupon: {
12691
+ type: "fixed" | "percentage";
12692
+ value: string;
12693
+ code: string;
12694
+ startDate: string | null;
12695
+ endDate: string | null;
12696
+ minProductCount: number | null;
12697
+ maxProductCount: number | null;
12698
+ } | null;
12699
+ billingAddress: {
12700
+ id: string;
12701
+ type: "shipping" | "billing" | "merchant";
12702
+ company: string | null;
12703
+ name: string | null;
12704
+ city: string | null;
12705
+ line1: string | null;
12706
+ line2: string | null;
12707
+ postalCode: string | null;
12708
+ state: string | null;
12709
+ country: string | null;
12710
+ phone: string | null;
12711
+ taxId: string | null;
12712
+ createdAt: string;
12713
+ updatedAt: string;
12714
+ } | null;
12715
+ shippingAddress: {
12716
+ id: string;
12717
+ type: "shipping" | "billing" | "merchant";
12718
+ company: string | null;
12719
+ name: string | null;
12720
+ city: string | null;
12721
+ line1: string | null;
12722
+ line2: string | null;
12723
+ postalCode: string | null;
12724
+ state: string | null;
12725
+ country: string | null;
12726
+ phone: string | null;
12727
+ taxId: string | null;
12728
+ createdAt: string;
12729
+ updatedAt: string;
12730
+ } | null;
12731
+ billingAddressId: string | null;
12732
+ shippingAddressId: string | null;
12733
+ stripePaymentIntentId: string | null;
12734
+ checkoutSessionId: string | null;
12735
+ customerId: string | null;
12736
+ customer: {
12737
+ id: string;
12738
+ email: string | null;
12739
+ storeId: string;
12740
+ createdAt: string;
12741
+ updatedAt: string;
12742
+ userId: string | null;
12743
+ stripeCustomerId: string | null;
12744
+ user: {
12745
+ id: string;
12746
+ name: string;
12747
+ email: string;
12748
+ } | null;
12749
+ couponId: string | null;
12750
+ coupon: {
12751
+ type: "fixed" | "percentage";
12752
+ value: string;
12753
+ code: string;
12754
+ startDate: string | null;
12755
+ endDate: string | null;
12756
+ minProductCount: number | null;
12757
+ maxProductCount: number | null;
12758
+ } | null;
12759
+ } | null;
12760
+ addonData: {
12761
+ [x: string]: unknown;
12762
+ } | null;
12763
+ deliverySlot: unknown;
12764
+ ucpSessionStatus: "incomplete" | "ready_for_complete" | "requires_escalation" | "complete_in_progress" | "completed" | "canceled" | null;
12765
+ ucpMetadata: {
12766
+ buyerEmail?: string | undefined;
12767
+ buyerName?: string | undefined;
12768
+ buyerPhone?: string | undefined;
12769
+ agentId?: string | undefined;
12770
+ externalReference?: string | undefined;
12771
+ escalationReason?: string | undefined;
12772
+ } | null;
12773
+ acpSessionStatus: "completed" | "canceled" | "not_ready_for_payment" | "ready_for_payment" | null;
12774
+ acpMetadata: {
12775
+ buyerEmail?: string | undefined;
12776
+ buyerName?: string | undefined;
12777
+ buyerPhone?: string | undefined;
12778
+ agentId?: string | undefined;
12779
+ externalReference?: string | undefined;
12780
+ idempotencyKey?: string | undefined;
12781
+ } | null;
12782
+ inventory: {
12783
+ committedAt: string;
12784
+ lines: {
12785
+ variantId: string;
12786
+ quantity: number;
12787
+ }[];
12788
+ } | null;
12789
+ reservation: {
12790
+ expiredAt: string | null;
12791
+ transferDeclaredAt: string | null;
12792
+ } | null;
12793
+ freeShippingThreshold: number | null;
12794
+ totalNet: number | null;
12795
+ subtotalNet: number | null;
12796
+ totalGross: number | null;
12797
+ subtotalGross: number | null;
12798
+ shippingGross: number | null;
12799
+ total: number | null;
12800
+ subtotal: number | null;
12801
+ totalTax: number | null;
12802
+ taxBreakdown: Record<string, {
12803
+ taxRate: {
12804
+ id: string;
12805
+ storeId: string;
12806
+ name: string;
12807
+ rate: string;
12808
+ label: string | null;
12809
+ createdAt: string;
12810
+ updatedAt: string;
12811
+ };
12812
+ tax: number | null;
12813
+ }> | null;
12814
+ stripeTaxData: {
12815
+ amountTax: number;
12816
+ breakdown?: {
12817
+ amount: number;
12818
+ rate: {
12819
+ displayName: string;
12820
+ percentage: number;
12821
+ jurisdiction?: string | null | undefined;
12822
+ };
12823
+ }[] | null | undefined;
12824
+ } | null;
12825
+ currency: string | null;
12826
+ checkoutConsents: {
12827
+ id: string;
12828
+ content: unknown;
12829
+ required: boolean;
12830
+ accepted: boolean;
12831
+ type: "general" | "newsletter";
12832
+ }[] | null;
12833
+ };
12834
+ externalShipmentId: string | null;
12835
+ paymentDeduplicationId: string | null;
12836
+ paymentProvider: string | null;
12837
+ ticketCode: string | null;
12838
+ shareToken: string | null;
12839
+ reservationExpiresAt: string | null;
12840
+ activeSubscriptionId: string | null;
12841
+ packedAt: string | null;
12842
+ packedBy: string | null;
12843
+ tags: string[];
12844
+ activeSubscription: {
12845
+ interval: number;
12846
+ id: string;
12847
+ createdAt: string;
12848
+ updatedAt: string;
12849
+ storeId: string;
12850
+ status: "active" | "incomplete" | "canceled" | "trialing" | "past_due" | "paused" | "unpaid" | "incomplete_expired";
12851
+ stripeCustomerId: string | null;
12852
+ environment: "live" | "test";
12853
+ stripeSubscriptionId: string;
12854
+ cancelAtPeriodEnd: boolean | null;
12855
+ productId: string;
12856
+ quantity: number;
12857
+ cadence: "month" | "week";
12858
+ productVariantId: string;
12859
+ originalOrderId: string;
12860
+ canceledAt: Date | null;
12861
+ cancelAt: Date | null;
12862
+ cancellationDetails: {
12863
+ comment?: string | null;
12864
+ feedback?: string | null;
12865
+ reason?: string | null;
12866
+ } | null;
12867
+ productSnapshot: unknown;
12868
+ productVariantSnapshot: unknown;
12869
+ shippingSnapshot: unknown;
12870
+ pausedAt: Date | null;
12871
+ resumeAt: Date | null;
12872
+ skippedUntil: Date | null;
12873
+ skipCount: number;
12874
+ nextBillingDate: Date | null;
12875
+ stripeDeduplicationId: string | null;
12876
+ } | null;
12877
+ } & {
12878
+ orderData: {
12879
+ id: string;
12880
+ storeId: string;
12881
+ shippingId: string | null;
12882
+ shipping: {
12883
+ id: string;
12884
+ storeId: string;
12885
+ name: string;
12886
+ price: string;
12887
+ freeShippingThreshold: string | null;
12888
+ minShippingTime: number | null;
12889
+ maxShippingTime: number | null;
12890
+ description: string | null;
12891
+ addonId: string | null;
12892
+ shippingAddon: {
12893
+ type: "shipping" | "products" | "analytics" | "invoicing" | "orders";
12894
+ storeId: string;
12895
+ id: string;
12896
+ name: string;
12897
+ createdAt: string;
12898
+ updatedAt: string;
12899
+ } | null;
12900
+ type: "courier" | "parcel" | "pickup_point" | "in_store";
12901
+ addonData: {
12902
+ id: number;
12903
+ name: string;
12904
+ service: "dpd" | "fedex" | "ups" | "gls" | "poczta" | "inpost" | "orlen" | "dhl";
12905
+ } | {
12906
+ carrier: "inpost";
12907
+ name: string;
12908
+ service: "inpost";
12909
+ } | {
12910
+ carrier: "gls";
12911
+ name: string;
12912
+ service: "gls";
12913
+ } | null;
12914
+ deliverySlots: unknown;
12915
+ shippingTaxRate: {
12916
+ shippingId: string;
12917
+ taxRateId: string;
12918
+ taxRate: {
12919
+ id: string;
12920
+ storeId: string;
12921
+ name: string;
12922
+ rate: string;
12923
+ label: string | null;
12924
+ createdAt: string;
12925
+ updatedAt: string;
12926
+ };
12927
+ createdAt: string;
12928
+ updatedAt: string;
12929
+ } | null;
12930
+ position: number | null;
12931
+ createdAt: string;
12932
+ updatedAt: string;
12933
+ countries: string[] | null;
12934
+ } | null;
12935
+ createdAt: string;
12936
+ lineItems: {
12937
+ id: string;
12938
+ cartId: string;
12939
+ quantity: number;
12940
+ unitCost: string | null;
12941
+ createdAt: string;
12942
+ updatedAt: string;
12943
+ productVariant: {
12944
+ id: string;
12945
+ sku: string | null;
12946
+ barcode: string | null;
12947
+ description: string | null;
12948
+ price: string;
12949
+ calculatedPrice: string | null;
12950
+ prePromotionPrice: string | null;
12951
+ preVolumePricingPrice: string | null;
12952
+ stock: number | null;
12953
+ depth: number | null;
12954
+ width: number | null;
12955
+ height: number | null;
12956
+ weight: number | null;
12957
+ images: string[];
12958
+ digital: string[] | null;
12959
+ shippable: boolean;
12960
+ externalId: string | null;
12961
+ product: {
12962
+ id: string;
12963
+ name: string;
12964
+ slug: string;
12965
+ status: "published" | "draft" | "hidden" | null;
12966
+ images: string[];
12967
+ badge: {
12968
+ content?: string | undefined;
12969
+ backgroundColor?: string | undefined;
12970
+ textColor?: string | undefined;
12971
+ } | null;
12972
+ storeId: string;
12973
+ categoryId: string | null;
12974
+ brandId: string | null;
12975
+ summary: string | null;
12976
+ content: any;
12977
+ createdAt: string;
12978
+ updatedAt: string;
12979
+ productTaxRate: {
12980
+ productId: string;
12981
+ taxRateId: string;
12982
+ taxRate: {
12983
+ id: string;
12984
+ storeId: string;
12985
+ name: string;
12986
+ rate: string;
12987
+ label: string | null;
12988
+ createdAt: string;
12989
+ updatedAt: string;
12990
+ };
12991
+ createdAt: string;
12992
+ updatedAt: string;
12993
+ } | null;
12994
+ flags: {
12995
+ gold?: boolean | null | undefined;
12996
+ event?: {
12997
+ enabled: boolean;
12998
+ startsAt?: string | null | undefined;
12999
+ location?: string | null | undefined;
13000
+ capacity?: number | null | undefined;
13001
+ guestLabel?: string | null | undefined;
13002
+ guest?: string | null | undefined;
13003
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
13004
+ salesPaused?: boolean | null | undefined;
13005
+ } | null | undefined;
13006
+ scheduledPublishAt?: string | null | undefined;
13007
+ gpsr?: {
13008
+ safetyInformation?: {
13009
+ type: "NO_SAFETY_INFORMATION";
13010
+ } | {
13011
+ type: "TEXT";
13012
+ description: string;
13013
+ } | null | undefined;
13014
+ } | null | undefined;
13015
+ } | null;
13016
+ type: "set" | "product" | "bundle";
13017
+ subscriptionMode: "optional" | "only" | "rolling";
13018
+ subscriptionAddonDiscountPercent: number | null;
13019
+ bundleDiscountPercentage: string | null;
13020
+ bundlePriceMode: "fixed" | "amount" | "percent";
13021
+ bundleFixedPriceAmount: string | null;
13022
+ bundleAmountOffAmount: string | null;
13023
+ productCollections: {
13024
+ collection: {
13025
+ createdAt: string;
13026
+ description: any;
13027
+ id: string;
13028
+ image: string | null;
13029
+ name: string;
13030
+ slug: string;
13031
+ storeId: string;
13032
+ updatedAt: string;
13033
+ filter: {
13034
+ type: "manual";
13035
+ } | {
13036
+ type: "dynamicPrice";
13037
+ min?: number | null | undefined;
13038
+ max?: number | null | undefined;
13039
+ } | {
13040
+ type: "variantValues";
13041
+ values: Record<string, string[]>;
13042
+ } | {
13043
+ type: "newest";
13044
+ days?: number | null | undefined;
13045
+ };
13046
+ active: boolean;
13047
+ seo?: {
13048
+ title?: string | null | undefined;
13049
+ description?: string | null | undefined;
13050
+ canonical?: string | null | undefined;
13051
+ } | null | undefined;
13052
+ };
13053
+ collectionId: string;
13054
+ position: string | null;
13055
+ productId: string;
13056
+ }[];
13057
+ bundleGroups: {
13058
+ id: string;
13059
+ minQuantity: number;
13060
+ maxQuantity: number | null;
13061
+ allowDuplicates: boolean;
13062
+ }[];
13063
+ bundleProducts: {
13064
+ bundleId: string;
13065
+ variantId: string;
13066
+ groupId: string | null;
13067
+ quantity: number;
13068
+ position: number;
13069
+ forced: boolean;
13070
+ defaultSelected: boolean;
13071
+ maxQuantity: number | null;
13072
+ createdAt: string;
13073
+ updatedAt: string;
13074
+ variant: {
13075
+ id: string;
13076
+ sku: string | null;
13077
+ barcode: string | null;
13078
+ description: string | null;
13079
+ price: string;
13080
+ shippable: boolean;
13081
+ calculatedPrice: string | null;
13082
+ stock: number | null;
13083
+ depth: number | null;
13084
+ width: number | null;
13085
+ height: number | null;
13086
+ weight: number | null;
13087
+ images: string[];
13088
+ digital: string[] | null;
13089
+ externalId: string | null;
13090
+ product: {
13091
+ id: string;
13092
+ name: string;
13093
+ slug: string;
13094
+ images: string[];
13095
+ productTaxRate: {
13096
+ taxRate: {
13097
+ rate: string;
13098
+ label: string | null;
13099
+ };
13100
+ } | null;
13101
+ };
13102
+ createdAt: string;
13103
+ productId: string;
13104
+ updatedAt: string;
13105
+ attributes: {
13106
+ checked: boolean | null;
13107
+ key: string;
13108
+ value: string;
13109
+ }[] | null;
13110
+ storeId: string;
13111
+ originalPrice?: string | null | undefined;
13112
+ } & {
13113
+ originalPrice: string;
13114
+ };
13115
+ }[];
13116
+ setProduct: {
13117
+ selectionCount: number;
13118
+ allowDuplicates: boolean;
13119
+ discountPercentage: string;
13120
+ } | null;
13121
+ seo: {
13122
+ title?: string | null | undefined;
13123
+ description?: string | null | undefined;
13124
+ canonical?: string | null | undefined;
13125
+ } | null;
13126
+ stripeTaxCode: string | null;
13127
+ active?: boolean | null | undefined;
13128
+ };
13129
+ createdAt: string;
13130
+ productId: string;
13131
+ updatedAt: string;
13132
+ combinations: {
13133
+ createdAt: string;
13134
+ updatedAt: string;
13135
+ productVariantId: string;
13136
+ variantValueId: string;
13137
+ variantValue: {
13138
+ id: string;
13139
+ value: string;
13140
+ variantType: {
13141
+ id: string;
13142
+ label: string;
13143
+ productId?: string | null | undefined;
13144
+ createdAt?: string | null | undefined;
13145
+ updatedAt?: string | null | undefined;
13146
+ };
13147
+ variantTypeId?: string | null | undefined;
13148
+ };
13149
+ }[];
13150
+ attributes: {
13151
+ checked: boolean | null;
13152
+ key: string;
13153
+ value: string;
13154
+ }[] | null;
13155
+ storeId: string;
13156
+ originalPrice?: string | null | undefined;
13157
+ } & {
13158
+ originalPrice: string;
13159
+ };
13160
+ productVariantId: string;
13161
+ preVolumePricingPrice: string | null;
13162
+ subscriptionPlanId: string | null;
13163
+ subscriptionPlan: {
13164
+ id: string;
13165
+ name: string;
13166
+ cadence: "month" | "week";
13167
+ interval: number;
13168
+ discountPercent: number;
13169
+ description: string | null;
13170
+ benefits: string | null;
13171
+ active: boolean;
13172
+ createdAt: string;
13173
+ position: number;
13174
+ storeId: string;
13175
+ updatedAt: string;
13176
+ } | null;
13177
+ rollingCycle: {
13178
+ id: string;
13179
+ title: string;
13180
+ startsAt: string;
13181
+ items: {
13182
+ productVariantId: string;
13183
+ productId: string;
13184
+ name: string;
13185
+ variantLabel: string | null;
13186
+ sku: string | null;
13187
+ image: string | null;
13188
+ quantity: number;
13189
+ }[];
13190
+ } | null;
13191
+ subscriptionAddon: {
13192
+ addonId: string;
13193
+ discountPercent: number;
13194
+ listPrice: string;
13195
+ } | null;
13196
+ slotId: string | null;
13197
+ attendees: {
13198
+ name: string;
13199
+ email: string | null;
13200
+ phone: string | null;
13201
+ dietary: string | null;
13202
+ notes: string | null;
13203
+ }[] | null;
13204
+ setSelections: {
13205
+ id: string;
13206
+ lineItemId: string;
13207
+ selectedVariantId: string;
13208
+ quantity: number;
13209
+ position: number;
13210
+ createdAt: string;
13211
+ updatedAt: string;
13212
+ selectedVariant: {
13213
+ id: string;
13214
+ price: string;
13215
+ product: {
13216
+ id: string;
13217
+ name: string;
13218
+ };
13219
+ combinations: {
13220
+ createdAt: string;
13221
+ updatedAt: string;
13222
+ productVariantId: string;
13223
+ variantValueId: string;
13224
+ variantValue: {
13225
+ id: string;
13226
+ value: string;
13227
+ variantType: {
13228
+ id: string;
13229
+ label: string;
13230
+ productId?: string | null | undefined;
13231
+ createdAt?: string | null | undefined;
13232
+ updatedAt?: string | null | undefined;
13233
+ };
13234
+ variantTypeId?: string | null | undefined;
13235
+ };
13236
+ }[];
13237
+ };
13238
+ }[];
13239
+ }[];
13240
+ updatedAt: string;
13241
+ couponId: string | null;
11267
13242
  coupon: {
11268
13243
  type: "fixed" | "percentage";
11269
13244
  value: string;
@@ -11408,55 +13383,12 @@ type APIOrderGetByIdResult = Omit<{
11408
13383
  type: "general" | "newsletter";
11409
13384
  }[] | null;
11410
13385
  };
11411
- externalShipmentId: string | null;
11412
- paymentDeduplicationId: string | null;
11413
- paymentProvider: string | null;
11414
- ticketCode: string | null;
11415
- shareToken: string | null;
11416
- reservationExpiresAt: string | null;
11417
- activeSubscriptionId: string | null;
11418
- packedAt: string | null;
11419
- packedBy: string | null;
11420
- tags: string[];
11421
- activeSubscription: {
11422
- interval: number;
11423
- id: string;
11424
- createdAt: string;
11425
- updatedAt: string;
11426
- storeId: string;
11427
- status: "active" | "incomplete" | "canceled" | "trialing" | "past_due" | "paused" | "unpaid" | "incomplete_expired";
11428
- stripeCustomerId: string | null;
11429
- environment: "live" | "test";
11430
- stripeSubscriptionId: string;
11431
- cancelAtPeriodEnd: boolean | null;
11432
- productId: string;
11433
- quantity: number;
11434
- cadence: "month" | "week";
11435
- productVariantId: string;
11436
- originalOrderId: string;
11437
- canceledAt: Date | null;
11438
- cancelAt: Date | null;
11439
- cancellationDetails: {
11440
- comment?: string | null;
11441
- feedback?: string | null;
11442
- reason?: string | null;
11443
- } | null;
11444
- productSnapshot: unknown;
11445
- productVariantSnapshot: unknown;
11446
- shippingSnapshot: unknown;
11447
- pausedAt: Date | null;
11448
- resumeAt: Date | null;
11449
- skippedUntil: Date | null;
11450
- skipCount: number;
11451
- nextBillingDate: Date | null;
11452
- stripeDeduplicationId: string | null;
11453
- } | null;
11454
- } & {
13386
+ }, "attribution" | "orderData"> & {
11455
13387
  orderData: {
11456
13388
  id: string;
11457
13389
  storeId: string;
11458
13390
  shippingId: string | null;
11459
- shipping: {
13391
+ shipping: ({
11460
13392
  id: string;
11461
13393
  storeId: string;
11462
13394
  name: string;
@@ -11495,242 +13427,906 @@ type APIOrderGetByIdResult = Omit<{
11495
13427
  taxRate: {
11496
13428
  id: string;
11497
13429
  storeId: string;
11498
- name: string;
11499
- rate: string;
11500
- label: string | null;
13430
+ name: string;
13431
+ rate: string;
13432
+ label: string | null;
13433
+ createdAt: string;
13434
+ updatedAt: string;
13435
+ };
13436
+ createdAt: string;
13437
+ updatedAt: string;
13438
+ } | null;
13439
+ position: number | null;
13440
+ createdAt: string;
13441
+ updatedAt: string;
13442
+ countries: string[] | null;
13443
+ } & {
13444
+ priceGross: string;
13445
+ }) | null;
13446
+ createdAt: string;
13447
+ lineItems: {
13448
+ id: string;
13449
+ cartId: string;
13450
+ quantity: number;
13451
+ unitCost: string | null;
13452
+ createdAt: string;
13453
+ updatedAt: string;
13454
+ productVariant: {
13455
+ [K in keyof ({
13456
+ id: string;
13457
+ sku: string | null;
13458
+ barcode: string | null;
13459
+ description: string | null;
13460
+ price: string;
13461
+ calculatedPrice: string | null;
13462
+ prePromotionPrice: string | null;
13463
+ preVolumePricingPrice: string | null;
13464
+ stock: number | null;
13465
+ depth: number | null;
13466
+ width: number | null;
13467
+ height: number | null;
13468
+ weight: number | null;
13469
+ images: string[];
13470
+ digital: string[] | null;
13471
+ shippable: boolean;
13472
+ externalId: string | null;
13473
+ product: {
13474
+ id: string;
13475
+ name: string;
13476
+ slug: string;
13477
+ status: "published" | "draft" | "hidden" | null;
13478
+ images: string[];
13479
+ badge: {
13480
+ content?: string | undefined;
13481
+ backgroundColor?: string | undefined;
13482
+ textColor?: string | undefined;
13483
+ } | null;
13484
+ storeId: string;
13485
+ categoryId: string | null;
13486
+ brandId: string | null;
13487
+ summary: string | null;
13488
+ content: any;
13489
+ createdAt: string;
13490
+ updatedAt: string;
13491
+ productTaxRate: {
13492
+ productId: string;
13493
+ taxRateId: string;
13494
+ taxRate: {
13495
+ id: string;
13496
+ storeId: string;
13497
+ name: string;
13498
+ rate: string;
13499
+ label: string | null;
13500
+ createdAt: string;
13501
+ updatedAt: string;
13502
+ };
13503
+ createdAt: string;
13504
+ updatedAt: string;
13505
+ } | null;
13506
+ flags: {
13507
+ gold?: boolean | null | undefined;
13508
+ event?: {
13509
+ enabled: boolean;
13510
+ startsAt?: string | null | undefined;
13511
+ location?: string | null | undefined;
13512
+ capacity?: number | null | undefined;
13513
+ guestLabel?: string | null | undefined;
13514
+ guest?: string | null | undefined;
13515
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
13516
+ salesPaused?: boolean | null | undefined;
13517
+ } | null | undefined;
13518
+ scheduledPublishAt?: string | null | undefined;
13519
+ gpsr?: {
13520
+ safetyInformation?: {
13521
+ type: "NO_SAFETY_INFORMATION";
13522
+ } | {
13523
+ type: "TEXT";
13524
+ description: string;
13525
+ } | null | undefined;
13526
+ } | null | undefined;
13527
+ } | null;
13528
+ type: "set" | "product" | "bundle";
13529
+ subscriptionMode: "optional" | "only" | "rolling";
13530
+ subscriptionAddonDiscountPercent: number | null;
13531
+ bundleDiscountPercentage: string | null;
13532
+ bundlePriceMode: "fixed" | "amount" | "percent";
13533
+ bundleFixedPriceAmount: string | null;
13534
+ bundleAmountOffAmount: string | null;
13535
+ productCollections: {
13536
+ collection: {
13537
+ createdAt: string;
13538
+ description: any;
13539
+ id: string;
13540
+ image: string | null;
13541
+ name: string;
13542
+ slug: string;
13543
+ storeId: string;
13544
+ updatedAt: string;
13545
+ filter: {
13546
+ type: "manual";
13547
+ } | {
13548
+ type: "dynamicPrice";
13549
+ min?: number | null | undefined;
13550
+ max?: number | null | undefined;
13551
+ } | {
13552
+ type: "variantValues";
13553
+ values: Record<string, string[]>;
13554
+ } | {
13555
+ type: "newest";
13556
+ days?: number | null | undefined;
13557
+ };
13558
+ active: boolean;
13559
+ seo?: {
13560
+ title?: string | null | undefined;
13561
+ description?: string | null | undefined;
13562
+ canonical?: string | null | undefined;
13563
+ } | null | undefined;
13564
+ };
13565
+ collectionId: string;
13566
+ position: string | null;
13567
+ productId: string;
13568
+ }[];
13569
+ bundleGroups: {
13570
+ id: string;
13571
+ minQuantity: number;
13572
+ maxQuantity: number | null;
13573
+ allowDuplicates: boolean;
13574
+ }[];
13575
+ bundleProducts: {
13576
+ bundleId: string;
13577
+ variantId: string;
13578
+ groupId: string | null;
13579
+ quantity: number;
13580
+ position: number;
13581
+ forced: boolean;
13582
+ defaultSelected: boolean;
13583
+ maxQuantity: number | null;
13584
+ createdAt: string;
13585
+ updatedAt: string;
13586
+ variant: {
13587
+ id: string;
13588
+ sku: string | null;
13589
+ barcode: string | null;
13590
+ description: string | null;
13591
+ price: string;
13592
+ shippable: boolean;
13593
+ calculatedPrice: string | null;
13594
+ stock: number | null;
13595
+ depth: number | null;
13596
+ width: number | null;
13597
+ height: number | null;
13598
+ weight: number | null;
13599
+ images: string[];
13600
+ digital: string[] | null;
13601
+ externalId: string | null;
13602
+ product: {
13603
+ id: string;
13604
+ name: string;
13605
+ slug: string;
13606
+ images: string[];
13607
+ productTaxRate: {
13608
+ taxRate: {
13609
+ rate: string;
13610
+ label: string | null;
13611
+ };
13612
+ } | null;
13613
+ };
13614
+ createdAt: string;
13615
+ productId: string;
13616
+ updatedAt: string;
13617
+ attributes: {
13618
+ checked: boolean | null;
13619
+ key: string;
13620
+ value: string;
13621
+ }[] | null;
13622
+ storeId: string;
13623
+ originalPrice?: string | null | undefined;
13624
+ } & {
13625
+ originalPrice: string;
13626
+ };
13627
+ }[];
13628
+ setProduct: {
13629
+ selectionCount: number;
13630
+ allowDuplicates: boolean;
13631
+ discountPercentage: string;
13632
+ } | null;
13633
+ seo: {
13634
+ title?: string | null | undefined;
13635
+ description?: string | null | undefined;
13636
+ canonical?: string | null | undefined;
13637
+ } | null;
13638
+ stripeTaxCode: string | null;
13639
+ active?: boolean | null | undefined;
13640
+ };
13641
+ createdAt: string;
13642
+ productId: string;
13643
+ updatedAt: string;
13644
+ combinations: {
13645
+ createdAt: string;
13646
+ updatedAt: string;
13647
+ productVariantId: string;
13648
+ variantValueId: string;
13649
+ variantValue: {
13650
+ id: string;
13651
+ value: string;
13652
+ variantType: {
13653
+ id: string;
13654
+ label: string;
13655
+ productId?: string | null | undefined;
13656
+ createdAt?: string | null | undefined;
13657
+ updatedAt?: string | null | undefined;
13658
+ };
13659
+ variantTypeId?: string | null | undefined;
13660
+ };
13661
+ }[];
13662
+ attributes: {
13663
+ checked: boolean | null;
13664
+ key: string;
13665
+ value: string;
13666
+ }[] | null;
13667
+ storeId: string;
13668
+ originalPrice?: string | null | undefined;
13669
+ } & {
13670
+ originalPrice: string;
13671
+ })]: K extends "prices" ? Array<(({
13672
+ id: string;
13673
+ sku: string | null;
13674
+ barcode: string | null;
13675
+ description: string | null;
13676
+ price: string;
13677
+ calculatedPrice: string | null;
13678
+ prePromotionPrice: string | null;
13679
+ preVolumePricingPrice: string | null;
13680
+ stock: number | null;
13681
+ depth: number | null;
13682
+ width: number | null;
13683
+ height: number | null;
13684
+ weight: number | null;
13685
+ images: string[];
13686
+ digital: string[] | null;
13687
+ shippable: boolean;
13688
+ externalId: string | null;
13689
+ product: {
13690
+ id: string;
13691
+ name: string;
13692
+ slug: string;
13693
+ status: "published" | "draft" | "hidden" | null;
13694
+ images: string[];
13695
+ badge: {
13696
+ content?: string | undefined;
13697
+ backgroundColor?: string | undefined;
13698
+ textColor?: string | undefined;
13699
+ } | null;
13700
+ storeId: string;
13701
+ categoryId: string | null;
13702
+ brandId: string | null;
13703
+ summary: string | null;
13704
+ content: any;
13705
+ createdAt: string;
13706
+ updatedAt: string;
13707
+ productTaxRate: {
13708
+ productId: string;
13709
+ taxRateId: string;
13710
+ taxRate: {
13711
+ id: string;
13712
+ storeId: string;
13713
+ name: string;
13714
+ rate: string;
13715
+ label: string | null;
13716
+ createdAt: string;
13717
+ updatedAt: string;
13718
+ };
13719
+ createdAt: string;
13720
+ updatedAt: string;
13721
+ } | null;
13722
+ flags: {
13723
+ gold?: boolean | null | undefined;
13724
+ event?: {
13725
+ enabled: boolean;
13726
+ startsAt?: string | null | undefined;
13727
+ location?: string | null | undefined;
13728
+ capacity?: number | null | undefined;
13729
+ guestLabel?: string | null | undefined;
13730
+ guest?: string | null | undefined;
13731
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
13732
+ salesPaused?: boolean | null | undefined;
13733
+ } | null | undefined;
13734
+ scheduledPublishAt?: string | null | undefined;
13735
+ gpsr?: {
13736
+ safetyInformation?: {
13737
+ type: "NO_SAFETY_INFORMATION";
13738
+ } | {
13739
+ type: "TEXT";
13740
+ description: string;
13741
+ } | null | undefined;
13742
+ } | null | undefined;
13743
+ } | null;
13744
+ type: "set" | "product" | "bundle";
13745
+ subscriptionMode: "optional" | "only" | "rolling";
13746
+ subscriptionAddonDiscountPercent: number | null;
13747
+ bundleDiscountPercentage: string | null;
13748
+ bundlePriceMode: "fixed" | "amount" | "percent";
13749
+ bundleFixedPriceAmount: string | null;
13750
+ bundleAmountOffAmount: string | null;
13751
+ productCollections: {
13752
+ collection: {
13753
+ createdAt: string;
13754
+ description: any;
13755
+ id: string;
13756
+ image: string | null;
13757
+ name: string;
13758
+ slug: string;
13759
+ storeId: string;
13760
+ updatedAt: string;
13761
+ filter: {
13762
+ type: "manual";
13763
+ } | {
13764
+ type: "dynamicPrice";
13765
+ min?: number | null | undefined;
13766
+ max?: number | null | undefined;
13767
+ } | {
13768
+ type: "variantValues";
13769
+ values: Record<string, string[]>;
13770
+ } | {
13771
+ type: "newest";
13772
+ days?: number | null | undefined;
13773
+ };
13774
+ active: boolean;
13775
+ seo?: {
13776
+ title?: string | null | undefined;
13777
+ description?: string | null | undefined;
13778
+ canonical?: string | null | undefined;
13779
+ } | null | undefined;
13780
+ };
13781
+ collectionId: string;
13782
+ position: string | null;
13783
+ productId: string;
13784
+ }[];
13785
+ bundleGroups: {
13786
+ id: string;
13787
+ minQuantity: number;
13788
+ maxQuantity: number | null;
13789
+ allowDuplicates: boolean;
13790
+ }[];
13791
+ bundleProducts: {
13792
+ bundleId: string;
13793
+ variantId: string;
13794
+ groupId: string | null;
13795
+ quantity: number;
13796
+ position: number;
13797
+ forced: boolean;
13798
+ defaultSelected: boolean;
13799
+ maxQuantity: number | null;
13800
+ createdAt: string;
13801
+ updatedAt: string;
13802
+ variant: {
13803
+ id: string;
13804
+ sku: string | null;
13805
+ barcode: string | null;
13806
+ description: string | null;
13807
+ price: string;
13808
+ shippable: boolean;
13809
+ calculatedPrice: string | null;
13810
+ stock: number | null;
13811
+ depth: number | null;
13812
+ width: number | null;
13813
+ height: number | null;
13814
+ weight: number | null;
13815
+ images: string[];
13816
+ digital: string[] | null;
13817
+ externalId: string | null;
13818
+ product: {
13819
+ id: string;
13820
+ name: string;
13821
+ slug: string;
13822
+ images: string[];
13823
+ productTaxRate: {
13824
+ taxRate: {
13825
+ rate: string;
13826
+ label: string | null;
13827
+ };
13828
+ } | null;
13829
+ };
13830
+ createdAt: string;
13831
+ productId: string;
13832
+ updatedAt: string;
13833
+ attributes: {
13834
+ checked: boolean | null;
13835
+ key: string;
13836
+ value: string;
13837
+ }[] | null;
13838
+ storeId: string;
13839
+ originalPrice?: string | null | undefined;
13840
+ } & {
13841
+ originalPrice: string;
13842
+ };
13843
+ }[];
13844
+ setProduct: {
13845
+ selectionCount: number;
13846
+ allowDuplicates: boolean;
13847
+ discountPercentage: string;
13848
+ } | null;
13849
+ seo: {
13850
+ title?: string | null | undefined;
13851
+ description?: string | null | undefined;
13852
+ canonical?: string | null | undefined;
13853
+ } | null;
13854
+ stripeTaxCode: string | null;
13855
+ active?: boolean | null | undefined;
13856
+ };
11501
13857
  createdAt: string;
13858
+ productId: string;
11502
13859
  updatedAt: string;
11503
- };
11504
- createdAt: string;
11505
- updatedAt: string;
11506
- } | null;
11507
- position: number | null;
11508
- createdAt: string;
11509
- updatedAt: string;
11510
- countries: string[] | null;
11511
- } | null;
11512
- createdAt: string;
11513
- lineItems: {
11514
- id: string;
11515
- cartId: string;
11516
- quantity: number;
11517
- unitCost: string | null;
11518
- createdAt: string;
11519
- updatedAt: string;
11520
- productVariant: {
11521
- id: string;
11522
- sku: string | null;
11523
- barcode: string | null;
11524
- description: string | null;
11525
- price: string;
11526
- calculatedPrice: string | null;
11527
- prePromotionPrice: string | null;
11528
- preVolumePricingPrice: string | null;
11529
- stock: number | null;
11530
- depth: number | null;
11531
- width: number | null;
11532
- height: number | null;
11533
- weight: number | null;
11534
- images: string[];
11535
- digital: string[] | null;
11536
- shippable: boolean;
11537
- externalId: string | null;
11538
- product: {
13860
+ combinations: {
13861
+ createdAt: string;
13862
+ updatedAt: string;
13863
+ productVariantId: string;
13864
+ variantValueId: string;
13865
+ variantValue: {
13866
+ id: string;
13867
+ value: string;
13868
+ variantType: {
13869
+ id: string;
13870
+ label: string;
13871
+ productId?: string | null | undefined;
13872
+ createdAt?: string | null | undefined;
13873
+ updatedAt?: string | null | undefined;
13874
+ };
13875
+ variantTypeId?: string | null | undefined;
13876
+ };
13877
+ }[];
13878
+ attributes: {
13879
+ checked: boolean | null;
13880
+ key: string;
13881
+ value: string;
13882
+ }[] | null;
13883
+ storeId: string;
13884
+ originalPrice?: string | null | undefined;
13885
+ } & {
13886
+ originalPrice: string;
13887
+ })[K] extends readonly (infer TElement)[] ? TElement : never) & {
13888
+ /** `price` converted to gross with the owning product's tax rate. */
13889
+ priceGross: string;
13890
+ /** `calculatedPrice` converted to gross; null when there is no calculated price. */
13891
+ calculatedPriceGross: string | null;
13892
+ }> : ({
11539
13893
  id: string;
11540
- name: string;
11541
- slug: string;
11542
- status: "published" | "draft" | "hidden" | null;
13894
+ sku: string | null;
13895
+ barcode: string | null;
13896
+ description: string | null;
13897
+ price: string;
13898
+ calculatedPrice: string | null;
13899
+ prePromotionPrice: string | null;
13900
+ preVolumePricingPrice: string | null;
13901
+ stock: number | null;
13902
+ depth: number | null;
13903
+ width: number | null;
13904
+ height: number | null;
13905
+ weight: number | null;
11543
13906
  images: string[];
11544
- badge: {
11545
- content?: string | undefined;
11546
- backgroundColor?: string | undefined;
11547
- textColor?: string | undefined;
11548
- } | null;
11549
- storeId: string;
11550
- categoryId: string | null;
11551
- brandId: string | null;
11552
- summary: string | null;
11553
- content: any;
11554
- createdAt: string;
11555
- updatedAt: string;
11556
- productTaxRate: {
11557
- productId: string;
11558
- taxRateId: string;
11559
- taxRate: {
13907
+ digital: string[] | null;
13908
+ shippable: boolean;
13909
+ externalId: string | null;
13910
+ product: {
13911
+ id: string;
13912
+ name: string;
13913
+ slug: string;
13914
+ status: "published" | "draft" | "hidden" | null;
13915
+ images: string[];
13916
+ badge: {
13917
+ content?: string | undefined;
13918
+ backgroundColor?: string | undefined;
13919
+ textColor?: string | undefined;
13920
+ } | null;
13921
+ storeId: string;
13922
+ categoryId: string | null;
13923
+ brandId: string | null;
13924
+ summary: string | null;
13925
+ content: any;
13926
+ createdAt: string;
13927
+ updatedAt: string;
13928
+ productTaxRate: {
13929
+ productId: string;
13930
+ taxRateId: string;
13931
+ taxRate: {
13932
+ id: string;
13933
+ storeId: string;
13934
+ name: string;
13935
+ rate: string;
13936
+ label: string | null;
13937
+ createdAt: string;
13938
+ updatedAt: string;
13939
+ };
13940
+ createdAt: string;
13941
+ updatedAt: string;
13942
+ } | null;
13943
+ flags: {
13944
+ gold?: boolean | null | undefined;
13945
+ event?: {
13946
+ enabled: boolean;
13947
+ startsAt?: string | null | undefined;
13948
+ location?: string | null | undefined;
13949
+ capacity?: number | null | undefined;
13950
+ guestLabel?: string | null | undefined;
13951
+ guest?: string | null | undefined;
13952
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
13953
+ salesPaused?: boolean | null | undefined;
13954
+ } | null | undefined;
13955
+ scheduledPublishAt?: string | null | undefined;
13956
+ gpsr?: {
13957
+ safetyInformation?: {
13958
+ type: "NO_SAFETY_INFORMATION";
13959
+ } | {
13960
+ type: "TEXT";
13961
+ description: string;
13962
+ } | null | undefined;
13963
+ } | null | undefined;
13964
+ } | null;
13965
+ type: "set" | "product" | "bundle";
13966
+ subscriptionMode: "optional" | "only" | "rolling";
13967
+ subscriptionAddonDiscountPercent: number | null;
13968
+ bundleDiscountPercentage: string | null;
13969
+ bundlePriceMode: "fixed" | "amount" | "percent";
13970
+ bundleFixedPriceAmount: string | null;
13971
+ bundleAmountOffAmount: string | null;
13972
+ productCollections: {
13973
+ collection: {
13974
+ createdAt: string;
13975
+ description: any;
13976
+ id: string;
13977
+ image: string | null;
13978
+ name: string;
13979
+ slug: string;
13980
+ storeId: string;
13981
+ updatedAt: string;
13982
+ filter: {
13983
+ type: "manual";
13984
+ } | {
13985
+ type: "dynamicPrice";
13986
+ min?: number | null | undefined;
13987
+ max?: number | null | undefined;
13988
+ } | {
13989
+ type: "variantValues";
13990
+ values: Record<string, string[]>;
13991
+ } | {
13992
+ type: "newest";
13993
+ days?: number | null | undefined;
13994
+ };
13995
+ active: boolean;
13996
+ seo?: {
13997
+ title?: string | null | undefined;
13998
+ description?: string | null | undefined;
13999
+ canonical?: string | null | undefined;
14000
+ } | null | undefined;
14001
+ };
14002
+ collectionId: string;
14003
+ position: string | null;
14004
+ productId: string;
14005
+ }[];
14006
+ bundleGroups: {
11560
14007
  id: string;
11561
- storeId: string;
11562
- name: string;
11563
- rate: string;
11564
- label: string | null;
14008
+ minQuantity: number;
14009
+ maxQuantity: number | null;
14010
+ allowDuplicates: boolean;
14011
+ }[];
14012
+ bundleProducts: {
14013
+ bundleId: string;
14014
+ variantId: string;
14015
+ groupId: string | null;
14016
+ quantity: number;
14017
+ position: number;
14018
+ forced: boolean;
14019
+ defaultSelected: boolean;
14020
+ maxQuantity: number | null;
11565
14021
  createdAt: string;
11566
14022
  updatedAt: string;
11567
- };
14023
+ variant: {
14024
+ id: string;
14025
+ sku: string | null;
14026
+ barcode: string | null;
14027
+ description: string | null;
14028
+ price: string;
14029
+ shippable: boolean;
14030
+ calculatedPrice: string | null;
14031
+ stock: number | null;
14032
+ depth: number | null;
14033
+ width: number | null;
14034
+ height: number | null;
14035
+ weight: number | null;
14036
+ images: string[];
14037
+ digital: string[] | null;
14038
+ externalId: string | null;
14039
+ product: {
14040
+ id: string;
14041
+ name: string;
14042
+ slug: string;
14043
+ images: string[];
14044
+ productTaxRate: {
14045
+ taxRate: {
14046
+ rate: string;
14047
+ label: string | null;
14048
+ };
14049
+ } | null;
14050
+ };
14051
+ createdAt: string;
14052
+ productId: string;
14053
+ updatedAt: string;
14054
+ attributes: {
14055
+ checked: boolean | null;
14056
+ key: string;
14057
+ value: string;
14058
+ }[] | null;
14059
+ storeId: string;
14060
+ originalPrice?: string | null | undefined;
14061
+ } & {
14062
+ originalPrice: string;
14063
+ };
14064
+ }[];
14065
+ setProduct: {
14066
+ selectionCount: number;
14067
+ allowDuplicates: boolean;
14068
+ discountPercentage: string;
14069
+ } | null;
14070
+ seo: {
14071
+ title?: string | null | undefined;
14072
+ description?: string | null | undefined;
14073
+ canonical?: string | null | undefined;
14074
+ } | null;
14075
+ stripeTaxCode: string | null;
14076
+ active?: boolean | null | undefined;
14077
+ };
14078
+ createdAt: string;
14079
+ productId: string;
14080
+ updatedAt: string;
14081
+ combinations: {
11568
14082
  createdAt: string;
11569
14083
  updatedAt: string;
11570
- } | null;
11571
- flags: {
11572
- gold?: boolean | null | undefined;
11573
- event?: {
11574
- enabled: boolean;
11575
- startsAt?: string | null | undefined;
11576
- location?: string | null | undefined;
11577
- capacity?: number | null | undefined;
11578
- guestLabel?: string | null | undefined;
11579
- guest?: string | null | undefined;
11580
- attendeeInfo?: "optional" | "none" | "required" | null | undefined;
11581
- salesPaused?: boolean | null | undefined;
11582
- } | null | undefined;
11583
- scheduledPublishAt?: string | null | undefined;
11584
- gpsr?: {
11585
- safetyInformation?: {
11586
- type: "NO_SAFETY_INFORMATION";
11587
- } | {
11588
- type: "TEXT";
11589
- description: string;
11590
- } | null | undefined;
11591
- } | null | undefined;
11592
- } | null;
11593
- type: "set" | "product" | "bundle";
11594
- bundleDiscountPercentage: string | null;
11595
- bundlePriceMode: "fixed" | "amount" | "percent";
11596
- bundleFixedPriceAmount: string | null;
11597
- bundleAmountOffAmount: string | null;
11598
- productCollections: {
11599
- collection: {
11600
- createdAt: string;
11601
- description: any;
14084
+ productVariantId: string;
14085
+ variantValueId: string;
14086
+ variantValue: {
11602
14087
  id: string;
11603
- image: string | null;
11604
- name: string;
11605
- slug: string;
11606
- storeId: string;
11607
- updatedAt: string;
11608
- filter: {
11609
- type: "manual";
11610
- } | {
11611
- type: "dynamicPrice";
11612
- min?: number | null | undefined;
11613
- max?: number | null | undefined;
11614
- } | {
11615
- type: "variantValues";
11616
- values: Record<string, string[]>;
11617
- } | {
11618
- type: "newest";
11619
- days?: number | null | undefined;
14088
+ value: string;
14089
+ variantType: {
14090
+ id: string;
14091
+ label: string;
14092
+ productId?: string | null | undefined;
14093
+ createdAt?: string | null | undefined;
14094
+ updatedAt?: string | null | undefined;
11620
14095
  };
11621
- active: boolean;
11622
- seo?: {
11623
- title?: string | null | undefined;
11624
- description?: string | null | undefined;
11625
- canonical?: string | null | undefined;
11626
- } | null | undefined;
14096
+ variantTypeId?: string | null | undefined;
11627
14097
  };
11628
- collectionId: string;
11629
- position: string | null;
11630
- productId: string;
11631
14098
  }[];
11632
- bundleGroups: {
14099
+ attributes: {
14100
+ checked: boolean | null;
14101
+ key: string;
14102
+ value: string;
14103
+ }[] | null;
14104
+ storeId: string;
14105
+ originalPrice?: string | null | undefined;
14106
+ } & {
14107
+ originalPrice: string;
14108
+ })[K];
14109
+ } & {
14110
+ /** `price` (the effective net price) converted to gross with the product's tax rate. */
14111
+ priceGross: string;
14112
+ } & {
14113
+ [K in Extract<keyof ({
14114
+ id: string;
14115
+ sku: string | null;
14116
+ barcode: string | null;
14117
+ description: string | null;
14118
+ price: string;
14119
+ calculatedPrice: string | null;
14120
+ prePromotionPrice: string | null;
14121
+ preVolumePricingPrice: string | null;
14122
+ stock: number | null;
14123
+ depth: number | null;
14124
+ width: number | null;
14125
+ height: number | null;
14126
+ weight: number | null;
14127
+ images: string[];
14128
+ digital: string[] | null;
14129
+ shippable: boolean;
14130
+ externalId: string | null;
14131
+ product: {
11633
14132
  id: string;
11634
- minQuantity: number;
11635
- maxQuantity: number | null;
11636
- allowDuplicates: boolean;
11637
- }[];
11638
- bundleProducts: {
11639
- bundleId: string;
11640
- variantId: string;
11641
- groupId: string | null;
11642
- quantity: number;
11643
- position: number;
11644
- forced: boolean;
11645
- defaultSelected: boolean;
11646
- maxQuantity: number | null;
14133
+ name: string;
14134
+ slug: string;
14135
+ status: "published" | "draft" | "hidden" | null;
14136
+ images: string[];
14137
+ badge: {
14138
+ content?: string | undefined;
14139
+ backgroundColor?: string | undefined;
14140
+ textColor?: string | undefined;
14141
+ } | null;
14142
+ storeId: string;
14143
+ categoryId: string | null;
14144
+ brandId: string | null;
14145
+ summary: string | null;
14146
+ content: any;
11647
14147
  createdAt: string;
11648
14148
  updatedAt: string;
11649
- variant: {
11650
- id: string;
11651
- sku: string | null;
11652
- barcode: string | null;
11653
- description: string | null;
11654
- price: string;
11655
- shippable: boolean;
11656
- calculatedPrice: string | null;
11657
- stock: number | null;
11658
- depth: number | null;
11659
- width: number | null;
11660
- height: number | null;
11661
- weight: number | null;
11662
- images: string[];
11663
- digital: string[] | null;
11664
- externalId: string | null;
11665
- product: {
14149
+ productTaxRate: {
14150
+ productId: string;
14151
+ taxRateId: string;
14152
+ taxRate: {
11666
14153
  id: string;
14154
+ storeId: string;
11667
14155
  name: string;
11668
- slug: string;
11669
- images: string[];
11670
- productTaxRate: {
11671
- taxRate: {
11672
- rate: string;
11673
- label: string | null;
11674
- };
11675
- } | null;
14156
+ rate: string;
14157
+ label: string | null;
14158
+ createdAt: string;
14159
+ updatedAt: string;
11676
14160
  };
11677
14161
  createdAt: string;
14162
+ updatedAt: string;
14163
+ } | null;
14164
+ flags: {
14165
+ gold?: boolean | null | undefined;
14166
+ event?: {
14167
+ enabled: boolean;
14168
+ startsAt?: string | null | undefined;
14169
+ location?: string | null | undefined;
14170
+ capacity?: number | null | undefined;
14171
+ guestLabel?: string | null | undefined;
14172
+ guest?: string | null | undefined;
14173
+ attendeeInfo?: "optional" | "none" | "required" | null | undefined;
14174
+ salesPaused?: boolean | null | undefined;
14175
+ } | null | undefined;
14176
+ scheduledPublishAt?: string | null | undefined;
14177
+ gpsr?: {
14178
+ safetyInformation?: {
14179
+ type: "NO_SAFETY_INFORMATION";
14180
+ } | {
14181
+ type: "TEXT";
14182
+ description: string;
14183
+ } | null | undefined;
14184
+ } | null | undefined;
14185
+ } | null;
14186
+ type: "set" | "product" | "bundle";
14187
+ subscriptionMode: "optional" | "only" | "rolling";
14188
+ subscriptionAddonDiscountPercent: number | null;
14189
+ bundleDiscountPercentage: string | null;
14190
+ bundlePriceMode: "fixed" | "amount" | "percent";
14191
+ bundleFixedPriceAmount: string | null;
14192
+ bundleAmountOffAmount: string | null;
14193
+ productCollections: {
14194
+ collection: {
14195
+ createdAt: string;
14196
+ description: any;
14197
+ id: string;
14198
+ image: string | null;
14199
+ name: string;
14200
+ slug: string;
14201
+ storeId: string;
14202
+ updatedAt: string;
14203
+ filter: {
14204
+ type: "manual";
14205
+ } | {
14206
+ type: "dynamicPrice";
14207
+ min?: number | null | undefined;
14208
+ max?: number | null | undefined;
14209
+ } | {
14210
+ type: "variantValues";
14211
+ values: Record<string, string[]>;
14212
+ } | {
14213
+ type: "newest";
14214
+ days?: number | null | undefined;
14215
+ };
14216
+ active: boolean;
14217
+ seo?: {
14218
+ title?: string | null | undefined;
14219
+ description?: string | null | undefined;
14220
+ canonical?: string | null | undefined;
14221
+ } | null | undefined;
14222
+ };
14223
+ collectionId: string;
14224
+ position: string | null;
11678
14225
  productId: string;
14226
+ }[];
14227
+ bundleGroups: {
14228
+ id: string;
14229
+ minQuantity: number;
14230
+ maxQuantity: number | null;
14231
+ allowDuplicates: boolean;
14232
+ }[];
14233
+ bundleProducts: {
14234
+ bundleId: string;
14235
+ variantId: string;
14236
+ groupId: string | null;
14237
+ quantity: number;
14238
+ position: number;
14239
+ forced: boolean;
14240
+ defaultSelected: boolean;
14241
+ maxQuantity: number | null;
14242
+ createdAt: string;
11679
14243
  updatedAt: string;
11680
- attributes: {
11681
- checked: boolean | null;
11682
- key: string;
11683
- value: string;
11684
- }[] | null;
11685
- storeId: string;
11686
- originalPrice?: string | null | undefined;
11687
- } & {
11688
- originalPrice: string;
11689
- };
11690
- }[];
11691
- setProduct: {
11692
- selectionCount: number;
11693
- allowDuplicates: boolean;
11694
- discountPercentage: string;
11695
- } | null;
11696
- seo: {
11697
- title?: string | null | undefined;
11698
- description?: string | null | undefined;
11699
- canonical?: string | null | undefined;
11700
- } | null;
11701
- stripeTaxCode: string | null;
11702
- active?: boolean | null | undefined;
11703
- };
11704
- createdAt: string;
11705
- productId: string;
11706
- updatedAt: string;
11707
- combinations: {
14244
+ variant: {
14245
+ id: string;
14246
+ sku: string | null;
14247
+ barcode: string | null;
14248
+ description: string | null;
14249
+ price: string;
14250
+ shippable: boolean;
14251
+ calculatedPrice: string | null;
14252
+ stock: number | null;
14253
+ depth: number | null;
14254
+ width: number | null;
14255
+ height: number | null;
14256
+ weight: number | null;
14257
+ images: string[];
14258
+ digital: string[] | null;
14259
+ externalId: string | null;
14260
+ product: {
14261
+ id: string;
14262
+ name: string;
14263
+ slug: string;
14264
+ images: string[];
14265
+ productTaxRate: {
14266
+ taxRate: {
14267
+ rate: string;
14268
+ label: string | null;
14269
+ };
14270
+ } | null;
14271
+ };
14272
+ createdAt: string;
14273
+ productId: string;
14274
+ updatedAt: string;
14275
+ attributes: {
14276
+ checked: boolean | null;
14277
+ key: string;
14278
+ value: string;
14279
+ }[] | null;
14280
+ storeId: string;
14281
+ originalPrice?: string | null | undefined;
14282
+ } & {
14283
+ originalPrice: string;
14284
+ };
14285
+ }[];
14286
+ setProduct: {
14287
+ selectionCount: number;
14288
+ allowDuplicates: boolean;
14289
+ discountPercentage: string;
14290
+ } | null;
14291
+ seo: {
14292
+ title?: string | null | undefined;
14293
+ description?: string | null | undefined;
14294
+ canonical?: string | null | undefined;
14295
+ } | null;
14296
+ stripeTaxCode: string | null;
14297
+ active?: boolean | null | undefined;
14298
+ };
11708
14299
  createdAt: string;
14300
+ productId: string;
11709
14301
  updatedAt: string;
11710
- productVariantId: string;
11711
- variantValueId: string;
11712
- variantValue: {
11713
- id: string;
11714
- value: string;
11715
- variantType: {
14302
+ combinations: {
14303
+ createdAt: string;
14304
+ updatedAt: string;
14305
+ productVariantId: string;
14306
+ variantValueId: string;
14307
+ variantValue: {
11716
14308
  id: string;
11717
- label: string;
11718
- productId?: string | null | undefined;
11719
- createdAt?: string | null | undefined;
11720
- updatedAt?: string | null | undefined;
14309
+ value: string;
14310
+ variantType: {
14311
+ id: string;
14312
+ label: string;
14313
+ productId?: string | null | undefined;
14314
+ createdAt?: string | null | undefined;
14315
+ updatedAt?: string | null | undefined;
14316
+ };
14317
+ variantTypeId?: string | null | undefined;
11721
14318
  };
11722
- variantTypeId?: string | null | undefined;
11723
- };
11724
- }[];
11725
- attributes: {
11726
- checked: boolean | null;
11727
- key: string;
11728
- value: string;
11729
- }[] | null;
11730
- storeId: string;
11731
- originalPrice?: string | null | undefined;
11732
- } & {
11733
- originalPrice: string;
14319
+ }[];
14320
+ attributes: {
14321
+ checked: boolean | null;
14322
+ key: string;
14323
+ value: string;
14324
+ }[] | null;
14325
+ storeId: string;
14326
+ originalPrice?: string | null | undefined;
14327
+ } & {
14328
+ originalPrice: string;
14329
+ }), "calculatedPrice" | "originalPrice" | "prePromotionPrice" | "omnibusPrice"> as `${K}Gross`]: string | null;
11734
14330
  };
11735
14331
  productVariantId: string;
11736
14332
  preVolumePricingPrice: string | null;
@@ -11749,6 +14345,25 @@ type APIOrderGetByIdResult = Omit<{
11749
14345
  storeId: string;
11750
14346
  updatedAt: string;
11751
14347
  } | null;
14348
+ rollingCycle: {
14349
+ id: string;
14350
+ title: string;
14351
+ startsAt: string;
14352
+ items: {
14353
+ productVariantId: string;
14354
+ productId: string;
14355
+ name: string;
14356
+ variantLabel: string | null;
14357
+ sku: string | null;
14358
+ image: string | null;
14359
+ quantity: number;
14360
+ }[];
14361
+ } | null;
14362
+ subscriptionAddon: {
14363
+ addonId: string;
14364
+ discountPercent: number;
14365
+ listPrice: string;
14366
+ } | null;
11752
14367
  slotId: string | null;
11753
14368
  attendees: {
11754
14369
  name: string;
@@ -11939,7 +14554,6 @@ type APIOrderGetByIdResult = Omit<{
11939
14554
  type: "general" | "newsletter";
11940
14555
  }[] | null;
11941
14556
  };
11942
- }, "attribution"> & {
11943
14557
  trackingNumber: string | null;
11944
14558
  shipments: APIShipment[];
11945
14559
  };
@@ -12253,6 +14867,8 @@ type APICollectionGetByIdResult = ({
12253
14867
  summary: string | null;
12254
14868
  images: string[];
12255
14869
  badge: unknown;
14870
+ subscriptionMode: "optional" | "only" | "rolling";
14871
+ subscriptionAddonDiscountPercent: number | null;
12256
14872
  bundleDiscountPercentage: string | null;
12257
14873
  bundlePriceMode: "fixed" | "amount" | "percent";
12258
14874
  bundleFixedPriceAmount: string | null;
@@ -12316,6 +14932,8 @@ type APICollectionGetByIdResult = ({
12316
14932
  summary: string | null;
12317
14933
  images: string[];
12318
14934
  badge: unknown;
14935
+ subscriptionMode: "optional" | "only" | "rolling";
14936
+ subscriptionAddonDiscountPercent: number | null;
12319
14937
  bundleDiscountPercentage: string | null;
12320
14938
  bundlePriceMode: "fixed" | "amount" | "percent";
12321
14939
  bundleFixedPriceAmount: string | null;
@@ -13329,6 +15947,8 @@ type APICollectionUpdateResult = {
13329
15947
  summary: string | null;
13330
15948
  images: string[];
13331
15949
  badge: unknown;
15950
+ subscriptionMode: "optional" | "only" | "rolling";
15951
+ subscriptionAddonDiscountPercent: number | null;
13332
15952
  bundleDiscountPercentage: string | null;
13333
15953
  bundlePriceMode: "fixed" | "amount" | "percent";
13334
15954
  bundleFixedPriceAmount: string | null;