@wix/ecom 1.0.727 → 1.0.729

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.
@@ -2960,7 +2960,7 @@ interface LineItem$7 {
2960
2960
  id?: string | null;
2961
2961
  /** Item quantity. */
2962
2962
  quantity?: number;
2963
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
2963
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
2964
2964
  catalogReference?: CatalogReference$d;
2965
2965
  /**
2966
2966
  * Item name.
@@ -3505,7 +3505,7 @@ interface UpdateCartRequest$3 {
3505
3505
  /** Catalog line items. */
3506
3506
  lineItems?: LineItem$7[];
3507
3507
  /**
3508
- * Custom line items.
3508
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3509
3509
  *
3510
3510
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3511
3511
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -3590,7 +3590,7 @@ interface CustomLineItem$9 {
3590
3590
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
3591
3591
  */
3592
3592
  depositAmount?: string | null;
3593
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
3593
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
3594
3594
  catalogReference?: CatalogReference$d;
3595
3595
  }
3596
3596
  interface UpdateCartResponse$3 {
@@ -4290,7 +4290,7 @@ interface CreateCartRequest$1 {
4290
4290
  /** Catalog line items. */
4291
4291
  lineItems?: LineItem$7[];
4292
4292
  /**
4293
- * Custom line items.
4293
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
4294
4294
  *
4295
4295
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4296
4296
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -4315,7 +4315,7 @@ interface AddToCartRequest$1 {
4315
4315
  /** Catalog line items. */
4316
4316
  lineItems?: LineItem$7[];
4317
4317
  /**
4318
- * Custom line items.
4318
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
4319
4319
  *
4320
4320
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4321
4321
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -4912,7 +4912,7 @@ interface LineItem$6 {
4912
4912
  _id?: string | null;
4913
4913
  /** Item quantity. */
4914
4914
  quantity?: number;
4915
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
4915
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
4916
4916
  catalogReference?: CatalogReference$c;
4917
4917
  /**
4918
4918
  * Item name.
@@ -5383,7 +5383,7 @@ interface UpdateCartRequest$2 {
5383
5383
  /** Catalog line items. */
5384
5384
  lineItems?: LineItem$6[];
5385
5385
  /**
5386
- * Custom line items.
5386
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
5387
5387
  *
5388
5388
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5389
5389
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -5472,7 +5472,7 @@ interface CustomLineItem$8 {
5472
5472
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
5473
5473
  */
5474
5474
  depositAmount?: string | null;
5475
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
5475
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
5476
5476
  catalogReference?: CatalogReference$c;
5477
5477
  }
5478
5478
  interface UpdateCartResponse$2 {
@@ -6181,7 +6181,7 @@ interface CreateCartRequest {
6181
6181
  /** Catalog line items. */
6182
6182
  lineItems?: LineItem$6[];
6183
6183
  /**
6184
- * Custom line items.
6184
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
6185
6185
  *
6186
6186
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6187
6187
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -6206,7 +6206,7 @@ interface AddToCartRequest {
6206
6206
  /** Catalog line items. */
6207
6207
  lineItems?: LineItem$6[];
6208
6208
  /**
6209
- * Custom line items.
6209
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
6210
6210
  *
6211
6211
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6212
6212
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -6840,7 +6840,7 @@ interface LineItem$5 {
6840
6840
  id?: string | null;
6841
6841
  /** Item quantity. */
6842
6842
  quantity?: number;
6843
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
6843
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
6844
6844
  catalogReference?: CatalogReference$b;
6845
6845
  /**
6846
6846
  * Item name.
@@ -7391,7 +7391,7 @@ interface UpdateCartRequest$1 {
7391
7391
  /** Catalog line items. */
7392
7392
  lineItems?: LineItem$5[];
7393
7393
  /**
7394
- * Custom line items.
7394
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
7395
7395
  *
7396
7396
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7397
7397
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -7476,7 +7476,7 @@ interface CustomLineItem$7 {
7476
7476
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
7477
7477
  */
7478
7478
  depositAmount?: string | null;
7479
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
7479
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
7480
7480
  catalogReference?: CatalogReference$b;
7481
7481
  }
7482
7482
  interface UpdateCartResponse$1 {
@@ -7487,7 +7487,7 @@ interface AddToCurrentCartRequest$1 {
7487
7487
  /** Catalog line items. */
7488
7488
  lineItems?: LineItem$5[];
7489
7489
  /**
7490
- * Custom line items.
7490
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
7491
7491
  *
7492
7492
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7493
7493
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -8752,7 +8752,7 @@ interface LineItem$4 {
8752
8752
  _id?: string | null;
8753
8753
  /** Item quantity. */
8754
8754
  quantity?: number;
8755
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
8755
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
8756
8756
  catalogReference?: CatalogReference$a;
8757
8757
  /**
8758
8758
  * Item name.
@@ -9229,7 +9229,7 @@ interface UpdateCartRequest {
9229
9229
  /** Catalog line items. */
9230
9230
  lineItems?: LineItem$4[];
9231
9231
  /**
9232
- * Custom line items.
9232
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
9233
9233
  *
9234
9234
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
9235
9235
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -9318,7 +9318,7 @@ interface CustomLineItem$6 {
9318
9318
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
9319
9319
  */
9320
9320
  depositAmount?: string | null;
9321
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
9321
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
9322
9322
  catalogReference?: CatalogReference$a;
9323
9323
  }
9324
9324
  interface UpdateCartResponse {
@@ -9329,7 +9329,7 @@ interface AddToCurrentCartRequest {
9329
9329
  /** Catalog line items. */
9330
9330
  lineItems?: LineItem$4[];
9331
9331
  /**
9332
- * Custom line items.
9332
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
9333
9333
  *
9334
9334
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
9335
9335
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -10686,20 +10686,18 @@ interface Checkout$1 {
10686
10686
  /**
10687
10687
  * Additional settings for customization of the checkout process.
10688
10688
  *
10689
- * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
10689
+ * > **Notes:**
10690
+ * > * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
10691
+ * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10690
10692
  */
10691
10693
  customSettings?: CustomSettings$1;
10692
10694
  /**
10693
- * Customize the content of the checkout page.
10695
+ * Reference IDs for the app and component providing custom checkout page content.
10694
10696
  *
10695
- * Includes IDs for the app and the component providing the content
10697
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
10698
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10696
10699
  */
10697
10700
  customContentReference?: CustomContentReference$3;
10698
- /**
10699
- * Used for integration and tracking across different platforms.
10700
- * Contains external system IDs (e.g., app ID, external ID) to link the checkout with other systems.
10701
- */
10702
- externalReference?: ExternalReference$3;
10703
10701
  }
10704
10702
  interface LineItem$3 {
10705
10703
  /**
@@ -10714,7 +10712,7 @@ interface LineItem$3 {
10714
10712
  * Max: `"100000"`
10715
10713
  */
10716
10714
  quantity?: number;
10717
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
10715
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
10718
10716
  catalogReference?: CatalogReference$9;
10719
10717
  /**
10720
10718
  * Item name.
@@ -10828,7 +10826,7 @@ interface LineItem$3 {
10828
10826
  */
10829
10827
  depositAmount?: MultiCurrencyPrice$3;
10830
10828
  /**
10831
- * Whether the line item is custom or from catalog.
10829
+ * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
10832
10830
  * @readonly
10833
10831
  */
10834
10832
  customLineItem?: boolean;
@@ -11911,21 +11909,15 @@ interface CustomContentReference$3 {
11911
11909
  */
11912
11910
  componentId?: string;
11913
11911
  }
11914
- interface ExternalReference$3 {
11915
- /** ID of the app that associated with the purchase flow. */
11916
- appId?: string;
11917
- /** Reference to an external system ID, used to link the purchase flow to a specific ID in another system */
11918
- resourceId?: string | null;
11919
- }
11920
11912
  interface CreateCheckoutRequest$1 {
11921
11913
  /** Checkout information. */
11922
11914
  checkoutInfo?: Checkout$1;
11923
11915
  /** Coupon code. */
11924
11916
  couponCode?: string | null;
11925
- /** Line items to add to the checkout. */
11917
+ /** Catalog line items to add to the checkout. */
11926
11918
  lineItems?: LineItem$3[];
11927
11919
  /**
11928
- * Custom line items to add to the checkout.
11920
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
11929
11921
  *
11930
11922
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
11931
11923
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -12034,7 +12026,7 @@ interface CustomLineItem$5 {
12034
12026
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
12035
12027
  */
12036
12028
  depositAmount?: string | null;
12037
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
12029
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
12038
12030
  catalogReference?: CatalogReference$9;
12039
12031
  }
12040
12032
  interface CreateCheckoutResponse$1 {
@@ -12084,10 +12076,10 @@ interface UpdateCheckoutRequest$1 {
12084
12076
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
12085
12077
  */
12086
12078
  overrideCheckoutUrl?: string | null;
12087
- /** Line items. */
12079
+ /** Catalog line items. */
12088
12080
  lineItems?: LineItem$3[];
12089
12081
  /**
12090
- * Custom line items.
12082
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
12091
12083
  *
12092
12084
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12093
12085
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -12128,7 +12120,7 @@ interface AddToCheckoutRequest$1 {
12128
12120
  /** Catalog line items. */
12129
12121
  lineItems?: LineItem$3[];
12130
12122
  /**
12131
- * Custom line items.
12123
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
12132
12124
  *
12133
12125
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12134
12126
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -12836,16 +12828,12 @@ interface Checkout {
12836
12828
  */
12837
12829
  customSettings?: CustomSettings;
12838
12830
  /**
12839
- * Customize the content of the checkout page.
12831
+ * Reference IDs for the app and component providing custom checkout page content.
12840
12832
  *
12841
- * Includes IDs for the app and the component providing the content
12833
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12834
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
12842
12835
  */
12843
12836
  customContentReference?: CustomContentReference$2;
12844
- /**
12845
- * Used for integration and tracking across different platforms.
12846
- * Contains external system IDs (e.g., app ID, external ID) to link the checkout with other systems.
12847
- */
12848
- externalReference?: ExternalReference$2;
12849
12837
  }
12850
12838
  interface LineItem$2 {
12851
12839
  /**
@@ -12860,7 +12848,7 @@ interface LineItem$2 {
12860
12848
  * Max: `"100000"`
12861
12849
  */
12862
12850
  quantity?: number;
12863
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
12851
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
12864
12852
  catalogReference?: CatalogReference$8;
12865
12853
  /**
12866
12854
  * Item name.
@@ -12973,7 +12961,7 @@ interface LineItem$2 {
12973
12961
  */
12974
12962
  depositAmount?: MultiCurrencyPrice$2;
12975
12963
  /**
12976
- * Whether the line item is custom or from catalog.
12964
+ * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
12977
12965
  * @readonly
12978
12966
  */
12979
12967
  customLineItem?: boolean;
@@ -14007,21 +13995,15 @@ interface CustomContentReference$2 {
14007
13995
  */
14008
13996
  componentId?: string;
14009
13997
  }
14010
- interface ExternalReference$2 {
14011
- /** ID of the app that associated with the purchase flow. */
14012
- appId?: string;
14013
- /** Reference to an external system ID, used to link the purchase flow to a specific ID in another system */
14014
- resourceId?: string | null;
14015
- }
14016
13998
  interface CreateCheckoutRequest {
14017
13999
  /** Checkout information. */
14018
14000
  checkoutInfo?: Checkout;
14019
14001
  /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
14020
14002
  couponCode?: string | null;
14021
- /** Line items to add to the checkout. */
14003
+ /** Catalog line items to add to the checkout. */
14022
14004
  lineItems?: LineItem$2[];
14023
14005
  /**
14024
- * Custom line items to add to the checkout.
14006
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
14025
14007
  *
14026
14008
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
14027
14009
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -14119,7 +14101,7 @@ interface CustomLineItem$4 {
14119
14101
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
14120
14102
  */
14121
14103
  depositAmount?: string | null;
14122
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
14104
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
14123
14105
  catalogReference?: CatalogReference$8;
14124
14106
  }
14125
14107
  interface CreateCheckoutResponse {
@@ -14163,10 +14145,10 @@ interface UpdateCheckoutRequest {
14163
14145
  * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
14164
14146
  */
14165
14147
  overrideCheckoutUrl?: string | null;
14166
- /** Line items. */
14148
+ /** Catalog line items. */
14167
14149
  lineItems?: LineItem$2[];
14168
14150
  /**
14169
- * Custom line items.
14151
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
14170
14152
  *
14171
14153
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
14172
14154
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -14207,7 +14189,7 @@ interface AddToCheckoutRequest {
14207
14189
  /** Catalog line items. */
14208
14190
  lineItems?: LineItem$2[];
14209
14191
  /**
14210
- * Custom line items.
14192
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
14211
14193
  *
14212
14194
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
14213
14195
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
@@ -15193,13 +15175,13 @@ interface CheckoutTemplate$1 {
15193
15175
  /** Custom settings to apply to the checkout page created from this template. */
15194
15176
  customization?: CheckoutCustomization$1;
15195
15177
  /**
15196
- * Line items.
15178
+ * Catalog line items.
15197
15179
  *
15198
15180
  * Max: 300 items
15199
15181
  */
15200
15182
  lineItems?: V1LineItem$1[];
15201
15183
  /**
15202
- * Custom line items.
15184
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
15203
15185
  *
15204
15186
  * Max: 300 items
15205
15187
  */
@@ -15212,16 +15194,12 @@ interface CheckoutTemplate$1 {
15212
15194
  */
15213
15195
  couponCode?: string | null;
15214
15196
  /**
15215
- * Customize the content of the checkout page.
15197
+ * Reference IDs for the app and component providing custom checkout page content.
15216
15198
  *
15217
- * Includes IDs for the app and the component providing the content
15199
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
15200
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
15218
15201
  */
15219
15202
  customContentReference?: CustomContentReference$1;
15220
- /**
15221
- * Used for integration and tracking across different platforms.
15222
- * Contains external system IDs (e.g., app ID, external ID) to link the checkout template with other systems.
15223
- */
15224
- externalReference?: ExternalReference$1;
15225
15203
  }
15226
15204
  declare enum Status$3 {
15227
15205
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -15272,11 +15250,7 @@ interface V1LineItem$1 {
15272
15250
  * Max: `100000`
15273
15251
  */
15274
15252
  quantity?: number;
15275
- /**
15276
- * Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
15277
- *
15278
- * > **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).
15279
- */
15253
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
15280
15254
  catalogReference?: CatalogReference$7;
15281
15255
  /** Overriding values for catalog item properties. */
15282
15256
  catalogOverrideFields?: CatalogOverrideFields$1;
@@ -15481,7 +15455,7 @@ interface CustomLineItem$3 {
15481
15455
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
15482
15456
  */
15483
15457
  depositAmount?: string | null;
15484
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
15458
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
15485
15459
  catalogReference?: CatalogReference$7;
15486
15460
  }
15487
15461
  interface PriceDescription$5 {
@@ -15572,12 +15546,6 @@ interface CustomContentReference$1 {
15572
15546
  */
15573
15547
  componentId?: string;
15574
15548
  }
15575
- interface ExternalReference$1 {
15576
- /** ID of the app that associated with the purchase flow. */
15577
- appId?: string;
15578
- /** Reference to an external system ID, used to link the purchase flow to a specific ID in another system */
15579
- resourceId?: string | null;
15580
- }
15581
15549
  interface CreateCheckoutTemplateRequest$1 {
15582
15550
  /** Checkout template to create. */
15583
15551
  checkoutTemplate: CheckoutTemplate$1;
@@ -15870,13 +15838,13 @@ interface CheckoutTemplate {
15870
15838
  /** Custom settings to apply to the checkout page created from this template. */
15871
15839
  customization?: CheckoutCustomization;
15872
15840
  /**
15873
- * Line items.
15841
+ * Catalog line items.
15874
15842
  *
15875
15843
  * Max: 300 items
15876
15844
  */
15877
15845
  lineItems?: V1LineItem[];
15878
15846
  /**
15879
- * Custom line items.
15847
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
15880
15848
  *
15881
15849
  * Max: 300 items
15882
15850
  */
@@ -15889,16 +15857,12 @@ interface CheckoutTemplate {
15889
15857
  */
15890
15858
  couponCode?: string | null;
15891
15859
  /**
15892
- * Customize the content of the checkout page.
15860
+ * Reference IDs for the app and component providing custom checkout page content.
15893
15861
  *
15894
- * Includes IDs for the app and the component providing the content
15862
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
15863
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
15895
15864
  */
15896
15865
  customContentReference?: CustomContentReference;
15897
- /**
15898
- * Used for integration and tracking across different platforms.
15899
- * Contains external system IDs (e.g., app ID, external ID) to link the checkout template with other systems.
15900
- */
15901
- externalReference?: ExternalReference;
15902
15866
  }
15903
15867
  declare enum Status$2 {
15904
15868
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -15949,11 +15913,7 @@ interface V1LineItem {
15949
15913
  * Max: `100000`
15950
15914
  */
15951
15915
  quantity?: number;
15952
- /**
15953
- * Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
15954
- *
15955
- * > **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).
15956
- */
15916
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
15957
15917
  catalogReference?: CatalogReference$6;
15958
15918
  /** Overriding values for catalog item properties. */
15959
15919
  catalogOverrideFields?: CatalogOverrideFields;
@@ -16146,7 +16106,7 @@ interface CustomLineItem$2 {
16146
16106
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
16147
16107
  */
16148
16108
  depositAmount?: string | null;
16149
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
16109
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
16150
16110
  catalogReference?: CatalogReference$6;
16151
16111
  }
16152
16112
  interface PriceDescription$4 {
@@ -16231,12 +16191,6 @@ interface CustomContentReference {
16231
16191
  */
16232
16192
  componentId?: string;
16233
16193
  }
16234
- interface ExternalReference {
16235
- /** ID of the app that associated with the purchase flow. */
16236
- appId?: string;
16237
- /** Reference to an external system ID, used to link the purchase flow to a specific ID in another system */
16238
- resourceId?: string | null;
16239
- }
16240
16194
  interface CreateCheckoutTemplateRequest {
16241
16195
  /** Checkout template to create. */
16242
16196
  checkoutTemplate: CheckoutTemplate;
@@ -17749,7 +17703,7 @@ interface OrderLineItem$3 {
17749
17703
  productName?: ProductName$3;
17750
17704
  /**
17751
17705
  * References to the line item's origin catalog.
17752
- * This field is empty in the case of a custom line item.
17706
+ * This field may be empty in the case of a custom line item.
17753
17707
  */
17754
17708
  catalogReference?: CatalogReference$5;
17755
17709
  /** Line item quantity. */
@@ -18847,11 +18801,11 @@ interface AddLineItemsToDraftOrderRequest$1 {
18847
18801
  draftOrderId: string;
18848
18802
  /** Catalog line items to add to draft order. */
18849
18803
  catalogLineItems?: CatalogReferenceLineItem$1[];
18850
- /** Custom line items to add to draft order. */
18804
+ /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
18851
18805
  customLineItems?: CustomLineItem$1[];
18852
18806
  }
18853
18807
  interface CatalogReferenceLineItem$1 {
18854
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
18808
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
18855
18809
  catalogReference?: CatalogReference$5;
18856
18810
  /** Item quantity. */
18857
18811
  quantity?: number;
@@ -18868,7 +18822,7 @@ interface CustomLineItem$1 {
18868
18822
  * Max: `"100000"`
18869
18823
  */
18870
18824
  quantity?: number;
18871
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
18825
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
18872
18826
  catalogReference?: CatalogReference$5;
18873
18827
  /**
18874
18828
  * Item name.
@@ -20287,7 +20241,7 @@ interface OrderLineItem$2 {
20287
20241
  productName?: ProductName$2;
20288
20242
  /**
20289
20243
  * References to the line item's origin catalog.
20290
- * This field is empty in the case of a custom line item.
20244
+ * This field may be empty in the case of a custom line item.
20291
20245
  */
20292
20246
  catalogReference?: CatalogReference$4;
20293
20247
  /** Line item quantity. */
@@ -21342,11 +21296,11 @@ interface AddLineItemsToDraftOrderRequest {
21342
21296
  draftOrderId: string;
21343
21297
  /** Catalog line items to add to draft order. */
21344
21298
  catalogLineItems?: CatalogReferenceLineItem[];
21345
- /** Custom line items to add to draft order. */
21299
+ /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
21346
21300
  customLineItems?: CustomLineItem[];
21347
21301
  }
21348
21302
  interface CatalogReferenceLineItem {
21349
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
21303
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
21350
21304
  catalogReference?: CatalogReference$4;
21351
21305
  /** Item quantity. */
21352
21306
  quantity?: number;
@@ -21363,7 +21317,7 @@ interface CustomLineItem {
21363
21317
  * Max: `"100000"`
21364
21318
  */
21365
21319
  quantity?: number;
21366
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
21320
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
21367
21321
  catalogReference?: CatalogReference$4;
21368
21322
  /**
21369
21323
  * Item name.
@@ -23963,7 +23917,7 @@ interface OrderLineItem$1 {
23963
23917
  productName?: ProductName$1;
23964
23918
  /**
23965
23919
  * References to the line item's origin catalog.
23966
- * This field is empty in the case of a custom line item.
23920
+ * This field may be empty in the case of a custom line item.
23967
23921
  */
23968
23922
  catalogReference?: CatalogReference$3;
23969
23923
  /** Line item quantity. */
@@ -25040,7 +24994,7 @@ interface AuthorizationDetails$3 {
25040
24994
  /** Void associated with payment */
25041
24995
  void?: AuthorizationVoid$3;
25042
24996
  /** Scheduled action for this transaction */
25043
- scheduledAction?: ScheduledAction$3;
24997
+ scheduledAction?: V1ScheduledAction$1;
25044
24998
  }
25045
24999
  interface AuthorizationCapture$3 {
25046
25000
  /**
@@ -25099,7 +25053,7 @@ declare enum Reason$3 {
25099
25053
  MANUAL = "MANUAL",
25100
25054
  SCHEDULED = "SCHEDULED"
25101
25055
  }
25102
- interface ScheduledAction$3 {
25056
+ interface V1ScheduledAction$1 {
25103
25057
  /** type of the action */
25104
25058
  actionType?: ActionType$3;
25105
25059
  /** the date and time of the action */
@@ -25434,14 +25388,14 @@ interface AuthorizationVoidNonNullableFields$3 {
25434
25388
  failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$3;
25435
25389
  reason: Reason$3;
25436
25390
  }
25437
- interface ScheduledActionNonNullableFields$3 {
25391
+ interface V1ScheduledActionNonNullableFields$1 {
25438
25392
  actionType: ActionType$3;
25439
25393
  }
25440
25394
  interface AuthorizationDetailsNonNullableFields$3 {
25441
25395
  delayedCapture: boolean;
25442
25396
  captures: AuthorizationCaptureNonNullableFields$3[];
25443
25397
  void?: AuthorizationVoidNonNullableFields$3;
25444
- scheduledAction?: ScheduledActionNonNullableFields$3;
25398
+ scheduledAction?: V1ScheduledActionNonNullableFields$1;
25445
25399
  }
25446
25400
  interface RegularPaymentDetailsNonNullableFields$3 {
25447
25401
  offlinePayment: boolean;
@@ -26120,7 +26074,7 @@ interface OrderLineItem {
26120
26074
  * + Events - `ticket.name`
26121
26075
  */
26122
26076
  productName?: ProductName;
26123
- /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */
26077
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
26124
26078
  catalogReference?: CatalogReference$2;
26125
26079
  /** Line item quantity. */
26126
26080
  quantity?: number;
@@ -27156,7 +27110,7 @@ interface AuthorizationDetails$2 {
27156
27110
  /** Void associated with payment */
27157
27111
  void?: AuthorizationVoid$2;
27158
27112
  /** Scheduled action for this transaction */
27159
- scheduledAction?: ScheduledAction$2;
27113
+ scheduledAction?: V1ScheduledAction;
27160
27114
  }
27161
27115
  interface AuthorizationCapture$2 {
27162
27116
  /**
@@ -27215,7 +27169,7 @@ declare enum Reason$2 {
27215
27169
  MANUAL = "MANUAL",
27216
27170
  SCHEDULED = "SCHEDULED"
27217
27171
  }
27218
- interface ScheduledAction$2 {
27172
+ interface V1ScheduledAction {
27219
27173
  /** type of the action */
27220
27174
  actionType?: ActionType$2;
27221
27175
  /** the date and time of the action */
@@ -27550,14 +27504,14 @@ interface AuthorizationVoidNonNullableFields$2 {
27550
27504
  failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$2;
27551
27505
  reason: Reason$2;
27552
27506
  }
27553
- interface ScheduledActionNonNullableFields$2 {
27507
+ interface V1ScheduledActionNonNullableFields {
27554
27508
  actionType: ActionType$2;
27555
27509
  }
27556
27510
  interface AuthorizationDetailsNonNullableFields$2 {
27557
27511
  delayedCapture: boolean;
27558
27512
  captures: AuthorizationCaptureNonNullableFields$2[];
27559
27513
  void?: AuthorizationVoidNonNullableFields$2;
27560
- scheduledAction?: ScheduledActionNonNullableFields$2;
27514
+ scheduledAction?: V1ScheduledActionNonNullableFields;
27561
27515
  }
27562
27516
  interface RegularPaymentDetailsNonNullableFields$2 {
27563
27517
  offlinePayment: boolean;
@@ -31703,7 +31657,7 @@ interface LineItem$1 {
31703
31657
  /**
31704
31658
  * Optional references to the line item's origin catalog.
31705
31659
  * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.
31706
- * This field is empty in the case of a custom line item.
31660
+ * This field may be empty in the case of a custom line item.
31707
31661
  * currently we only use the catalog app id to set tax=0 for specific apps.
31708
31662
  */
31709
31663
  catalogReference?: CatalogReference$1;
@@ -32839,7 +32793,7 @@ interface LineItem {
32839
32793
  /**
32840
32794
  * Optional references to the line item's origin catalog.
32841
32795
  * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.
32842
- * This field is empty in the case of a custom line item.
32796
+ * This field may be empty in the case of a custom line item.
32843
32797
  * currently we only use the catalog app id to set tax=0 for specific apps.
32844
32798
  */
32845
32799
  catalogReference?: CatalogReference;