@wix/auto_sdk_ecom_subscription-contracts 1.0.19 → 1.0.21

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 (134) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
  11. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +35 -0
  12. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
  13. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
  14. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +198 -0
  15. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
  16. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
  17. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +66 -0
  18. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
  20. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +153 -0
  21. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
  22. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
  23. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +161 -0
  24. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
  25. package/build/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.mts → cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
  26. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +342 -0
  27. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
  39. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +16 -0
  40. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
  41. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
  42. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +193 -0
  43. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
  44. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
  45. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +38 -0
  46. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
  47. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
  48. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +132 -0
  49. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
  50. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
  51. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +158 -0
  52. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
  53. package/build/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.ts → es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
  54. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +314 -0
  55. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
  66. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +35 -0
  67. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
  69. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +198 -0
  70. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
  72. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +66 -0
  73. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
  75. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +153 -0
  76. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
  78. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +161 -0
  79. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
  80. package/build/internal/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.mts → cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
  81. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +342 -0
  82. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
  93. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +16 -0
  94. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
  96. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +193 -0
  97. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
  99. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +38 -0
  100. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
  102. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +132 -0
  103. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
  105. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +158 -0
  106. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
  107. package/build/internal/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.ts → es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
  108. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +314 -0
  109. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -39
  112. package/build/index.d.ts +0 -39
  113. package/build/index.js +0 -659
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -615
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -39
  118. package/build/internal/index.d.ts +0 -39
  119. package/build/internal/index.js +0 -659
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -615
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -1320
  124. package/build/internal/meta.d.ts +0 -1320
  125. package/build/internal/meta.js +0 -257
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -229
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -1320
  130. package/build/meta.d.ts +0 -1320
  131. package/build/meta.js +0 -257
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -229
  134. package/build/meta.mjs.map +0 -1
package/build/meta.d.mts DELETED
@@ -1,1320 +0,0 @@
1
- import { aw as GetSubscriptionContractRequest$1, ax as GetSubscriptionContractResponse$1, aA as QuerySubscriptionContractsRequest$1, aF as QuerySubscriptionContractsResponse$1 } from './ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.mjs';
2
-
3
- /**
4
- * A SubscriptionContract is a ...
5
- * You can ...
6
- * Read more about SubscriptionContracts
7
- * in this [article](<LINK_TO_KB_ARTICLE>).
8
- */
9
- interface SubscriptionContract {
10
- /**
11
- * SubscriptionContract ID.
12
- * @format GUID
13
- * @readonly
14
- */
15
- id?: string | null;
16
- /**
17
- * Revision number, which increments by 1 each time the SubscriptionContract is updated.
18
- * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
19
- *
20
- * Ignored when creating a SubscriptionOrderContract.
21
- * @readonly
22
- */
23
- revision?: string | null;
24
- /**
25
- * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
26
- * @readonly
27
- */
28
- createdDate?: Date | null;
29
- /**
30
- * Date and time the subscription contract was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
31
- * @readonly
32
- */
33
- updatedDate?: Date | null;
34
- /**
35
- * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
36
- * @maxLength 500
37
- * @deprecated Subscription option description. For example, `"1kg of selected coffee, once a month"`.
38
- * @replacedBy subscription_description
39
- * @targetRemovalDate 2025-10-01
40
- */
41
- description?: string | null;
42
- /**
43
- * Subscription detailed information.
44
- * @immutable
45
- */
46
- subscriptionSettings?: V1SubscriptionSettings;
47
- /**
48
- * Order line items.
49
- * @minSize 1
50
- * @maxSize 1
51
- * @readonly
52
- */
53
- lineItems?: OrderLineItem[];
54
- /** Buyer information. */
55
- buyerInfo?: BuyerInfo;
56
- /**
57
- * Language for communication with the buyer. Defaults to the site language.
58
- * For a site that supports multiple languages, this is the language the buyer selected.
59
- */
60
- buyerLanguage?: string | null;
61
- /** Weight measurement unit - defaults to site's weight unit. */
62
- weightUnit?: WeightUnit;
63
- /**
64
- * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
65
- * @format CURRENCY
66
- * @immutable
67
- */
68
- currency?: string | null;
69
- /** Multi-currency information of the subscription. conversionRate may reflect updated exchange rate on created order per recurring cycle. */
70
- currencyConversionDetails?: CurrencyConversionDetails;
71
- /**
72
- * Whether tax is included in line item prices.
73
- *
74
- * Default: `false`
75
- * @immutable
76
- */
77
- taxIncludedInPrices?: boolean;
78
- /**
79
- * Order price summary.
80
- * @readonly
81
- */
82
- priceSummary?: PriceSummary;
83
- /** Billing address and contact details. */
84
- billingInfo?: AddressWithContact;
85
- /** Shipping info and selected shipping option details. */
86
- shippingInfo?: ShippingInformation;
87
- /** Applied discounts. */
88
- appliedDiscounts?: AppliedDiscount[];
89
- /** Information about the sales channel that submitted this order. */
90
- channelInfo?: ChannelInfo;
91
- /** Custom fields. */
92
- customFields?: CustomField[];
93
- /**
94
- * Order recipient address and contact details.
95
- *
96
- * This field may differ from the address in `shippingInfo.logistics` when:
97
- * + The chosen shipping option is pickup point or store pickup.
98
- * + No shipping option is selected.
99
- */
100
- recipientInfo?: AddressWithContact;
101
- /**
102
- * Custom field data for the subscription contract object.
103
- *
104
- * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
105
- */
106
- extendedFields?: ExtendedFields;
107
- /**
108
- * Subscription option title. For example, `"Monthly coffee Subscription"`.
109
- * @maxLength 150
110
- * @deprecated Subscription option title. For example, `"Monthly coffee Subscription"`.
111
- * @replacedBy subscription_title
112
- * @targetRemovalDate 2025-10-01
113
- */
114
- title?: string | null;
115
- /**
116
- * Additional fees applied to subscription contract.
117
- * @maxSize 100
118
- */
119
- additionalFees?: AdditionalFee[];
120
- }
121
- interface V1SubscriptionSettings {
122
- /** Frequency of recurring payment. */
123
- frequency?: SubscriptionFrequency;
124
- /**
125
- * Interval of recurring payment.
126
- * @min 1
127
- * @max 50
128
- */
129
- interval?: number | null;
130
- /** Whether subscription is renewed automatically at the end of each period. */
131
- autoRenewal?: boolean;
132
- /**
133
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
134
- * @min 1
135
- */
136
- billingCycles?: number | null;
137
- /** Whether to allow the customer to cancel the subscription. */
138
- enableCustomerCancellation?: boolean;
139
- }
140
- declare enum SubscriptionFrequency {
141
- UNDEFINED = "UNDEFINED",
142
- DAY = "DAY",
143
- WEEK = "WEEK",
144
- MONTH = "MONTH",
145
- YEAR = "YEAR"
146
- }
147
- interface OrderLineItem {
148
- /**
149
- * Line item ID.
150
- * @immutable
151
- */
152
- id?: string;
153
- /**
154
- * Item name.
155
- * + Stores - `product.name`
156
- * + Bookings - `service.info.name`
157
- * + Events - `ticket.name`
158
- */
159
- productName?: ProductName;
160
- /**
161
- * References to the line item's origin catalog.
162
- * This field may be empty in the case of a custom line item.
163
- */
164
- catalogReference?: CatalogReference;
165
- /**
166
- * Line item quantity.
167
- * @min 1
168
- * @max 100000
169
- */
170
- quantity?: number;
171
- /**
172
- * Total discount for this line item's entire quantity.
173
- * @readonly
174
- */
175
- totalDiscount?: Price;
176
- /**
177
- * Line item description lines. Used for display purposes for the cart, checkout and order.
178
- * @maxSize 20
179
- */
180
- descriptionLines?: DescriptionLine[];
181
- /** Line item image. */
182
- image?: Image;
183
- /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
184
- physicalProperties?: PhysicalProperties;
185
- /** Item type. Either a preset type or custom. */
186
- itemType?: ItemType;
187
- /**
188
- * Fulfiller ID. Field is empty when the line item is self-fulfilled.
189
- * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
190
- * @format GUID
191
- */
192
- fulfillerId?: string | null;
193
- /**
194
- * Number of items that were refunded.
195
- * @max 100000
196
- */
197
- refundQuantity?: number | null;
198
- /**
199
- * Number of items restocked.
200
- * @max 100000
201
- */
202
- restockQuantity?: number | null;
203
- /** Line item price after line item discounts for display purposes. */
204
- price?: Price;
205
- /**
206
- * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
207
- * @readonly
208
- */
209
- priceBeforeDiscounts?: Price;
210
- /**
211
- * Total price after discounts, and before tax.
212
- * @readonly
213
- */
214
- totalPriceBeforeTax?: Price;
215
- /**
216
- * Total price after all discounts and tax.
217
- * @readonly
218
- */
219
- totalPriceAfterTax?: Price;
220
- /**
221
- * Type of selected payment option for current item.
222
- *
223
- * Default: `FULL_PAYMENT_ONLINE`
224
- */
225
- paymentOption?: PaymentOptionType;
226
- /**
227
- * Deprecated. Use `taxInfo` instead.
228
- * This field will be removed on September 30, 2024.
229
- * Tax details for this line item.
230
- * @deprecated Deprecated. Use `taxInfo` instead.
231
- * This field will be removed on September 30, 2024.
232
- * Tax details for this line item.
233
- * @replacedBy tax_info
234
- * @targetRemovalDate 2024-09-30
235
- */
236
- taxDetails?: ItemTaxFullDetails;
237
- /** Represents all the relevant tax details for a specific line item. */
238
- taxInfo?: LineItemTaxInfo;
239
- /** Digital file identifier, relevant only for items with type DIGITAL. */
240
- digitalFile?: DigitalFile;
241
- /** Subscription info. */
242
- subscriptionInfo?: SubscriptionInfo;
243
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
244
- priceDescription?: PriceDescription;
245
- /**
246
- * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
247
- * @readonly
248
- */
249
- depositAmount?: Price;
250
- /**
251
- * Line item locations.
252
- *
253
- * The location's total quantity must not exceed the line item quantity.
254
- * @maxSize 5
255
- */
256
- locations?: LocationAndQuantity[];
257
- /**
258
- * Custom extended fields for the line item object.
259
- *
260
- * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
261
- */
262
- extendedFields?: ExtendedFields;
263
- }
264
- interface ProductName {
265
- /**
266
- * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
267
- *
268
- * Min: 1 character.
269
- * Max: 200 characters.
270
- * @minLength 1
271
- * @maxLength 200
272
- */
273
- original?: string;
274
- /**
275
- * Item name translated into the buyer's language.
276
- *
277
- * Min: 1 character.
278
- * Max: 400 characters.
279
- * Default: Same as `original`.
280
- * @minLength 1
281
- * @maxLength 400
282
- */
283
- translated?: string | null;
284
- }
285
- /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
286
- interface CatalogReference {
287
- /**
288
- * ID of the item within the catalog it belongs to.
289
- * @minLength 1
290
- * @maxLength 36
291
- */
292
- catalogItemId?: string;
293
- /**
294
- * ID of the app providing the catalog.
295
- *
296
- * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
297
- *
298
- * For items from Wix catalogs, the following values always apply:
299
- * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
300
- * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
301
- * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
302
- * @minLength 1
303
- */
304
- appId?: string;
305
- /**
306
- * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
307
- *
308
- * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
309
- */
310
- options?: Record<string, any> | null;
311
- }
312
- interface Price {
313
- /**
314
- * Amount.
315
- * @decimalValue options { gte:0, lte:1000000000000000 }
316
- */
317
- amount?: string;
318
- /**
319
- * Amount formatted with currency symbol.
320
- * @readonly
321
- */
322
- formattedAmount?: string;
323
- }
324
- interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
325
- /** Description line plain text value. */
326
- plainText?: PlainTextValue;
327
- /** Description line color value. */
328
- colorInfo?: Color;
329
- /** Description line name. */
330
- name?: DescriptionLineName;
331
- }
332
- /** @oneof */
333
- interface DescriptionLineValueOneOf {
334
- /** Description line plain text value. */
335
- plainText?: PlainTextValue;
336
- /** Description line color value. */
337
- colorInfo?: Color;
338
- }
339
- /** @oneof */
340
- interface DescriptionLineDescriptionLineValueOneOf {
341
- }
342
- interface DescriptionLineName {
343
- /**
344
- * Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
345
- * @maxLength 100
346
- */
347
- original?: string;
348
- /**
349
- * Description line name translated into the buyer's language.
350
- *
351
- * Default: Same as `original`.
352
- * @maxLength 200
353
- */
354
- translated?: string | null;
355
- }
356
- interface PlainTextValue {
357
- /**
358
- * Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
359
- * @maxLength 600
360
- */
361
- original?: string;
362
- /**
363
- * Description line plain text value translated into the buyer's language.
364
- *
365
- * Default: Same as `original`.
366
- * @maxLength 600
367
- */
368
- translated?: string | null;
369
- }
370
- interface Color {
371
- /**
372
- * Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
373
- * @maxLength 500
374
- */
375
- original?: string;
376
- /**
377
- * Description line color name translated into the buyer's language.
378
- *
379
- * Default: Same as `original`.
380
- * @maxLength 500
381
- */
382
- translated?: string | null;
383
- /** HEX or RGB color code for display. */
384
- code?: string | null;
385
- }
386
- interface Image {
387
- /** WixMedia image ID. */
388
- id?: string;
389
- /** Image URL. */
390
- url?: string;
391
- /**
392
- * Original image height.
393
- * @readonly
394
- */
395
- height?: number;
396
- /**
397
- * Original image width.
398
- * @readonly
399
- */
400
- width?: number;
401
- /** Image alt text. */
402
- altText?: string | null;
403
- /**
404
- * Image filename.
405
- * @readonly
406
- */
407
- filename?: string | null;
408
- }
409
- interface PhysicalProperties {
410
- /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
411
- weight?: number | null;
412
- /**
413
- * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
414
- * @maxLength 40
415
- */
416
- sku?: string | null;
417
- /** Whether this line item is shippable. */
418
- shippable?: boolean;
419
- }
420
- interface ItemType extends ItemTypeItemTypeDataOneOf {
421
- /** Preset item type. */
422
- preset?: ItemTypeItemType;
423
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
424
- custom?: string;
425
- }
426
- /** @oneof */
427
- interface ItemTypeItemTypeDataOneOf {
428
- /** Preset item type. */
429
- preset?: ItemTypeItemType;
430
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
431
- custom?: string;
432
- }
433
- declare enum ItemTypeItemType {
434
- UNRECOGNISED = "UNRECOGNISED",
435
- PHYSICAL = "PHYSICAL",
436
- DIGITAL = "DIGITAL",
437
- GIFT_CARD = "GIFT_CARD",
438
- SERVICE = "SERVICE"
439
- }
440
- /** Type of selected payment option for catalog item */
441
- declare enum PaymentOptionType {
442
- /** The entire payment for this item happens as part of the checkout. */
443
- FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
444
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
445
- FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
446
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
447
- MEMBERSHIP = "MEMBERSHIP",
448
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
449
- DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
450
- /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
451
- MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
452
- }
453
- interface ItemTaxFullDetails {
454
- /** Taxable amount of this line item. */
455
- taxableAmount?: Price;
456
- /**
457
- * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
458
- * @decimalValue options { gte:0, maxScale:6 }
459
- */
460
- taxRate?: string;
461
- /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
462
- totalTax?: Price;
463
- }
464
- interface LineItemTaxInfo {
465
- /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
466
- taxAmount?: Price;
467
- /** Amount for which tax is calculated. */
468
- taxableAmount?: Price;
469
- /**
470
- * Tax rate %, as a decimal point.
471
- * @format DECIMAL_VALUE
472
- * @decimalValue options { gte:0, maxScale:6 }
473
- */
474
- taxRate?: string | null;
475
- /**
476
- * Tax group ID.
477
- * @format GUID
478
- */
479
- taxGroupId?: string | null;
480
- /** Indicates whether the price already includes tax. */
481
- taxIncludedInPrice?: boolean;
482
- /**
483
- * Tax information for a line item.
484
- * @maxSize 7
485
- */
486
- taxBreakdown?: LineItemTaxBreakdown[];
487
- }
488
- /**
489
- * TaxBreakdown represents tax information for a line item.
490
- * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
491
- */
492
- interface LineItemTaxBreakdown {
493
- /**
494
- * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
495
- * @maxLength 200
496
- */
497
- jurisdiction?: string | null;
498
- /**
499
- * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
500
- * @format DECIMAL_VALUE
501
- * @decimalValue options { gte:0, maxScale:6 }
502
- */
503
- rate?: string | null;
504
- /** Amount of tax calculated for this line item. */
505
- taxAmount?: Price;
506
- /**
507
- * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
508
- * @maxLength 200
509
- */
510
- taxType?: string | null;
511
- /**
512
- * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
513
- * This name should be explicit enough to allow the merchant to understand what tax was calculated.
514
- * @maxLength 200
515
- */
516
- taxName?: string | null;
517
- /** Type of jurisdiction that taxes were calculated for. */
518
- jurisdictionType?: JurisdictionType;
519
- /** Non-taxable amount of the line item price. */
520
- nonTaxableAmount?: Price;
521
- /** Taxable amount of the line item price. */
522
- taxableAmount?: Price;
523
- }
524
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
525
- declare enum JurisdictionType {
526
- UNDEFINED = "UNDEFINED",
527
- COUNTRY = "COUNTRY",
528
- STATE = "STATE",
529
- COUNTY = "COUNTY",
530
- CITY = "CITY",
531
- SPECIAL = "SPECIAL"
532
- }
533
- interface DigitalFile {
534
- /**
535
- * ID of the secure file in media.
536
- * @minLength 1
537
- * @maxLength 100
538
- */
539
- fileId?: string;
540
- /**
541
- * Link will exist after the digital links have been generated on the order.
542
- * @format WEB_URL
543
- * @minLength 1
544
- * @maxLength 2000
545
- */
546
- link?: string | null;
547
- /**
548
- * Link expiration time and date.
549
- * @readonly
550
- */
551
- expirationDate?: Date | null;
552
- }
553
- interface SubscriptionInfo {
554
- /**
555
- * Subscription ID.
556
- * @format GUID
557
- */
558
- id?: string | null;
559
- /**
560
- * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
561
- * @min 1
562
- */
563
- cycleNumber?: number;
564
- /**
565
- * Subscription option title. For example, `"Monthly coffee Subscription"`.
566
- * @maxLength 20
567
- * @deprecated Subscription option title. For example, `"Monthly coffee Subscription"`.
568
- * @replacedBy title
569
- * @targetRemovalDate 2025-10-01
570
- */
571
- subscriptionOptionTitle?: string;
572
- /**
573
- * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
574
- * @maxLength 60
575
- * @deprecated Subscription option description. For example, `"1kg of selected coffee, once a month"`.
576
- * @replacedBy description
577
- * @targetRemovalDate 2025-10-01
578
- */
579
- subscriptionOptionDescription?: string | null;
580
- /**
581
- * Subscription detailed information.
582
- * @immutable
583
- */
584
- subscriptionSettings?: SubscriptionSettings;
585
- }
586
- interface SubscriptionSettings {
587
- /** Frequency of recurring payment. */
588
- frequency?: V2SubscriptionFrequency;
589
- /**
590
- * Interval of recurring payment.
591
- * @min 1
592
- * @max 50
593
- */
594
- interval?: number | null;
595
- /** Whether subscription is renewed automatically at the end of each period. */
596
- autoRenewal?: boolean;
597
- /**
598
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
599
- * @min 1
600
- */
601
- billingCycles?: number | null;
602
- }
603
- /** Frequency unit of recurring payment */
604
- declare enum V2SubscriptionFrequency {
605
- UNDEFINED = "UNDEFINED",
606
- DAY = "DAY",
607
- WEEK = "WEEK",
608
- MONTH = "MONTH",
609
- YEAR = "YEAR"
610
- }
611
- interface PriceDescription {
612
- /**
613
- * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
614
- * @minLength 1
615
- * @maxLength 100
616
- */
617
- original?: string;
618
- /**
619
- * Price description translated into the buyer's language.
620
- *
621
- * Default: Same as `original`.
622
- * @minLength 1
623
- * @maxLength 100
624
- */
625
- translated?: string | null;
626
- }
627
- interface LocationAndQuantity {
628
- /**
629
- * Location id in the associated owner app.
630
- * @format GUID
631
- */
632
- id?: string;
633
- /**
634
- * Location owner app, if not provided then the site business info locations will be used.
635
- * @format GUID
636
- * @deprecated Location owner app, if not provided then the site business info locations will be used.
637
- * @targetRemovalDate 2025-03-01
638
- */
639
- appId?: string | null;
640
- /**
641
- * Quantity for specific location.
642
- * @min 1
643
- * @max 100000
644
- */
645
- quantity?: number;
646
- /**
647
- * Location name.
648
- * @maxLength 500
649
- * @readonly
650
- */
651
- name?: string | null;
652
- }
653
- interface ExtendedFields {
654
- /**
655
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
656
- * The value of each key is structured according to the schema defined when the extended fields were configured.
657
- *
658
- * You can only access fields for which you have the appropriate permissions.
659
- *
660
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
661
- */
662
- namespaces?: Record<string, Record<string, any>>;
663
- }
664
- /** Buyer Info */
665
- interface BuyerInfo extends BuyerInfoIdOneOf {
666
- /**
667
- * Visitor ID (if site visitor is not a member).
668
- * @format GUID
669
- */
670
- visitorId?: string;
671
- /**
672
- * Member ID (if site visitor is a site member).
673
- * @format GUID
674
- */
675
- memberId?: string;
676
- /**
677
- * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
678
- * @format GUID
679
- */
680
- contactId?: string | null;
681
- /**
682
- * Buyer email address.
683
- * @format EMAIL
684
- */
685
- email?: string | null;
686
- }
687
- /** @oneof */
688
- interface BuyerInfoIdOneOf {
689
- /**
690
- * Visitor ID (if site visitor is not a member).
691
- * @format GUID
692
- */
693
- visitorId?: string;
694
- /**
695
- * Member ID (if site visitor is a site member).
696
- * @format GUID
697
- */
698
- memberId?: string;
699
- }
700
- declare enum WeightUnit {
701
- /** Weight unit can't be classified due to an error. */
702
- UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
703
- /** Kilograms. */
704
- KG = "KG",
705
- /** Pounds. */
706
- LB = "LB"
707
- }
708
- interface CurrencyConversionDetails {
709
- /**
710
- * Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
711
- * @readonly
712
- * @immutable
713
- * @format CURRENCY
714
- */
715
- originalCurrency?: string | null;
716
- /**
717
- * The rate used when converting from the original currency to the payment currency.
718
- * @readonly
719
- * @immutable
720
- * @decimalValue options { gt:0, lte:1000000000000000 }
721
- */
722
- conversionRate?: string | null;
723
- }
724
- interface PriceSummary {
725
- /** Subtotal of all the line items, before discounts and before tax. */
726
- subtotal?: Price;
727
- /** Total shipping price, before discounts and before tax. */
728
- shipping?: Price;
729
- /** Total tax on this order. */
730
- tax?: Price;
731
- /** Total calculated discount value. */
732
- discount?: Price;
733
- /** Order’s total price after discounts and tax. */
734
- total?: Price;
735
- /** Total price of additional fees before tax. */
736
- totalAdditionalFees?: Price;
737
- }
738
- /** Billing Info and shipping details */
739
- interface AddressWithContact {
740
- /** Address. */
741
- address?: Address;
742
- /** Contact details. */
743
- contactDetails?: FullAddressContactDetails;
744
- }
745
- /** Physical address */
746
- interface Address {
747
- /**
748
- * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
749
- * @format COUNTRY
750
- */
751
- country?: string | null;
752
- /**
753
- * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
754
- * @maxLength 50
755
- */
756
- subdivision?: string | null;
757
- /**
758
- * City name.
759
- * @maxLength 50
760
- */
761
- city?: string | null;
762
- /**
763
- * Postal or zip code.
764
- * @maxLength 50
765
- */
766
- postalCode?: string | null;
767
- /** Street address. */
768
- streetAddress?: StreetAddress;
769
- /**
770
- * Main address line (usually street name and number).
771
- * @maxLength 150
772
- */
773
- addressLine?: string | null;
774
- /**
775
- * Free text providing more detailed address info. Usually contains apt, suite, floor.
776
- * @maxLength 100
777
- */
778
- addressLine2?: string | null;
779
- /**
780
- * Country's full name.
781
- * @readonly
782
- */
783
- countryFullname?: string | null;
784
- /**
785
- * Subdivision full-name.
786
- * @readonly
787
- */
788
- subdivisionFullname?: string | null;
789
- }
790
- interface StreetAddress {
791
- /** Street number. */
792
- number?: string;
793
- /** Street name. */
794
- name?: string;
795
- }
796
- /** Full contact details for an address */
797
- interface FullAddressContactDetails {
798
- /**
799
- * First name.
800
- * @maxLength 100
801
- */
802
- firstName?: string | null;
803
- /**
804
- * Last name.
805
- * @maxLength 100
806
- */
807
- lastName?: string | null;
808
- /**
809
- * Phone number.
810
- * @format PHONE
811
- */
812
- phone?: string | null;
813
- /**
814
- * Company name.
815
- * @maxLength 1000
816
- */
817
- company?: string | null;
818
- /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
819
- vatId?: VatId;
820
- }
821
- interface VatId {
822
- /** Customer's tax ID. */
823
- id?: string;
824
- /**
825
- * Tax type.
826
- *
827
- * Supported values:
828
- * + `CPF`: for individual tax payers
829
- * + `CNPJ`: for corporations
830
- */
831
- type?: VatType;
832
- }
833
- /** tax info types */
834
- declare enum VatType {
835
- UNSPECIFIED = "UNSPECIFIED",
836
- /** CPF - for individual tax payers. */
837
- CPF = "CPF",
838
- /** CNPJ - for corporations */
839
- CNPJ = "CNPJ"
840
- }
841
- interface ShippingInformation {
842
- /**
843
- * App Def Id of external provider which was a source of shipping info
844
- * @minLength 1
845
- * @maxLength 100
846
- */
847
- carrierId?: string | null;
848
- /**
849
- * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
850
- * @minLength 1
851
- * @maxLength 100
852
- */
853
- code?: string | null;
854
- /**
855
- * Shipping option title.
856
- * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
857
- * @maxLength 250
858
- */
859
- title?: string;
860
- /** Shipping logistics. */
861
- logistics?: DeliveryLogistics;
862
- /** Shipping costs. */
863
- cost?: ShippingPrice;
864
- /** Shipping region. */
865
- region?: ShippingRegion;
866
- }
867
- interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
868
- /** Shipping address and contact details. */
869
- shippingDestination?: AddressWithContact;
870
- /** Pickup details. */
871
- pickupDetails?: PickupDetails;
872
- /**
873
- * Expected delivery time in free text. For example, `"3-5 business days"`.
874
- * @maxLength 500
875
- */
876
- deliveryTime?: string | null;
877
- /**
878
- * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
879
- * @maxLength 1000
880
- */
881
- instructions?: string | null;
882
- /**
883
- * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
884
- * @deprecated
885
- */
886
- deliverByDate?: Date | null;
887
- /** Expected delivery time. */
888
- deliveryTimeSlot?: DeliveryTimeSlot;
889
- }
890
- /** @oneof */
891
- interface DeliveryLogisticsAddressOneOf {
892
- /** Shipping address and contact details. */
893
- shippingDestination?: AddressWithContact;
894
- /** Pickup details. */
895
- pickupDetails?: PickupDetails;
896
- }
897
- interface PickupDetails {
898
- /** Pickup address. */
899
- address?: PickupAddress;
900
- /** Pickup method */
901
- pickupMethod?: PickupMethod;
902
- }
903
- /** Physical address */
904
- interface PickupAddress {
905
- /**
906
- * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
907
- * @format COUNTRY
908
- */
909
- country?: string | null;
910
- /**
911
- * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
912
- * @maxLength 50
913
- */
914
- subdivision?: string | null;
915
- /**
916
- * City name.
917
- * @maxLength 1000
918
- */
919
- city?: string | null;
920
- /**
921
- * Postal or zip code.
922
- * @maxLength 1000
923
- */
924
- postalCode?: string | null;
925
- /** Street address object, with number, name, and apartment number in separate fields. */
926
- streetAddress?: StreetAddress;
927
- /**
928
- * Main address line (usually street name and number).
929
- * @maxLength 1000
930
- */
931
- addressLine?: string | null;
932
- /**
933
- * Free text providing more detailed address info. Usually contains apt, suite, floor.
934
- * @maxLength 1000
935
- */
936
- addressLine2?: string | null;
937
- /**
938
- * Country's full name.
939
- * @readonly
940
- */
941
- countryFullname?: string | null;
942
- /**
943
- * Subdivision full-name.
944
- * @readonly
945
- */
946
- subdivisionFullname?: string | null;
947
- }
948
- declare enum PickupMethod {
949
- UNKNOWN_METHOD = "UNKNOWN_METHOD",
950
- STORE_PICKUP = "STORE_PICKUP",
951
- PICKUP_POINT = "PICKUP_POINT"
952
- }
953
- interface DeliveryTimeSlot {
954
- /** Delivery slot starting time. */
955
- from?: Date | null;
956
- /** Delivery slot ending time. */
957
- to?: Date | null;
958
- }
959
- interface ShippingPrice {
960
- /** Shipping price for display purposes. */
961
- price?: Price;
962
- /**
963
- * Total price of shipping after discounts (when relevant), and before tax.
964
- * @readonly
965
- */
966
- totalPriceBeforeTax?: Price;
967
- /**
968
- * Shipping price after all discounts (if any exist), and after tax.
969
- * @readonly
970
- */
971
- totalPriceAfterTax?: Price;
972
- /** Tax details. */
973
- taxDetails?: ItemTaxFullDetails;
974
- /**
975
- * Shipping discount before tax.
976
- * @readonly
977
- */
978
- discount?: Price;
979
- }
980
- interface ShippingRegion {
981
- /**
982
- * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
983
- * @maxLength 100
984
- */
985
- name?: string | null;
986
- }
987
- interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
988
- /** Applied coupon info. */
989
- coupon?: Coupon;
990
- /** Merchant discount. */
991
- merchantDiscount?: MerchantDiscount;
992
- /** Automatic Discount */
993
- discountRule?: DiscountRule;
994
- /**
995
- * Discount type.
996
- * * `"GLOBAL"` - discount applies to entire order.
997
- * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
998
- * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
999
- */
1000
- discountType?: DiscountType;
1001
- /**
1002
- * IDs of line items discount applies to.
1003
- * Deprecated. Use `line_item_discounts` instead.
1004
- * @format GUID
1005
- * @maxSize 1
1006
- * @deprecated IDs of line items discount applies to.
1007
- * Deprecated. Use `line_item_discounts` instead.
1008
- * @replacedBy line_item_discounts
1009
- * @targetRemovalDate 2024-10-30
1010
- */
1011
- lineItemIds?: string[];
1012
- /**
1013
- * Discount id.
1014
- * @format GUID
1015
- * @immutable
1016
- */
1017
- id?: string | null;
1018
- }
1019
- /** @oneof */
1020
- interface AppliedDiscountDiscountSourceOneOf {
1021
- /** Applied coupon info. */
1022
- coupon?: Coupon;
1023
- /** Merchant discount. */
1024
- merchantDiscount?: MerchantDiscount;
1025
- /** Automatic Discount */
1026
- discountRule?: DiscountRule;
1027
- }
1028
- declare enum DiscountType {
1029
- GLOBAL = "GLOBAL",
1030
- SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1031
- SHIPPING = "SHIPPING"
1032
- }
1033
- /** Coupon */
1034
- interface Coupon {
1035
- /** Coupon ID. */
1036
- id?: string;
1037
- /** Coupon code. */
1038
- code?: string;
1039
- /** Coupon name. */
1040
- name?: string;
1041
- /** Coupon value. */
1042
- amount?: Price;
1043
- }
1044
- interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1045
- /**
1046
- * Pre-defined discount reason (optional).
1047
- * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1048
- */
1049
- discountReason?: DiscountReason;
1050
- /**
1051
- * Discount description as free text (optional).
1052
- * @maxLength 200
1053
- */
1054
- description?: string | null;
1055
- /** Discount amount. */
1056
- amount?: Price;
1057
- }
1058
- /** @oneof */
1059
- interface MerchantDiscountMerchantDiscountReasonOneOf {
1060
- /**
1061
- * Pre-defined discount reason (optional).
1062
- * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1063
- */
1064
- discountReason?: DiscountReason;
1065
- /**
1066
- * Discount description as free text (optional).
1067
- * @maxLength 200
1068
- */
1069
- description?: string | null;
1070
- }
1071
- declare enum DiscountReason {
1072
- UNSPECIFIED = "UNSPECIFIED",
1073
- EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1074
- BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1075
- }
1076
- interface DiscountRule {
1077
- /**
1078
- * Discount rule ID
1079
- * @format GUID
1080
- */
1081
- id?: string;
1082
- /** Discount rule name */
1083
- name?: DiscountRuleName;
1084
- /** Discount value. */
1085
- amount?: Price;
1086
- }
1087
- interface DiscountRuleName {
1088
- /**
1089
- * Original discount rule name (in site's default language).
1090
- * @minLength 1
1091
- * @maxLength 256
1092
- */
1093
- original?: string;
1094
- /**
1095
- * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1096
- * @minLength 1
1097
- * @maxLength 500
1098
- */
1099
- translated?: string | null;
1100
- }
1101
- interface ChannelInfo {
1102
- /** Sales channel that submitted the order. */
1103
- type?: ChannelType;
1104
- /**
1105
- * Reference to an order ID from an external system.
1106
- * @maxLength 100
1107
- */
1108
- externalOrderId?: string | null;
1109
- /**
1110
- * URL to the order in the external system.
1111
- * @maxLength 300
1112
- */
1113
- externalOrderUrl?: string | null;
1114
- }
1115
- declare enum ChannelType {
1116
- /** Unspecified sales channel. This value is not supported. */
1117
- UNSPECIFIED = "UNSPECIFIED",
1118
- /** A web client. */
1119
- WEB = "WEB",
1120
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
1121
- POS = "POS",
1122
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
1123
- EBAY = "EBAY",
1124
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
1125
- AMAZON = "AMAZON",
1126
- /** Other sales platform. */
1127
- OTHER_PLATFORM = "OTHER_PLATFORM",
1128
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
1129
- WIX_APP_STORE = "WIX_APP_STORE",
1130
- /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
1131
- WIX_INVOICES = "WIX_INVOICES",
1132
- /** Wix merchant backoffice. */
1133
- BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
1134
- /** Wish sales channel. */
1135
- WISH = "WISH",
1136
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
1137
- CLASS_PASS = "CLASS_PASS",
1138
- /** Global-E sales channel. */
1139
- GLOBAL_E = "GLOBAL_E",
1140
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
1141
- FACEBOOK = "FACEBOOK",
1142
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
1143
- ETSY = "ETSY",
1144
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
1145
- TIKTOK = "TIKTOK",
1146
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1147
- FAIRE_COM = "FAIRE_COM"
1148
- }
1149
- interface CustomField {
1150
- /** Custom field value. */
1151
- value?: any;
1152
- /**
1153
- * Custom field title.
1154
- * @minLength 1
1155
- * @maxLength 500
1156
- */
1157
- title?: string;
1158
- /**
1159
- * Translated custom field title.
1160
- * @minLength 1
1161
- * @maxLength 500
1162
- */
1163
- translatedTitle?: string | null;
1164
- }
1165
- interface AdditionalFee {
1166
- /**
1167
- * Additional fee's unique code for future processing.
1168
- * @minLength 1
1169
- * @maxLength 100
1170
- */
1171
- code?: string | null;
1172
- /**
1173
- * Name of additional fee.
1174
- * @minLength 1
1175
- * @maxLength 50
1176
- */
1177
- name?: string;
1178
- /** Additional fee's price. */
1179
- price?: Price;
1180
- /** Tax details. */
1181
- taxDetails?: ItemTaxFullDetails;
1182
- /**
1183
- * SPI implementer's `appId`.
1184
- * @format GUID
1185
- */
1186
- providerAppId?: string | null;
1187
- /** Additional fee's price before tax. */
1188
- priceBeforeTax?: Price;
1189
- /** Additional fee's price after tax. */
1190
- priceAfterTax?: Price;
1191
- /**
1192
- * Additional fee's id.
1193
- * @format GUID
1194
- * @immutable
1195
- */
1196
- id?: string;
1197
- /**
1198
- * Optional - Line items associated with this additional fee.
1199
- * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1200
- * @format GUID
1201
- */
1202
- lineItemIds?: string[];
1203
- }
1204
- interface GetSubscriptionContractRequest {
1205
- /**
1206
- * ID of the SubscriptionContract to retrieve.
1207
- * @format GUID
1208
- */
1209
- subscriptionContractId: string;
1210
- }
1211
- interface GetSubscriptionContractResponse {
1212
- /** The requested SubscriptionContract. */
1213
- subscriptionContract?: SubscriptionContract;
1214
- }
1215
- interface QuerySubscriptionContractsRequest {
1216
- /** WQL expression. */
1217
- query?: CursorQuery;
1218
- }
1219
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
1220
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1221
- cursorPaging?: CursorPaging;
1222
- /**
1223
- * Filter object in the following format:
1224
- * `"filter" : {
1225
- * "fieldName1": "value1",
1226
- * "fieldName2":{"$operator":"value2"}
1227
- * }`
1228
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1229
- * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1230
- */
1231
- filter?: Record<string, any> | null;
1232
- /**
1233
- * Sort object in the following format:
1234
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1235
- * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1236
- * @maxSize 5
1237
- */
1238
- sort?: Sorting[];
1239
- }
1240
- /** @oneof */
1241
- interface CursorQueryPagingMethodOneOf {
1242
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1243
- cursorPaging?: CursorPaging;
1244
- }
1245
- interface Sorting {
1246
- /**
1247
- * Name of the field to sort by.
1248
- * @maxLength 512
1249
- */
1250
- fieldName?: string;
1251
- /** Sort order. */
1252
- order?: SortOrder;
1253
- }
1254
- declare enum SortOrder {
1255
- ASC = "ASC",
1256
- DESC = "DESC"
1257
- }
1258
- interface CursorPaging {
1259
- /**
1260
- * Maximum number of items to return in the results.
1261
- * @max 100
1262
- */
1263
- limit?: number | null;
1264
- /**
1265
- * Pointer to the next or previous page in the list of results.
1266
- *
1267
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1268
- * Not relevant for the first request.
1269
- * @maxLength 16000
1270
- */
1271
- cursor?: string | null;
1272
- }
1273
- interface QuerySubscriptionContractsResponse {
1274
- /** List of SubscriptionContracts. */
1275
- subscriptionContracts?: SubscriptionContract[];
1276
- /** Paging metadata */
1277
- pagingMetadata?: CursorPagingMetadata;
1278
- }
1279
- interface CursorPagingMetadata {
1280
- /** Number of items returned in the response. */
1281
- count?: number | null;
1282
- /** Cursor strings that point to the next page, previous page, or both. */
1283
- cursors?: Cursors;
1284
- /**
1285
- * Whether there are more pages to retrieve following the current page.
1286
- *
1287
- * + `true`: Another page of results can be retrieved.
1288
- * + `false`: This is the last page.
1289
- */
1290
- hasNext?: boolean | null;
1291
- }
1292
- interface Cursors {
1293
- /**
1294
- * Cursor string pointing to the next page in the list of results.
1295
- * @maxLength 16000
1296
- */
1297
- next?: string | null;
1298
- /**
1299
- * Cursor pointing to the previous page in the list of results.
1300
- * @maxLength 16000
1301
- */
1302
- prev?: string | null;
1303
- }
1304
-
1305
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1306
- getUrl: (context: any) => string;
1307
- httpMethod: K;
1308
- path: string;
1309
- pathParams: M;
1310
- __requestType: T;
1311
- __originalRequestType: S;
1312
- __responseType: Q;
1313
- __originalResponseType: R;
1314
- };
1315
- declare function getSubscriptionContract(): __PublicMethodMetaInfo<'GET', {
1316
- subscriptionContractId: string;
1317
- }, GetSubscriptionContractRequest$1, GetSubscriptionContractRequest, GetSubscriptionContractResponse$1, GetSubscriptionContractResponse>;
1318
- declare function querySubscriptionContracts(): __PublicMethodMetaInfo<'GET', {}, QuerySubscriptionContractsRequest$1, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse$1, QuerySubscriptionContractsResponse>;
1319
-
1320
- export { type __PublicMethodMetaInfo, getSubscriptionContract, querySubscriptionContracts };