@wix/auto_sdk_ecom_orders 1.0.87 → 1.0.89
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-Bcw6NjJM.d.ts → ecom-v1-order-orders.universal-CBJ5qQrX.d.ts} +311 -25
- package/build/cjs/index.d.ts +6 -6
- package/build/cjs/index.js +15 -10
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +15 -10
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +714 -8
- package/build/cjs/meta.js +0 -10
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-Bcw6NjJM.d.mts → ecom-v1-order-orders.universal-CBJ5qQrX.d.mts} +311 -25
- package/build/es/index.d.mts +6 -6
- package/build/es/index.mjs +15 -10
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +15 -10
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +714 -8
- package/build/es/meta.mjs +0 -10
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DJbQYSET.d.ts → ecom-v1-order-orders.universal-BIDprMe0.d.ts} +228 -175
- package/build/internal/cjs/index.d.ts +13 -13
- package/build/internal/cjs/index.js +15 -10
- 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 +15 -10
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +714 -8
- package/build/internal/cjs/meta.js +0 -10
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{ecom-v1-order-orders.universal-DJbQYSET.d.mts → ecom-v1-order-orders.universal-BIDprMe0.d.mts} +228 -175
- package/build/internal/es/index.d.mts +13 -13
- package/build/internal/es/index.mjs +15 -10
- 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 +15 -10
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +714 -8
- package/build/internal/es/meta.mjs +0 -10
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1503,69 +1503,52 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1503
1503
|
merchantComment?: MerchantComment;
|
|
1504
1504
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1505
1505
|
orderRefunded?: OrderRefunded;
|
|
1506
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1507
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1508
|
+
/** Details of the payment method saved for order */
|
|
1509
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1510
|
+
/** Details of an authorized payment created. */
|
|
1511
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1512
|
+
/** Details of an authorized payment captured. */
|
|
1513
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1514
|
+
/** Details of an authorized payment voided. */
|
|
1515
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1506
1516
|
/**
|
|
1507
1517
|
* Details of an initiated refund process.
|
|
1508
1518
|
*
|
|
1509
|
-
* > **Note:** A single `
|
|
1510
|
-
* > In these cases, the `
|
|
1511
|
-
* @internal
|
|
1519
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1520
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1512
1521
|
*/
|
|
1513
1522
|
refundInitiated?: RefundInitiated;
|
|
1514
1523
|
/**
|
|
1515
1524
|
* Details of a refunded payment.
|
|
1516
1525
|
*
|
|
1517
|
-
* > **Note:** A single `
|
|
1518
|
-
* > In these cases, the `
|
|
1519
|
-
* @internal
|
|
1526
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1527
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1520
1528
|
*/
|
|
1521
1529
|
paymentRefunded?: PaymentRefunded;
|
|
1522
1530
|
/**
|
|
1523
1531
|
* Details of a failed payment refund.
|
|
1524
1532
|
*
|
|
1525
|
-
* > **Note:** A single `
|
|
1526
|
-
* > In these cases, the `
|
|
1527
|
-
* @internal
|
|
1533
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1534
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1528
1535
|
*/
|
|
1529
1536
|
paymentRefundFailed?: PaymentRefundFailed;
|
|
1530
|
-
/**
|
|
1531
|
-
* Details of refund to store credit.
|
|
1532
|
-
* @internal
|
|
1533
|
-
*/
|
|
1537
|
+
/** Details of refund to store credit. */
|
|
1534
1538
|
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1535
|
-
/**
|
|
1536
|
-
* Details of a pending payment
|
|
1537
|
-
* @internal
|
|
1538
|
-
*/
|
|
1539
|
+
/** Details of a pending payment. */
|
|
1539
1540
|
paymentPending?: PaymentPending;
|
|
1540
|
-
/**
|
|
1541
|
-
* Details of a canceled payment
|
|
1542
|
-
* @internal
|
|
1543
|
-
*/
|
|
1541
|
+
/** Details of a canceled payment. */
|
|
1544
1542
|
paymentCanceled?: PaymentCanceled;
|
|
1545
|
-
/**
|
|
1546
|
-
* Details of a declined payment
|
|
1547
|
-
* @internal
|
|
1548
|
-
*/
|
|
1543
|
+
/** Details of a declined payment. */
|
|
1549
1544
|
paymentDeclined?: PaymentDeclined;
|
|
1550
|
-
/**
|
|
1551
|
-
* Receipt was added for associated payment
|
|
1552
|
-
* @internal
|
|
1553
|
-
*/
|
|
1545
|
+
/** Receipt was added for associated payment. */
|
|
1554
1546
|
receiptCreated?: ReceiptCreated;
|
|
1555
|
-
/**
|
|
1556
|
-
* Receipt sent to customer
|
|
1557
|
-
* @internal
|
|
1558
|
-
*/
|
|
1547
|
+
/** Receipt sent to customer. */
|
|
1559
1548
|
receiptSent?: ReceiptSent;
|
|
1560
|
-
/**
|
|
1561
|
-
* Order received a chargeback for one of its' payments.
|
|
1562
|
-
* @internal
|
|
1563
|
-
*/
|
|
1549
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1564
1550
|
chargebackCreated?: ChargebackCreated;
|
|
1565
|
-
/**
|
|
1566
|
-
* Chargeback reversed for one of the order's payments.
|
|
1567
|
-
* @internal
|
|
1568
|
-
*/
|
|
1551
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1569
1552
|
chargebackReversed?: ChargebackReversed;
|
|
1570
1553
|
/**
|
|
1571
1554
|
* Activity ID.
|
|
@@ -1595,69 +1578,52 @@ interface ActivityContentOneOf {
|
|
|
1595
1578
|
merchantComment?: MerchantComment;
|
|
1596
1579
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1597
1580
|
orderRefunded?: OrderRefunded;
|
|
1581
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1582
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1583
|
+
/** Details of the payment method saved for order */
|
|
1584
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1585
|
+
/** Details of an authorized payment created. */
|
|
1586
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1587
|
+
/** Details of an authorized payment captured. */
|
|
1588
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1589
|
+
/** Details of an authorized payment voided. */
|
|
1590
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1598
1591
|
/**
|
|
1599
1592
|
* Details of an initiated refund process.
|
|
1600
1593
|
*
|
|
1601
|
-
* > **Note:** A single `
|
|
1602
|
-
* > In these cases, the `
|
|
1603
|
-
* @internal
|
|
1594
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1595
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1604
1596
|
*/
|
|
1605
1597
|
refundInitiated?: RefundInitiated;
|
|
1606
1598
|
/**
|
|
1607
1599
|
* Details of a refunded payment.
|
|
1608
1600
|
*
|
|
1609
|
-
* > **Note:** A single `
|
|
1610
|
-
* > In these cases, the `
|
|
1611
|
-
* @internal
|
|
1601
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1602
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1612
1603
|
*/
|
|
1613
1604
|
paymentRefunded?: PaymentRefunded;
|
|
1614
1605
|
/**
|
|
1615
1606
|
* Details of a failed payment refund.
|
|
1616
1607
|
*
|
|
1617
|
-
* > **Note:** A single `
|
|
1618
|
-
* > In these cases, the `
|
|
1619
|
-
* @internal
|
|
1608
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1609
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1620
1610
|
*/
|
|
1621
1611
|
paymentRefundFailed?: PaymentRefundFailed;
|
|
1622
|
-
/**
|
|
1623
|
-
* Details of refund to store credit.
|
|
1624
|
-
* @internal
|
|
1625
|
-
*/
|
|
1612
|
+
/** Details of refund to store credit. */
|
|
1626
1613
|
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1627
|
-
/**
|
|
1628
|
-
* Details of a pending payment
|
|
1629
|
-
* @internal
|
|
1630
|
-
*/
|
|
1614
|
+
/** Details of a pending payment. */
|
|
1631
1615
|
paymentPending?: PaymentPending;
|
|
1632
|
-
/**
|
|
1633
|
-
* Details of a canceled payment
|
|
1634
|
-
* @internal
|
|
1635
|
-
*/
|
|
1616
|
+
/** Details of a canceled payment. */
|
|
1636
1617
|
paymentCanceled?: PaymentCanceled;
|
|
1637
|
-
/**
|
|
1638
|
-
* Details of a declined payment
|
|
1639
|
-
* @internal
|
|
1640
|
-
*/
|
|
1618
|
+
/** Details of a declined payment. */
|
|
1641
1619
|
paymentDeclined?: PaymentDeclined;
|
|
1642
|
-
/**
|
|
1643
|
-
* Receipt was added for associated payment
|
|
1644
|
-
* @internal
|
|
1645
|
-
*/
|
|
1620
|
+
/** Receipt was added for associated payment. */
|
|
1646
1621
|
receiptCreated?: ReceiptCreated;
|
|
1647
|
-
/**
|
|
1648
|
-
* Receipt sent to customer
|
|
1649
|
-
* @internal
|
|
1650
|
-
*/
|
|
1622
|
+
/** Receipt sent to customer. */
|
|
1651
1623
|
receiptSent?: ReceiptSent;
|
|
1652
|
-
/**
|
|
1653
|
-
* Order received a chargeback for one of its' payments.
|
|
1654
|
-
* @internal
|
|
1655
|
-
*/
|
|
1624
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1656
1625
|
chargebackCreated?: ChargebackCreated;
|
|
1657
|
-
/**
|
|
1658
|
-
* Chargeback reversed for one of the order's payments.
|
|
1659
|
-
* @internal
|
|
1660
|
-
*/
|
|
1626
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1661
1627
|
chargebackReversed?: ChargebackReversed;
|
|
1662
1628
|
}
|
|
1663
1629
|
interface CustomActivity {
|
|
@@ -2230,44 +2196,139 @@ interface ChargebackReversed {
|
|
|
2230
2196
|
paymentDetails?: RegularPayment;
|
|
2231
2197
|
}
|
|
2232
2198
|
declare enum ActivityType {
|
|
2199
|
+
/** Order was refunded, either partially or fully. */
|
|
2233
2200
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2201
|
+
/** New order was created and placed. */
|
|
2234
2202
|
ORDER_PLACED = "ORDER_PLACED",
|
|
2203
|
+
/** Order payment was completed and confirmed. */
|
|
2235
2204
|
ORDER_PAID = "ORDER_PAID",
|
|
2205
|
+
/** Order items were marked as fulfilled (shipped or ready for pickup). */
|
|
2236
2206
|
ORDER_FULFILLED = "ORDER_FULFILLED",
|
|
2207
|
+
/** Order fulfillment status was changed to not fulfilled. */
|
|
2237
2208
|
ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
|
|
2209
|
+
/** Order was canceled by merchant or customer. */
|
|
2238
2210
|
ORDER_CANCELED = "ORDER_CANCELED",
|
|
2211
|
+
/** Download link was sent for digital items in the order. */
|
|
2239
2212
|
DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
|
|
2213
|
+
/** Shipping tracking number was added to the order. */
|
|
2240
2214
|
TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
|
|
2215
|
+
/** Existing shipping tracking number was modified. */
|
|
2241
2216
|
TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
|
|
2217
|
+
/** Tracking link for shipment was added to the order. */
|
|
2242
2218
|
TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
|
|
2219
|
+
/** Email confirming shipment was sent to the customer. */
|
|
2243
2220
|
SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
|
|
2221
|
+
/** Invoice document was added to the order. */
|
|
2244
2222
|
INVOICE_ADDED = "INVOICE_ADDED",
|
|
2223
|
+
/** Invoice was removed from the order. */
|
|
2245
2224
|
INVOICE_REMOVED = "INVOICE_REMOVED",
|
|
2225
|
+
/** Invoice was sent to the customer via email. */
|
|
2246
2226
|
INVOICE_SENT = "INVOICE_SENT",
|
|
2227
|
+
/** Notification email was sent to the order fulfiller. */
|
|
2247
2228
|
FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
|
|
2229
|
+
/** Order's shipping address was modified. */
|
|
2248
2230
|
SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
|
|
2231
|
+
/** Order's contact email address was changed. */
|
|
2249
2232
|
EMAIL_EDITED = "EMAIL_EDITED",
|
|
2233
|
+
/** Email notification for pickup readiness was sent. */
|
|
2250
2234
|
PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
|
|
2235
|
+
/** Custom activity created by a third-party application. */
|
|
2251
2236
|
CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
|
|
2237
|
+
/** Comment added to the order by a merchant. */
|
|
2252
2238
|
MERCHANT_COMMENT = "MERCHANT_COMMENT",
|
|
2239
|
+
/** Order was created as a result of an exchange. */
|
|
2253
2240
|
ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
|
|
2241
|
+
/** New exchange order was created from this order. */
|
|
2254
2242
|
NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
|
|
2243
|
+
/** Partial payment was received for the order. */
|
|
2255
2244
|
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
|
|
2245
|
+
/** Changes were applied to a draft order. */
|
|
2256
2246
|
DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
|
|
2247
|
+
/** Payment method was saved for future use. */
|
|
2257
2248
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
2258
|
-
/**
|
|
2249
|
+
/**
|
|
2250
|
+
* Payment was authorized but not yet captured.
|
|
2251
|
+
* @documentationMaturity preview
|
|
2252
|
+
*/
|
|
2253
|
+
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
2254
|
+
/**
|
|
2255
|
+
* Previously authorized payment was captured.
|
|
2256
|
+
* @documentationMaturity preview
|
|
2257
|
+
*/
|
|
2258
|
+
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
2259
|
+
/**
|
|
2260
|
+
* Previously authorized payment was voided.
|
|
2261
|
+
* @documentationMaturity preview
|
|
2262
|
+
*/
|
|
2263
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
2264
|
+
/**
|
|
2265
|
+
* Refund process was initiated.
|
|
2266
|
+
* @documentationMaturity preview
|
|
2267
|
+
*/
|
|
2268
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
2269
|
+
/**
|
|
2270
|
+
* Payment was successfully refunded.
|
|
2271
|
+
* @documentationMaturity preview
|
|
2272
|
+
*/
|
|
2273
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
2274
|
+
/**
|
|
2275
|
+
* Attempt to refund payment failed.
|
|
2276
|
+
* @documentationMaturity preview
|
|
2277
|
+
*/
|
|
2278
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED",
|
|
2279
|
+
/**
|
|
2280
|
+
* Refund was issued as store credit.
|
|
2281
|
+
* @documentationMaturity preview
|
|
2282
|
+
*/
|
|
2283
|
+
REFUNDED_AS_STORE_CREDIT = "REFUNDED_AS_STORE_CREDIT",
|
|
2284
|
+
/**
|
|
2285
|
+
* Payment is awaiting processing or confirmation.
|
|
2286
|
+
* @documentationMaturity preview
|
|
2287
|
+
*/
|
|
2259
2288
|
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
2260
|
-
/**
|
|
2289
|
+
/**
|
|
2290
|
+
* Payment was canceled before completion.
|
|
2291
|
+
* @documentationMaturity preview
|
|
2292
|
+
*/
|
|
2261
2293
|
PAYMENT_CANCELED = "PAYMENT_CANCELED",
|
|
2262
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Payment was declined by payment provider.
|
|
2296
|
+
* @documentationMaturity preview
|
|
2297
|
+
*/
|
|
2263
2298
|
PAYMENT_DECLINED = "PAYMENT_DECLINED",
|
|
2264
|
-
/**
|
|
2299
|
+
/**
|
|
2300
|
+
* Order is awaiting approval or processing.
|
|
2301
|
+
* @documentationMaturity preview
|
|
2302
|
+
*/
|
|
2265
2303
|
ORDER_PENDING = "ORDER_PENDING",
|
|
2266
|
-
/**
|
|
2267
|
-
|
|
2304
|
+
/**
|
|
2305
|
+
* Order was rejected by merchant.
|
|
2306
|
+
* @documentationMaturity preview
|
|
2307
|
+
*/
|
|
2308
|
+
ORDER_REJECTED = "ORDER_REJECTED",
|
|
2309
|
+
/**
|
|
2310
|
+
* Receipt was generated for a payment.
|
|
2311
|
+
* @documentationMaturity preview
|
|
2312
|
+
*/
|
|
2313
|
+
RECEIPT_CREATED = "RECEIPT_CREATED",
|
|
2314
|
+
/**
|
|
2315
|
+
* Receipt was sent to the customer.
|
|
2316
|
+
* @documentationMaturity preview
|
|
2317
|
+
*/
|
|
2318
|
+
RECEIPT_SENT = "RECEIPT_SENT",
|
|
2319
|
+
/**
|
|
2320
|
+
* Chargeback was created for one of the order's payments.
|
|
2321
|
+
* @documentationMaturity preview
|
|
2322
|
+
*/
|
|
2323
|
+
CHARGEBACK_CREATED = "CHARGEBACK_CREATED",
|
|
2324
|
+
/**
|
|
2325
|
+
* Chargeback was resolved in merchant's favor.
|
|
2326
|
+
* @documentationMaturity preview
|
|
2327
|
+
*/
|
|
2328
|
+
CHARGEBACK_REVERSED = "CHARGEBACK_REVERSED"
|
|
2268
2329
|
}
|
|
2269
2330
|
/** @enumType */
|
|
2270
|
-
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';
|
|
2331
|
+
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';
|
|
2271
2332
|
declare enum AttributionSource {
|
|
2272
2333
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2273
2334
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
@@ -2414,7 +2475,6 @@ interface BalanceSummary {
|
|
|
2414
2475
|
authorized?: Price;
|
|
2415
2476
|
/**
|
|
2416
2477
|
* Sum of all pending refund transactions.
|
|
2417
|
-
* @internal
|
|
2418
2478
|
* @readonly
|
|
2419
2479
|
*/
|
|
2420
2480
|
pendingRefund?: Price;
|
|
@@ -2425,13 +2485,11 @@ interface BalanceSummary {
|
|
|
2425
2485
|
pending?: Price;
|
|
2426
2486
|
/**
|
|
2427
2487
|
* Sum of all transaction chargebacks.
|
|
2428
|
-
* @internal
|
|
2429
2488
|
* @readonly
|
|
2430
2489
|
*/
|
|
2431
2490
|
chargeback?: Price;
|
|
2432
2491
|
/**
|
|
2433
2492
|
* Sum of all chargeback reversals.
|
|
2434
|
-
* @internal
|
|
2435
2493
|
* @readonly
|
|
2436
2494
|
*/
|
|
2437
2495
|
chargebackReversal?: Price;
|
|
@@ -5193,68 +5251,56 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5193
5251
|
newExchangeOrderCreated?: NewExchangeOrderCreated;
|
|
5194
5252
|
/** Order partially paid. During the checkout for orders with deposit items. */
|
|
5195
5253
|
orderPartiallyPaid?: OrderPartiallyPaid;
|
|
5196
|
-
/** Draft order changes applied */
|
|
5254
|
+
/** Draft order changes applied. */
|
|
5197
5255
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5198
|
-
/** Payment method is saved for order */
|
|
5256
|
+
/** Payment method is saved for order. */
|
|
5199
5257
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5258
|
+
/** Details of an authorized payment created. */
|
|
5259
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
5260
|
+
/** Details of an authorized payment captured. */
|
|
5261
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
5262
|
+
/** Details of an authorized payment voided. */
|
|
5263
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
5200
5264
|
/**
|
|
5201
5265
|
* Details of an initiated refund process.
|
|
5202
5266
|
*
|
|
5203
|
-
* > **Note:** A single `
|
|
5204
|
-
* > In these cases, the `
|
|
5205
|
-
* @internal
|
|
5267
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5268
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5206
5269
|
*/
|
|
5207
5270
|
refundInitiated?: RefundInitiated;
|
|
5208
5271
|
/**
|
|
5209
5272
|
* Details of a refunded payment.
|
|
5210
5273
|
*
|
|
5211
|
-
* > **Note:** A single `
|
|
5212
|
-
* > In these cases, the `
|
|
5213
|
-
* @internal
|
|
5274
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5275
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5214
5276
|
*/
|
|
5215
5277
|
paymentRefunded?: PaymentRefunded;
|
|
5216
5278
|
/**
|
|
5217
5279
|
* Details of a failed payment refund.
|
|
5218
5280
|
*
|
|
5219
|
-
* > **Note:** A single `
|
|
5220
|
-
* > In these cases, the `
|
|
5221
|
-
* @internal
|
|
5281
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5282
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5222
5283
|
*/
|
|
5223
5284
|
paymentRefundFailed?: PaymentRefundFailed;
|
|
5224
|
-
/**
|
|
5225
|
-
* Details of refund to store credit.
|
|
5226
|
-
* @internal
|
|
5227
|
-
*/
|
|
5285
|
+
/** Details of refund to store credit. */
|
|
5228
5286
|
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5229
|
-
/** Details of a pending payment */
|
|
5287
|
+
/** Details of a pending payment. */
|
|
5230
5288
|
paymentPending?: PaymentPending;
|
|
5231
|
-
/** Details of a canceled payment */
|
|
5289
|
+
/** Details of a canceled payment. */
|
|
5232
5290
|
paymentCanceled?: PaymentCanceled;
|
|
5233
|
-
/** Details of a declined payment */
|
|
5291
|
+
/** Details of a declined payment. */
|
|
5234
5292
|
paymentDeclined?: PaymentDeclined;
|
|
5235
|
-
/** Order pending */
|
|
5293
|
+
/** Order pending. */
|
|
5236
5294
|
orderPending?: OrderPending;
|
|
5237
|
-
/** Order rejected */
|
|
5295
|
+
/** Order rejected. */
|
|
5238
5296
|
orderRejected?: OrderRejected;
|
|
5239
|
-
/**
|
|
5240
|
-
* Receipt was added for associated payment
|
|
5241
|
-
* @internal
|
|
5242
|
-
*/
|
|
5297
|
+
/** Receipt was added for associated payment. */
|
|
5243
5298
|
receiptCreated?: ReceiptCreated;
|
|
5244
|
-
/**
|
|
5245
|
-
* Receipt sent to customer
|
|
5246
|
-
* @internal
|
|
5247
|
-
*/
|
|
5299
|
+
/** Receipt sent to customer. */
|
|
5248
5300
|
receiptSent?: ReceiptSent;
|
|
5249
|
-
/**
|
|
5250
|
-
* Chargeback created for one of the order's payments.
|
|
5251
|
-
* @internal
|
|
5252
|
-
*/
|
|
5301
|
+
/** Chargeback created for one of the order's payments. */
|
|
5253
5302
|
chargebackCreated?: ChargebackCreated;
|
|
5254
|
-
/**
|
|
5255
|
-
* Chargeback reversed for one of the order's payments.
|
|
5256
|
-
* @internal
|
|
5257
|
-
*/
|
|
5303
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
5258
5304
|
chargebackReversed?: ChargebackReversed;
|
|
5259
5305
|
/**
|
|
5260
5306
|
* Internal activity ID.
|
|
@@ -5316,68 +5362,56 @@ interface InternalActivityContentOneOf {
|
|
|
5316
5362
|
newExchangeOrderCreated?: NewExchangeOrderCreated;
|
|
5317
5363
|
/** Order partially paid. During the checkout for orders with deposit items. */
|
|
5318
5364
|
orderPartiallyPaid?: OrderPartiallyPaid;
|
|
5319
|
-
/** Draft order changes applied */
|
|
5365
|
+
/** Draft order changes applied. */
|
|
5320
5366
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5321
|
-
/** Payment method is saved for order */
|
|
5367
|
+
/** Payment method is saved for order. */
|
|
5322
5368
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5369
|
+
/** Details of an authorized payment created. */
|
|
5370
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
5371
|
+
/** Details of an authorized payment captured. */
|
|
5372
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
5373
|
+
/** Details of an authorized payment voided. */
|
|
5374
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
5323
5375
|
/**
|
|
5324
5376
|
* Details of an initiated refund process.
|
|
5325
5377
|
*
|
|
5326
|
-
* > **Note:** A single `
|
|
5327
|
-
* > In these cases, the `
|
|
5328
|
-
* @internal
|
|
5378
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5379
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5329
5380
|
*/
|
|
5330
5381
|
refundInitiated?: RefundInitiated;
|
|
5331
5382
|
/**
|
|
5332
5383
|
* Details of a refunded payment.
|
|
5333
5384
|
*
|
|
5334
|
-
* > **Note:** A single `
|
|
5335
|
-
* > In these cases, the `
|
|
5336
|
-
* @internal
|
|
5385
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5386
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5337
5387
|
*/
|
|
5338
5388
|
paymentRefunded?: PaymentRefunded;
|
|
5339
5389
|
/**
|
|
5340
5390
|
* Details of a failed payment refund.
|
|
5341
5391
|
*
|
|
5342
|
-
* > **Note:** A single `
|
|
5343
|
-
* > In these cases, the `
|
|
5344
|
-
* @internal
|
|
5392
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
5393
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
5345
5394
|
*/
|
|
5346
5395
|
paymentRefundFailed?: PaymentRefundFailed;
|
|
5347
|
-
/**
|
|
5348
|
-
* Details of refund to store credit.
|
|
5349
|
-
* @internal
|
|
5350
|
-
*/
|
|
5396
|
+
/** Details of refund to store credit. */
|
|
5351
5397
|
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5352
|
-
/** Details of a pending payment */
|
|
5398
|
+
/** Details of a pending payment. */
|
|
5353
5399
|
paymentPending?: PaymentPending;
|
|
5354
|
-
/** Details of a canceled payment */
|
|
5400
|
+
/** Details of a canceled payment. */
|
|
5355
5401
|
paymentCanceled?: PaymentCanceled;
|
|
5356
|
-
/** Details of a declined payment */
|
|
5402
|
+
/** Details of a declined payment. */
|
|
5357
5403
|
paymentDeclined?: PaymentDeclined;
|
|
5358
|
-
/** Order pending */
|
|
5404
|
+
/** Order pending. */
|
|
5359
5405
|
orderPending?: OrderPending;
|
|
5360
|
-
/** Order rejected */
|
|
5406
|
+
/** Order rejected. */
|
|
5361
5407
|
orderRejected?: OrderRejected;
|
|
5362
|
-
/**
|
|
5363
|
-
* Receipt was added for associated payment
|
|
5364
|
-
* @internal
|
|
5365
|
-
*/
|
|
5408
|
+
/** Receipt was added for associated payment. */
|
|
5366
5409
|
receiptCreated?: ReceiptCreated;
|
|
5367
|
-
/**
|
|
5368
|
-
* Receipt sent to customer
|
|
5369
|
-
* @internal
|
|
5370
|
-
*/
|
|
5410
|
+
/** Receipt sent to customer. */
|
|
5371
5411
|
receiptSent?: ReceiptSent;
|
|
5372
|
-
/**
|
|
5373
|
-
* Chargeback created for one of the order's payments.
|
|
5374
|
-
* @internal
|
|
5375
|
-
*/
|
|
5412
|
+
/** Chargeback created for one of the order's payments. */
|
|
5376
5413
|
chargebackCreated?: ChargebackCreated;
|
|
5377
|
-
/**
|
|
5378
|
-
* Chargeback reversed for one of the order's payments.
|
|
5379
|
-
* @internal
|
|
5380
|
-
*/
|
|
5414
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
5381
5415
|
chargebackReversed?: ChargebackReversed;
|
|
5382
5416
|
}
|
|
5383
5417
|
/** Order placed */
|
|
@@ -6351,6 +6385,10 @@ type PreparePaymentCollectionApplicationErrors = {
|
|
|
6351
6385
|
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
6352
6386
|
description?: string;
|
|
6353
6387
|
data?: Record<string, any>;
|
|
6388
|
+
} | {
|
|
6389
|
+
code?: 'ORDER_HAS_CHARGEBACKS';
|
|
6390
|
+
description?: string;
|
|
6391
|
+
data?: Record<string, any>;
|
|
6354
6392
|
};
|
|
6355
6393
|
/** @docsIgnore */
|
|
6356
6394
|
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
@@ -6375,6 +6413,10 @@ type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
|
6375
6413
|
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6376
6414
|
description?: string;
|
|
6377
6415
|
data?: Record<string, any>;
|
|
6416
|
+
} | {
|
|
6417
|
+
code?: 'ORDER_HAS_CHARGEBACKS';
|
|
6418
|
+
description?: string;
|
|
6419
|
+
data?: Record<string, any>;
|
|
6378
6420
|
};
|
|
6379
6421
|
/** @docsIgnore */
|
|
6380
6422
|
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
@@ -6732,6 +6774,17 @@ interface PreparePaymentCollectionOptions {
|
|
|
6732
6774
|
* @targetRemovalDate 2024-09-30
|
|
6733
6775
|
*/
|
|
6734
6776
|
delayedCapture?: boolean;
|
|
6777
|
+
/**
|
|
6778
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
6779
|
+
* Default: `true`
|
|
6780
|
+
* @internal
|
|
6781
|
+
*/
|
|
6782
|
+
merchantInitiated?: boolean | null;
|
|
6783
|
+
/**
|
|
6784
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
6785
|
+
* @internal
|
|
6786
|
+
*/
|
|
6787
|
+
redirectUrls?: RedirectUrls;
|
|
6735
6788
|
/** Delayed capture payment settings */
|
|
6736
6789
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6737
6790
|
}
|
|
@@ -6780,7 +6833,7 @@ declare function recordManuallyCollectedPayment(orderId: string, amount: Price):
|
|
|
6780
6833
|
* @applicableIdentity APP
|
|
6781
6834
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
6782
6835
|
*/
|
|
6783
|
-
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, `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> & {
|
|
6836
|
+
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, `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> & {
|
|
6784
6837
|
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
6785
6838
|
}>;
|
|
6786
6839
|
/**
|
|
@@ -6928,7 +6981,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
|
|
|
6928
6981
|
* @returns Fulfilled - The requested order.
|
|
6929
6982
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
6930
6983
|
*/
|
|
6931
|
-
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> & {
|
|
6984
|
+
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> & {
|
|
6932
6985
|
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
6933
6986
|
}>;
|
|
6934
6987
|
interface OrderSearchSpec extends SearchSpec {
|
|
@@ -7082,7 +7135,7 @@ type OrderSearch = {
|
|
|
7082
7135
|
* @returns Newly created order.
|
|
7083
7136
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
7084
7137
|
*/
|
|
7085
|
-
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> & {
|
|
7138
|
+
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> & {
|
|
7086
7139
|
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
7087
7140
|
}>;
|
|
7088
7141
|
interface CreateOrderOptions {
|
|
@@ -7125,7 +7178,7 @@ interface CreateOrderOptions {
|
|
|
7125
7178
|
* @returns Newly created order.
|
|
7126
7179
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
7127
7180
|
*/
|
|
7128
|
-
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> & {
|
|
7181
|
+
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> & {
|
|
7129
7182
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
7130
7183
|
}>;
|
|
7131
7184
|
interface UpdateOrder {
|
|
@@ -7357,7 +7410,7 @@ interface BulkUpdateOrdersOptions {
|
|
|
7357
7410
|
* @applicableIdentity APP
|
|
7358
7411
|
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
7359
7412
|
*/
|
|
7360
|
-
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`, 4>): Promise<NonNullablePaths<CommitDeltasResponse, `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> & {
|
|
7413
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`, 4>): Promise<NonNullablePaths<CommitDeltasResponse, `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> & {
|
|
7361
7414
|
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
7362
7415
|
}>;
|
|
7363
7416
|
interface CommitDeltasOptions {
|
|
@@ -7389,7 +7442,7 @@ interface CommitDeltasOptions {
|
|
|
7389
7442
|
* @deprecated
|
|
7390
7443
|
* @targetRemovalDate 2024-02-15
|
|
7391
7444
|
*/
|
|
7392
|
-
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`, 2>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, `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>>;
|
|
7445
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`, 2>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, `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>>;
|
|
7393
7446
|
interface UpdateOrderLineItemIdentifiers {
|
|
7394
7447
|
/**
|
|
7395
7448
|
* Order ID
|
|
@@ -7548,7 +7601,7 @@ interface UpdateOrderLineItem {
|
|
|
7548
7601
|
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
7549
7602
|
* @targetRemovalDate 2024-11-01
|
|
7550
7603
|
*/
|
|
7551
|
-
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, `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` | `activityId`, 7>>;
|
|
7604
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, `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` | `activityId`, 7>>;
|
|
7552
7605
|
/**
|
|
7553
7606
|
* Updates an order's activity.
|
|
7554
7607
|
* @param activity - Activity info.
|
|
@@ -7562,7 +7615,7 @@ declare function addActivity(_id: string, activity: PublicActivity): Promise<Non
|
|
|
7562
7615
|
* @applicableIdentity APP
|
|
7563
7616
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
7564
7617
|
*/
|
|
7565
|
-
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`, 2>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, `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>>;
|
|
7618
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`, 2>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, `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>>;
|
|
7566
7619
|
interface UpdateActivityIdentifiers {
|
|
7567
7620
|
/**
|
|
7568
7621
|
* Order ID.
|
|
@@ -7589,7 +7642,7 @@ interface UpdateActivityIdentifiers {
|
|
|
7589
7642
|
* @applicableIdentity APP
|
|
7590
7643
|
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
7591
7644
|
*/
|
|
7592
|
-
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`, 2>): Promise<NonNullablePaths<DeleteActivityResponse, `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>>;
|
|
7645
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`, 2>): Promise<NonNullablePaths<DeleteActivityResponse, `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>>;
|
|
7593
7646
|
interface DeleteActivityIdentifiers {
|
|
7594
7647
|
/**
|
|
7595
7648
|
* Order ID.
|
|
@@ -7615,7 +7668,7 @@ interface DeleteActivityIdentifiers {
|
|
|
7615
7668
|
* @applicableIdentity APP
|
|
7616
7669
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
7617
7670
|
*/
|
|
7618
|
-
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> & {
|
|
7671
|
+
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> & {
|
|
7619
7672
|
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
7620
7673
|
}>;
|
|
7621
7674
|
interface CancelOrderOptions {
|
|
@@ -7654,7 +7707,7 @@ interface CancelOrderOptions {
|
|
|
7654
7707
|
* @applicableIdentity APP
|
|
7655
7708
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
7656
7709
|
*/
|
|
7657
|
-
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, `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> & {
|
|
7710
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, `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> & {
|
|
7658
7711
|
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
7659
7712
|
}>;
|
|
7660
7713
|
/** @internal
|