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