@wix/auto_sdk_ecom_orders 1.0.86 → 1.0.88
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.
- package/build/cjs/{ecom-v1-order-orders.universal-DQ3VbtMx.d.ts → ecom-v1-order-orders.universal-CBJ5qQrX.d.ts} +315 -27
- package/build/cjs/index.d.ts +6 -6
- package/build/cjs/index.js +16 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +16 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +718 -10
- package/build/es/{ecom-v1-order-orders.universal-DQ3VbtMx.d.mts → ecom-v1-order-orders.universal-CBJ5qQrX.d.mts} +315 -27
- package/build/es/index.d.mts +6 -6
- package/build/es/index.mjs +16 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +16 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +718 -10
- package/build/internal/cjs/{ecom-v1-order-orders.universal-EBZGBmtA.d.ts → ecom-v1-order-orders.universal-BIDprMe0.d.ts} +232 -177
- package/build/internal/cjs/index.d.ts +13 -13
- package/build/internal/cjs/index.js +16 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +16 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +718 -10
- package/build/internal/es/{ecom-v1-order-orders.universal-EBZGBmtA.d.mts → ecom-v1-order-orders.universal-BIDprMe0.d.mts} +232 -177
- package/build/internal/es/index.d.mts +13 -13
- package/build/internal/es/index.mjs +16 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +16 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +718 -10
- package/package.json +2 -2
|
@@ -1457,6 +1457,53 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1457
1457
|
merchantComment?: MerchantComment;
|
|
1458
1458
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1459
1459
|
orderRefunded?: OrderRefunded;
|
|
1460
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1461
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1462
|
+
/** Details of the payment method saved for order */
|
|
1463
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1464
|
+
/** Details of an authorized payment created. */
|
|
1465
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1466
|
+
/** Details of an authorized payment captured. */
|
|
1467
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1468
|
+
/** Details of an authorized payment voided. */
|
|
1469
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1470
|
+
/**
|
|
1471
|
+
* Details of an initiated refund process.
|
|
1472
|
+
*
|
|
1473
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1474
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1475
|
+
*/
|
|
1476
|
+
refundInitiated?: RefundInitiated;
|
|
1477
|
+
/**
|
|
1478
|
+
* Details of a refunded payment.
|
|
1479
|
+
*
|
|
1480
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1481
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1482
|
+
*/
|
|
1483
|
+
paymentRefunded?: PaymentRefunded;
|
|
1484
|
+
/**
|
|
1485
|
+
* Details of a failed payment refund.
|
|
1486
|
+
*
|
|
1487
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1488
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1489
|
+
*/
|
|
1490
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1491
|
+
/** Details of refund to store credit. */
|
|
1492
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1493
|
+
/** Details of a pending payment. */
|
|
1494
|
+
paymentPending?: PaymentPending;
|
|
1495
|
+
/** Details of a canceled payment. */
|
|
1496
|
+
paymentCanceled?: PaymentCanceled;
|
|
1497
|
+
/** Details of a declined payment. */
|
|
1498
|
+
paymentDeclined?: PaymentDeclined;
|
|
1499
|
+
/** Receipt was added for associated payment. */
|
|
1500
|
+
receiptCreated?: ReceiptCreated;
|
|
1501
|
+
/** Receipt sent to customer. */
|
|
1502
|
+
receiptSent?: ReceiptSent;
|
|
1503
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1504
|
+
chargebackCreated?: ChargebackCreated;
|
|
1505
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1506
|
+
chargebackReversed?: ChargebackReversed;
|
|
1460
1507
|
/**
|
|
1461
1508
|
* Activity ID.
|
|
1462
1509
|
* @format GUID
|
|
@@ -1485,6 +1532,53 @@ interface ActivityContentOneOf {
|
|
|
1485
1532
|
merchantComment?: MerchantComment;
|
|
1486
1533
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1487
1534
|
orderRefunded?: OrderRefunded;
|
|
1535
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1536
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1537
|
+
/** Details of the payment method saved for order */
|
|
1538
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1539
|
+
/** Details of an authorized payment created. */
|
|
1540
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1541
|
+
/** Details of an authorized payment captured. */
|
|
1542
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1543
|
+
/** Details of an authorized payment voided. */
|
|
1544
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1545
|
+
/**
|
|
1546
|
+
* Details of an initiated refund process.
|
|
1547
|
+
*
|
|
1548
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1549
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1550
|
+
*/
|
|
1551
|
+
refundInitiated?: RefundInitiated;
|
|
1552
|
+
/**
|
|
1553
|
+
* Details of a refunded payment.
|
|
1554
|
+
*
|
|
1555
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1556
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1557
|
+
*/
|
|
1558
|
+
paymentRefunded?: PaymentRefunded;
|
|
1559
|
+
/**
|
|
1560
|
+
* Details of a failed payment refund.
|
|
1561
|
+
*
|
|
1562
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1563
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1564
|
+
*/
|
|
1565
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1566
|
+
/** Details of refund to store credit. */
|
|
1567
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1568
|
+
/** Details of a pending payment. */
|
|
1569
|
+
paymentPending?: PaymentPending;
|
|
1570
|
+
/** Details of a canceled payment. */
|
|
1571
|
+
paymentCanceled?: PaymentCanceled;
|
|
1572
|
+
/** Details of a declined payment. */
|
|
1573
|
+
paymentDeclined?: PaymentDeclined;
|
|
1574
|
+
/** Receipt was added for associated payment. */
|
|
1575
|
+
receiptCreated?: ReceiptCreated;
|
|
1576
|
+
/** Receipt sent to customer. */
|
|
1577
|
+
receiptSent?: ReceiptSent;
|
|
1578
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1579
|
+
chargebackCreated?: ChargebackCreated;
|
|
1580
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1581
|
+
chargebackReversed?: ChargebackReversed;
|
|
1488
1582
|
}
|
|
1489
1583
|
interface CustomActivity {
|
|
1490
1584
|
/**
|
|
@@ -2056,44 +2150,139 @@ interface ChargebackReversed {
|
|
|
2056
2150
|
paymentDetails?: RegularPayment;
|
|
2057
2151
|
}
|
|
2058
2152
|
declare enum ActivityType {
|
|
2153
|
+
/** Order was refunded, either partially or fully. */
|
|
2059
2154
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2155
|
+
/** New order was created and placed. */
|
|
2060
2156
|
ORDER_PLACED = "ORDER_PLACED",
|
|
2157
|
+
/** Order payment was completed and confirmed. */
|
|
2061
2158
|
ORDER_PAID = "ORDER_PAID",
|
|
2159
|
+
/** Order items were marked as fulfilled (shipped or ready for pickup). */
|
|
2062
2160
|
ORDER_FULFILLED = "ORDER_FULFILLED",
|
|
2161
|
+
/** Order fulfillment status was changed to not fulfilled. */
|
|
2063
2162
|
ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
|
|
2163
|
+
/** Order was canceled by merchant or customer. */
|
|
2064
2164
|
ORDER_CANCELED = "ORDER_CANCELED",
|
|
2165
|
+
/** Download link was sent for digital items in the order. */
|
|
2065
2166
|
DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
|
|
2167
|
+
/** Shipping tracking number was added to the order. */
|
|
2066
2168
|
TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
|
|
2169
|
+
/** Existing shipping tracking number was modified. */
|
|
2067
2170
|
TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
|
|
2171
|
+
/** Tracking link for shipment was added to the order. */
|
|
2068
2172
|
TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
|
|
2173
|
+
/** Email confirming shipment was sent to the customer. */
|
|
2069
2174
|
SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
|
|
2175
|
+
/** Invoice document was added to the order. */
|
|
2070
2176
|
INVOICE_ADDED = "INVOICE_ADDED",
|
|
2177
|
+
/** Invoice was removed from the order. */
|
|
2071
2178
|
INVOICE_REMOVED = "INVOICE_REMOVED",
|
|
2179
|
+
/** Invoice was sent to the customer via email. */
|
|
2072
2180
|
INVOICE_SENT = "INVOICE_SENT",
|
|
2181
|
+
/** Notification email was sent to the order fulfiller. */
|
|
2073
2182
|
FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
|
|
2183
|
+
/** Order's shipping address was modified. */
|
|
2074
2184
|
SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
|
|
2185
|
+
/** Order's contact email address was changed. */
|
|
2075
2186
|
EMAIL_EDITED = "EMAIL_EDITED",
|
|
2187
|
+
/** Email notification for pickup readiness was sent. */
|
|
2076
2188
|
PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
|
|
2189
|
+
/** Custom activity created by a third-party application. */
|
|
2077
2190
|
CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
|
|
2191
|
+
/** Comment added to the order by a merchant. */
|
|
2078
2192
|
MERCHANT_COMMENT = "MERCHANT_COMMENT",
|
|
2193
|
+
/** Order was created as a result of an exchange. */
|
|
2079
2194
|
ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
|
|
2195
|
+
/** New exchange order was created from this order. */
|
|
2080
2196
|
NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
|
|
2197
|
+
/** Partial payment was received for the order. */
|
|
2081
2198
|
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
|
|
2199
|
+
/** Changes were applied to a draft order. */
|
|
2082
2200
|
DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
|
|
2201
|
+
/** Payment method was saved for future use. */
|
|
2083
2202
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
2084
|
-
/**
|
|
2203
|
+
/**
|
|
2204
|
+
* Payment was authorized but not yet captured.
|
|
2205
|
+
* @documentationMaturity preview
|
|
2206
|
+
*/
|
|
2207
|
+
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
2208
|
+
/**
|
|
2209
|
+
* Previously authorized payment was captured.
|
|
2210
|
+
* @documentationMaturity preview
|
|
2211
|
+
*/
|
|
2212
|
+
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
2213
|
+
/**
|
|
2214
|
+
* Previously authorized payment was voided.
|
|
2215
|
+
* @documentationMaturity preview
|
|
2216
|
+
*/
|
|
2217
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
2218
|
+
/**
|
|
2219
|
+
* Refund process was initiated.
|
|
2220
|
+
* @documentationMaturity preview
|
|
2221
|
+
*/
|
|
2222
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
2223
|
+
/**
|
|
2224
|
+
* Payment was successfully refunded.
|
|
2225
|
+
* @documentationMaturity preview
|
|
2226
|
+
*/
|
|
2227
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
2228
|
+
/**
|
|
2229
|
+
* Attempt to refund payment failed.
|
|
2230
|
+
* @documentationMaturity preview
|
|
2231
|
+
*/
|
|
2232
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED",
|
|
2233
|
+
/**
|
|
2234
|
+
* Refund was issued as store credit.
|
|
2235
|
+
* @documentationMaturity preview
|
|
2236
|
+
*/
|
|
2237
|
+
REFUNDED_AS_STORE_CREDIT = "REFUNDED_AS_STORE_CREDIT",
|
|
2238
|
+
/**
|
|
2239
|
+
* Payment is awaiting processing or confirmation.
|
|
2240
|
+
* @documentationMaturity preview
|
|
2241
|
+
*/
|
|
2085
2242
|
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
2086
|
-
/**
|
|
2243
|
+
/**
|
|
2244
|
+
* Payment was canceled before completion.
|
|
2245
|
+
* @documentationMaturity preview
|
|
2246
|
+
*/
|
|
2087
2247
|
PAYMENT_CANCELED = "PAYMENT_CANCELED",
|
|
2088
|
-
/**
|
|
2248
|
+
/**
|
|
2249
|
+
* Payment was declined by payment provider.
|
|
2250
|
+
* @documentationMaturity preview
|
|
2251
|
+
*/
|
|
2089
2252
|
PAYMENT_DECLINED = "PAYMENT_DECLINED",
|
|
2090
|
-
/**
|
|
2253
|
+
/**
|
|
2254
|
+
* Order is awaiting approval or processing.
|
|
2255
|
+
* @documentationMaturity preview
|
|
2256
|
+
*/
|
|
2091
2257
|
ORDER_PENDING = "ORDER_PENDING",
|
|
2092
|
-
/**
|
|
2093
|
-
|
|
2258
|
+
/**
|
|
2259
|
+
* Order was rejected by merchant.
|
|
2260
|
+
* @documentationMaturity preview
|
|
2261
|
+
*/
|
|
2262
|
+
ORDER_REJECTED = "ORDER_REJECTED",
|
|
2263
|
+
/**
|
|
2264
|
+
* Receipt was generated for a payment.
|
|
2265
|
+
* @documentationMaturity preview
|
|
2266
|
+
*/
|
|
2267
|
+
RECEIPT_CREATED = "RECEIPT_CREATED",
|
|
2268
|
+
/**
|
|
2269
|
+
* Receipt was sent to the customer.
|
|
2270
|
+
* @documentationMaturity preview
|
|
2271
|
+
*/
|
|
2272
|
+
RECEIPT_SENT = "RECEIPT_SENT",
|
|
2273
|
+
/**
|
|
2274
|
+
* Chargeback was created for one of the order's payments.
|
|
2275
|
+
* @documentationMaturity preview
|
|
2276
|
+
*/
|
|
2277
|
+
CHARGEBACK_CREATED = "CHARGEBACK_CREATED",
|
|
2278
|
+
/**
|
|
2279
|
+
* Chargeback was resolved in merchant's favor.
|
|
2280
|
+
* @documentationMaturity preview
|
|
2281
|
+
*/
|
|
2282
|
+
CHARGEBACK_REVERSED = "CHARGEBACK_REVERSED"
|
|
2094
2283
|
}
|
|
2095
2284
|
/** @enumType */
|
|
2096
|
-
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
2285
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'AUTHORIZED_PAYMENT_CREATED' | 'AUTHORIZED_PAYMENT_CAPTURED' | 'AUTHORIZED_PAYMENT_VOIDED' | 'REFUND_INITIATED' | 'PAYMENT_REFUNDED' | 'PAYMENT_REFUND_FAILED' | 'REFUNDED_AS_STORE_CREDIT' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED' | 'RECEIPT_CREATED' | 'RECEIPT_SENT' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_REVERSED';
|
|
2097
2286
|
declare enum AttributionSource {
|
|
2098
2287
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2099
2288
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
@@ -2193,10 +2382,12 @@ declare enum ChannelType {
|
|
|
2193
2382
|
/** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
|
|
2194
2383
|
TIKTOK = "TIKTOK",
|
|
2195
2384
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2196
|
-
FAIRE_COM = "FAIRE_COM"
|
|
2385
|
+
FAIRE_COM = "FAIRE_COM",
|
|
2386
|
+
/** PayPal Agentic Checkout sales channel. */
|
|
2387
|
+
PAYPAL_AGENTIC_CHECKOUT = "PAYPAL_AGENTIC_CHECKOUT"
|
|
2197
2388
|
}
|
|
2198
2389
|
/** @enumType */
|
|
2199
|
-
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';
|
|
2390
|
+
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' | 'PAYPAL_AGENTIC_CHECKOUT';
|
|
2200
2391
|
interface CustomField {
|
|
2201
2392
|
/** Custom field value. */
|
|
2202
2393
|
value?: any;
|
|
@@ -2236,11 +2427,26 @@ interface BalanceSummary {
|
|
|
2236
2427
|
* @readonly
|
|
2237
2428
|
*/
|
|
2238
2429
|
authorized?: Price;
|
|
2430
|
+
/**
|
|
2431
|
+
* Sum of all pending refund transactions.
|
|
2432
|
+
* @readonly
|
|
2433
|
+
*/
|
|
2434
|
+
pendingRefund?: Price;
|
|
2239
2435
|
/**
|
|
2240
2436
|
* Sum of all pending transactions.
|
|
2241
2437
|
* @readonly
|
|
2242
2438
|
*/
|
|
2243
2439
|
pending?: Price;
|
|
2440
|
+
/**
|
|
2441
|
+
* Sum of all transaction chargebacks.
|
|
2442
|
+
* @readonly
|
|
2443
|
+
*/
|
|
2444
|
+
chargeback?: Price;
|
|
2445
|
+
/**
|
|
2446
|
+
* Sum of all chargeback reversals.
|
|
2447
|
+
* @readonly
|
|
2448
|
+
*/
|
|
2449
|
+
chargebackReversal?: Price;
|
|
2244
2450
|
}
|
|
2245
2451
|
/**
|
|
2246
2452
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -4873,20 +5079,57 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
4873
5079
|
newExchangeOrderCreated?: NewExchangeOrderCreated;
|
|
4874
5080
|
/** Order partially paid. During the checkout for orders with deposit items. */
|
|
4875
5081
|
orderPartiallyPaid?: OrderPartiallyPaid;
|
|
4876
|
-
/** Draft order changes applied */
|
|
5082
|
+
/** Draft order changes applied. */
|
|
4877
5083
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
4878
|
-
/** Payment method is saved for order */
|
|
5084
|
+
/** Payment method is saved for order. */
|
|
4879
5085
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
4880
|
-
/** Details of
|
|
5086
|
+
/** Details of an authorized payment created. */
|
|
5087
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
5088
|
+
/** Details of an authorized payment captured. */
|
|
5089
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
5090
|
+
/** Details of an authorized payment voided. */
|
|
5091
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
5092
|
+
/**
|
|
5093
|
+
* Details of an initiated refund process.
|
|
5094
|
+
*
|
|
5095
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5096
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5097
|
+
*/
|
|
5098
|
+
refundInitiated?: RefundInitiated;
|
|
5099
|
+
/**
|
|
5100
|
+
* Details of a refunded payment.
|
|
5101
|
+
*
|
|
5102
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5103
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5104
|
+
*/
|
|
5105
|
+
paymentRefunded?: PaymentRefunded;
|
|
5106
|
+
/**
|
|
5107
|
+
* Details of a failed payment refund.
|
|
5108
|
+
*
|
|
5109
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5110
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5111
|
+
*/
|
|
5112
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5113
|
+
/** Details of refund to store credit. */
|
|
5114
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5115
|
+
/** Details of a pending payment. */
|
|
4881
5116
|
paymentPending?: PaymentPending;
|
|
4882
|
-
/** Details of a canceled payment */
|
|
5117
|
+
/** Details of a canceled payment. */
|
|
4883
5118
|
paymentCanceled?: PaymentCanceled;
|
|
4884
|
-
/** Details of a declined payment */
|
|
5119
|
+
/** Details of a declined payment. */
|
|
4885
5120
|
paymentDeclined?: PaymentDeclined;
|
|
4886
|
-
/** Order pending */
|
|
5121
|
+
/** Order pending. */
|
|
4887
5122
|
orderPending?: OrderPending;
|
|
4888
|
-
/** Order rejected */
|
|
5123
|
+
/** Order rejected. */
|
|
4889
5124
|
orderRejected?: OrderRejected;
|
|
5125
|
+
/** Receipt was added for associated payment. */
|
|
5126
|
+
receiptCreated?: ReceiptCreated;
|
|
5127
|
+
/** Receipt sent to customer. */
|
|
5128
|
+
receiptSent?: ReceiptSent;
|
|
5129
|
+
/** Chargeback created for one of the order's payments. */
|
|
5130
|
+
chargebackCreated?: ChargebackCreated;
|
|
5131
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
5132
|
+
chargebackReversed?: ChargebackReversed;
|
|
4890
5133
|
/**
|
|
4891
5134
|
* Internal activity ID.
|
|
4892
5135
|
* @format GUID
|
|
@@ -4947,20 +5190,57 @@ interface InternalActivityContentOneOf {
|
|
|
4947
5190
|
newExchangeOrderCreated?: NewExchangeOrderCreated;
|
|
4948
5191
|
/** Order partially paid. During the checkout for orders with deposit items. */
|
|
4949
5192
|
orderPartiallyPaid?: OrderPartiallyPaid;
|
|
4950
|
-
/** Draft order changes applied */
|
|
5193
|
+
/** Draft order changes applied. */
|
|
4951
5194
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
4952
|
-
/** Payment method is saved for order */
|
|
5195
|
+
/** Payment method is saved for order. */
|
|
4953
5196
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
4954
|
-
/** Details of
|
|
5197
|
+
/** Details of an authorized payment created. */
|
|
5198
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
5199
|
+
/** Details of an authorized payment captured. */
|
|
5200
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
5201
|
+
/** Details of an authorized payment voided. */
|
|
5202
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
5203
|
+
/**
|
|
5204
|
+
* Details of an initiated refund process.
|
|
5205
|
+
*
|
|
5206
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5207
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5208
|
+
*/
|
|
5209
|
+
refundInitiated?: RefundInitiated;
|
|
5210
|
+
/**
|
|
5211
|
+
* Details of a refunded payment.
|
|
5212
|
+
*
|
|
5213
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5214
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5215
|
+
*/
|
|
5216
|
+
paymentRefunded?: PaymentRefunded;
|
|
5217
|
+
/**
|
|
5218
|
+
* Details of a failed payment refund.
|
|
5219
|
+
*
|
|
5220
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5221
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5222
|
+
*/
|
|
5223
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5224
|
+
/** Details of refund to store credit. */
|
|
5225
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5226
|
+
/** Details of a pending payment. */
|
|
4955
5227
|
paymentPending?: PaymentPending;
|
|
4956
|
-
/** Details of a canceled payment */
|
|
5228
|
+
/** Details of a canceled payment. */
|
|
4957
5229
|
paymentCanceled?: PaymentCanceled;
|
|
4958
|
-
/** Details of a declined payment */
|
|
5230
|
+
/** Details of a declined payment. */
|
|
4959
5231
|
paymentDeclined?: PaymentDeclined;
|
|
4960
|
-
/** Order pending */
|
|
5232
|
+
/** Order pending. */
|
|
4961
5233
|
orderPending?: OrderPending;
|
|
4962
|
-
/** Order rejected */
|
|
5234
|
+
/** Order rejected. */
|
|
4963
5235
|
orderRejected?: OrderRejected;
|
|
5236
|
+
/** Receipt was added for associated payment. */
|
|
5237
|
+
receiptCreated?: ReceiptCreated;
|
|
5238
|
+
/** Receipt sent to customer. */
|
|
5239
|
+
receiptSent?: ReceiptSent;
|
|
5240
|
+
/** Chargeback created for one of the order's payments. */
|
|
5241
|
+
chargebackCreated?: ChargebackCreated;
|
|
5242
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
5243
|
+
chargebackReversed?: ChargebackReversed;
|
|
4964
5244
|
}
|
|
4965
5245
|
/** Order placed */
|
|
4966
5246
|
interface OrderPlaced {
|
|
@@ -5933,6 +6213,10 @@ type PreparePaymentCollectionApplicationErrors = {
|
|
|
5933
6213
|
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
5934
6214
|
description?: string;
|
|
5935
6215
|
data?: Record<string, any>;
|
|
6216
|
+
} | {
|
|
6217
|
+
code?: 'ORDER_HAS_CHARGEBACKS';
|
|
6218
|
+
description?: string;
|
|
6219
|
+
data?: Record<string, any>;
|
|
5936
6220
|
};
|
|
5937
6221
|
/** @docsIgnore */
|
|
5938
6222
|
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
@@ -5957,6 +6241,10 @@ type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
|
5957
6241
|
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5958
6242
|
description?: string;
|
|
5959
6243
|
data?: Record<string, any>;
|
|
6244
|
+
} | {
|
|
6245
|
+
code?: 'ORDER_HAS_CHARGEBACKS';
|
|
6246
|
+
description?: string;
|
|
6247
|
+
data?: Record<string, any>;
|
|
5960
6248
|
};
|
|
5961
6249
|
/** @docsIgnore */
|
|
5962
6250
|
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
@@ -6397,7 +6685,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
|
|
|
6397
6685
|
* @returns Fulfilled - The requested order.
|
|
6398
6686
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
6399
6687
|
*/
|
|
6400
|
-
declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6688
|
+
declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6401
6689
|
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
6402
6690
|
}>;
|
|
6403
6691
|
interface OrderSearchSpec extends SearchSpec {
|
|
@@ -6551,7 +6839,7 @@ type OrderSearch = {
|
|
|
6551
6839
|
* @returns Newly created order.
|
|
6552
6840
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
6553
6841
|
*/
|
|
6554
|
-
declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 5>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6842
|
+
declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 5>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6555
6843
|
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
6556
6844
|
}>;
|
|
6557
6845
|
interface CreateOrderOptions {
|
|
@@ -6594,7 +6882,7 @@ interface CreateOrderOptions {
|
|
|
6594
6882
|
* @returns Newly created order.
|
|
6595
6883
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
6596
6884
|
*/
|
|
6597
|
-
declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6885
|
+
declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
6598
6886
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
6599
6887
|
}>;
|
|
6600
6888
|
interface UpdateOrder {
|
|
@@ -7005,7 +7293,7 @@ interface DeleteActivityIdentifiers {
|
|
|
7005
7293
|
* @applicableIdentity APP
|
|
7006
7294
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
7007
7295
|
*/
|
|
7008
|
-
declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.customActivity.appId` | `order.activities.${number}.customActivity.type` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.type` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name`, 7> & {
|
|
7296
|
+
declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.customActivity.appId` | `order.activities.${number}.customActivity.type` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name`, 7> & {
|
|
7009
7297
|
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
7010
7298
|
}>;
|
|
7011
7299
|
interface CancelOrderOptions {
|