@wix/auto_sdk_ecom_order-transactions 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/src/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-DRvhf2o2.d.mts} +246 -224
  2. package/build/{internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-DRvhf2o2.d.ts} +246 -224
  3. package/build/index.d.mts +69 -0
  4. package/build/index.d.ts +69 -0
  5. package/build/index.js +942 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +887 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/ecom-v1-order-transactions-order-transactions.types.d.ts → internal/ecom-v1-order-transactions-order-transactions.universal-aENRFMbJ.d.mts} +330 -224
  10. package/build/internal/{es/src/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-aENRFMbJ.d.ts} +330 -224
  11. package/build/internal/index.d.mts +118 -0
  12. package/build/internal/index.d.ts +118 -0
  13. package/build/internal/index.js +942 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +887 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +614 -0
  18. package/build/internal/meta.d.ts +614 -0
  19. package/build/internal/meta.js +566 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +533 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +614 -0
  24. package/build/meta.d.ts +614 -0
  25. package/build/meta.js +566 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +533 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -9
  40. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.js +0 -41
  41. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
  43. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.js +0 -466
  44. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
  46. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -161
  47. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -63
  49. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.js +0 -76
  50. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.types.js +0 -303
  52. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2589
  54. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -695
  55. package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -9
  67. package/build/es/src/ecom-v1-order-transactions-order-transactions.context.js +0 -13
  68. package/build/es/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
  70. package/build/es/src/ecom-v1-order-transactions-order-transactions.http.js +0 -456
  71. package/build/es/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
  73. package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -128
  74. package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -63
  76. package/build/es/src/ecom-v1-order-transactions-order-transactions.public.js +0 -41
  77. package/build/es/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-order-transactions-order-transactions.types.js +0 -300
  79. package/build/es/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2589
  81. package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -662
  82. package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -13
  93. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.js +0 -41
  94. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
  96. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.js +0 -466
  97. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
  99. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -161
  100. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -108
  102. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.js +0 -76
  103. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.js +0 -303
  105. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2740
  107. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -695
  108. package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -13
  119. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.js +0 -13
  120. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
  122. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.js +0 -456
  123. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
  125. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -128
  126. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -108
  128. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.js +0 -41
  129. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.types.js +0 -300
  131. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2740
  133. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -662
  134. package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
@@ -1,2589 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface OrderTransactions {
3
- /**
4
- * Order ID.
5
- * @format GUID
6
- */
7
- orderId?: string;
8
- /**
9
- * Record of payments made to the merchant.
10
- * @maxSize 100
11
- */
12
- payments?: Payment[];
13
- /**
14
- * Record of refunds made to the buyer.
15
- * @maxSize 300
16
- */
17
- refunds?: Refund[];
18
- }
19
- export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
20
- /** Regular payment details. */
21
- regularPaymentDetails?: RegularPaymentDetails;
22
- /** Gift card payment details. */
23
- giftcardPaymentDetails?: GiftCardPaymentDetails;
24
- /**
25
- * Payment ID.
26
- * @format GUID
27
- * @readonly
28
- */
29
- _id?: string | null;
30
- /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
31
- _createdDate?: Date | null;
32
- /**
33
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
34
- * @readonly
35
- */
36
- _updatedDate?: Date | null;
37
- /** Payment amount. */
38
- amount?: Price;
39
- /**
40
- * Whether refunds for this payment are disabled.
41
- * + `true`: This payment is not refundable.
42
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
43
- */
44
- refundDisabled?: boolean;
45
- }
46
- /** @oneof */
47
- export interface PaymentPaymentDetailsOneOf {
48
- /** Regular payment details. */
49
- regularPaymentDetails?: RegularPaymentDetails;
50
- /** Gift card payment details. */
51
- giftcardPaymentDetails?: GiftCardPaymentDetails;
52
- }
53
- /** @oneof */
54
- export interface PaymentReceiptInfoOneOf {
55
- }
56
- export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
57
- /** Whether regular card used */
58
- creditCardDetails?: CreditCardPaymentMethodDetails;
59
- /**
60
- * Wix Payments order ID.
61
- * @maxLength 100
62
- */
63
- paymentOrderId?: string | null;
64
- /**
65
- * Payment gateway's transaction ID.
66
- * This field is only returned when the value of `offline_payment` is `false`.
67
- * @maxLength 100
68
- */
69
- gatewayTransactionId?: string | null;
70
- /**
71
- * Payment method. Non-exhaustive list of supported values:
72
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
73
- * @maxLength 100
74
- */
75
- paymentMethod?: string | null;
76
- /**
77
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
78
- * @maxLength 100
79
- */
80
- providerTransactionId?: string | null;
81
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
82
- offlinePayment?: boolean;
83
- /** Payment status. */
84
- status?: TransactionStatusWithLiterals;
85
- /**
86
- * Whether there is a payment agreement that allows for future charges.
87
- * @immutable
88
- */
89
- savedPaymentMethod?: boolean;
90
- /** Authorization details. */
91
- authorizationDetails?: AuthorizationDetails;
92
- }
93
- /** @oneof */
94
- export interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
95
- /** Whether regular card used */
96
- creditCardDetails?: CreditCardPaymentMethodDetails;
97
- }
98
- export declare enum TransactionStatus {
99
- UNDEFINED = "UNDEFINED",
100
- APPROVED = "APPROVED",
101
- PENDING = "PENDING",
102
- PENDING_MERCHANT = "PENDING_MERCHANT",
103
- CANCELED = "CANCELED",
104
- DECLINED = "DECLINED",
105
- REFUNDED = "REFUNDED",
106
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
107
- AUTHORIZED = "AUTHORIZED",
108
- VOIDED = "VOIDED"
109
- }
110
- /** @enumType */
111
- export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
112
- export interface CreditCardPaymentMethodDetails {
113
- /**
114
- * The last 4 digits of the card number.
115
- * @maxLength 4
116
- */
117
- lastFourDigits?: string | null;
118
- /**
119
- * Card issuer's brand.
120
- * @maxLength 100
121
- */
122
- brand?: string | null;
123
- }
124
- export interface AuthorizationDetails {
125
- /**
126
- * Whether the authorized payment is of a delayed capture.
127
- * @readonly
128
- */
129
- delayedCapture?: boolean;
130
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
131
- authorizedDate?: Date | null;
132
- /**
133
- * List of captures associated with payment
134
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
135
- * @maxSize 1
136
- */
137
- captures?: AuthorizationCapture[];
138
- /** Void associated with payment */
139
- void?: AuthorizationVoid;
140
- /** Scheduled action for this transaction */
141
- scheduledAction?: ScheduledAction;
142
- }
143
- export interface AuthorizationCapture {
144
- /**
145
- * Capture ID.
146
- * @format GUID
147
- * @readonly
148
- */
149
- _id?: string | null;
150
- /** Status of this capture action */
151
- status?: AuthorizationCaptureStatusWithLiterals;
152
- /**
153
- * Amount of this capture
154
- * @immutable
155
- */
156
- amount?: Price;
157
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
158
- _createdDate?: Date | null;
159
- /** In case of status is FAILED may contain failure details */
160
- failureDetails?: AuthorizationActionFailureDetails;
161
- }
162
- export declare enum AuthorizationCaptureStatus {
163
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
164
- /** Capture operation still in progress. */
165
- PENDING = "PENDING",
166
- /** Capture operation succeeded. */
167
- SUCCEEDED = "SUCCEEDED",
168
- /** Capture operation failed. */
169
- FAILED = "FAILED"
170
- }
171
- /** @enumType */
172
- export type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
173
- export interface Price {
174
- /**
175
- * Amount.
176
- * @decimalValue options { gte:0, lte:1000000000000000 }
177
- */
178
- amount?: string;
179
- /**
180
- * Amount formatted with currency symbol.
181
- * @readonly
182
- */
183
- formattedAmount?: string;
184
- }
185
- export interface AuthorizationActionFailureDetails {
186
- /** @maxLength 100 */
187
- failureCode?: string;
188
- }
189
- export interface AuthorizationVoid {
190
- /** Status of this void action */
191
- status?: AuthorizationVoidStatusWithLiterals;
192
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
193
- voidedDate?: Date | null;
194
- /** In case of status is FAILED may contain failure details */
195
- failureDetails?: AuthorizationActionFailureDetails;
196
- /** Reason of void action */
197
- reason?: ReasonWithLiterals;
198
- }
199
- export declare enum AuthorizationVoidStatus {
200
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
201
- /** Void operation still in progress. */
202
- PENDING = "PENDING",
203
- /** Void operation succeeded. */
204
- SUCCEEDED = "SUCCEEDED",
205
- /** Void operation failed. */
206
- FAILED = "FAILED"
207
- }
208
- /** @enumType */
209
- export type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
210
- /** Reason the authorization was voided. */
211
- export declare enum Reason {
212
- UNKNOWN_REASON = "UNKNOWN_REASON",
213
- /** Authorization was voided by user. */
214
- MANUAL = "MANUAL",
215
- /** Authorization passed execution date. */
216
- SCHEDULED = "SCHEDULED"
217
- }
218
- /** @enumType */
219
- export type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
220
- export interface ScheduledAction {
221
- /** Type of the action. */
222
- actionType?: ActionTypeWithLiterals;
223
- /** The date and time of the action. */
224
- executionDate?: Date | null;
225
- }
226
- export declare enum ActionType {
227
- UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
228
- VOID = "VOID",
229
- CAPTURE = "CAPTURE"
230
- }
231
- /** @enumType */
232
- export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
233
- export interface GiftCardPaymentDetails {
234
- /**
235
- * Gift card payment ID.
236
- * @minLength 1
237
- * @maxLength 100
238
- */
239
- giftCardPaymentId?: string;
240
- /**
241
- * ID of the app that created the gift card.
242
- * @format GUID
243
- */
244
- appId?: string;
245
- /**
246
- * Whether the gift card is voided.
247
- * @readonly
248
- */
249
- voided?: boolean;
250
- }
251
- export interface MembershipPaymentDetails {
252
- /**
253
- * Membership ID.
254
- * @minLength 1
255
- * @maxLength 100
256
- */
257
- membershipId?: string;
258
- /**
259
- * ID of the line item this membership applies to.
260
- * @minLength 1
261
- * @maxLength 100
262
- */
263
- lineItemId?: string;
264
- /** Payment status. */
265
- status?: MembershipPaymentStatusWithLiterals;
266
- /** Membership name. */
267
- name?: MembershipName;
268
- /**
269
- * The transaction ID in the membership system. Can be used to void the transaction.
270
- * @minLength 1
271
- * @maxLength 100
272
- */
273
- externalTransactionId?: string | null;
274
- /**
275
- * Whether the membership is voided.
276
- * @readonly
277
- */
278
- voided?: boolean;
279
- /**
280
- * ID of the application providing this payment option.
281
- * @format GUID
282
- */
283
- providerAppId?: string;
284
- }
285
- export declare enum MembershipPaymentStatus {
286
- /** Payment was charged. */
287
- CHARGED = "CHARGED",
288
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
289
- CHARGE_FAILED = "CHARGE_FAILED"
290
- }
291
- /** @enumType */
292
- export type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
293
- export interface MembershipName {
294
- /**
295
- * Membership name.
296
- * @maxLength 100
297
- */
298
- original?: string;
299
- /**
300
- * Translated membership name. Defaults to `original` when not provided.
301
- * @maxLength 100
302
- */
303
- translated?: string | null;
304
- }
305
- export interface WixReceiptInfo {
306
- /**
307
- * Receipt ID
308
- * @format GUID
309
- */
310
- receiptId?: string;
311
- /**
312
- * Display number of receipt
313
- * @minLength 1
314
- * @maxLength 40
315
- */
316
- displayNumber?: string | null;
317
- }
318
- export interface ExternalReceiptInfo {
319
- /**
320
- * External receipt ID
321
- * @maxLength 100
322
- */
323
- receiptId?: string | null;
324
- /**
325
- * ID of the app providing the receipt
326
- * @format GUID
327
- */
328
- appId?: string | null;
329
- /**
330
- * Display number of receipt
331
- * @minLength 1
332
- * @maxLength 40
333
- */
334
- displayNumber?: string | null;
335
- }
336
- export interface Refund {
337
- /**
338
- * Refund ID.
339
- * @format GUID
340
- * @readonly
341
- */
342
- _id?: string;
343
- /**
344
- * List of transactions.
345
- * @maxSize 50
346
- */
347
- transactions?: RefundTransaction[];
348
- /** Refund business details. */
349
- details?: RefundDetails;
350
- /**
351
- * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
352
- * @readonly
353
- * @immutable
354
- */
355
- _createdDate?: Date | null;
356
- /**
357
- * Aggregated refund summary.
358
- * @readonly
359
- */
360
- summary?: AggregatedRefundSummary;
361
- /**
362
- * ID of the app that initiated this refund.
363
- * @format GUID
364
- * @readonly
365
- * @immutable
366
- */
367
- requestingServiceAppId?: string | null;
368
- }
369
- export interface RefundTransaction {
370
- /**
371
- * ID of the payment associated with this refund.
372
- * @format GUID
373
- * @immutable
374
- */
375
- paymentId?: string;
376
- /**
377
- * Refund amount.
378
- * @immutable
379
- */
380
- amount?: Price;
381
- /** Refund status. */
382
- refundStatus?: RefundStatusWithLiterals;
383
- /** Optional details of current refund status. */
384
- refundStatusInfo?: RefundStatusInfo;
385
- /**
386
- * Payment gateway's refund ID.
387
- * This field is only returned when the value of `external_refund` is `false`.
388
- * @format GUID
389
- */
390
- gatewayRefundId?: string | null;
391
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
392
- providerRefundId?: string | null;
393
- /**
394
- * Whether refund was made externally and manually on the payment provider's side.
395
- * @immutable
396
- */
397
- externalRefund?: boolean;
398
- }
399
- /** Refund transaction status. */
400
- export declare enum RefundStatus {
401
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
402
- PENDING = "PENDING",
403
- /** Refund transaction succeeded. */
404
- SUCCEEDED = "SUCCEEDED",
405
- /** Refund transaction failed. */
406
- FAILED = "FAILED",
407
- /** Refund request acknowledged, and will be executed soon. */
408
- SCHEDULED = "SCHEDULED",
409
- /** Refund was initiated on payment provider side. */
410
- STARTED = "STARTED"
411
- }
412
- /** @enumType */
413
- export type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
414
- export interface RefundStatusInfo {
415
- /**
416
- * Reason code for the refund's current status.
417
- *
418
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
419
- * @minLength 1
420
- * @maxLength 10
421
- */
422
- paymentGatewayReasonCode?: string | null;
423
- /**
424
- * Free text explanation of current refund status.
425
- * @minLength 1
426
- * @maxLength 1000
427
- */
428
- description?: string | null;
429
- }
430
- /** Business model of a refund request */
431
- export interface RefundDetails {
432
- /**
433
- * Order line item IDs and quantities that were refunded.
434
- * @maxSize 300
435
- */
436
- items?: RefundItem[];
437
- /** Whether the shipping fee was also refunded. */
438
- shippingIncluded?: boolean;
439
- /**
440
- * Reason for the refund, provided by customer (optional).
441
- * @maxLength 200
442
- */
443
- reason?: string | null;
444
- /**
445
- * Line items that were refunded.
446
- * @maxSize 300
447
- */
448
- lineItems?: LineItemRefund[];
449
- /**
450
- * Additional fees that were refunded.
451
- * @maxSize 100
452
- */
453
- additionalFees?: AdditionalFeeRefund[];
454
- /** Shipping amount that was refunded. */
455
- shipping?: ShippingRefund;
456
- }
457
- export interface RefundItem {
458
- /**
459
- * Line item ID the refunded line item.
460
- * @format GUID
461
- */
462
- lineItemId?: string;
463
- /**
464
- * Line item quantity refunded.
465
- * @min 1
466
- * @max 100000
467
- */
468
- quantity?: number;
469
- }
470
- export interface LineItemRefund {
471
- /**
472
- * Line item ID.
473
- * @format GUID
474
- * @immutable
475
- */
476
- lineItemId?: string;
477
- /**
478
- * Refund quantity.
479
- * @min 1
480
- * @max 100000
481
- * @immutable
482
- */
483
- quantity?: number;
484
- }
485
- export interface AdditionalFeeRefund {
486
- /**
487
- * Additional fee ID.
488
- * @format GUID
489
- * @immutable
490
- */
491
- additionalFeeId?: string;
492
- /**
493
- * Refund amount.
494
- * @immutable
495
- */
496
- amount?: Price;
497
- }
498
- export interface ShippingRefund {
499
- /**
500
- * Refund amount.
501
- * @immutable
502
- */
503
- amount?: Price;
504
- }
505
- export interface AggregatedRefundSummary {
506
- /** Total amount requested for refund. */
507
- requestedRefund?: Price;
508
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
509
- pendingRefund?: Price;
510
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
511
- refunded?: Price;
512
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
513
- failedRefundAmount?: Price;
514
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
515
- pending?: boolean;
516
- /** Breakdown of refunded items. Available only after refund is complete. */
517
- breakdown?: RefundItemsBreakdown;
518
- }
519
- export interface RefundItemsBreakdown {
520
- /**
521
- * Refunded line items and the amount refunded for each.
522
- * @maxSize 300
523
- */
524
- lineItems?: LineItemRefundSummary[];
525
- }
526
- export interface LineItemRefundSummary {
527
- /**
528
- * ID of the refunded line item.
529
- * @format GUID
530
- */
531
- lineItemId?: string;
532
- /** Total refunded amount for the line item. */
533
- totalRefundedAmount?: Price;
534
- }
535
- export interface SnapshotMessage {
536
- _id?: string;
537
- opType?: number;
538
- }
539
- export interface IndexingMessage {
540
- _id?: string;
541
- opType?: number;
542
- requiredVersions?: string[];
543
- }
544
- export interface DiffmatokyPayload {
545
- left?: string;
546
- right?: string;
547
- compareChannel?: string;
548
- entityId?: string;
549
- errorInformation?: ErrorInformation;
550
- tags?: string[];
551
- }
552
- export interface ErrorInformation {
553
- stackTrace?: string;
554
- }
555
- export interface OrderRefunded {
556
- /**
557
- * Refund ID.
558
- * @readonly
559
- */
560
- refundId?: string;
561
- /**
562
- * Refunded order data.
563
- * @readonly
564
- */
565
- order?: Order;
566
- }
567
- export interface Order {
568
- /**
569
- * Order ID (auto-generated upon order creation).
570
- * @format GUID
571
- * @readonly
572
- */
573
- _id?: string | null;
574
- /**
575
- * Order number displayed in the owner's store (auto-generated).
576
- * @readonly
577
- */
578
- number?: number;
579
- /**
580
- * Order creation date and time.
581
- * @readonly
582
- */
583
- dateCreated?: Date | null;
584
- /** Buyer information. */
585
- buyerInfo?: BuyerInfo;
586
- /**
587
- * 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.
588
- * @format CURRENCY
589
- */
590
- currency?: string | null;
591
- /** Weight unit used in this store. */
592
- weightUnit?: WeightUnitWithLiterals;
593
- /** Totals for order's line items. */
594
- totals?: Totals;
595
- /** Billing information. */
596
- billingInfo?: BillingInfo;
597
- /** Shipping information. */
598
- shippingInfo?: ShippingInfo;
599
- /**
600
- * A note added by the buyer.
601
- * @maxLength 1000
602
- */
603
- buyerNote?: string | null;
604
- /**
605
- * Deprecated.
606
- * @readonly
607
- * @deprecated
608
- */
609
- read?: boolean;
610
- /**
611
- * Whether or not the order was archived.
612
- * @readonly
613
- */
614
- archived?: boolean;
615
- /** Current status of the payment. */
616
- paymentStatus?: PaymentStatusWithLiterals;
617
- /**
618
- * Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).
619
- * @readonly
620
- */
621
- fulfillmentStatus?: FulfillmentStatusWithLiterals;
622
- /**
623
- * Line items ordered.
624
- * @minSize 1
625
- * @maxSize 300
626
- */
627
- lineItems?: LineItem[];
628
- /**
629
- * Log of updates related to the order.
630
- * @readonly
631
- */
632
- activities?: Activity[];
633
- /** Invoice information. */
634
- invoiceInfo?: V2InvoiceInfo;
635
- /**
636
- * Order fulfillment information.
637
- * @readonly
638
- */
639
- fulfillments?: Fulfillment[];
640
- /** Discount information. */
641
- discount?: Discount;
642
- /** Custom field information. */
643
- customField?: CustomField;
644
- /**
645
- * Shopping cart ID.
646
- * @format GUID
647
- */
648
- cartId?: string | null;
649
- /**
650
- * Language for communication with the buyer. Defaults to the site language.
651
- * For a site that supports multiple languages, this is the language the buyer selected.
652
- * @maxLength 10
653
- */
654
- buyerLanguage?: string | null;
655
- /** Information about the sales channel that submitted this order. */
656
- channelInfo?: ChannelInfo;
657
- /**
658
- * Identity of the order's initiator.
659
- * @readonly
660
- */
661
- enteredBy?: EnteredBy;
662
- /**
663
- * Date and time of latest update.
664
- * @readonly
665
- */
666
- lastUpdated?: Date | null;
667
- /** Subscription information. */
668
- subscriptionInfo?: SubscriptionInfo;
669
- /**
670
- * Order’s unique numeric ID.
671
- * Primarily used for sorting and filtering when crawling all orders.
672
- * @readonly
673
- */
674
- numericId?: string;
675
- /**
676
- * Refund information.
677
- * @readonly
678
- */
679
- refunds?: V2Refund[];
680
- }
681
- /** Buyer Info */
682
- export interface BuyerInfo {
683
- /**
684
- * Wix customer ID
685
- * @format GUID
686
- */
687
- _id?: string | null;
688
- /**
689
- * Deprecated (use identityType instead)
690
- * @readonly
691
- * @deprecated
692
- */
693
- type?: IdentityTypeWithLiterals;
694
- /** Customer type */
695
- identityType?: IdentityTypeWithLiterals;
696
- /**
697
- * Customer's first name
698
- * @readonly
699
- */
700
- firstName?: string;
701
- /**
702
- * Customer's last name
703
- * @readonly
704
- */
705
- lastName?: string;
706
- /**
707
- * Customer's phone number
708
- * @readonly
709
- */
710
- phone?: string | null;
711
- /**
712
- * Customer's email address
713
- * @readonly
714
- */
715
- email?: string;
716
- }
717
- export declare enum IdentityType {
718
- UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
719
- /** Site member */
720
- MEMBER = "MEMBER",
721
- /** Contact */
722
- CONTACT = "CONTACT"
723
- }
724
- /** @enumType */
725
- export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
726
- export declare enum WeightUnit {
727
- /** Weight unit can't be classified due to an error. */
728
- UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
729
- /** Kilograms. */
730
- KG = "KG",
731
- /** Pounds. */
732
- LB = "LB"
733
- }
734
- /** @enumType */
735
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
736
- export interface Totals {
737
- /**
738
- * Subtotal of all the line items, before tax.
739
- * @format DECIMAL_VALUE
740
- */
741
- subtotal?: string;
742
- /**
743
- * Total shipping price, before tax.
744
- * @format DECIMAL_VALUE
745
- */
746
- shipping?: string | null;
747
- /**
748
- * Total tax.
749
- * @format DECIMAL_VALUE
750
- */
751
- tax?: string | null;
752
- /**
753
- * Total calculated discount value.
754
- * @format DECIMAL_VALUE
755
- */
756
- discount?: string | null;
757
- /**
758
- * Total price charged.
759
- * @format DECIMAL_VALUE
760
- */
761
- total?: string;
762
- /**
763
- * Total items weight.
764
- * @readonly
765
- */
766
- weight?: string;
767
- /**
768
- * Total number of line items.
769
- * @readonly
770
- */
771
- quantity?: number;
772
- /**
773
- * Total refund.
774
- * @format DECIMAL_VALUE
775
- * @readonly
776
- */
777
- refund?: string | null;
778
- /**
779
- * Total calculated gift card value.
780
- * @format DECIMAL_VALUE
781
- */
782
- giftCard?: string | null;
783
- }
784
- export interface BillingInfo {
785
- /**
786
- * Payment method used for this order
787
- * @maxLength 50
788
- */
789
- paymentMethod?: string | null;
790
- /**
791
- * Deprecated (use paymentProviderTransactionId instead)
792
- * @readonly
793
- * @deprecated
794
- */
795
- externalTransactionId?: string | null;
796
- /**
797
- * Transaction ID from payment provider (e.g., PayPal, Square, Stripe) transaction ID
798
- * @maxLength 100
799
- */
800
- paymentProviderTransactionId?: string | null;
801
- /**
802
- * Transaction ID from payment gateway (e.g., Wix Payments)
803
- * @maxLength 100
804
- */
805
- paymentGatewayTransactionId?: string | null;
806
- /** Full billing address */
807
- address?: Address;
808
- /**
809
- * Payment date
810
- * @readonly
811
- */
812
- paidDate?: Date | null;
813
- /** Whether order can be refunded by payment provider (manually or automatic) */
814
- refundableByPaymentProvider?: boolean | null;
815
- }
816
- export interface Address extends AddressAddressLine1OptionsOneOf {
817
- /**
818
- * Address line 1 (free text)
819
- * @maxLength 1000
820
- */
821
- addressLine1?: string;
822
- /** Address line 1 (street) */
823
- street?: Street;
824
- /** Addressee name */
825
- fullName?: FullName;
826
- /**
827
- * Country code (2 letters)
828
- * @format COUNTRY
829
- */
830
- country?: string | null;
831
- /**
832
- * State or district
833
- * @maxLength 50
834
- */
835
- subdivision?: string | null;
836
- /**
837
- * City name
838
- * @maxLength 150
839
- */
840
- city?: string | null;
841
- /**
842
- * ZIP/postal code
843
- * @maxLength 200
844
- */
845
- zipCode?: string | null;
846
- /**
847
- * Phone number
848
- * @maxLength 200
849
- */
850
- phone?: string | null;
851
- /**
852
- * Company name
853
- * @maxLength 500
854
- */
855
- company?: string | null;
856
- /**
857
- * Email address
858
- * @maxLength 500
859
- */
860
- email?: string | null;
861
- /**
862
- * address line
863
- * @maxLength 250
864
- */
865
- addressLine2?: string | null;
866
- /** Tax information (for Brazil only) */
867
- vatId?: VatId;
868
- }
869
- /** @oneof */
870
- export interface AddressAddressLine1OptionsOneOf {
871
- /**
872
- * Address line 1 (free text)
873
- * @maxLength 1000
874
- */
875
- addressLine1?: string;
876
- /** Address line 1 (street) */
877
- street?: Street;
878
- }
879
- export interface FullName {
880
- /**
881
- * Customer's first name
882
- * @maxLength 1000
883
- */
884
- firstName?: string;
885
- /**
886
- * Customer's last name
887
- * @maxLength 1000
888
- */
889
- lastName?: string;
890
- }
891
- export interface Street {
892
- /**
893
- * Street number
894
- * @maxLength 500
895
- */
896
- number?: string;
897
- /**
898
- * Street name
899
- * @maxLength 1000
900
- */
901
- name?: string;
902
- }
903
- export interface VatId {
904
- /**
905
- * Customer's tax ID.
906
- * @maxLength 50
907
- */
908
- number?: string;
909
- /**
910
- * Tax type.
911
- * + `CPF`: For individual tax payers.
912
- * + `CNPJ`: For corporations.
913
- */
914
- type?: VatTypeWithLiterals;
915
- }
916
- /** Brazilian tax info types */
917
- export declare enum VatType {
918
- /** When the tax info type can't be classified, due to an error */
919
- UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
920
- /** CPF - for individual tax payers */
921
- CPF = "CPF",
922
- /** CNPJ - for corporations */
923
- CNPJ = "CNPJ"
924
- }
925
- /** @enumType */
926
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
927
- export interface ShippingInfo extends ShippingInfoDetailsOneOf {
928
- /** Shipment details (when this object describes shipment). */
929
- shipmentDetails?: ShipmentDetails;
930
- /** Pickup details (when this object describes pickup). */
931
- pickupDetails?: PickupDetails;
932
- /**
933
- * Shipping option name.
934
- * @maxLength 1000
935
- */
936
- deliveryOption?: string;
937
- /**
938
- * Shipping option delivery time.
939
- * @maxLength 500
940
- */
941
- estimatedDeliveryTime?: string | null;
942
- /**
943
- * Deprecated - Latest expected delivery date.
944
- * @deprecated
945
- */
946
- deliverByDate?: Date | null;
947
- /**
948
- * Shipping region.
949
- * @maxLength 100
950
- */
951
- shippingRegion?: string | null;
952
- /**
953
- * Unique code of provided shipping option. For example, `"usps_std_overnight"`.
954
- * @maxLength 100
955
- * @readonly
956
- */
957
- code?: string | null;
958
- }
959
- /** @oneof */
960
- export interface ShippingInfoDetailsOneOf {
961
- /** Shipment details (when this object describes shipment). */
962
- shipmentDetails?: ShipmentDetails;
963
- /** Pickup details (when this object describes pickup). */
964
- pickupDetails?: PickupDetails;
965
- }
966
- export interface ShipmentDetails {
967
- /** Shipping destination address. */
968
- address?: Address;
969
- /**
970
- * Deprecated (use fulfillments instead).
971
- * @readonly
972
- * @deprecated
973
- */
974
- trackingInfo?: TrackingInfo;
975
- /**
976
- * Discount applied for shipping.
977
- * @format DECIMAL_VALUE
978
- */
979
- discount?: string | null;
980
- /**
981
- * Tax applied for shipping.
982
- * @format DECIMAL_VALUE
983
- */
984
- tax?: string | null;
985
- /** Price data. */
986
- priceData?: ShippingPriceData;
987
- }
988
- export interface TrackingInfo {
989
- /**
990
- * Tracking number
991
- * @maxLength 100
992
- * @readonly
993
- */
994
- trackingNumber?: string | null;
995
- /**
996
- * Shipping provider
997
- * @maxLength 100
998
- * @readonly
999
- */
1000
- shippingProvider?: string | null;
1001
- /**
1002
- * Tracking link
1003
- * @format WEB_URL
1004
- * @readonly
1005
- */
1006
- trackingLink?: string | null;
1007
- }
1008
- export interface ShippingPriceData {
1009
- /** Whether tax is included in the price. */
1010
- taxIncludedInPrice?: boolean;
1011
- /**
1012
- * Shipping price.
1013
- * @format DECIMAL_VALUE
1014
- */
1015
- price?: string | null;
1016
- }
1017
- export interface PickupDetails {
1018
- /** Pickup address. */
1019
- pickupAddress?: PickupAddress;
1020
- /**
1021
- * Deprecated (use billingInfo instead).
1022
- * @readonly
1023
- * @deprecated
1024
- */
1025
- buyerDetails?: BuyerDetails;
1026
- /**
1027
- * Store owner's pickup instructions.
1028
- * @maxLength 1000
1029
- */
1030
- pickupInstructions?: string | null;
1031
- }
1032
- export interface PickupAddress {
1033
- /** Country code (3 letters) */
1034
- country?: string;
1035
- /**
1036
- * State/District
1037
- * @maxLength 50
1038
- */
1039
- subdivision?: string | null;
1040
- /**
1041
- * Address
1042
- * @maxLength 250
1043
- */
1044
- addressLine1?: string;
1045
- /**
1046
- * City
1047
- * @maxLength 100
1048
- */
1049
- city?: string;
1050
- /**
1051
- * ZIP/postal code
1052
- * @maxLength 50
1053
- */
1054
- zipCode?: string;
1055
- }
1056
- export interface BuyerDetails {
1057
- /** Addressee name */
1058
- fullName?: FullName;
1059
- /**
1060
- * Email address
1061
- * @maxLength 100
1062
- * @format EMAIL
1063
- */
1064
- email?: string;
1065
- /**
1066
- * Phone number
1067
- * @maxLength 30
1068
- * @format PHONE
1069
- */
1070
- phone?: string;
1071
- }
1072
- /** This might be extended in the future with pending orders statuses */
1073
- export declare enum PaymentStatus {
1074
- /** Payment status can't be classified, due to an error */
1075
- UNSPECIFIED_PAYMENT_STATUS = "UNSPECIFIED_PAYMENT_STATUS",
1076
- /** Order is pending response from the payment provider */
1077
- PENDING = "PENDING",
1078
- /** Order is marked as not paid, and can be marked as paid later on. This is relevant for POS and offline orders */
1079
- NOT_PAID = "NOT_PAID",
1080
- /** The order is marked as paid */
1081
- PAID = "PAID",
1082
- /** Order was refunded, refund amount less than order total price */
1083
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
1084
- /** Full order total price was refunded */
1085
- FULLY_REFUNDED = "FULLY_REFUNDED",
1086
- /** At least one payment was received and approved, covering less than total price amount */
1087
- PARTIALLY_PAID = "PARTIALLY_PAID"
1088
- }
1089
- /** @enumType */
1090
- export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED_PAYMENT_STATUS' | 'PENDING' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PARTIALLY_PAID';
1091
- export declare enum FulfillmentStatus {
1092
- /** None of the order items are fulfilled */
1093
- NOT_FULFILLED = "NOT_FULFILLED",
1094
- /**
1095
- * All of the order items are fulfilled
1096
- * Orders without shipping info are fulfilled automatically
1097
- */
1098
- FULFILLED = "FULFILLED",
1099
- /** Order is canceled */
1100
- CANCELED = "CANCELED",
1101
- /** Some, but not all of the order items are fulfilled */
1102
- PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
1103
- }
1104
- /** @enumType */
1105
- export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'CANCELED' | 'PARTIALLY_FULFILLED';
1106
- export interface LineItem {
1107
- /**
1108
- * Line item ID (auto-generated, stable within this order only)
1109
- * @readonly
1110
- */
1111
- index?: number | null;
1112
- /**
1113
- * Line item quantity
1114
- * @min 1
1115
- * @max 100000
1116
- */
1117
- quantity?: number;
1118
- /**
1119
- * Deprecated (use priceData instead)
1120
- * @format DECIMAL_VALUE
1121
- * @readonly
1122
- * @deprecated
1123
- */
1124
- price?: string | null;
1125
- /**
1126
- * Line item name
1127
- * @minLength 1
1128
- * @maxLength 200
1129
- */
1130
- name?: string | null;
1131
- /** Product name, translated into the customer's language */
1132
- translatedName?: string | null;
1133
- /**
1134
- * Line item product ID (optional for POS orders)
1135
- * @minLength 1
1136
- */
1137
- productId?: string | null;
1138
- /**
1139
- * Deprecated (use priceData instead)
1140
- * @format DECIMAL_VALUE
1141
- * @readonly
1142
- * @deprecated
1143
- */
1144
- totalPrice?: string | null;
1145
- /** Line item type (may be extended) */
1146
- lineItemType?: LineItemTypeWithLiterals;
1147
- /**
1148
- * Line item options ordered
1149
- * @maxSize 500
1150
- */
1151
- options?: OptionSelection[];
1152
- /**
1153
- * Line item custom text field entry
1154
- * @maxSize 500
1155
- */
1156
- customTextFields?: CustomTextFieldSelection[];
1157
- /**
1158
- * Line item weight
1159
- * @format DECIMAL_VALUE
1160
- */
1161
- weight?: string | null;
1162
- /** Primary media for preview of the line item */
1163
- mediaItem?: MediaItem;
1164
- /**
1165
- * Line item SKU
1166
- * @maxLength 40
1167
- */
1168
- sku?: string | null;
1169
- /**
1170
- * Line item notes
1171
- * @maxLength 1000
1172
- */
1173
- notes?: string | null;
1174
- /** Line item variantId (from Stores Catalog) */
1175
- variantId?: string | null;
1176
- /**
1177
- * Line item fulfillerId from stores fulfillers. No value equals self fulfilled
1178
- * @format GUID
1179
- */
1180
- fulfillerId?: string | null;
1181
- /**
1182
- * Discount applied for this line item
1183
- * @format DECIMAL_VALUE
1184
- */
1185
- discount?: string | null;
1186
- /**
1187
- * Tax applied for this line item
1188
- * @format DECIMAL_VALUE
1189
- */
1190
- tax?: string | null;
1191
- /**
1192
- * Deprecated (use priceData instead)
1193
- * @readonly
1194
- * @deprecated
1195
- */
1196
- taxIncludedInPrice?: boolean;
1197
- /**
1198
- * Tax group ID
1199
- * @format GUID
1200
- */
1201
- taxGroupId?: string | null;
1202
- /** Price data */
1203
- priceData?: LineItemPriceData;
1204
- }
1205
- export declare enum LineItemType {
1206
- /** Line item type can't be classified, due to an error */
1207
- UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
1208
- /** Physical item type */
1209
- PHYSICAL = "PHYSICAL",
1210
- /** Digital item type */
1211
- DIGITAL = "DIGITAL",
1212
- /** Custom item price */
1213
- CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
1214
- }
1215
- /** @enumType */
1216
- export type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
1217
- export interface OptionSelection {
1218
- /**
1219
- * Option name
1220
- * @maxLength 1000
1221
- */
1222
- option?: string;
1223
- /**
1224
- * Selected choice for this option
1225
- * @maxLength 16000
1226
- */
1227
- selection?: string;
1228
- }
1229
- export interface CustomTextFieldSelection {
1230
- /**
1231
- * Custom text field name
1232
- * @maxLength 1000
1233
- */
1234
- title?: string;
1235
- /**
1236
- * Custom text field value
1237
- * @maxLength 16000
1238
- */
1239
- value?: string;
1240
- }
1241
- export interface MediaItem {
1242
- /**
1243
- * Media type
1244
- * @readonly
1245
- */
1246
- mediaType?: MediaItemTypeWithLiterals;
1247
- /**
1248
- * Media URL
1249
- * @format WEB_URL
1250
- * @readonly
1251
- */
1252
- url?: string;
1253
- /**
1254
- * Media item width
1255
- * @readonly
1256
- */
1257
- width?: number;
1258
- /**
1259
- * Media item height
1260
- * @readonly
1261
- */
1262
- height?: number;
1263
- /**
1264
- * Deprecated
1265
- * @deprecated
1266
- */
1267
- mediaId?: string | null;
1268
- /** Media ID (for media items previously saved in Wix Media) */
1269
- _id?: string | null;
1270
- /** Media external URL */
1271
- externalImageUrl?: string | null;
1272
- /**
1273
- * Alternative text for presentation when media cannot be displayed
1274
- * @maxLength 256
1275
- */
1276
- altText?: string | null;
1277
- }
1278
- export declare enum MediaItemType {
1279
- /** Media item type can't be classified, due to an error */
1280
- UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
1281
- /** Image item type */
1282
- IMAGE = "IMAGE"
1283
- }
1284
- /** @enumType */
1285
- export type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
1286
- export interface LineItemPriceData {
1287
- /** Whether tax is included in the price set for this line item */
1288
- taxIncludedInPrice?: boolean;
1289
- /**
1290
- * Line item price
1291
- * @format DECIMAL_VALUE
1292
- */
1293
- price?: string;
1294
- /**
1295
- * Total price charged to the customer (per line item) after computation of quantity and discount
1296
- * @format DECIMAL_VALUE
1297
- * @readonly
1298
- */
1299
- totalPrice?: string | null;
1300
- }
1301
- export interface DigitalFile {
1302
- /**
1303
- * id of the secure file in media
1304
- * @minLength 1
1305
- * @maxLength 100
1306
- */
1307
- fileId?: string;
1308
- }
1309
- export interface Activity {
1310
- /**
1311
- * Activity item type
1312
- * @readonly
1313
- */
1314
- type?: ActivityTypeWithLiterals;
1315
- /**
1316
- * Activity item author
1317
- * @maxLength 50
1318
- * @readonly
1319
- */
1320
- author?: string | null;
1321
- /**
1322
- * Comment added to activity item
1323
- * @maxLength 1000
1324
- * @readonly
1325
- */
1326
- message?: string | null;
1327
- /**
1328
- * Activity item timestamp
1329
- * @readonly
1330
- */
1331
- timestamp?: Date | null;
1332
- }
1333
- export declare enum ActivityType {
1334
- /** Activity item type can't be classified, due to an error */
1335
- UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE = "UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE",
1336
- /** Store owner added a comment */
1337
- MERCHANT_COMMENT = "MERCHANT_COMMENT",
1338
- /** Order placed */
1339
- ORDER_PLACED = "ORDER_PLACED",
1340
- /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
1341
- ORDER_PAID = "ORDER_PAID",
1342
- /** Order shipping status set as fulfilled */
1343
- ORDER_FULFILLED = "ORDER_FULFILLED",
1344
- /** Order shipping status set as not fulfilled */
1345
- ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
1346
- /** A download link was sent (relevant for orders with digital line items) */
1347
- DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
1348
- /** An email notification for pickup was sent */
1349
- PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
1350
- /** Shipping tracking number was set */
1351
- TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
1352
- /** Shipping tracking number was edited */
1353
- TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
1354
- /** Shipping tracking link was set */
1355
- TRACKING_LINK_WAS_SET = "TRACKING_LINK_WAS_SET",
1356
- /** An email confirmation of order shipment was sent */
1357
- SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
1358
- /** Invoice was set in the order */
1359
- INVOICE_WAS_SET = "INVOICE_WAS_SET",
1360
- /** Invoice was removed from the order */
1361
- INVOICE_WAS_REMOVED = "INVOICE_WAS_REMOVED",
1362
- /** Invoice was sent to customer via email */
1363
- INVOICE_WAS_SENT = "INVOICE_WAS_SENT",
1364
- /** Email was sent to fulfiller */
1365
- FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
1366
- /** Shipping address was updated */
1367
- SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
1368
- /** Order email was updated */
1369
- EMAIL_EDITED = "EMAIL_EDITED",
1370
- /** Order partially paid. During the checkout for orders with deposit items. */
1371
- ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID"
1372
- }
1373
- /** @enumType */
1374
- export type ActivityTypeWithLiterals = ActivityType | 'UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE' | 'MERCHANT_COMMENT' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'DOWNLOAD_LINK_SENT' | 'PICKUP_READY_EMAIL_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_WAS_SET' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_WAS_SET' | 'INVOICE_WAS_REMOVED' | 'INVOICE_WAS_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'ORDER_PARTIALLY_PAID';
1375
- export interface V2InvoiceInfo {
1376
- /**
1377
- * Invoice ID
1378
- * @maxLength 100
1379
- */
1380
- _id?: string;
1381
- /** Invoice source */
1382
- source?: InvoiceSourceWithLiterals;
1383
- }
1384
- export declare enum InvoiceSource {
1385
- /** Invoice source can't be classified, due to an error */
1386
- UNSPECIFIED_INVOICE_SOURCE = "UNSPECIFIED_INVOICE_SOURCE",
1387
- /** Invoice created using the Invoices API */
1388
- WIX = "WIX"
1389
- }
1390
- /** @enumType */
1391
- export type InvoiceSourceWithLiterals = InvoiceSource | 'UNSPECIFIED_INVOICE_SOURCE' | 'WIX';
1392
- export interface Fulfillment {
1393
- /**
1394
- * Fulfillment ID (auto generated upon fulfillment creation).
1395
- * @format GUID
1396
- * @readonly
1397
- */
1398
- _id?: string | null;
1399
- /**
1400
- * Fulfillment creation date and time.
1401
- * @readonly
1402
- */
1403
- dateCreated?: Date | null;
1404
- /**
1405
- * Information about the line items in the fulfilled order.
1406
- * @minSize 1
1407
- * @maxSize 300
1408
- */
1409
- lineItems?: FulfillmentLineItem[];
1410
- /** Tracking information. */
1411
- trackingInfo?: FulfillmentTrackingInfo;
1412
- }
1413
- export interface FulfillmentLineItem {
1414
- /**
1415
- * Line item ID (mirrors the line item index of the order).
1416
- * @min 1
1417
- * @max 200
1418
- */
1419
- index?: number;
1420
- /**
1421
- * Line item quantity.
1422
- * On creation, if this parameter isn't passed, the new fulfillment will automatically include all items of this line item that have not already been linked to a fulfillment.
1423
- * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error will be returned.
1424
- * This property will always have a value when returned.
1425
- * @min 1
1426
- * @max 100000
1427
- */
1428
- quantity?: number | null;
1429
- }
1430
- export interface FulfillmentTrackingInfo {
1431
- /**
1432
- * Tracking number.
1433
- * @minLength 1
1434
- * @maxLength 100
1435
- */
1436
- trackingNumber?: string;
1437
- /**
1438
- * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:
1439
- * * `fedex`
1440
- * * `ups`
1441
- * * `usps`
1442
- * * `dhl`
1443
- * * `canadaPost`
1444
- * @minLength 1
1445
- * @maxLength 100
1446
- */
1447
- shippingProvider?: string;
1448
- /**
1449
- * Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation.
1450
- * @minLength 1
1451
- * @maxLength 2048
1452
- * @format WEB_URL
1453
- */
1454
- trackingLink?: string | null;
1455
- }
1456
- export interface Discount {
1457
- /**
1458
- * Deprecated (use Totals.discount instead)
1459
- * @readonly
1460
- * @deprecated
1461
- */
1462
- value?: string;
1463
- /** Applied coupon */
1464
- appliedCoupon?: AppliedCoupon;
1465
- }
1466
- export interface AppliedCoupon {
1467
- /**
1468
- * Coupon ID
1469
- * @minLength 1
1470
- * @maxLength 100
1471
- */
1472
- couponId?: string;
1473
- /**
1474
- * Coupon name
1475
- * @maxLength 100
1476
- */
1477
- name?: string;
1478
- /**
1479
- * Coupon code
1480
- * @maxLength 100
1481
- */
1482
- code?: string;
1483
- }
1484
- /** Custom field */
1485
- export interface CustomField {
1486
- /**
1487
- * Free text that the customer entered in the custom field during the checkout process
1488
- * @maxLength 2000
1489
- */
1490
- value?: string;
1491
- /**
1492
- * Title for the custom field
1493
- * @maxLength 1000
1494
- */
1495
- title?: string;
1496
- /**
1497
- * The title translated according to the buyer language
1498
- * @maxLength 1000
1499
- */
1500
- translatedTitle?: string;
1501
- }
1502
- export interface ChannelInfo {
1503
- /** Sales channel that submitted the order */
1504
- type?: ChannelTypeWithLiterals;
1505
- /**
1506
- * Reference to an order ID from an external system, as defined in channelInfo (e.g., eBay or Amazon)
1507
- * @maxLength 100
1508
- */
1509
- externalOrderId?: string | null;
1510
- /**
1511
- * URL to the order in the external system, as defined in channelInfo (e.g., eBay or Amazon)
1512
- * @maxLength 300
1513
- */
1514
- externalOrderUrl?: string | null;
1515
- }
1516
- export declare enum ChannelType {
1517
- UNSPECIFIED = "UNSPECIFIED",
1518
- WEB = "WEB",
1519
- POS = "POS",
1520
- EBAY = "EBAY",
1521
- AMAZON = "AMAZON",
1522
- OTHER_PLATFORM = "OTHER_PLATFORM",
1523
- WIX_APP_STORE = "WIX_APP_STORE",
1524
- WIX_INVOICES = "WIX_INVOICES",
1525
- BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
1526
- WISH = "WISH",
1527
- CLASS_PASS = "CLASS_PASS",
1528
- GLOBAL_E = "GLOBAL_E",
1529
- FACEBOOK = "FACEBOOK",
1530
- ETSY = "ETSY",
1531
- TIKTOK = "TIKTOK",
1532
- FAIRE_COM = "FAIRE_COM"
1533
- }
1534
- /** @enumType */
1535
- export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
1536
- export interface EnteredBy {
1537
- /** @format GUID */
1538
- _id?: string;
1539
- identityType?: EnteredByIdentityTypeWithLiterals;
1540
- }
1541
- export declare enum EnteredByIdentityType {
1542
- USER = "USER",
1543
- MEMBER = "MEMBER",
1544
- CONTACT = "CONTACT",
1545
- APP = "APP"
1546
- }
1547
- /** @enumType */
1548
- export type EnteredByIdentityTypeWithLiterals = EnteredByIdentityType | 'USER' | 'MEMBER' | 'CONTACT' | 'APP';
1549
- export interface SubscriptionInfo {
1550
- /**
1551
- * Subscription ID.
1552
- * @format GUID
1553
- */
1554
- _id?: string | null;
1555
- /**
1556
- * Current cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value will be `3`.
1557
- * @min 1
1558
- */
1559
- cycleNumber?: number;
1560
- /** Subscription settings. */
1561
- subscriptionSettings?: SubscriptionSettings;
1562
- /** Subscription options info. */
1563
- subscriptionOptionInfo?: SubscriptionOptionInfo;
1564
- }
1565
- export interface SubscriptionSettings {
1566
- /** Frequency of recurring payment. */
1567
- frequency?: SubscriptionFrequencyWithLiterals;
1568
- /** Whether subscription is renewed automatically at the end of each period. */
1569
- autoRenewal?: boolean;
1570
- /**
1571
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1572
- * @min 2
1573
- * @max 999
1574
- */
1575
- billingCycles?: number | null;
1576
- }
1577
- /** Frequency unit of recurring payment */
1578
- export declare enum SubscriptionFrequency {
1579
- UNDEFINED = "UNDEFINED",
1580
- DAY = "DAY",
1581
- WEEK = "WEEK",
1582
- MONTH = "MONTH",
1583
- YEAR = "YEAR"
1584
- }
1585
- /** @enumType */
1586
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1587
- export interface SubscriptionOptionInfo {
1588
- /**
1589
- * Subscription option title.
1590
- * @minLength 1
1591
- * @maxLength 150
1592
- */
1593
- title?: string;
1594
- /**
1595
- * Subscription option description.
1596
- * @maxLength 500
1597
- */
1598
- description?: string | null;
1599
- }
1600
- export interface V2Refund {
1601
- /** Refund created timestamp. */
1602
- dateCreated?: Date | null;
1603
- /**
1604
- * Refund amount.
1605
- * @format DECIMAL_VALUE
1606
- */
1607
- amount?: string;
1608
- /** Reason for refund, given by user (optional). */
1609
- reason?: string | null;
1610
- /** Payment provider transaction ID. Used to find refund transaction info on the payment provider's side. */
1611
- paymentProviderTransactionId?: string | null;
1612
- /**
1613
- * Refund ID.
1614
- * @format GUID
1615
- */
1616
- _id?: string;
1617
- /** Whether refund was made externally (on the payment provider's side). */
1618
- externalRefund?: boolean;
1619
- }
1620
- export interface GiftCard {
1621
- /**
1622
- * @minLength 1
1623
- * @maxLength 100
1624
- */
1625
- transactionId?: string;
1626
- /**
1627
- * giftcard internal ID
1628
- * @maxLength 36
1629
- * @deprecated giftcard internal ID
1630
- * @targetRemovalDate 2024-12-31
1631
- */
1632
- _id?: string;
1633
- /**
1634
- * giftcard provider appid
1635
- * @format GUID
1636
- */
1637
- providerId?: string;
1638
- /**
1639
- * giftcard amount
1640
- * @format DECIMAL_VALUE
1641
- */
1642
- amount?: string;
1643
- }
1644
- /** Triggered when a payment is updated. */
1645
- export interface PaymentsUpdated {
1646
- /** Updated order transactions. */
1647
- orderTransactions?: OrderTransactions;
1648
- /**
1649
- * List of IDs of the updated payments.
1650
- * @maxSize 100
1651
- */
1652
- paymentIds?: string[];
1653
- /**
1654
- * List of IDs of the updated refunds.
1655
- * @maxSize 300
1656
- */
1657
- refundIds?: string[];
1658
- }
1659
- /** Triggered when a payment is updated. */
1660
- export interface PaymentDetailsUpdated {
1661
- /** Updated order transactions. */
1662
- orderTransactions?: OrderTransactions;
1663
- /**
1664
- * List of IDs of the updated payments.
1665
- * @format GUID
1666
- * @maxSize 100
1667
- */
1668
- paymentIds?: string[];
1669
- /**
1670
- * List of IDs of the updated refunds.
1671
- * @format GUID
1672
- * @maxSize 300
1673
- */
1674
- refundIds?: string[];
1675
- }
1676
- /** Triggered when a refund is created. */
1677
- export interface RefundCreated {
1678
- /** Updated order transactions. */
1679
- orderTransactions?: OrderTransactions;
1680
- /** ID of the created refund. */
1681
- refundId?: string;
1682
- /** Inventory restock details as part of this refund.. */
1683
- restockInfo?: RestockInfo;
1684
- /** Whether to send a refund confirmation email to the customer. */
1685
- sendOrderRefundedEmail?: boolean;
1686
- /** Custom message added to the refund confirmation email. */
1687
- customMessage?: string | null;
1688
- /** Refunded line items and quantities that are part of the created refund. */
1689
- refundItems?: RefundItem[];
1690
- }
1691
- export interface RestockInfo {
1692
- /** Restock type. */
1693
- type?: RestockTypeWithLiterals;
1694
- /**
1695
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
1696
- * @maxSize 300
1697
- */
1698
- items?: RestockItem[];
1699
- }
1700
- export declare enum RestockType {
1701
- NO_ITEMS = "NO_ITEMS",
1702
- ALL_ITEMS = "ALL_ITEMS",
1703
- SOME_ITEMS = "SOME_ITEMS"
1704
- }
1705
- /** @enumType */
1706
- export type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
1707
- export interface RestockItem {
1708
- /**
1709
- * ID of the line item being restocked.
1710
- * @format GUID
1711
- */
1712
- lineItemId?: string;
1713
- /**
1714
- * Line item quantity being restocked.
1715
- * @min 1
1716
- * @max 100000
1717
- */
1718
- quantity?: number;
1719
- }
1720
- export interface RefundCompleted {
1721
- /**
1722
- * Order ID.
1723
- * @format GUID
1724
- */
1725
- orderId?: string;
1726
- /** Completed refund. */
1727
- refund?: Refund;
1728
- /** Refund side effects. */
1729
- sideEffects?: RefundSideEffects;
1730
- /** Order transactions after refund is completed. */
1731
- orderTransactions?: OrderTransactions;
1732
- }
1733
- export interface RefundSideEffects {
1734
- /** Inventory restock details as part of this refund. */
1735
- restockInfo?: RestockInfo;
1736
- /** Whether to send a refund confirmation email to the customer. */
1737
- sendOrderRefundedEmail?: boolean;
1738
- /**
1739
- * Custom message added to the refund confirmation email.
1740
- * @minLength 1
1741
- * @maxLength 1000
1742
- */
1743
- customMessage?: string | null;
1744
- }
1745
- export interface ListTransactionsForSingleOrderRequest {
1746
- /**
1747
- * Order ID.
1748
- * @minLength 1
1749
- * @maxLength 100
1750
- */
1751
- orderId: string;
1752
- }
1753
- export interface ListTransactionsForSingleOrderResponse {
1754
- /** Order ID and its associated transactions. */
1755
- orderTransactions?: OrderTransactions;
1756
- }
1757
- export interface ListTransactionsForMultipleOrdersRequest {
1758
- /**
1759
- * Order IDs for which to retrieve transactions.
1760
- * @minSize 1
1761
- * @maxSize 100
1762
- * @minLength 1
1763
- * @maxLength 100
1764
- */
1765
- orderIds: string[];
1766
- }
1767
- export interface ListTransactionsForMultipleOrdersResponse {
1768
- /** List of order IDs and their associated transactions. */
1769
- orderTransactions?: OrderTransactions[];
1770
- }
1771
- export interface AddPaymentsRequest {
1772
- /**
1773
- * Order ID.
1774
- * @format GUID
1775
- */
1776
- orderId: string;
1777
- /**
1778
- * Payments to be added to order.
1779
- * @minSize 1
1780
- * @maxSize 50
1781
- */
1782
- payments: Payment[];
1783
- }
1784
- export interface AddPaymentsResponse {
1785
- /** Order ID and its associated transactions. */
1786
- orderTransactions?: OrderTransactions;
1787
- /** IDs of added order payments. */
1788
- paymentsIds?: string[];
1789
- }
1790
- export interface AddRefundRequest {
1791
- /**
1792
- * Order ID this refunds related to
1793
- * @minLength 1
1794
- * @maxLength 100
1795
- */
1796
- orderId?: string;
1797
- /** Refund with refund transactions to be added to order. */
1798
- refund?: Refund;
1799
- /** Side effect details related to refund */
1800
- sideEffects?: RefundSideEffects;
1801
- }
1802
- export interface AddRefundResponse {
1803
- /** Order ID and its associated transactions. */
1804
- orderTransactions?: OrderTransactions;
1805
- /** Created refund ID */
1806
- refundId?: string;
1807
- }
1808
- export interface UpdatePaymentStatusRequest {
1809
- /**
1810
- * Order ID.
1811
- * @format GUID
1812
- */
1813
- orderId: string;
1814
- /**
1815
- * Payment ID.
1816
- * @format GUID
1817
- */
1818
- paymentId: string;
1819
- /** Payment status. */
1820
- status?: TransactionStatusWithLiterals;
1821
- }
1822
- export interface UpdatePaymentStatusResponse {
1823
- /** Order ID and its associated transactions after update. */
1824
- orderTransactions?: OrderTransactions;
1825
- }
1826
- export interface BulkUpdatePaymentStatusesRequest {
1827
- /**
1828
- * Order and payment IDs for which to update payment status.
1829
- * @minSize 1
1830
- * @maxSize 300
1831
- */
1832
- paymentAndOrderIds: PaymentAndOrderId[];
1833
- /** Whether to return the full payment entity (`results.item`) in the response. */
1834
- returnFullEntity?: boolean;
1835
- /** Payment status. */
1836
- status?: TransactionStatusWithLiterals;
1837
- }
1838
- export interface PaymentAndOrderId {
1839
- /**
1840
- * Order ID.
1841
- * @format GUID
1842
- */
1843
- orderId?: string;
1844
- /**
1845
- * Payment ID.
1846
- * todo: remove comment once UI will use BulkMarkOrderAsPaid
1847
- */
1848
- paymentId?: string;
1849
- }
1850
- export interface BulkUpdatePaymentStatusesResponse {
1851
- /** Bulk operation results. */
1852
- results?: BulkPaymentResult[];
1853
- /** Bulk operation metadata. */
1854
- bulkActionMetadata?: BulkActionMetadata;
1855
- }
1856
- export interface BulkPaymentResult {
1857
- /** Item metadata. */
1858
- itemMetadata?: ItemMetadata;
1859
- /** Updated payment. Returned if `return_full_entity` set to `true`. */
1860
- item?: Payment;
1861
- }
1862
- export interface ItemMetadata {
1863
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1864
- _id?: string | null;
1865
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1866
- originalIndex?: number;
1867
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1868
- success?: boolean;
1869
- /** Details about the error in case of failure. */
1870
- error?: ApplicationError;
1871
- }
1872
- export interface ApplicationError {
1873
- /** Error code. */
1874
- code?: string;
1875
- /** Description of the error. */
1876
- description?: string;
1877
- /** Data related to the error. */
1878
- data?: Record<string, any> | null;
1879
- }
1880
- export interface BulkActionMetadata {
1881
- /** Number of items that were successfully processed. */
1882
- totalSuccesses?: number;
1883
- /** Number of items that couldn't be processed. */
1884
- totalFailures?: number;
1885
- /** Number of failures without details because detailed failure threshold was exceeded. */
1886
- undetailedFailures?: number;
1887
- }
1888
- export interface UpdateRefundRequest {
1889
- /**
1890
- * Order ID.
1891
- * @format GUID
1892
- */
1893
- orderId?: string;
1894
- /** Refund with updated field values. */
1895
- refund?: Refund;
1896
- }
1897
- export interface UpdateRefundResponse {
1898
- /** Refund after update. */
1899
- refund?: Refund;
1900
- /** Order transactions after update. */
1901
- orderTransactions?: OrderTransactions;
1902
- }
1903
- export interface UpdateRefundTransactionRequest {
1904
- }
1905
- export interface UpdateRefundTransactionResponse {
1906
- }
1907
- export interface UpdatePaymentsRequest {
1908
- }
1909
- export interface MaskedPayment {
1910
- }
1911
- export interface UpdatePaymentsResponse {
1912
- }
1913
- export interface QueryOrderTransactionsRequest {
1914
- }
1915
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1916
- /** 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`. */
1917
- cursorPaging?: CursorPaging;
1918
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
1919
- filter?: Record<string, any> | null;
1920
- /**
1921
- * Sort object in the following format:
1922
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1923
- * @maxSize 5
1924
- */
1925
- sort?: Sorting[];
1926
- }
1927
- /** @oneof */
1928
- export interface CursorQueryPagingMethodOneOf {
1929
- /** 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`. */
1930
- cursorPaging?: CursorPaging;
1931
- }
1932
- export interface Sorting {
1933
- /**
1934
- * Name of the field to sort by.
1935
- * @maxLength 512
1936
- */
1937
- fieldName?: string;
1938
- /** Sort order. */
1939
- order?: SortOrderWithLiterals;
1940
- }
1941
- export declare enum SortOrder {
1942
- /** Ascending order. */
1943
- ASC = "ASC",
1944
- /** Descending order. */
1945
- DESC = "DESC"
1946
- }
1947
- /** @enumType */
1948
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1949
- export interface CursorPaging {
1950
- /**
1951
- * Maximum number of items to return in the results.
1952
- * @max 100
1953
- */
1954
- limit?: number | null;
1955
- /**
1956
- * Pointer to the next or previous page in the list of results.
1957
- *
1958
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1959
- * Not relevant for the first request.
1960
- * @maxLength 16000
1961
- */
1962
- cursor?: string | null;
1963
- }
1964
- export interface QueryOrderTransactionsResponse {
1965
- }
1966
- export interface CursorPagingMetadata {
1967
- /** Number of items returned in the response. */
1968
- count?: number | null;
1969
- /** Cursor strings that point to the next page, previous page, or both. */
1970
- cursors?: Cursors;
1971
- /**
1972
- * Whether there are more pages to retrieve following the current page.
1973
- *
1974
- * + `true`: Another page of results can be retrieved.
1975
- * + `false`: This is the last page.
1976
- */
1977
- hasNext?: boolean | null;
1978
- }
1979
- export interface Cursors {
1980
- /**
1981
- * Cursor string pointing to the next page in the list of results.
1982
- * @maxLength 16000
1983
- */
1984
- next?: string | null;
1985
- /**
1986
- * Cursor pointing to the previous page in the list of results.
1987
- * @maxLength 16000
1988
- */
1989
- prev?: string | null;
1990
- }
1991
- export interface TriggerRefundRequest {
1992
- /**
1993
- * The order this refund related to
1994
- * @minLength 1
1995
- * @maxLength 100
1996
- */
1997
- orderId?: string;
1998
- /**
1999
- * Refund operations information
2000
- * Currently, only *one* payment refund is supported per request
2001
- * @minSize 1
2002
- * @maxSize 1
2003
- */
2004
- payments?: PaymentRefund[];
2005
- /** Business model of a refund */
2006
- details?: RefundDetails;
2007
- /** How to restock items as part of this refund */
2008
- restockInfo?: RestockInfo;
2009
- /** Should send a confirmation mail to the customer */
2010
- sendOrderRefundedEmail?: boolean;
2011
- /**
2012
- * Personal note added to the email
2013
- * @minLength 1
2014
- * @maxLength 1000
2015
- */
2016
- customMessage?: string | null;
2017
- }
2018
- export interface PaymentRefund {
2019
- /**
2020
- * Specific payment within the order to refund
2021
- * @format GUID
2022
- */
2023
- paymentId?: string;
2024
- /** Refund amount. Not relevant for membership and gift card refunds. */
2025
- amount?: Price;
2026
- /**
2027
- * Whether refund is made externally and manually (on the payment provider's side)
2028
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
2029
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2030
- */
2031
- externalRefund?: boolean;
2032
- }
2033
- export interface TriggerRefundResponse {
2034
- /** All order's transactions after the refunds were added */
2035
- orderTransactions?: OrderTransactions;
2036
- /** Created refund ID */
2037
- refundId?: string;
2038
- }
2039
- export interface CalculateRefundRequest {
2040
- /**
2041
- * Order ID
2042
- * @minLength 1
2043
- * @maxLength 100
2044
- */
2045
- orderId?: string;
2046
- /**
2047
- * Refunded line items and quantity
2048
- * @maxSize 300
2049
- */
2050
- refundItems?: CalculateRefundItemRequest[];
2051
- /** Should include shipping in refund calculation */
2052
- refundShipping?: boolean;
2053
- }
2054
- export interface CalculateRefundItemRequest {
2055
- /**
2056
- * ID of the line item being refunded
2057
- * @format GUID
2058
- */
2059
- lineItemId?: string;
2060
- /**
2061
- * How much of that line item is being refunded
2062
- * @min 1
2063
- * @max 100000
2064
- */
2065
- quantity?: number;
2066
- /** Should this item be restocked (used for validation purposes) */
2067
- restock?: boolean;
2068
- }
2069
- export interface CalculateRefundResponse {
2070
- /**
2071
- * Total refundable amount
2072
- * @format DECIMAL_VALUE
2073
- */
2074
- total?: string;
2075
- /**
2076
- * Tax cost of the order
2077
- * @format DECIMAL_VALUE
2078
- */
2079
- tax?: string;
2080
- /**
2081
- * Discount given for this order
2082
- * @format DECIMAL_VALUE
2083
- */
2084
- discount?: string;
2085
- /**
2086
- * Total cost of the order (without tax)
2087
- * @format DECIMAL_VALUE
2088
- */
2089
- subtotal?: string;
2090
- /**
2091
- * Previous refund given on that order
2092
- * @format DECIMAL_VALUE
2093
- */
2094
- previouslyRefundedAmount?: string | null;
2095
- /** The refundable items of that order */
2096
- items?: CalculateRefundItemResponse[];
2097
- }
2098
- export interface CalculateRefundItemResponse {
2099
- /** Line item ID */
2100
- lineItemId?: string;
2101
- /** The line item's price */
2102
- lineItemPrice?: number;
2103
- }
2104
- export interface GetRefundabilityStatusRequest {
2105
- /**
2106
- * Order ID.
2107
- * @minLength 1
2108
- * @maxLength 100
2109
- */
2110
- orderId?: string;
2111
- }
2112
- export interface GetRefundabilityStatusResponse {
2113
- /**
2114
- * Refundability details.
2115
- * @maxSize 1
2116
- */
2117
- refundabilities?: Refundability[];
2118
- /** Whether the order supports refunding per item. */
2119
- refundablePerItem?: boolean;
2120
- }
2121
- export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2122
- /** Reason why payment is not refundable. */
2123
- nonRefundableReason?: NonRefundableReasonWithLiterals;
2124
- /** Reason why payment is only refundable manually. */
2125
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2126
- /** Payment ID. */
2127
- paymentId?: string;
2128
- /** Payment refundability status. */
2129
- refundabilityStatus?: RefundableStatusWithLiterals;
2130
- /** Link to payment provider dashboard. */
2131
- providerLink?: string | null;
2132
- }
2133
- /** @oneof */
2134
- export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2135
- /** Reason why payment is not refundable. */
2136
- nonRefundableReason?: NonRefundableReasonWithLiterals;
2137
- /** Reason why payment is only refundable manually. */
2138
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2139
- }
2140
- export declare enum RefundableStatus {
2141
- /** Not refundable. */
2142
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
2143
- /** Refundable manually. */
2144
- MANUAL = "MANUAL",
2145
- /** Refundable. */
2146
- REFUNDABLE = "REFUNDABLE"
2147
- }
2148
- /** @enumType */
2149
- export type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
2150
- export declare enum NonRefundableReason {
2151
- /** No reason. */
2152
- NONE = "NONE",
2153
- /** Payment already refunded. */
2154
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
2155
- /** Payment provider is down. */
2156
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2157
- /** Internal error occurred. */
2158
- INTERNAL_ERROR = "INTERNAL_ERROR",
2159
- /** Payment not made. */
2160
- NOT_PAID = "NOT_PAID",
2161
- /** Access denied. */
2162
- ACCESS_DENIED = "ACCESS_DENIED",
2163
- /** Payment amount is zero. */
2164
- ZERO_PRICE = "ZERO_PRICE",
2165
- /** Disabled by provider. */
2166
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2167
- /** Payment partially paid. */
2168
- PARTIALLY_PAID = "PARTIALLY_PAID",
2169
- /** Deposit for online item. */
2170
- DEPOSIT_ONLINE_ITEM = "DEPOSIT_ONLINE_ITEM",
2171
- /** Refund is pending. */
2172
- PENDING_REFUND = "PENDING_REFUND",
2173
- /** Action forbidden. */
2174
- FORBIDDEN = "FORBIDDEN"
2175
- }
2176
- /** @enumType */
2177
- export type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PARTIALLY_PAID' | 'DEPOSIT_ONLINE_ITEM' | 'PENDING_REFUND' | 'FORBIDDEN';
2178
- export declare enum ManuallyRefundableReason {
2179
- /** Payment expired. */
2180
- EXPIRED = "EXPIRED",
2181
- /** Payment method not supported. */
2182
- NOT_SUPPORTED = "NOT_SUPPORTED",
2183
- /** Payment not found. */
2184
- NOT_FOUND = "NOT_FOUND",
2185
- /** Payment made offline. */
2186
- OFFLINE = "OFFLINE",
2187
- /** Refund requires interaction with card reader. */
2188
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
2189
- }
2190
- /** @enumType */
2191
- export type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'NOT_FOUND' | 'OFFLINE' | 'REQUIRES_CARD_READER';
2192
- export interface ListInvoicesForSingleOrderRequest {
2193
- /**
2194
- * Order ID.
2195
- * @minLength 1
2196
- * @maxLength 100
2197
- */
2198
- orderId?: string;
2199
- }
2200
- export interface ListInvoicesForSingleOrderResponse {
2201
- /** List of invoices. */
2202
- invoices?: InvoiceInfo[];
2203
- }
2204
- export interface InvoiceInfo {
2205
- /** Invoice ID. */
2206
- _id?: string;
2207
- /** ID of the app that set the invoice. */
2208
- appId?: string;
2209
- /**
2210
- * Invoice URL.
2211
- * @deprecated
2212
- */
2213
- url?: string | null;
2214
- /**
2215
- * Invoice creation date and time.
2216
- * @deprecated
2217
- */
2218
- _createdDate?: Date | null;
2219
- }
2220
- export interface ListInvoicesForMultipleOrdersRequest {
2221
- /**
2222
- * Order IDs for which to retrieve invoices.
2223
- * @maxSize 300
2224
- * @minLength 1
2225
- * @maxLength 100
2226
- */
2227
- orderIds?: string[];
2228
- }
2229
- export interface ListInvoicesForMultipleOrdersResponse {
2230
- /** List of order IDs and their associated invoices. */
2231
- invoicesForOrder?: InvoicesForOrder[];
2232
- }
2233
- export interface InvoicesForOrder {
2234
- /** Order ID. */
2235
- orderId?: string;
2236
- /** Invoices info. */
2237
- invoicesInfo?: InvoiceInfo[];
2238
- }
2239
- export interface GenerateInvoiceRequest {
2240
- /**
2241
- * Order ID.
2242
- * @minLength 1
2243
- * @maxLength 100
2244
- */
2245
- orderId?: string;
2246
- }
2247
- export interface GenerateInvoiceResponse {
2248
- /** Invoice ID. */
2249
- invoiceId?: string;
2250
- }
2251
- export interface BulkGenerateInvoicesRequest {
2252
- /**
2253
- * Order IDs.
2254
- * @minSize 1
2255
- * @maxSize 100
2256
- * @minLength 1
2257
- * @maxLength 100
2258
- */
2259
- orderIds?: string[];
2260
- }
2261
- export interface BulkGenerateInvoicesResponse {
2262
- results?: BulkInvoiceResult[];
2263
- bulkActionMetadata?: BulkActionMetadata;
2264
- }
2265
- export interface BulkInvoiceResult {
2266
- itemMetadata?: ItemMetadata;
2267
- item?: InvoiceForOrder;
2268
- }
2269
- export interface InvoiceForOrder {
2270
- /** Order ID. */
2271
- orderId?: string;
2272
- /** Invoice ID. */
2273
- invoiceId?: string;
2274
- }
2275
- export interface AddInvoiceToOrderRequest {
2276
- /**
2277
- * Order ID.
2278
- * @minLength 1
2279
- * @maxLength 100
2280
- */
2281
- orderId?: string;
2282
- /** Invoice info. */
2283
- invoiceInfo?: InvoiceInfo;
2284
- }
2285
- export interface AddInvoiceToOrderResponse {
2286
- /** List of order invoices. */
2287
- orderInvoices?: InvoiceInfo[];
2288
- }
2289
- export interface DomainEvent extends DomainEventBodyOneOf {
2290
- createdEvent?: EntityCreatedEvent;
2291
- updatedEvent?: EntityUpdatedEvent;
2292
- deletedEvent?: EntityDeletedEvent;
2293
- actionEvent?: ActionEvent;
2294
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2295
- _id?: string;
2296
- /**
2297
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2298
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2299
- */
2300
- entityFqdn?: string;
2301
- /**
2302
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2303
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2304
- */
2305
- slug?: string;
2306
- /** ID of the entity associated with the event. */
2307
- entityId?: string;
2308
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2309
- eventTime?: Date | null;
2310
- /**
2311
- * Whether the event was triggered as a result of a privacy regulation application
2312
- * (for example, GDPR).
2313
- */
2314
- triggeredByAnonymizeRequest?: boolean | null;
2315
- /** If present, indicates the action that triggered the event. */
2316
- originatedFrom?: string | null;
2317
- /**
2318
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2319
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2320
- */
2321
- entityEventSequence?: string | null;
2322
- }
2323
- /** @oneof */
2324
- export interface DomainEventBodyOneOf {
2325
- createdEvent?: EntityCreatedEvent;
2326
- updatedEvent?: EntityUpdatedEvent;
2327
- deletedEvent?: EntityDeletedEvent;
2328
- actionEvent?: ActionEvent;
2329
- }
2330
- export interface EntityCreatedEvent {
2331
- entity?: string;
2332
- }
2333
- export interface RestoreInfo {
2334
- deletedDate?: Date | null;
2335
- }
2336
- export interface EntityUpdatedEvent {
2337
- /**
2338
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2339
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2340
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2341
- */
2342
- currentEntity?: string;
2343
- }
2344
- export interface EntityDeletedEvent {
2345
- /** Entity that was deleted. */
2346
- deletedEntity?: string | null;
2347
- }
2348
- export interface ActionEvent {
2349
- body?: string;
2350
- }
2351
- export interface MessageEnvelope {
2352
- /**
2353
- * App instance ID.
2354
- * @format GUID
2355
- */
2356
- instanceId?: string | null;
2357
- /**
2358
- * Event type.
2359
- * @maxLength 150
2360
- */
2361
- eventType?: string;
2362
- /** The identification type and identity data. */
2363
- identity?: IdentificationData;
2364
- /** Stringify payload. */
2365
- data?: string;
2366
- }
2367
- export interface IdentificationData extends IdentificationDataIdOneOf {
2368
- /**
2369
- * ID of a site visitor that has not logged in to the site.
2370
- * @format GUID
2371
- */
2372
- anonymousVisitorId?: string;
2373
- /**
2374
- * ID of a site visitor that has logged in to the site.
2375
- * @format GUID
2376
- */
2377
- memberId?: string;
2378
- /**
2379
- * ID of a Wix user (site owner, contributor, etc.).
2380
- * @format GUID
2381
- */
2382
- wixUserId?: string;
2383
- /**
2384
- * ID of an app.
2385
- * @format GUID
2386
- */
2387
- appId?: string;
2388
- /** @readonly */
2389
- identityType?: WebhookIdentityTypeWithLiterals;
2390
- }
2391
- /** @oneof */
2392
- export interface IdentificationDataIdOneOf {
2393
- /**
2394
- * ID of a site visitor that has not logged in to the site.
2395
- * @format GUID
2396
- */
2397
- anonymousVisitorId?: string;
2398
- /**
2399
- * ID of a site visitor that has logged in to the site.
2400
- * @format GUID
2401
- */
2402
- memberId?: string;
2403
- /**
2404
- * ID of a Wix user (site owner, contributor, etc.).
2405
- * @format GUID
2406
- */
2407
- wixUserId?: string;
2408
- /**
2409
- * ID of an app.
2410
- * @format GUID
2411
- */
2412
- appId?: string;
2413
- }
2414
- export declare enum WebhookIdentityType {
2415
- UNKNOWN = "UNKNOWN",
2416
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2417
- MEMBER = "MEMBER",
2418
- WIX_USER = "WIX_USER",
2419
- APP = "APP"
2420
- }
2421
- /** @enumType */
2422
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2423
- type OrderTransactionsNonNullablePaths = `orderId` | `payments` | `payments.${number}.regularPaymentDetails.offlinePayment` | `payments.${number}.regularPaymentDetails.status` | `payments.${number}.regularPaymentDetails.savedPaymentMethod` | `payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `payments.${number}.giftcardPaymentDetails.appId` | `payments.${number}.giftcardPaymentDetails.voided` | `payments.${number}.refundDisabled` | `refunds` | `refunds.${number}._id` | `refunds.${number}.details.shippingIncluded` | `refunds.${number}.summary.pending`;
2424
- /**
2425
- * Retrieves information about payments and refunds associated with a specified order.
2426
- *
2427
- *
2428
- * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
2429
- * @param orderId - Order ID.
2430
- * @public
2431
- * @requiredField orderId
2432
- * @permissionId ECOM.READ_TRANSACTIONS
2433
- * @permissionScope Manage Stores - all permissions
2434
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2435
- * @permissionScope Manage Stores
2436
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2437
- * @permissionScope Read eCommerce - all read permissions
2438
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
2439
- * @permissionScope Read Orders
2440
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
2441
- * @permissionScope Read Stores - all read permissions
2442
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
2443
- * @permissionScope Manage Restaurants - all permissions
2444
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2445
- * @permissionScope Manage eCommerce - all permissions
2446
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2447
- * @permissionScope Manage Orders
2448
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2449
- * @applicableIdentity APP
2450
- * @fqn com.wix.ecom.orders.payments.v1.Payments.ListTransactionsForSingleOrder
2451
- */
2452
- export declare function listTransactionsForSingleOrder(orderId: string): Promise<NonNullablePaths<ListTransactionsForSingleOrderResponse, {
2453
- [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
2454
- }[OrderTransactionsNonNullablePaths]>>;
2455
- /**
2456
- * Retrieves information about payments and refunds associated with all specified orders.
2457
- *
2458
- *
2459
- * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
2460
- * @param orderIds - Order IDs for which to retrieve transactions.
2461
- * @public
2462
- * @requiredField orderIds
2463
- * @permissionId ECOM.READ_TRANSACTIONS
2464
- * @permissionScope Manage Stores - all permissions
2465
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2466
- * @permissionScope Manage Stores
2467
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2468
- * @permissionScope Read eCommerce - all read permissions
2469
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
2470
- * @permissionScope Read Orders
2471
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
2472
- * @permissionScope Read Stores - all read permissions
2473
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
2474
- * @permissionScope Manage Restaurants - all permissions
2475
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2476
- * @permissionScope Manage eCommerce - all permissions
2477
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2478
- * @permissionScope Manage Orders
2479
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2480
- * @applicableIdentity APP
2481
- * @fqn com.wix.ecom.orders.payments.v1.Payments.ListTransactionsForMultipleOrders
2482
- */
2483
- export declare function listTransactionsForMultipleOrders(orderIds: string[]): Promise<NonNullablePaths<ListTransactionsForMultipleOrdersResponse, {
2484
- [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${number}.${P}`;
2485
- }[OrderTransactionsNonNullablePaths]>>;
2486
- /**
2487
- * Adds up to 50 payment records to an order.
2488
- *
2489
- *
2490
- * The `addPayments()` function returns a Promise that resolves when the payment records are added to an order.
2491
- *
2492
- * > **Note:** This does **NOT** perform the actual charging - the order is only updated with records of the payments.
2493
- * @param orderId - Order ID.
2494
- * @param payments - Payments to be added to order.
2495
- * @public
2496
- * @requiredField orderId
2497
- * @requiredField payments
2498
- * @requiredField payments.amount
2499
- * @requiredField payments.paymentDetails
2500
- * @requiredField payments.paymentDetails.giftcardPaymentDetails.giftCardPaymentId
2501
- * @permissionId ECOM.MODIFY_TRANSACTIONS
2502
- * @permissionScope Manage Stores - all permissions
2503
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2504
- * @permissionScope Manage Stores
2505
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2506
- * @permissionScope Manage Restaurants - all permissions
2507
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2508
- * @permissionScope Manage eCommerce - all permissions
2509
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2510
- * @permissionScope Manage Orders
2511
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2512
- * @applicableIdentity APP
2513
- * @fqn com.wix.ecom.orders.payments.v1.Payments.AddPayments
2514
- */
2515
- export declare function addPayments(orderId: string, payments: NonNullablePaths<Payment, `amount` | `giftcardPaymentDetails.giftCardPaymentId`>[]): Promise<NonNullablePaths<AddPaymentsResponse, {
2516
- [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
2517
- }[OrderTransactionsNonNullablePaths] | `paymentsIds`>>;
2518
- /**
2519
- * Updates the status of an order's payment.
2520
- *
2521
- *
2522
- * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
2523
- * @public
2524
- * @requiredField identifiers
2525
- * @requiredField identifiers.orderId
2526
- * @requiredField identifiers.paymentId
2527
- * @permissionId ECOM.MODIFY_TRANSACTIONS
2528
- * @permissionScope Manage Stores - all permissions
2529
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2530
- * @permissionScope Manage Stores
2531
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2532
- * @permissionScope Manage Restaurants - all permissions
2533
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2534
- * @permissionScope Manage eCommerce - all permissions
2535
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2536
- * @permissionScope Manage Orders
2537
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2538
- * @applicableIdentity APP
2539
- * @fqn com.wix.ecom.orders.payments.v1.Payments.UpdatePaymentStatus
2540
- */
2541
- export declare function updatePaymentStatus(identifiers: NonNullablePaths<UpdatePaymentStatusIdentifiers, `orderId` | `paymentId`>, options?: UpdatePaymentStatusOptions): Promise<NonNullablePaths<UpdatePaymentStatusResponse, {
2542
- [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
2543
- }[OrderTransactionsNonNullablePaths]>>;
2544
- export interface UpdatePaymentStatusIdentifiers {
2545
- /**
2546
- * Payment ID.
2547
- * @format GUID
2548
- */
2549
- paymentId: string;
2550
- /**
2551
- * Order ID.
2552
- * @format GUID
2553
- */
2554
- orderId: string;
2555
- }
2556
- export interface UpdatePaymentStatusOptions {
2557
- /** Payment status. */
2558
- status?: TransactionStatusWithLiterals;
2559
- }
2560
- /**
2561
- * Updates multiple order payments with a specified status.
2562
- *
2563
- *
2564
- * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
2565
- * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.
2566
- * @public
2567
- * @requiredField paymentAndOrderIds
2568
- * @permissionId ECOM.MODIFY_TRANSACTIONS
2569
- * @permissionScope Manage Stores - all permissions
2570
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2571
- * @permissionScope Manage Stores
2572
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2573
- * @permissionScope Manage Restaurants - all permissions
2574
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2575
- * @permissionScope Manage eCommerce - all permissions
2576
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2577
- * @permissionScope Manage Orders
2578
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2579
- * @applicableIdentity APP
2580
- * @fqn com.wix.ecom.orders.payments.v1.Payments.BulkUpdatePaymentStatuses
2581
- */
2582
- export declare function bulkUpdatePaymentStatuses(paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions): Promise<NonNullablePaths<BulkUpdatePaymentStatusesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.regularPaymentDetails.offlinePayment` | `results.${number}.item.regularPaymentDetails.status` | `results.${number}.item.regularPaymentDetails.savedPaymentMethod` | `results.${number}.item.regularPaymentDetails.authorizationDetails.delayedCapture` | `results.${number}.item.regularPaymentDetails.authorizationDetails.void.status` | `results.${number}.item.regularPaymentDetails.authorizationDetails.void.reason` | `results.${number}.item.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `results.${number}.item.giftcardPaymentDetails.giftCardPaymentId` | `results.${number}.item.giftcardPaymentDetails.appId` | `results.${number}.item.giftcardPaymentDetails.voided` | `results.${number}.item.refundDisabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
2583
- export interface BulkUpdatePaymentStatusesOptions {
2584
- /** Whether to return the full payment entity (`results.item`) in the response. */
2585
- returnFullEntity?: boolean;
2586
- /** Payment status. */
2587
- status?: TransactionStatusWithLiterals;
2588
- }
2589
- export {};