@wix/auto_sdk_ecom_orders 1.0.69 → 1.0.70
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/{internal/cjs/ecom-v1-order-orders.universal-BAE6DVkA.d.ts → cjs/ecom-v1-order-orders.universal-C73TYoI7.d.ts} +1857 -885
- package/build/cjs/index.d.ts +59 -6
- package/build/cjs/index.js +1118 -56
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +1295 -333
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1006 -38
- package/build/cjs/meta.js +665 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-BAE6DVkA.d.mts → es/ecom-v1-order-orders.universal-C73TYoI7.d.mts} +1857 -885
- package/build/es/index.d.mts +59 -6
- package/build/es/index.mjs +1090 -55
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +1267 -332
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1006 -38
- package/build/es/meta.mjs +653 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-Br3Nippn.d.ts → internal/cjs/ecom-v1-order-orders.universal-KCtJReRk.d.ts} +2528 -365
- package/build/internal/cjs/index.d.ts +165 -6
- package/build/internal/cjs/index.js +1118 -56
- 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 +1295 -333
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1006 -38
- package/build/internal/cjs/meta.js +665 -3
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-Br3Nippn.d.mts → internal/es/ecom-v1-order-orders.universal-KCtJReRk.d.mts} +2528 -365
- package/build/internal/es/index.d.mts +165 -6
- package/build/internal/es/index.mjs +1090 -55
- 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 +1267 -332
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1006 -38
- package/build/internal/es/meta.mjs +653 -2
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -283,12 +283,25 @@ interface OrderLineItem {
|
|
|
283
283
|
locations?: LocationAndQuantity[];
|
|
284
284
|
/** Address used for tax calculation. */
|
|
285
285
|
taxableAddress?: TaxableAddress;
|
|
286
|
+
/**
|
|
287
|
+
* ID of the app managing the inventory.
|
|
288
|
+
* @internal
|
|
289
|
+
* @format GUID
|
|
290
|
+
*/
|
|
291
|
+
inventoryAppId?: string | null;
|
|
286
292
|
/**
|
|
287
293
|
* Custom extended fields for the line item object.
|
|
288
294
|
*
|
|
289
295
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
290
296
|
*/
|
|
291
297
|
extendedFields?: ExtendedFields;
|
|
298
|
+
/**
|
|
299
|
+
* Modifier groups that were added to the item.
|
|
300
|
+
* @internal
|
|
301
|
+
* @readonly
|
|
302
|
+
* @maxSize 10
|
|
303
|
+
*/
|
|
304
|
+
modifierGroups?: ModifierGroup[];
|
|
292
305
|
}
|
|
293
306
|
interface ProductName {
|
|
294
307
|
/**
|
|
@@ -359,6 +372,11 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
359
372
|
colorInfo?: Color;
|
|
360
373
|
/** Description line name. */
|
|
361
374
|
name?: DescriptionLineName;
|
|
375
|
+
/**
|
|
376
|
+
* Whether the description line originates from a modifier.
|
|
377
|
+
* @internal
|
|
378
|
+
*/
|
|
379
|
+
modifierDescriptionLine?: boolean;
|
|
362
380
|
}
|
|
363
381
|
/** @oneof */
|
|
364
382
|
interface DescriptionLineValueOneOf {
|
|
@@ -603,6 +621,11 @@ interface SubscriptionInfo {
|
|
|
603
621
|
* @targetRemovalDate 2025-10-01
|
|
604
622
|
*/
|
|
605
623
|
subscriptionOptionTitle?: string;
|
|
624
|
+
/**
|
|
625
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
title?: SubscriptionTitle;
|
|
606
629
|
/**
|
|
607
630
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
608
631
|
* @maxLength 60
|
|
@@ -611,6 +634,11 @@ interface SubscriptionInfo {
|
|
|
611
634
|
* @targetRemovalDate 2025-10-01
|
|
612
635
|
*/
|
|
613
636
|
subscriptionOptionDescription?: string | null;
|
|
637
|
+
/**
|
|
638
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
639
|
+
* @internal
|
|
640
|
+
*/
|
|
641
|
+
description?: SubscriptionDescription;
|
|
614
642
|
/**
|
|
615
643
|
* Subscription detailed information.
|
|
616
644
|
* @immutable
|
|
@@ -621,6 +649,11 @@ interface SubscriptionInfo {
|
|
|
621
649
|
* @maxLength 1000
|
|
622
650
|
*/
|
|
623
651
|
chargesDescription?: string | null;
|
|
652
|
+
/**
|
|
653
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
654
|
+
* @internal
|
|
655
|
+
*/
|
|
656
|
+
billingAdjustment?: BillingAdjustment;
|
|
624
657
|
}
|
|
625
658
|
interface SubscriptionTitle {
|
|
626
659
|
/**
|
|
@@ -670,6 +703,11 @@ interface SubscriptionSettings {
|
|
|
670
703
|
enableCustomerCancellation?: boolean;
|
|
671
704
|
/** Period until first cycle starts. If None => no free trial */
|
|
672
705
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
706
|
+
/**
|
|
707
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
708
|
+
* @internal
|
|
709
|
+
*/
|
|
710
|
+
startDate?: Date | null;
|
|
673
711
|
}
|
|
674
712
|
/** Frequency unit of recurring payment */
|
|
675
713
|
declare enum SubscriptionFrequency {
|
|
@@ -1346,6 +1384,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1346
1384
|
* @immutable
|
|
1347
1385
|
*/
|
|
1348
1386
|
_id?: string | null;
|
|
1387
|
+
/**
|
|
1388
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1389
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1390
|
+
* @internal
|
|
1391
|
+
* @min 1
|
|
1392
|
+
* @max 999
|
|
1393
|
+
*/
|
|
1394
|
+
subscriptionCycles?: number | null;
|
|
1349
1395
|
}
|
|
1350
1396
|
/** @oneof */
|
|
1351
1397
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -1387,6 +1433,13 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1387
1433
|
description?: string | null;
|
|
1388
1434
|
/** Discount amount. */
|
|
1389
1435
|
amount?: Price;
|
|
1436
|
+
/**
|
|
1437
|
+
* Discount percentage.
|
|
1438
|
+
* @internal
|
|
1439
|
+
* @format DECIMAL_VALUE
|
|
1440
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1441
|
+
*/
|
|
1442
|
+
percentage?: string | null;
|
|
1390
1443
|
}
|
|
1391
1444
|
/** @oneof */
|
|
1392
1445
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -1449,6 +1502,70 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1449
1502
|
merchantComment?: MerchantComment;
|
|
1450
1503
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1451
1504
|
orderRefunded?: OrderRefunded;
|
|
1505
|
+
/**
|
|
1506
|
+
* Details of an initiated refund process.
|
|
1507
|
+
*
|
|
1508
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1509
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1510
|
+
* @internal
|
|
1511
|
+
*/
|
|
1512
|
+
refundInitiated?: RefundInitiated;
|
|
1513
|
+
/**
|
|
1514
|
+
* Details of a refunded payment.
|
|
1515
|
+
*
|
|
1516
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1517
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1518
|
+
* @internal
|
|
1519
|
+
*/
|
|
1520
|
+
paymentRefunded?: PaymentRefunded;
|
|
1521
|
+
/**
|
|
1522
|
+
* Details of a failed payment refund.
|
|
1523
|
+
*
|
|
1524
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1525
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1526
|
+
* @internal
|
|
1527
|
+
*/
|
|
1528
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1529
|
+
/**
|
|
1530
|
+
* Details of refund to store credit.
|
|
1531
|
+
* @internal
|
|
1532
|
+
*/
|
|
1533
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1534
|
+
/**
|
|
1535
|
+
* Details of a pending payment
|
|
1536
|
+
* @internal
|
|
1537
|
+
*/
|
|
1538
|
+
paymentPending?: PaymentPending;
|
|
1539
|
+
/**
|
|
1540
|
+
* Details of a canceled payment
|
|
1541
|
+
* @internal
|
|
1542
|
+
*/
|
|
1543
|
+
paymentCanceled?: PaymentCanceled;
|
|
1544
|
+
/**
|
|
1545
|
+
* Details of a declined payment
|
|
1546
|
+
* @internal
|
|
1547
|
+
*/
|
|
1548
|
+
paymentDeclined?: PaymentDeclined;
|
|
1549
|
+
/**
|
|
1550
|
+
* Receipt was added for associated payment
|
|
1551
|
+
* @internal
|
|
1552
|
+
*/
|
|
1553
|
+
receiptCreated?: ReceiptCreated;
|
|
1554
|
+
/**
|
|
1555
|
+
* Receipt sent to customer
|
|
1556
|
+
* @internal
|
|
1557
|
+
*/
|
|
1558
|
+
receiptSent?: ReceiptSent;
|
|
1559
|
+
/**
|
|
1560
|
+
* Order received a chargeback for one of its' payments.
|
|
1561
|
+
* @internal
|
|
1562
|
+
*/
|
|
1563
|
+
chargebackCreated?: ChargebackCreated;
|
|
1564
|
+
/**
|
|
1565
|
+
* Chargeback reversed for one of the order's payments.
|
|
1566
|
+
* @internal
|
|
1567
|
+
*/
|
|
1568
|
+
chargebackReversed?: ChargebackReversed;
|
|
1452
1569
|
/**
|
|
1453
1570
|
* Activity ID.
|
|
1454
1571
|
* @format GUID
|
|
@@ -1477,6 +1594,70 @@ interface ActivityContentOneOf {
|
|
|
1477
1594
|
merchantComment?: MerchantComment;
|
|
1478
1595
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1479
1596
|
orderRefunded?: OrderRefunded;
|
|
1597
|
+
/**
|
|
1598
|
+
* Details of an initiated refund process.
|
|
1599
|
+
*
|
|
1600
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1601
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1602
|
+
* @internal
|
|
1603
|
+
*/
|
|
1604
|
+
refundInitiated?: RefundInitiated;
|
|
1605
|
+
/**
|
|
1606
|
+
* Details of a refunded payment.
|
|
1607
|
+
*
|
|
1608
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1609
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1610
|
+
* @internal
|
|
1611
|
+
*/
|
|
1612
|
+
paymentRefunded?: PaymentRefunded;
|
|
1613
|
+
/**
|
|
1614
|
+
* Details of a failed payment refund.
|
|
1615
|
+
*
|
|
1616
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1617
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1618
|
+
* @internal
|
|
1619
|
+
*/
|
|
1620
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1621
|
+
/**
|
|
1622
|
+
* Details of refund to store credit.
|
|
1623
|
+
* @internal
|
|
1624
|
+
*/
|
|
1625
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1626
|
+
/**
|
|
1627
|
+
* Details of a pending payment
|
|
1628
|
+
* @internal
|
|
1629
|
+
*/
|
|
1630
|
+
paymentPending?: PaymentPending;
|
|
1631
|
+
/**
|
|
1632
|
+
* Details of a canceled payment
|
|
1633
|
+
* @internal
|
|
1634
|
+
*/
|
|
1635
|
+
paymentCanceled?: PaymentCanceled;
|
|
1636
|
+
/**
|
|
1637
|
+
* Details of a declined payment
|
|
1638
|
+
* @internal
|
|
1639
|
+
*/
|
|
1640
|
+
paymentDeclined?: PaymentDeclined;
|
|
1641
|
+
/**
|
|
1642
|
+
* Receipt was added for associated payment
|
|
1643
|
+
* @internal
|
|
1644
|
+
*/
|
|
1645
|
+
receiptCreated?: ReceiptCreated;
|
|
1646
|
+
/**
|
|
1647
|
+
* Receipt sent to customer
|
|
1648
|
+
* @internal
|
|
1649
|
+
*/
|
|
1650
|
+
receiptSent?: ReceiptSent;
|
|
1651
|
+
/**
|
|
1652
|
+
* Order received a chargeback for one of its' payments.
|
|
1653
|
+
* @internal
|
|
1654
|
+
*/
|
|
1655
|
+
chargebackCreated?: ChargebackCreated;
|
|
1656
|
+
/**
|
|
1657
|
+
* Chargeback reversed for one of the order's payments.
|
|
1658
|
+
* @internal
|
|
1659
|
+
*/
|
|
1660
|
+
chargebackReversed?: ChargebackReversed;
|
|
1480
1661
|
}
|
|
1481
1662
|
interface CustomActivity {
|
|
1482
1663
|
/**
|
|
@@ -2228,11 +2409,29 @@ interface BalanceSummary {
|
|
|
2228
2409
|
* @readonly
|
|
2229
2410
|
*/
|
|
2230
2411
|
authorized?: Price;
|
|
2412
|
+
/**
|
|
2413
|
+
* Sum of all pending refund transactions.
|
|
2414
|
+
* @internal
|
|
2415
|
+
* @readonly
|
|
2416
|
+
*/
|
|
2417
|
+
pendingRefund?: Price;
|
|
2231
2418
|
/**
|
|
2232
2419
|
* Sum of all pending transactions.
|
|
2233
2420
|
* @readonly
|
|
2234
2421
|
*/
|
|
2235
2422
|
pending?: Price;
|
|
2423
|
+
/**
|
|
2424
|
+
* Sum of all transaction chargebacks.
|
|
2425
|
+
* @internal
|
|
2426
|
+
* @readonly
|
|
2427
|
+
*/
|
|
2428
|
+
chargeback?: Price;
|
|
2429
|
+
/**
|
|
2430
|
+
* Sum of all chargeback reversals.
|
|
2431
|
+
* @internal
|
|
2432
|
+
* @readonly
|
|
2433
|
+
*/
|
|
2434
|
+
chargebackReversal?: Price;
|
|
2236
2435
|
}
|
|
2237
2436
|
/**
|
|
2238
2437
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2294,6 +2493,14 @@ interface AdditionalFee {
|
|
|
2294
2493
|
* @format GUID
|
|
2295
2494
|
*/
|
|
2296
2495
|
lineItemIds?: string[];
|
|
2496
|
+
/**
|
|
2497
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
2498
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
2499
|
+
* @internal
|
|
2500
|
+
* @min 1
|
|
2501
|
+
* @max 999
|
|
2502
|
+
*/
|
|
2503
|
+
subscriptionCycles?: number | null;
|
|
2297
2504
|
}
|
|
2298
2505
|
interface FulfillmentStatusesAggregate {
|
|
2299
2506
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -2350,21 +2557,10 @@ interface Location {
|
|
|
2350
2557
|
*/
|
|
2351
2558
|
name?: string;
|
|
2352
2559
|
}
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
entityId?: string;
|
|
2358
|
-
errorInformation?: ErrorInformation;
|
|
2359
|
-
tags?: string[];
|
|
2360
|
-
}
|
|
2361
|
-
interface ErrorInformation {
|
|
2362
|
-
stackTrace?: string;
|
|
2363
|
-
}
|
|
2364
|
-
interface ContinueSideEffectsFlowInLegacyData {
|
|
2365
|
-
storeId?: string;
|
|
2366
|
-
orderId?: string;
|
|
2367
|
-
ordersExperiments?: OrdersExperiments;
|
|
2560
|
+
/** Triggered when the order status changes to approved */
|
|
2561
|
+
interface OrderApproved {
|
|
2562
|
+
/** The order that was updated */
|
|
2563
|
+
order?: Order;
|
|
2368
2564
|
}
|
|
2369
2565
|
interface OrdersExperiments {
|
|
2370
2566
|
epCommitTax?: boolean;
|
|
@@ -2373,20 +2569,6 @@ interface OrdersExperiments {
|
|
|
2373
2569
|
producedByEpBridge?: boolean;
|
|
2374
2570
|
enableRewrittenSideEffects?: boolean;
|
|
2375
2571
|
}
|
|
2376
|
-
interface SnapshotMessage {
|
|
2377
|
-
_id?: string;
|
|
2378
|
-
opType?: number;
|
|
2379
|
-
}
|
|
2380
|
-
interface IndexingMessage {
|
|
2381
|
-
_id?: string;
|
|
2382
|
-
opType?: number;
|
|
2383
|
-
requiredVersions?: string[];
|
|
2384
|
-
}
|
|
2385
|
-
/** Triggered when the order status changes to approved */
|
|
2386
|
-
interface OrderApproved {
|
|
2387
|
-
/** The order that was updated */
|
|
2388
|
-
order?: Order;
|
|
2389
|
-
}
|
|
2390
2572
|
interface OrderRejectedEventOrderRejected {
|
|
2391
2573
|
/** The order that was rejected */
|
|
2392
2574
|
order?: Order;
|
|
@@ -2396,9 +2578,9 @@ interface OrderItemsRestocked {
|
|
|
2396
2578
|
/** The order which items were restocked */
|
|
2397
2579
|
order?: Order;
|
|
2398
2580
|
/** Restocked items and quantities */
|
|
2399
|
-
restockItems?:
|
|
2581
|
+
restockItems?: V1RestockItem[];
|
|
2400
2582
|
}
|
|
2401
|
-
interface
|
|
2583
|
+
interface V1RestockItem {
|
|
2402
2584
|
/**
|
|
2403
2585
|
* ID of the line item being restocked.
|
|
2404
2586
|
* @format GUID
|
|
@@ -2411,129 +2593,1640 @@ interface RestockItem {
|
|
|
2411
2593
|
*/
|
|
2412
2594
|
quantity?: number;
|
|
2413
2595
|
}
|
|
2414
|
-
interface
|
|
2596
|
+
interface PreparePaymentCollectionRequest {
|
|
2415
2597
|
/**
|
|
2416
|
-
*
|
|
2598
|
+
* Ecom order ID.
|
|
2417
2599
|
* @minLength 1
|
|
2418
2600
|
* @maxLength 100
|
|
2419
2601
|
*/
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
/** The requested order. */
|
|
2424
|
-
order?: Order;
|
|
2425
|
-
}
|
|
2426
|
-
interface InternalQueryOrdersRequest {
|
|
2427
|
-
/** Query options. */
|
|
2428
|
-
query?: PlatformQuery;
|
|
2429
|
-
}
|
|
2430
|
-
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2431
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2432
|
-
paging?: PlatformPaging;
|
|
2433
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2434
|
-
cursorPaging?: CursorPaging;
|
|
2435
|
-
/** Filter object. */
|
|
2436
|
-
filter?: Record<string, any> | null;
|
|
2437
|
-
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
2438
|
-
sort?: Sorting[];
|
|
2439
|
-
}
|
|
2440
|
-
/** @oneof */
|
|
2441
|
-
interface PlatformQueryPagingMethodOneOf {
|
|
2442
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2443
|
-
paging?: PlatformPaging;
|
|
2444
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2445
|
-
cursorPaging?: CursorPaging;
|
|
2446
|
-
}
|
|
2447
|
-
interface Sorting {
|
|
2602
|
+
ecomOrderId: string;
|
|
2603
|
+
/** Amount to collect */
|
|
2604
|
+
amount: Price;
|
|
2448
2605
|
/**
|
|
2449
|
-
*
|
|
2450
|
-
*
|
|
2606
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
2607
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
2608
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
2451
2609
|
*/
|
|
2452
|
-
|
|
2453
|
-
/** Sort order. */
|
|
2454
|
-
order?: SortOrderWithLiterals;
|
|
2455
|
-
}
|
|
2456
|
-
declare enum SortOrder {
|
|
2457
|
-
ASC = "ASC",
|
|
2458
|
-
DESC = "DESC"
|
|
2459
|
-
}
|
|
2460
|
-
/** @enumType */
|
|
2461
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2462
|
-
interface PlatformPaging {
|
|
2610
|
+
paymentGatewayOrderId?: string | null;
|
|
2463
2611
|
/**
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2612
|
+
* Whether to delay capture of the payment.
|
|
2613
|
+
* Default: false
|
|
2614
|
+
* @deprecated Whether to delay capture of the payment.
|
|
2615
|
+
* Default: false
|
|
2616
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
2617
|
+
* @targetRemovalDate 2024-09-30
|
|
2466
2618
|
*/
|
|
2467
|
-
|
|
2468
|
-
/**
|
|
2469
|
-
|
|
2619
|
+
delayedCapture?: boolean;
|
|
2620
|
+
/**
|
|
2621
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
2622
|
+
* Default: `true`
|
|
2623
|
+
* @internal
|
|
2624
|
+
*/
|
|
2625
|
+
merchantInitiated?: boolean | null;
|
|
2626
|
+
/**
|
|
2627
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
2628
|
+
* @internal
|
|
2629
|
+
*/
|
|
2630
|
+
redirectUrls?: RedirectUrls;
|
|
2631
|
+
/** Delayed capture payment settings */
|
|
2632
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2470
2633
|
}
|
|
2471
|
-
interface
|
|
2634
|
+
interface RedirectUrls {
|
|
2472
2635
|
/**
|
|
2473
|
-
*
|
|
2474
|
-
* @
|
|
2636
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
2637
|
+
* @format WEB_URL
|
|
2475
2638
|
*/
|
|
2476
|
-
|
|
2639
|
+
successUrl?: string | null;
|
|
2477
2640
|
/**
|
|
2478
|
-
*
|
|
2479
|
-
*
|
|
2480
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2481
|
-
* Not relevant for the first request.
|
|
2482
|
-
* @maxLength 16000
|
|
2641
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
2642
|
+
* @format WEB_URL
|
|
2483
2643
|
*/
|
|
2484
|
-
|
|
2644
|
+
cancelUrl?: string | null;
|
|
2645
|
+
/**
|
|
2646
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
2647
|
+
* @format WEB_URL
|
|
2648
|
+
*/
|
|
2649
|
+
errorUrl?: string | null;
|
|
2650
|
+
/**
|
|
2651
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
2652
|
+
* @format WEB_URL
|
|
2653
|
+
*/
|
|
2654
|
+
pendingUrl?: string | null;
|
|
2485
2655
|
}
|
|
2486
|
-
interface
|
|
2487
|
-
/**
|
|
2488
|
-
|
|
2489
|
-
/**
|
|
2490
|
-
|
|
2656
|
+
interface DelayedCaptureSettings {
|
|
2657
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2658
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
2659
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2660
|
+
delayDuration?: Duration;
|
|
2491
2661
|
}
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
total?: number | null;
|
|
2499
|
-
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
2500
|
-
cursors?: Cursors;
|
|
2662
|
+
declare enum ScheduledAction {
|
|
2663
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
2664
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
2665
|
+
VOID = "VOID",
|
|
2666
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
2667
|
+
CAPTURE = "CAPTURE"
|
|
2501
2668
|
}
|
|
2502
|
-
|
|
2669
|
+
/** @enumType */
|
|
2670
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2671
|
+
interface Duration {
|
|
2503
2672
|
/**
|
|
2504
|
-
*
|
|
2505
|
-
* @
|
|
2673
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2674
|
+
* @min 1
|
|
2506
2675
|
*/
|
|
2507
|
-
|
|
2676
|
+
count?: number;
|
|
2677
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2678
|
+
unit?: DurationUnitWithLiterals;
|
|
2679
|
+
}
|
|
2680
|
+
declare enum DurationUnit {
|
|
2681
|
+
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2682
|
+
MINUTES = "MINUTES",
|
|
2683
|
+
HOURS = "HOURS",
|
|
2684
|
+
DAYS = "DAYS"
|
|
2685
|
+
}
|
|
2686
|
+
/** @enumType */
|
|
2687
|
+
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2688
|
+
interface PreparePaymentCollectionResponse {
|
|
2689
|
+
/** Payment gateway order id which is associated with given payment */
|
|
2690
|
+
paymentGatewayOrderId?: string;
|
|
2691
|
+
}
|
|
2692
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
2508
2693
|
/**
|
|
2509
|
-
*
|
|
2510
|
-
* @
|
|
2694
|
+
* Ecom order ID.
|
|
2695
|
+
* @minLength 1
|
|
2696
|
+
* @maxLength 100
|
|
2511
2697
|
*/
|
|
2512
|
-
|
|
2513
|
-
}
|
|
2514
|
-
interface QueryOrderRequest {
|
|
2515
|
-
/** Query options. */
|
|
2516
|
-
query?: PlatformQuery;
|
|
2698
|
+
ecomOrderId: string;
|
|
2517
2699
|
}
|
|
2518
|
-
interface
|
|
2519
|
-
/**
|
|
2520
|
-
|
|
2521
|
-
/**
|
|
2522
|
-
|
|
2700
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
2701
|
+
/** Payment collectability status */
|
|
2702
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2703
|
+
/** Collectable order amount */
|
|
2704
|
+
amount?: Price;
|
|
2523
2705
|
}
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2706
|
+
declare enum PaymentCollectabilityStatus {
|
|
2707
|
+
UNKNOWN = "UNKNOWN",
|
|
2708
|
+
COLLECTABLE = "COLLECTABLE",
|
|
2709
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
2710
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
2711
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
2712
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
2713
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2714
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2527
2715
|
}
|
|
2528
|
-
|
|
2716
|
+
/** @enumType */
|
|
2717
|
+
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
|
|
2718
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
2529
2719
|
/**
|
|
2530
|
-
*
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
2720
|
+
* Order ID.
|
|
2721
|
+
* @minLength 1
|
|
2722
|
+
* @maxLength 100
|
|
2533
2723
|
*/
|
|
2534
|
-
|
|
2724
|
+
orderId: string;
|
|
2725
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
2726
|
+
amount: Price;
|
|
2727
|
+
}
|
|
2728
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
2729
|
+
}
|
|
2730
|
+
interface MarkOrderAsPaidRequest {
|
|
2535
2731
|
/**
|
|
2536
|
-
*
|
|
2732
|
+
* Ecom order ID.
|
|
2733
|
+
* @minLength 1
|
|
2734
|
+
* @maxLength 100
|
|
2735
|
+
*/
|
|
2736
|
+
ecomOrderId: string;
|
|
2737
|
+
}
|
|
2738
|
+
interface MarkOrderAsPaidResponse {
|
|
2739
|
+
/** Updated order. */
|
|
2740
|
+
order?: Order;
|
|
2741
|
+
}
|
|
2742
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
2743
|
+
/**
|
|
2744
|
+
* IDs of orders to mark as paid.
|
|
2745
|
+
* @minSize 1
|
|
2746
|
+
* @maxSize 100
|
|
2747
|
+
* @minLength 1
|
|
2748
|
+
* @maxLength 100
|
|
2749
|
+
*/
|
|
2750
|
+
ecomOrderIds: string[];
|
|
2751
|
+
}
|
|
2752
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
2753
|
+
/**
|
|
2754
|
+
* Items updated by the bulk action.
|
|
2755
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
2756
|
+
*/
|
|
2757
|
+
results?: BulkOrderResult[];
|
|
2758
|
+
/** Bulk action metadata. */
|
|
2759
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2760
|
+
}
|
|
2761
|
+
interface BulkOrderResult {
|
|
2762
|
+
/** Item metadata. */
|
|
2763
|
+
itemMetadata?: ItemMetadata;
|
|
2764
|
+
/**
|
|
2765
|
+
* Updated order.
|
|
2766
|
+
*
|
|
2767
|
+
* Returned when `returnFullEntity = true`.
|
|
2768
|
+
*/
|
|
2769
|
+
item?: Order;
|
|
2770
|
+
}
|
|
2771
|
+
interface ItemMetadata {
|
|
2772
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2773
|
+
_id?: string | null;
|
|
2774
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2775
|
+
originalIndex?: number;
|
|
2776
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2777
|
+
success?: boolean;
|
|
2778
|
+
/** Details about the error in case of failure. */
|
|
2779
|
+
error?: ApplicationError;
|
|
2780
|
+
}
|
|
2781
|
+
interface ApplicationError {
|
|
2782
|
+
/** Error code. */
|
|
2783
|
+
code?: string;
|
|
2784
|
+
/** Description of the error. */
|
|
2785
|
+
description?: string;
|
|
2786
|
+
/** Data related to the error. */
|
|
2787
|
+
data?: Record<string, any> | null;
|
|
2788
|
+
}
|
|
2789
|
+
interface BulkActionMetadata {
|
|
2790
|
+
/** Number of items that were successfully processed. */
|
|
2791
|
+
totalSuccesses?: number;
|
|
2792
|
+
/** Number of items that couldn't be processed. */
|
|
2793
|
+
totalFailures?: number;
|
|
2794
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2795
|
+
undetailedFailures?: number;
|
|
2796
|
+
}
|
|
2797
|
+
interface GetRefundabilityStatusRequest {
|
|
2798
|
+
/**
|
|
2799
|
+
* Order ID.
|
|
2800
|
+
* @minLength 1
|
|
2801
|
+
* @maxLength 100
|
|
2802
|
+
*/
|
|
2803
|
+
ecomOrderId: string;
|
|
2804
|
+
}
|
|
2805
|
+
interface GetRefundabilityStatusResponse {
|
|
2806
|
+
/**
|
|
2807
|
+
* Refundability details.
|
|
2808
|
+
* @maxSize 300
|
|
2809
|
+
*/
|
|
2810
|
+
refundabilities?: Refundability[];
|
|
2811
|
+
/**
|
|
2812
|
+
* Whether the order supports refunding per item.
|
|
2813
|
+
* @deprecated
|
|
2814
|
+
*/
|
|
2815
|
+
refundablePerItem?: boolean;
|
|
2816
|
+
}
|
|
2817
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2818
|
+
/** Reason why payment is not refundable. */
|
|
2819
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2820
|
+
/** Reason why payment is only refundable manually. */
|
|
2821
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2822
|
+
/** Payment ID. */
|
|
2823
|
+
paymentId?: string;
|
|
2824
|
+
/** Payment refundability status. */
|
|
2825
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2826
|
+
/** Link to payment provider dashboard. */
|
|
2827
|
+
providerLink?: string | null;
|
|
2828
|
+
}
|
|
2829
|
+
/** @oneof */
|
|
2830
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2831
|
+
/** Reason why payment is not refundable. */
|
|
2832
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2833
|
+
/** Reason why payment is only refundable manually. */
|
|
2834
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2835
|
+
}
|
|
2836
|
+
declare enum RefundableStatus {
|
|
2837
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2838
|
+
MANUAL = "MANUAL",
|
|
2839
|
+
REFUNDABLE = "REFUNDABLE"
|
|
2840
|
+
}
|
|
2841
|
+
/** @enumType */
|
|
2842
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2843
|
+
declare enum NonRefundableReason {
|
|
2844
|
+
NONE = "NONE",
|
|
2845
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2846
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
2847
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
2848
|
+
NOT_PAID = "NOT_PAID",
|
|
2849
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
2850
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
2851
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
2852
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
2853
|
+
FORBIDDEN = "FORBIDDEN",
|
|
2854
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
2855
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2856
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2857
|
+
}
|
|
2858
|
+
/** @enumType */
|
|
2859
|
+
type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
|
|
2860
|
+
declare enum ManuallyRefundableReason {
|
|
2861
|
+
EXPIRED = "EXPIRED",
|
|
2862
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2863
|
+
OFFLINE = "OFFLINE",
|
|
2864
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2865
|
+
}
|
|
2866
|
+
/** @enumType */
|
|
2867
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2868
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
2869
|
+
/**
|
|
2870
|
+
* Ecom order ID.
|
|
2871
|
+
* @minLength 1
|
|
2872
|
+
* @maxLength 100
|
|
2873
|
+
*/
|
|
2874
|
+
ecomOrderId: string;
|
|
2875
|
+
/** Information about the user who initiated the payment. */
|
|
2876
|
+
chargedBy?: ChargedBy;
|
|
2877
|
+
}
|
|
2878
|
+
interface ChargedBy {
|
|
2879
|
+
/**
|
|
2880
|
+
* ID - id of the user who initiated the payment
|
|
2881
|
+
* @format GUID
|
|
2882
|
+
*/
|
|
2883
|
+
_id?: string;
|
|
2884
|
+
/**
|
|
2885
|
+
* Full name - name of the user who initiated the payment
|
|
2886
|
+
* @minLength 1
|
|
2887
|
+
* @maxLength 200
|
|
2888
|
+
*/
|
|
2889
|
+
fullName?: string | null;
|
|
2890
|
+
}
|
|
2891
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
2892
|
+
/** ID of the order created in the payment gateway */
|
|
2893
|
+
paymentGatewayOrderId?: string;
|
|
2894
|
+
}
|
|
2895
|
+
interface ChargeMembershipsRequest {
|
|
2896
|
+
/**
|
|
2897
|
+
* Order ID.
|
|
2898
|
+
* @minLength 1
|
|
2899
|
+
* @maxLength 100
|
|
2900
|
+
*/
|
|
2901
|
+
ecomOrderId: string;
|
|
2902
|
+
/**
|
|
2903
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
2904
|
+
* but a user which is using the membership on behalf of the a member
|
|
2905
|
+
* @format GUID
|
|
2906
|
+
*/
|
|
2907
|
+
memberId: string;
|
|
2908
|
+
/**
|
|
2909
|
+
* List of items to be paid by memberships
|
|
2910
|
+
* @minSize 1
|
|
2911
|
+
* @maxSize 300
|
|
2912
|
+
*/
|
|
2913
|
+
membershipCharges?: MembershipChargeItem[];
|
|
2914
|
+
}
|
|
2915
|
+
interface MembershipChargeItem {
|
|
2916
|
+
/**
|
|
2917
|
+
* The id of used membership
|
|
2918
|
+
* @minLength 1
|
|
2919
|
+
* @maxLength 100
|
|
2920
|
+
*/
|
|
2921
|
+
membershipId?: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* ID of the application providing this payment option
|
|
2924
|
+
* @format GUID
|
|
2925
|
+
*/
|
|
2926
|
+
appId?: string;
|
|
2927
|
+
/** The name of used membership */
|
|
2928
|
+
membershipName?: MembershipName;
|
|
2929
|
+
/** Additional data about this membership */
|
|
2930
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
2931
|
+
/** Catalog and item reference info. */
|
|
2932
|
+
catalogReference?: CatalogReference;
|
|
2933
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2934
|
+
serviceProperties?: ServiceProperties;
|
|
2935
|
+
/**
|
|
2936
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
2937
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2938
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2939
|
+
* @minLength 1
|
|
2940
|
+
* @maxLength 36
|
|
2941
|
+
*/
|
|
2942
|
+
rootCatalogItemId?: string | null;
|
|
2943
|
+
/**
|
|
2944
|
+
* line item id of Checkout/Order line item
|
|
2945
|
+
* @minLength 1
|
|
2946
|
+
* @maxLength 100
|
|
2947
|
+
*/
|
|
2948
|
+
lineItemId?: string;
|
|
2949
|
+
}
|
|
2950
|
+
interface MembershipName {
|
|
2951
|
+
/**
|
|
2952
|
+
* Membership name.
|
|
2953
|
+
* @maxLength 100
|
|
2954
|
+
*/
|
|
2955
|
+
original?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
2958
|
+
* @maxLength 100
|
|
2959
|
+
*/
|
|
2960
|
+
translated?: string | null;
|
|
2961
|
+
}
|
|
2962
|
+
interface ServiceProperties {
|
|
2963
|
+
/**
|
|
2964
|
+
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2965
|
+
* For example, the start time of a class.
|
|
2966
|
+
*/
|
|
2967
|
+
scheduledDate?: Date | null;
|
|
2968
|
+
/**
|
|
2969
|
+
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
2970
|
+
* @min 1
|
|
2971
|
+
* @max 10000
|
|
2972
|
+
*/
|
|
2973
|
+
numberOfParticipants?: number | null;
|
|
2974
|
+
}
|
|
2975
|
+
interface ChargeMembershipsResponse {
|
|
2976
|
+
}
|
|
2977
|
+
interface TriggerRefundRequest {
|
|
2978
|
+
/**
|
|
2979
|
+
* The order this refund related to
|
|
2980
|
+
* @minLength 1
|
|
2981
|
+
* @maxLength 100
|
|
2982
|
+
*/
|
|
2983
|
+
ecomOrderId: string;
|
|
2984
|
+
/**
|
|
2985
|
+
* Refund operations information
|
|
2986
|
+
* @minSize 1
|
|
2987
|
+
* @maxSize 1
|
|
2988
|
+
*/
|
|
2989
|
+
payments: PaymentRefund[];
|
|
2990
|
+
/** Business model of a refund */
|
|
2991
|
+
details?: RefundDetails;
|
|
2992
|
+
/** Side effect details related to refund */
|
|
2993
|
+
sideEffects?: RefundSideEffects;
|
|
2994
|
+
}
|
|
2995
|
+
interface PaymentRefund {
|
|
2996
|
+
/**
|
|
2997
|
+
* Specific payment within the order to refund
|
|
2998
|
+
* @format GUID
|
|
2999
|
+
*/
|
|
3000
|
+
paymentId?: string;
|
|
3001
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
3002
|
+
amount?: Price;
|
|
3003
|
+
/**
|
|
3004
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
3005
|
+
* When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
|
|
3006
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
3007
|
+
*/
|
|
3008
|
+
externalRefund?: boolean;
|
|
3009
|
+
}
|
|
3010
|
+
/** Business model of a refund request */
|
|
3011
|
+
interface RefundDetails {
|
|
3012
|
+
/**
|
|
3013
|
+
* Order line item IDs and quantities that were refunded.
|
|
3014
|
+
* @maxSize 300
|
|
3015
|
+
*/
|
|
3016
|
+
items?: RefundItem[];
|
|
3017
|
+
/** Whether the shipping fee was also refunded. */
|
|
3018
|
+
shippingIncluded?: boolean;
|
|
3019
|
+
/**
|
|
3020
|
+
* Reason for the refund, provided by customer (optional).
|
|
3021
|
+
* @maxLength 200
|
|
3022
|
+
*/
|
|
3023
|
+
reason?: string | null;
|
|
3024
|
+
/**
|
|
3025
|
+
* Line items that were refunded.
|
|
3026
|
+
* @maxSize 300
|
|
3027
|
+
*/
|
|
3028
|
+
lineItems?: LineItemRefund[];
|
|
3029
|
+
/**
|
|
3030
|
+
* Additional fees that were refunded.
|
|
3031
|
+
* @maxSize 100
|
|
3032
|
+
*/
|
|
3033
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
3034
|
+
/** Shipping amount that was refunded. */
|
|
3035
|
+
shipping?: ShippingRefund;
|
|
3036
|
+
}
|
|
3037
|
+
interface RefundItem {
|
|
3038
|
+
/**
|
|
3039
|
+
* Line item ID the refunded line item.
|
|
3040
|
+
* @format GUID
|
|
3041
|
+
*/
|
|
3042
|
+
lineItemId?: string;
|
|
3043
|
+
/**
|
|
3044
|
+
* Line item quantity refunded.
|
|
3045
|
+
* @min 1
|
|
3046
|
+
* @max 100000
|
|
3047
|
+
*/
|
|
3048
|
+
quantity?: number;
|
|
3049
|
+
}
|
|
3050
|
+
interface LineItemRefund {
|
|
3051
|
+
/**
|
|
3052
|
+
* Line item ID.
|
|
3053
|
+
* @format GUID
|
|
3054
|
+
* @immutable
|
|
3055
|
+
*/
|
|
3056
|
+
lineItemId?: string;
|
|
3057
|
+
/**
|
|
3058
|
+
* Refund quantity.
|
|
3059
|
+
* @min 1
|
|
3060
|
+
* @max 100000
|
|
3061
|
+
* @immutable
|
|
3062
|
+
*/
|
|
3063
|
+
quantity?: number;
|
|
3064
|
+
}
|
|
3065
|
+
interface AdditionalFeeRefund {
|
|
3066
|
+
/**
|
|
3067
|
+
* Additional fee ID.
|
|
3068
|
+
* @format GUID
|
|
3069
|
+
* @immutable
|
|
3070
|
+
*/
|
|
3071
|
+
additionalFeeId?: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* Refund amount.
|
|
3074
|
+
* @immutable
|
|
3075
|
+
*/
|
|
3076
|
+
amount?: Price;
|
|
3077
|
+
}
|
|
3078
|
+
interface ShippingRefund {
|
|
3079
|
+
/**
|
|
3080
|
+
* Refund amount.
|
|
3081
|
+
* @immutable
|
|
3082
|
+
*/
|
|
3083
|
+
amount?: Price;
|
|
3084
|
+
}
|
|
3085
|
+
interface RefundSideEffects {
|
|
3086
|
+
/** Inventory restock details as part of this refund. */
|
|
3087
|
+
restockInfo?: RestockInfo;
|
|
3088
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
3089
|
+
sendOrderRefundedEmail?: boolean;
|
|
3090
|
+
/**
|
|
3091
|
+
* Custom message added to the refund confirmation email.
|
|
3092
|
+
* @minLength 1
|
|
3093
|
+
* @maxLength 1000
|
|
3094
|
+
*/
|
|
3095
|
+
customMessage?: string | null;
|
|
3096
|
+
}
|
|
3097
|
+
interface RestockInfo {
|
|
3098
|
+
/** Restock type. */
|
|
3099
|
+
type?: RestockTypeWithLiterals;
|
|
3100
|
+
/**
|
|
3101
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
3102
|
+
* @maxSize 300
|
|
3103
|
+
*/
|
|
3104
|
+
items?: RestockItem[];
|
|
3105
|
+
}
|
|
3106
|
+
declare enum RestockType {
|
|
3107
|
+
NO_ITEMS = "NO_ITEMS",
|
|
3108
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
3109
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
3110
|
+
}
|
|
3111
|
+
/** @enumType */
|
|
3112
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
3113
|
+
interface RestockItem {
|
|
3114
|
+
/**
|
|
3115
|
+
* ID of the line item being restocked.
|
|
3116
|
+
* @format GUID
|
|
3117
|
+
*/
|
|
3118
|
+
lineItemId?: string;
|
|
3119
|
+
/**
|
|
3120
|
+
* Line item quantity being restocked.
|
|
3121
|
+
* @min 1
|
|
3122
|
+
* @max 100000
|
|
3123
|
+
*/
|
|
3124
|
+
quantity?: number;
|
|
3125
|
+
}
|
|
3126
|
+
interface TriggerRefundResponse {
|
|
3127
|
+
/** All order's transactions after the refunds were added */
|
|
3128
|
+
orderTransactions?: OrderTransactions;
|
|
3129
|
+
/** Created refund ID */
|
|
3130
|
+
refundId?: string | null;
|
|
3131
|
+
/** Payment ID's that the refund execution had failed for */
|
|
3132
|
+
failedPaymentIds?: ItemMetadata[];
|
|
3133
|
+
}
|
|
3134
|
+
interface OrderTransactions {
|
|
3135
|
+
/**
|
|
3136
|
+
* Order ID.
|
|
3137
|
+
* @format GUID
|
|
3138
|
+
*/
|
|
3139
|
+
orderId?: string;
|
|
3140
|
+
/**
|
|
3141
|
+
* Record of payments made to the merchant.
|
|
3142
|
+
* @maxSize 100
|
|
3143
|
+
*/
|
|
3144
|
+
payments?: Payment[];
|
|
3145
|
+
/**
|
|
3146
|
+
* Record of refunds made to the buyer.
|
|
3147
|
+
* @maxSize 300
|
|
3148
|
+
*/
|
|
3149
|
+
refunds?: Refund[];
|
|
3150
|
+
}
|
|
3151
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
3152
|
+
/** Regular payment details. */
|
|
3153
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3154
|
+
/** Gift card payment details. */
|
|
3155
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3156
|
+
/**
|
|
3157
|
+
* Receipt created by Wix
|
|
3158
|
+
* @internal
|
|
3159
|
+
*/
|
|
3160
|
+
wixReceipt?: WixReceiptInfo;
|
|
3161
|
+
/**
|
|
3162
|
+
* Receipt created by an external system.
|
|
3163
|
+
* @internal
|
|
3164
|
+
*/
|
|
3165
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
3166
|
+
/**
|
|
3167
|
+
* Payment ID.
|
|
3168
|
+
* @format GUID
|
|
3169
|
+
* @readonly
|
|
3170
|
+
*/
|
|
3171
|
+
_id?: string | null;
|
|
3172
|
+
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
3173
|
+
_createdDate?: Date | null;
|
|
3174
|
+
/**
|
|
3175
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
3176
|
+
* @readonly
|
|
3177
|
+
*/
|
|
3178
|
+
_updatedDate?: Date | null;
|
|
3179
|
+
/** Payment amount. */
|
|
3180
|
+
amount?: Price;
|
|
3181
|
+
/**
|
|
3182
|
+
* Whether refunds for this payment are disabled.
|
|
3183
|
+
* + `true`: This payment is not refundable.
|
|
3184
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
3185
|
+
*/
|
|
3186
|
+
refundDisabled?: boolean;
|
|
3187
|
+
/**
|
|
3188
|
+
* Whether receipt generation for this payment are allowed.
|
|
3189
|
+
* + `true`: This payment supports receipt generation.
|
|
3190
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
3191
|
+
* @internal
|
|
3192
|
+
* @readonly
|
|
3193
|
+
*/
|
|
3194
|
+
supportReceiptGeneration?: boolean;
|
|
3195
|
+
}
|
|
3196
|
+
/** @oneof */
|
|
3197
|
+
interface PaymentPaymentDetailsOneOf {
|
|
3198
|
+
/** Regular payment details. */
|
|
3199
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3200
|
+
/** Gift card payment details. */
|
|
3201
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3202
|
+
}
|
|
3203
|
+
/** @oneof */
|
|
3204
|
+
interface PaymentReceiptInfoOneOf {
|
|
3205
|
+
/**
|
|
3206
|
+
* Receipt created by Wix
|
|
3207
|
+
* @internal
|
|
3208
|
+
*/
|
|
3209
|
+
wixReceipt?: WixReceiptInfo;
|
|
3210
|
+
/**
|
|
3211
|
+
* Receipt created by an external system.
|
|
3212
|
+
* @internal
|
|
3213
|
+
*/
|
|
3214
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
3215
|
+
}
|
|
3216
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3217
|
+
/** Whether regular card used */
|
|
3218
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3219
|
+
/**
|
|
3220
|
+
* Wix Payments order ID.
|
|
3221
|
+
* @maxLength 100
|
|
3222
|
+
*/
|
|
3223
|
+
paymentOrderId?: string | null;
|
|
3224
|
+
/**
|
|
3225
|
+
* Payment gateway's transaction ID.
|
|
3226
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
3227
|
+
* @maxLength 100
|
|
3228
|
+
*/
|
|
3229
|
+
gatewayTransactionId?: string | null;
|
|
3230
|
+
/**
|
|
3231
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
3232
|
+
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
3233
|
+
* @maxLength 100
|
|
3234
|
+
*/
|
|
3235
|
+
paymentMethod?: string | null;
|
|
3236
|
+
/**
|
|
3237
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
3238
|
+
* @maxLength 100
|
|
3239
|
+
*/
|
|
3240
|
+
providerTransactionId?: string | null;
|
|
3241
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3242
|
+
offlinePayment?: boolean;
|
|
3243
|
+
/** Payment status. */
|
|
3244
|
+
status?: TransactionStatusWithLiterals;
|
|
3245
|
+
/**
|
|
3246
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
3247
|
+
* @immutable
|
|
3248
|
+
*/
|
|
3249
|
+
savedPaymentMethod?: boolean;
|
|
3250
|
+
/** Authorization details. */
|
|
3251
|
+
authorizationDetails?: AuthorizationDetails;
|
|
3252
|
+
/**
|
|
3253
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
3254
|
+
* @internal
|
|
3255
|
+
* @maxLength 300
|
|
3256
|
+
*/
|
|
3257
|
+
paymentProvider?: string | null;
|
|
3258
|
+
/**
|
|
3259
|
+
* Record of chargebacks made by the buyer.
|
|
3260
|
+
* @maxSize 6
|
|
3261
|
+
*/
|
|
3262
|
+
chargebacks?: Chargeback[];
|
|
3263
|
+
}
|
|
3264
|
+
/** @oneof */
|
|
3265
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3266
|
+
/** Whether regular card used */
|
|
3267
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3268
|
+
}
|
|
3269
|
+
declare enum TransactionStatus {
|
|
3270
|
+
UNDEFINED = "UNDEFINED",
|
|
3271
|
+
APPROVED = "APPROVED",
|
|
3272
|
+
PENDING = "PENDING",
|
|
3273
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3274
|
+
CANCELED = "CANCELED",
|
|
3275
|
+
DECLINED = "DECLINED",
|
|
3276
|
+
REFUNDED = "REFUNDED",
|
|
3277
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3278
|
+
AUTHORIZED = "AUTHORIZED",
|
|
3279
|
+
VOIDED = "VOIDED"
|
|
3280
|
+
}
|
|
3281
|
+
/** @enumType */
|
|
3282
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3283
|
+
interface CreditCardPaymentMethodDetails {
|
|
3284
|
+
/**
|
|
3285
|
+
* The last 4 digits of the card number.
|
|
3286
|
+
* @maxLength 4
|
|
3287
|
+
*/
|
|
3288
|
+
lastFourDigits?: string | null;
|
|
3289
|
+
/**
|
|
3290
|
+
* Card issuer's brand.
|
|
3291
|
+
* @maxLength 100
|
|
3292
|
+
*/
|
|
3293
|
+
brand?: string | null;
|
|
3294
|
+
}
|
|
3295
|
+
interface AuthorizationDetails {
|
|
3296
|
+
/**
|
|
3297
|
+
* Whether the authorized payment is of a delayed capture.
|
|
3298
|
+
* @readonly
|
|
3299
|
+
*/
|
|
3300
|
+
delayedCapture?: boolean;
|
|
3301
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3302
|
+
authorizedDate?: Date | null;
|
|
3303
|
+
/**
|
|
3304
|
+
* List of captures associated with payment
|
|
3305
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3306
|
+
* @maxSize 1
|
|
3307
|
+
*/
|
|
3308
|
+
captures?: AuthorizationCapture[];
|
|
3309
|
+
/** Void associated with payment */
|
|
3310
|
+
void?: AuthorizationVoid;
|
|
3311
|
+
/** Scheduled action for this transaction */
|
|
3312
|
+
scheduledAction?: V1ScheduledAction;
|
|
3313
|
+
}
|
|
3314
|
+
interface AuthorizationCapture {
|
|
3315
|
+
/**
|
|
3316
|
+
* Capture ID.
|
|
3317
|
+
* @format GUID
|
|
3318
|
+
* @readonly
|
|
3319
|
+
*/
|
|
3320
|
+
_id?: string | null;
|
|
3321
|
+
/** Status of this capture action */
|
|
3322
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3323
|
+
/**
|
|
3324
|
+
* Amount of this capture
|
|
3325
|
+
* @immutable
|
|
3326
|
+
*/
|
|
3327
|
+
amount?: Price;
|
|
3328
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3329
|
+
_createdDate?: Date | null;
|
|
3330
|
+
/** In case of status is FAILED may contain failure details */
|
|
3331
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3332
|
+
}
|
|
3333
|
+
declare enum AuthorizationCaptureStatus {
|
|
3334
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3335
|
+
/** Capture operation still in progress. */
|
|
3336
|
+
PENDING = "PENDING",
|
|
3337
|
+
/** Capture operation succeeded. */
|
|
3338
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3339
|
+
/** Capture operation failed. */
|
|
3340
|
+
FAILED = "FAILED"
|
|
3341
|
+
}
|
|
3342
|
+
/** @enumType */
|
|
3343
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3344
|
+
interface AuthorizationActionFailureDetails {
|
|
3345
|
+
/** @maxLength 100 */
|
|
3346
|
+
failureCode?: string;
|
|
3347
|
+
}
|
|
3348
|
+
interface AuthorizationVoid {
|
|
3349
|
+
/** Status of this void action */
|
|
3350
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
3351
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3352
|
+
voidedDate?: Date | null;
|
|
3353
|
+
/** In case of status is FAILED may contain failure details */
|
|
3354
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3355
|
+
/** Reason of void action */
|
|
3356
|
+
reason?: ReasonWithLiterals;
|
|
3357
|
+
}
|
|
3358
|
+
declare enum AuthorizationVoidStatus {
|
|
3359
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3360
|
+
/** Void operation still in progress. */
|
|
3361
|
+
PENDING = "PENDING",
|
|
3362
|
+
/** Void operation succeeded. */
|
|
3363
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3364
|
+
/** Void operation failed. */
|
|
3365
|
+
FAILED = "FAILED"
|
|
3366
|
+
}
|
|
3367
|
+
/** @enumType */
|
|
3368
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3369
|
+
/** Reason the authorization was voided. */
|
|
3370
|
+
declare enum Reason {
|
|
3371
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3372
|
+
/** Authorization was voided by user. */
|
|
3373
|
+
MANUAL = "MANUAL",
|
|
3374
|
+
/** Authorization passed execution date. */
|
|
3375
|
+
SCHEDULED = "SCHEDULED"
|
|
3376
|
+
}
|
|
3377
|
+
/** @enumType */
|
|
3378
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3379
|
+
interface V1ScheduledAction {
|
|
3380
|
+
/** Type of the action. */
|
|
3381
|
+
actionType?: ActionTypeWithLiterals;
|
|
3382
|
+
/** The date and time of the action. */
|
|
3383
|
+
executionDate?: Date | null;
|
|
3384
|
+
}
|
|
3385
|
+
declare enum ActionType {
|
|
3386
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3387
|
+
VOID = "VOID",
|
|
3388
|
+
CAPTURE = "CAPTURE"
|
|
3389
|
+
}
|
|
3390
|
+
/** @enumType */
|
|
3391
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3392
|
+
interface Chargeback {
|
|
3393
|
+
/**
|
|
3394
|
+
* Chargeback ID.
|
|
3395
|
+
* @format GUID
|
|
3396
|
+
* @readonly
|
|
3397
|
+
* @immutable
|
|
3398
|
+
*/
|
|
3399
|
+
_id?: string;
|
|
3400
|
+
/**
|
|
3401
|
+
* Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
3402
|
+
* @readonly
|
|
3403
|
+
* @immutable
|
|
3404
|
+
*/
|
|
3405
|
+
_createdDate?: Date | null;
|
|
3406
|
+
/**
|
|
3407
|
+
* Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
3408
|
+
* @readonly
|
|
3409
|
+
*/
|
|
3410
|
+
_updatedDate?: Date | null;
|
|
3411
|
+
/**
|
|
3412
|
+
* Amount.
|
|
3413
|
+
* @readonly
|
|
3414
|
+
* @immutable
|
|
3415
|
+
*/
|
|
3416
|
+
amount?: Price;
|
|
3417
|
+
/**
|
|
3418
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
3419
|
+
* @readonly
|
|
3420
|
+
*/
|
|
3421
|
+
reversalAmount?: Price;
|
|
3422
|
+
/**
|
|
3423
|
+
* Status.
|
|
3424
|
+
*
|
|
3425
|
+
* Default: `"APPROVED"`.
|
|
3426
|
+
*/
|
|
3427
|
+
status?: ChargebackStatusWithLiterals;
|
|
3428
|
+
/**
|
|
3429
|
+
* External chargeback ID.
|
|
3430
|
+
* @format GUID
|
|
3431
|
+
* @readonly
|
|
3432
|
+
* @immutable
|
|
3433
|
+
*/
|
|
3434
|
+
externalId?: string | null;
|
|
3435
|
+
}
|
|
3436
|
+
declare enum ChargebackStatus {
|
|
3437
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3438
|
+
/** Chargeback was approved. */
|
|
3439
|
+
APPROVED = "APPROVED",
|
|
3440
|
+
/** Chargeback was reversed. */
|
|
3441
|
+
REVERSED = "REVERSED"
|
|
3442
|
+
}
|
|
3443
|
+
/** @enumType */
|
|
3444
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3445
|
+
interface GiftCardPaymentDetails {
|
|
3446
|
+
/**
|
|
3447
|
+
* Gift card payment ID.
|
|
3448
|
+
* @minLength 1
|
|
3449
|
+
* @maxLength 100
|
|
3450
|
+
*/
|
|
3451
|
+
giftCardPaymentId?: string;
|
|
3452
|
+
/**
|
|
3453
|
+
* ID of the app that created the gift card.
|
|
3454
|
+
* @format GUID
|
|
3455
|
+
*/
|
|
3456
|
+
appId?: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* Whether the gift card is voided.
|
|
3459
|
+
* @readonly
|
|
3460
|
+
*/
|
|
3461
|
+
voided?: boolean;
|
|
3462
|
+
/**
|
|
3463
|
+
* Gift card obfuscated code.
|
|
3464
|
+
* @internal
|
|
3465
|
+
* @maxLength 30
|
|
3466
|
+
* @immutable
|
|
3467
|
+
*/
|
|
3468
|
+
obfuscatedCode?: string | null;
|
|
3469
|
+
}
|
|
3470
|
+
interface MembershipPaymentDetails {
|
|
3471
|
+
/**
|
|
3472
|
+
* Membership ID.
|
|
3473
|
+
* @minLength 1
|
|
3474
|
+
* @maxLength 100
|
|
3475
|
+
*/
|
|
3476
|
+
membershipId?: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* ID of the line item this membership applies to.
|
|
3479
|
+
* @minLength 1
|
|
3480
|
+
* @maxLength 100
|
|
3481
|
+
*/
|
|
3482
|
+
lineItemId?: string;
|
|
3483
|
+
/** Payment status. */
|
|
3484
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
3485
|
+
/** Membership name. */
|
|
3486
|
+
name?: MembershipName;
|
|
3487
|
+
/**
|
|
3488
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3489
|
+
* @minLength 1
|
|
3490
|
+
* @maxLength 100
|
|
3491
|
+
*/
|
|
3492
|
+
externalTransactionId?: string | null;
|
|
3493
|
+
/**
|
|
3494
|
+
* Whether the membership is voided.
|
|
3495
|
+
* @readonly
|
|
3496
|
+
*/
|
|
3497
|
+
voided?: boolean;
|
|
3498
|
+
/**
|
|
3499
|
+
* ID of the application providing this payment option.
|
|
3500
|
+
* @format GUID
|
|
3501
|
+
*/
|
|
3502
|
+
providerAppId?: string;
|
|
3503
|
+
}
|
|
3504
|
+
declare enum MembershipPaymentStatus {
|
|
3505
|
+
/** Payment was charged. */
|
|
3506
|
+
CHARGED = "CHARGED",
|
|
3507
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3508
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3509
|
+
}
|
|
3510
|
+
/** @enumType */
|
|
3511
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3512
|
+
interface WixReceiptInfo {
|
|
3513
|
+
/**
|
|
3514
|
+
* Receipt ID
|
|
3515
|
+
* @format GUID
|
|
3516
|
+
*/
|
|
3517
|
+
receiptId?: string;
|
|
3518
|
+
/**
|
|
3519
|
+
* Display number of receipt
|
|
3520
|
+
* @minLength 1
|
|
3521
|
+
* @maxLength 40
|
|
3522
|
+
*/
|
|
3523
|
+
displayNumber?: string | null;
|
|
3524
|
+
}
|
|
3525
|
+
interface ExternalReceiptInfo {
|
|
3526
|
+
/**
|
|
3527
|
+
* External receipt ID
|
|
3528
|
+
* @maxLength 100
|
|
3529
|
+
*/
|
|
3530
|
+
receiptId?: string | null;
|
|
3531
|
+
/**
|
|
3532
|
+
* ID of the app providing the receipt
|
|
3533
|
+
* @format GUID
|
|
3534
|
+
*/
|
|
3535
|
+
appId?: string | null;
|
|
3536
|
+
/**
|
|
3537
|
+
* Display number of receipt
|
|
3538
|
+
* @minLength 1
|
|
3539
|
+
* @maxLength 40
|
|
3540
|
+
*/
|
|
3541
|
+
displayNumber?: string | null;
|
|
3542
|
+
}
|
|
3543
|
+
interface Refund {
|
|
3544
|
+
/**
|
|
3545
|
+
* Refund ID.
|
|
3546
|
+
* @format GUID
|
|
3547
|
+
* @readonly
|
|
3548
|
+
*/
|
|
3549
|
+
_id?: string;
|
|
3550
|
+
/**
|
|
3551
|
+
* List of transactions.
|
|
3552
|
+
* @maxSize 50
|
|
3553
|
+
*/
|
|
3554
|
+
transactions?: RefundTransaction[];
|
|
3555
|
+
/** Refund business details. */
|
|
3556
|
+
details?: RefundDetails;
|
|
3557
|
+
/**
|
|
3558
|
+
* Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
3559
|
+
* @readonly
|
|
3560
|
+
* @immutable
|
|
3561
|
+
*/
|
|
3562
|
+
_createdDate?: Date | null;
|
|
3563
|
+
/**
|
|
3564
|
+
* Aggregated refund summary.
|
|
3565
|
+
* @readonly
|
|
3566
|
+
*/
|
|
3567
|
+
summary?: AggregatedRefundSummary;
|
|
3568
|
+
/**
|
|
3569
|
+
* ID of the app that initiated this refund.
|
|
3570
|
+
* @format GUID
|
|
3571
|
+
* @readonly
|
|
3572
|
+
* @immutable
|
|
3573
|
+
*/
|
|
3574
|
+
requestingServiceAppId?: string | null;
|
|
3575
|
+
}
|
|
3576
|
+
interface RefundTransaction {
|
|
3577
|
+
/**
|
|
3578
|
+
* ID of the payment associated with this refund.
|
|
3579
|
+
* @format GUID
|
|
3580
|
+
* @immutable
|
|
3581
|
+
*/
|
|
3582
|
+
paymentId?: string;
|
|
3583
|
+
/**
|
|
3584
|
+
* Refund amount.
|
|
3585
|
+
* @immutable
|
|
3586
|
+
*/
|
|
3587
|
+
amount?: Price;
|
|
3588
|
+
/** Refund status. */
|
|
3589
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
3590
|
+
/** Optional details of current refund status. */
|
|
3591
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
3592
|
+
/**
|
|
3593
|
+
* Payment gateway's refund ID.
|
|
3594
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
3595
|
+
* @format GUID
|
|
3596
|
+
*/
|
|
3597
|
+
gatewayRefundId?: string | null;
|
|
3598
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3599
|
+
providerRefundId?: string | null;
|
|
3600
|
+
/**
|
|
3601
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
3602
|
+
* @immutable
|
|
3603
|
+
*/
|
|
3604
|
+
externalRefund?: boolean;
|
|
3605
|
+
}
|
|
3606
|
+
/** Refund transaction status. */
|
|
3607
|
+
declare enum RefundStatus {
|
|
3608
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3609
|
+
PENDING = "PENDING",
|
|
3610
|
+
/** Refund transaction succeeded. */
|
|
3611
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3612
|
+
/** Refund transaction failed. */
|
|
3613
|
+
FAILED = "FAILED",
|
|
3614
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
3615
|
+
SCHEDULED = "SCHEDULED",
|
|
3616
|
+
/** Refund was initiated on payment provider side. */
|
|
3617
|
+
STARTED = "STARTED"
|
|
3618
|
+
}
|
|
3619
|
+
/** @enumType */
|
|
3620
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3621
|
+
interface RefundStatusInfo {
|
|
3622
|
+
/**
|
|
3623
|
+
* Reason code for the refund's current status.
|
|
3624
|
+
*
|
|
3625
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3626
|
+
* @minLength 1
|
|
3627
|
+
* @maxLength 10
|
|
3628
|
+
*/
|
|
3629
|
+
paymentGatewayReasonCode?: string | null;
|
|
3630
|
+
/**
|
|
3631
|
+
* Free text explanation of current refund status.
|
|
3632
|
+
* @minLength 1
|
|
3633
|
+
* @maxLength 1000
|
|
3634
|
+
*/
|
|
3635
|
+
description?: string | null;
|
|
3636
|
+
}
|
|
3637
|
+
interface AggregatedRefundSummary {
|
|
3638
|
+
/** Total amount requested for refund. */
|
|
3639
|
+
requestedRefund?: Price;
|
|
3640
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3641
|
+
pendingRefund?: Price;
|
|
3642
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3643
|
+
refunded?: Price;
|
|
3644
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3645
|
+
failedRefundAmount?: Price;
|
|
3646
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
3647
|
+
pending?: boolean;
|
|
3648
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3649
|
+
breakdown?: RefundItemsBreakdown;
|
|
3650
|
+
}
|
|
3651
|
+
interface RefundItemsBreakdown {
|
|
3652
|
+
/**
|
|
3653
|
+
* Refunded line items and the amount refunded for each.
|
|
3654
|
+
* @maxSize 300
|
|
3655
|
+
*/
|
|
3656
|
+
lineItems?: LineItemRefundSummary[];
|
|
3657
|
+
}
|
|
3658
|
+
interface LineItemRefundSummary {
|
|
3659
|
+
/**
|
|
3660
|
+
* ID of the refunded line item.
|
|
3661
|
+
* @format GUID
|
|
3662
|
+
*/
|
|
3663
|
+
lineItemId?: string;
|
|
3664
|
+
/** Total refunded amount for the line item. */
|
|
3665
|
+
totalRefundedAmount?: Price;
|
|
3666
|
+
}
|
|
3667
|
+
interface CalculateRefundRequest {
|
|
3668
|
+
/**
|
|
3669
|
+
* Order ID
|
|
3670
|
+
* @minLength 1
|
|
3671
|
+
* @maxLength 100
|
|
3672
|
+
*/
|
|
3673
|
+
ecomOrderId?: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* Refunded line items and quantity
|
|
3676
|
+
* @maxSize 300
|
|
3677
|
+
*/
|
|
3678
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
3679
|
+
/** Should include shipping in refund calculation */
|
|
3680
|
+
refundShipping?: boolean;
|
|
3681
|
+
}
|
|
3682
|
+
interface CalculateRefundItemRequest {
|
|
3683
|
+
/**
|
|
3684
|
+
* ID of the line item being refunded
|
|
3685
|
+
* @format GUID
|
|
3686
|
+
*/
|
|
3687
|
+
_id?: string;
|
|
3688
|
+
/**
|
|
3689
|
+
* How much of that line item is being refunded
|
|
3690
|
+
* @min 1
|
|
3691
|
+
* @max 100000
|
|
3692
|
+
*/
|
|
3693
|
+
quantity?: number;
|
|
3694
|
+
}
|
|
3695
|
+
interface CalculateRefundResponse {
|
|
3696
|
+
/** Total refundable amount */
|
|
3697
|
+
total?: Price;
|
|
3698
|
+
/** Tax cost of the order */
|
|
3699
|
+
tax?: Price;
|
|
3700
|
+
/** Discount given for this order */
|
|
3701
|
+
discount?: Price;
|
|
3702
|
+
/** Total cost of the order (without tax) */
|
|
3703
|
+
subtotal?: Price;
|
|
3704
|
+
/** Total shipping cost for order */
|
|
3705
|
+
shipping?: Price;
|
|
3706
|
+
/** Previous refund given on that order */
|
|
3707
|
+
previouslyRefundedAmount?: Price;
|
|
3708
|
+
/**
|
|
3709
|
+
* The refundable items of that order
|
|
3710
|
+
* @maxSize 300
|
|
3711
|
+
*/
|
|
3712
|
+
items?: CalculateRefundItemResponse[];
|
|
3713
|
+
}
|
|
3714
|
+
interface CalculateRefundItemResponse {
|
|
3715
|
+
/**
|
|
3716
|
+
* Line item ID
|
|
3717
|
+
* @format GUID
|
|
3718
|
+
*/
|
|
3719
|
+
_id?: string;
|
|
3720
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3721
|
+
price?: Price;
|
|
3722
|
+
}
|
|
3723
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
3724
|
+
/**
|
|
3725
|
+
* Wix eCommerce order ID
|
|
3726
|
+
* @minLength 1
|
|
3727
|
+
* @maxLength 100
|
|
3728
|
+
*/
|
|
3729
|
+
ecomOrderId: string;
|
|
3730
|
+
/**
|
|
3731
|
+
* Payment IDs
|
|
3732
|
+
* @minSize 1
|
|
3733
|
+
* @maxSize 100
|
|
3734
|
+
* @format GUID
|
|
3735
|
+
*/
|
|
3736
|
+
paymentIds: string[];
|
|
3737
|
+
}
|
|
3738
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
3739
|
+
/** All order's transactions after the void was triggered */
|
|
3740
|
+
orderTransactions?: OrderTransactions;
|
|
3741
|
+
}
|
|
3742
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
3743
|
+
/**
|
|
3744
|
+
* Wix eCommerce order ID
|
|
3745
|
+
* @minLength 1
|
|
3746
|
+
* @maxLength 100
|
|
3747
|
+
*/
|
|
3748
|
+
ecomOrderId: string;
|
|
3749
|
+
/**
|
|
3750
|
+
* Capture payments information
|
|
3751
|
+
* @minSize 1
|
|
3752
|
+
* @maxSize 100
|
|
3753
|
+
*/
|
|
3754
|
+
payments: PaymentCapture[];
|
|
3755
|
+
}
|
|
3756
|
+
interface PaymentCapture {
|
|
3757
|
+
/**
|
|
3758
|
+
* Payment ID
|
|
3759
|
+
* @format GUID
|
|
3760
|
+
*/
|
|
3761
|
+
paymentId?: string | null;
|
|
3762
|
+
/**
|
|
3763
|
+
* Capture amount.
|
|
3764
|
+
* If not provided - full authorized amount will be captured.
|
|
3765
|
+
*/
|
|
3766
|
+
amount?: Price;
|
|
3767
|
+
}
|
|
3768
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
3769
|
+
/** All order's transactions after the capture was triggered */
|
|
3770
|
+
orderTransactions?: OrderTransactions;
|
|
3771
|
+
}
|
|
3772
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
3773
|
+
/**
|
|
3774
|
+
* Ecom Order ID.
|
|
3775
|
+
* @minLength 1
|
|
3776
|
+
* @maxLength 100
|
|
3777
|
+
*/
|
|
3778
|
+
ecomOrderId?: string;
|
|
3779
|
+
/** Amount to be charged */
|
|
3780
|
+
amount?: Price;
|
|
3781
|
+
}
|
|
3782
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
3783
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3784
|
+
paymentGatewayOrderId?: string;
|
|
3785
|
+
}
|
|
3786
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3787
|
+
createdEvent?: EntityCreatedEvent;
|
|
3788
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3789
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3790
|
+
actionEvent?: ActionEvent;
|
|
3791
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3792
|
+
_id?: string;
|
|
3793
|
+
/**
|
|
3794
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3795
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3796
|
+
*/
|
|
3797
|
+
entityFqdn?: string;
|
|
3798
|
+
/**
|
|
3799
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3800
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3801
|
+
*/
|
|
3802
|
+
slug?: string;
|
|
3803
|
+
/** ID of the entity associated with the event. */
|
|
3804
|
+
entityId?: string;
|
|
3805
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3806
|
+
eventTime?: Date | null;
|
|
3807
|
+
/**
|
|
3808
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3809
|
+
* (for example, GDPR).
|
|
3810
|
+
*/
|
|
3811
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3812
|
+
/** If present, indicates the action that triggered the event. */
|
|
3813
|
+
originatedFrom?: string | null;
|
|
3814
|
+
/**
|
|
3815
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3816
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3817
|
+
*/
|
|
3818
|
+
entityEventSequence?: string | null;
|
|
3819
|
+
}
|
|
3820
|
+
/** @oneof */
|
|
3821
|
+
interface DomainEventBodyOneOf {
|
|
3822
|
+
createdEvent?: EntityCreatedEvent;
|
|
3823
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3824
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3825
|
+
actionEvent?: ActionEvent;
|
|
3826
|
+
}
|
|
3827
|
+
interface EntityCreatedEvent {
|
|
3828
|
+
entity?: string;
|
|
3829
|
+
}
|
|
3830
|
+
interface RestoreInfo {
|
|
3831
|
+
deletedDate?: Date | null;
|
|
3832
|
+
}
|
|
3833
|
+
interface EntityUpdatedEvent {
|
|
3834
|
+
/**
|
|
3835
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3836
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3837
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3838
|
+
*/
|
|
3839
|
+
currentEntity?: string;
|
|
3840
|
+
}
|
|
3841
|
+
interface EntityDeletedEvent {
|
|
3842
|
+
/** Entity that was deleted. */
|
|
3843
|
+
deletedEntity?: string | null;
|
|
3844
|
+
}
|
|
3845
|
+
interface ActionEvent {
|
|
3846
|
+
body?: string;
|
|
3847
|
+
}
|
|
3848
|
+
interface Empty {
|
|
3849
|
+
}
|
|
3850
|
+
interface MessageEnvelope {
|
|
3851
|
+
/**
|
|
3852
|
+
* App instance ID.
|
|
3853
|
+
* @format GUID
|
|
3854
|
+
*/
|
|
3855
|
+
instanceId?: string | null;
|
|
3856
|
+
/**
|
|
3857
|
+
* Event type.
|
|
3858
|
+
* @maxLength 150
|
|
3859
|
+
*/
|
|
3860
|
+
eventType?: string;
|
|
3861
|
+
/** The identification type and identity data. */
|
|
3862
|
+
identity?: IdentificationData;
|
|
3863
|
+
/** Stringify payload. */
|
|
3864
|
+
data?: string;
|
|
3865
|
+
}
|
|
3866
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3867
|
+
/**
|
|
3868
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3869
|
+
* @format GUID
|
|
3870
|
+
*/
|
|
3871
|
+
anonymousVisitorId?: string;
|
|
3872
|
+
/**
|
|
3873
|
+
* ID of a site visitor that has logged in to the site.
|
|
3874
|
+
* @format GUID
|
|
3875
|
+
*/
|
|
3876
|
+
memberId?: string;
|
|
3877
|
+
/**
|
|
3878
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3879
|
+
* @format GUID
|
|
3880
|
+
*/
|
|
3881
|
+
wixUserId?: string;
|
|
3882
|
+
/**
|
|
3883
|
+
* ID of an app.
|
|
3884
|
+
* @format GUID
|
|
3885
|
+
*/
|
|
3886
|
+
appId?: string;
|
|
3887
|
+
/** @readonly */
|
|
3888
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3889
|
+
}
|
|
3890
|
+
/** @oneof */
|
|
3891
|
+
interface IdentificationDataIdOneOf {
|
|
3892
|
+
/**
|
|
3893
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3894
|
+
* @format GUID
|
|
3895
|
+
*/
|
|
3896
|
+
anonymousVisitorId?: string;
|
|
3897
|
+
/**
|
|
3898
|
+
* ID of a site visitor that has logged in to the site.
|
|
3899
|
+
* @format GUID
|
|
3900
|
+
*/
|
|
3901
|
+
memberId?: string;
|
|
3902
|
+
/**
|
|
3903
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3904
|
+
* @format GUID
|
|
3905
|
+
*/
|
|
3906
|
+
wixUserId?: string;
|
|
3907
|
+
/**
|
|
3908
|
+
* ID of an app.
|
|
3909
|
+
* @format GUID
|
|
3910
|
+
*/
|
|
3911
|
+
appId?: string;
|
|
3912
|
+
}
|
|
3913
|
+
declare enum WebhookIdentityType {
|
|
3914
|
+
UNKNOWN = "UNKNOWN",
|
|
3915
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3916
|
+
MEMBER = "MEMBER",
|
|
3917
|
+
WIX_USER = "WIX_USER",
|
|
3918
|
+
APP = "APP"
|
|
3919
|
+
}
|
|
3920
|
+
/** @enumType */
|
|
3921
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3922
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
3923
|
+
/** insert/update documents */
|
|
3924
|
+
update?: InternalDocumentUpdateOperation;
|
|
3925
|
+
/** delete by document ids */
|
|
3926
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3927
|
+
/** delete documents matching filter */
|
|
3928
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3929
|
+
/** update internal documents matching filter */
|
|
3930
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3931
|
+
/** update only existing documents */
|
|
3932
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3933
|
+
/** insert/update documents with versioning */
|
|
3934
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3935
|
+
/** delete by document ids with versioning */
|
|
3936
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3937
|
+
/**
|
|
3938
|
+
* type of the documents
|
|
3939
|
+
* @minLength 2
|
|
3940
|
+
*/
|
|
3941
|
+
documentType?: string;
|
|
3942
|
+
/**
|
|
3943
|
+
* language of the documents (mandatory)
|
|
3944
|
+
* @minLength 2
|
|
3945
|
+
*/
|
|
3946
|
+
language?: string | null;
|
|
3947
|
+
/**
|
|
3948
|
+
* one or more search documents
|
|
3949
|
+
* @deprecated
|
|
3950
|
+
*/
|
|
3951
|
+
addDocuments?: InternalDocument[];
|
|
3952
|
+
/**
|
|
3953
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
3954
|
+
* @deprecated
|
|
3955
|
+
*/
|
|
3956
|
+
removeDocumentIds?: string[];
|
|
3957
|
+
/** id to pass to processing notification */
|
|
3958
|
+
correlationId?: string | null;
|
|
3959
|
+
/** when event was created / issued */
|
|
3960
|
+
issuedAt?: Date | null;
|
|
3961
|
+
}
|
|
3962
|
+
/** @oneof */
|
|
3963
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
3964
|
+
/** insert/update documents */
|
|
3965
|
+
update?: InternalDocumentUpdateOperation;
|
|
3966
|
+
/** delete by document ids */
|
|
3967
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3968
|
+
/** delete documents matching filter */
|
|
3969
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3970
|
+
/** update internal documents matching filter */
|
|
3971
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3972
|
+
/** update only existing documents */
|
|
3973
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3974
|
+
/** insert/update documents with versioning */
|
|
3975
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3976
|
+
/** delete by document ids with versioning */
|
|
3977
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3978
|
+
}
|
|
3979
|
+
interface InternalDocument {
|
|
3980
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
3981
|
+
document?: Record<string, any> | null;
|
|
3982
|
+
}
|
|
3983
|
+
interface InternalDocumentUpdateOperation {
|
|
3984
|
+
/** documents to index or update */
|
|
3985
|
+
documents?: InternalDocument[];
|
|
3986
|
+
}
|
|
3987
|
+
interface DeleteByIdsOperation {
|
|
3988
|
+
/** ids of the documents to delete */
|
|
3989
|
+
documentIds?: string[];
|
|
3990
|
+
/**
|
|
3991
|
+
* tenant id for custom tenancy strategy
|
|
3992
|
+
* @minLength 2
|
|
3993
|
+
* @maxLength 300
|
|
3994
|
+
*/
|
|
3995
|
+
tenantId?: string | null;
|
|
3996
|
+
}
|
|
3997
|
+
interface DeleteByFilterOperation {
|
|
3998
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
3999
|
+
filter?: Record<string, any> | null;
|
|
4000
|
+
/**
|
|
4001
|
+
* tenant id for custom tenancy strategy
|
|
4002
|
+
* @minLength 2
|
|
4003
|
+
* @maxLength 300
|
|
4004
|
+
*/
|
|
4005
|
+
tenantId?: string | null;
|
|
4006
|
+
}
|
|
4007
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
4008
|
+
/** documents matching this filter will be updated */
|
|
4009
|
+
filter?: Record<string, any> | null;
|
|
4010
|
+
/** partial document to apply */
|
|
4011
|
+
document?: InternalDocument;
|
|
4012
|
+
/**
|
|
4013
|
+
* tenant id for custom tenancy strategy
|
|
4014
|
+
* @minLength 2
|
|
4015
|
+
* @maxLength 300
|
|
4016
|
+
*/
|
|
4017
|
+
tenantId?: string | null;
|
|
4018
|
+
}
|
|
4019
|
+
interface InternalUpdateExistingOperation {
|
|
4020
|
+
/** documents to update */
|
|
4021
|
+
documents?: InternalDocument[];
|
|
4022
|
+
}
|
|
4023
|
+
interface VersionedDocumentUpdateOperation {
|
|
4024
|
+
/** documents to create or overwrite */
|
|
4025
|
+
documents?: InternalDocument[];
|
|
4026
|
+
/** versioning mode to use instead of default */
|
|
4027
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4028
|
+
}
|
|
4029
|
+
declare enum VersioningMode {
|
|
4030
|
+
/** use default versioning mode agreed with search team */
|
|
4031
|
+
DEFAULT = "DEFAULT",
|
|
4032
|
+
/** execute only if version is greater than existing */
|
|
4033
|
+
GREATER_THAN = "GREATER_THAN",
|
|
4034
|
+
/** execute only if version is greater or equal to existing */
|
|
4035
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4036
|
+
}
|
|
4037
|
+
/** @enumType */
|
|
4038
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4039
|
+
interface VersionedDeleteByIdsOperation {
|
|
4040
|
+
/** ids with version of the documents to delete */
|
|
4041
|
+
documentIds?: VersionedDocumentId[];
|
|
4042
|
+
/**
|
|
4043
|
+
* tenant id for custom tenancy strategy
|
|
4044
|
+
* @minLength 2
|
|
4045
|
+
* @maxLength 300
|
|
4046
|
+
*/
|
|
4047
|
+
tenantId?: string | null;
|
|
4048
|
+
}
|
|
4049
|
+
interface VersionedDocumentId {
|
|
4050
|
+
/** document id */
|
|
4051
|
+
documentId?: string;
|
|
4052
|
+
/** document version */
|
|
4053
|
+
version?: string;
|
|
4054
|
+
/** versioning mode to use instead of default */
|
|
4055
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4056
|
+
}
|
|
4057
|
+
interface TriggerReindexRequest {
|
|
4058
|
+
/** @format GUID */
|
|
4059
|
+
metasiteId?: string;
|
|
4060
|
+
/**
|
|
4061
|
+
* @minLength 1
|
|
4062
|
+
* @maxLength 100
|
|
4063
|
+
* @maxSize 100
|
|
4064
|
+
*/
|
|
4065
|
+
orderIds?: string[];
|
|
4066
|
+
}
|
|
4067
|
+
interface TriggerReindexResponse {
|
|
4068
|
+
}
|
|
4069
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
4070
|
+
/** @maxSize 25 */
|
|
4071
|
+
requests?: TriggerReindexOrderRequest[];
|
|
4072
|
+
}
|
|
4073
|
+
interface TriggerReindexOrderRequest {
|
|
4074
|
+
/** @format GUID */
|
|
4075
|
+
metasiteId?: string;
|
|
4076
|
+
/**
|
|
4077
|
+
* @minLength 1
|
|
4078
|
+
* @maxLength 100
|
|
4079
|
+
*/
|
|
4080
|
+
orderId?: string;
|
|
4081
|
+
}
|
|
4082
|
+
interface DiffmatokyPayload {
|
|
4083
|
+
left?: string;
|
|
4084
|
+
right?: string;
|
|
4085
|
+
compareChannel?: string;
|
|
4086
|
+
entityId?: string;
|
|
4087
|
+
errorInformation?: ErrorInformation;
|
|
4088
|
+
tags?: string[];
|
|
4089
|
+
}
|
|
4090
|
+
interface ErrorInformation {
|
|
4091
|
+
stackTrace?: string;
|
|
4092
|
+
}
|
|
4093
|
+
interface ContinueSideEffectsFlowInLegacyData {
|
|
4094
|
+
storeId?: string;
|
|
4095
|
+
orderId?: string;
|
|
4096
|
+
ordersExperiments?: OrdersExperiments;
|
|
4097
|
+
}
|
|
4098
|
+
interface SnapshotMessage {
|
|
4099
|
+
_id?: string;
|
|
4100
|
+
opType?: number;
|
|
4101
|
+
}
|
|
4102
|
+
interface IndexingMessage {
|
|
4103
|
+
_id?: string;
|
|
4104
|
+
opType?: number;
|
|
4105
|
+
requiredVersions?: string[];
|
|
4106
|
+
}
|
|
4107
|
+
interface GetOrderRequest {
|
|
4108
|
+
/**
|
|
4109
|
+
* ID of the order to retrieve.
|
|
4110
|
+
* @minLength 1
|
|
4111
|
+
* @maxLength 100
|
|
4112
|
+
*/
|
|
4113
|
+
_id: string;
|
|
4114
|
+
}
|
|
4115
|
+
interface GetOrderResponse {
|
|
4116
|
+
/** The requested order. */
|
|
4117
|
+
order?: Order;
|
|
4118
|
+
}
|
|
4119
|
+
interface InternalQueryOrdersRequest {
|
|
4120
|
+
/** Query options. */
|
|
4121
|
+
query?: PlatformQuery;
|
|
4122
|
+
}
|
|
4123
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4124
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4125
|
+
paging?: PlatformPaging;
|
|
4126
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4127
|
+
cursorPaging?: CursorPaging;
|
|
4128
|
+
/** Filter object. */
|
|
4129
|
+
filter?: Record<string, any> | null;
|
|
4130
|
+
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
4131
|
+
sort?: Sorting[];
|
|
4132
|
+
}
|
|
4133
|
+
/** @oneof */
|
|
4134
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
4135
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4136
|
+
paging?: PlatformPaging;
|
|
4137
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4138
|
+
cursorPaging?: CursorPaging;
|
|
4139
|
+
}
|
|
4140
|
+
interface Sorting {
|
|
4141
|
+
/**
|
|
4142
|
+
* Name of the field to sort by.
|
|
4143
|
+
* @maxLength 512
|
|
4144
|
+
*/
|
|
4145
|
+
fieldName?: string;
|
|
4146
|
+
/** Sort order. */
|
|
4147
|
+
order?: SortOrderWithLiterals;
|
|
4148
|
+
}
|
|
4149
|
+
declare enum SortOrder {
|
|
4150
|
+
ASC = "ASC",
|
|
4151
|
+
DESC = "DESC"
|
|
4152
|
+
}
|
|
4153
|
+
/** @enumType */
|
|
4154
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4155
|
+
interface PlatformPaging {
|
|
4156
|
+
/**
|
|
4157
|
+
* Number of items to load.
|
|
4158
|
+
* @max 100
|
|
4159
|
+
*/
|
|
4160
|
+
limit?: number | null;
|
|
4161
|
+
/** Number of items to skip in the current sort order. */
|
|
4162
|
+
offset?: number | null;
|
|
4163
|
+
}
|
|
4164
|
+
interface CursorPaging {
|
|
4165
|
+
/**
|
|
4166
|
+
* Maximum number of items to return in the results.
|
|
4167
|
+
* @max 100
|
|
4168
|
+
*/
|
|
4169
|
+
limit?: number | null;
|
|
4170
|
+
/**
|
|
4171
|
+
* Pointer to the next or previous page in the list of results.
|
|
4172
|
+
*
|
|
4173
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
4174
|
+
* Not relevant for the first request.
|
|
4175
|
+
* @maxLength 16000
|
|
4176
|
+
*/
|
|
4177
|
+
cursor?: string | null;
|
|
4178
|
+
}
|
|
4179
|
+
interface InternalQueryOrdersResponse {
|
|
4180
|
+
/** List of orders. */
|
|
4181
|
+
orders?: Order[];
|
|
4182
|
+
/** Details on the paged set of results returned. */
|
|
4183
|
+
metadata?: PlatformPagingMetadata;
|
|
4184
|
+
}
|
|
4185
|
+
interface PlatformPagingMetadata {
|
|
4186
|
+
/** The number of items returned in this response. */
|
|
4187
|
+
count?: number | null;
|
|
4188
|
+
/** The offset which was requested. Returned if offset paging was used. */
|
|
4189
|
+
offset?: number | null;
|
|
4190
|
+
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
4191
|
+
total?: number | null;
|
|
4192
|
+
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4193
|
+
cursors?: Cursors;
|
|
4194
|
+
}
|
|
4195
|
+
interface Cursors {
|
|
4196
|
+
/**
|
|
4197
|
+
* Cursor string pointing to the next page in the list of results.
|
|
4198
|
+
* @maxLength 16000
|
|
4199
|
+
*/
|
|
4200
|
+
next?: string | null;
|
|
4201
|
+
/**
|
|
4202
|
+
* Cursor pointing to the previous page in the list of results.
|
|
4203
|
+
* @maxLength 16000
|
|
4204
|
+
*/
|
|
4205
|
+
prev?: string | null;
|
|
4206
|
+
}
|
|
4207
|
+
interface QueryOrderRequest {
|
|
4208
|
+
/** Query options. */
|
|
4209
|
+
query?: PlatformQuery;
|
|
4210
|
+
}
|
|
4211
|
+
interface QueryOrderResponse {
|
|
4212
|
+
/** List of orders. */
|
|
4213
|
+
orders?: Order[];
|
|
4214
|
+
/** Details on the paged set of results returned. */
|
|
4215
|
+
metadata?: PlatformPagingMetadata;
|
|
4216
|
+
}
|
|
4217
|
+
interface SearchOrdersRequest {
|
|
4218
|
+
/** Search options. */
|
|
4219
|
+
search?: CursorSearch;
|
|
4220
|
+
}
|
|
4221
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
4222
|
+
/**
|
|
4223
|
+
* Cursor paging options.
|
|
4224
|
+
*
|
|
4225
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4226
|
+
*/
|
|
4227
|
+
cursorPaging?: CursorPaging;
|
|
4228
|
+
/**
|
|
4229
|
+
* Filter object.
|
|
2537
4230
|
*
|
|
2538
4231
|
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
2539
4232
|
*/
|
|
@@ -2629,65 +4322,29 @@ interface BulkUpdateOrdersRequest {
|
|
|
2629
4322
|
/**
|
|
2630
4323
|
* Orders to update.
|
|
2631
4324
|
* @minSize 1
|
|
2632
|
-
* @maxSize 100
|
|
2633
|
-
*/
|
|
2634
|
-
orders: MaskedOrder[];
|
|
2635
|
-
/**
|
|
2636
|
-
* Whether to return the full order entities.
|
|
2637
|
-
*
|
|
2638
|
-
* Default: `false`
|
|
2639
|
-
*/
|
|
2640
|
-
returnEntity?: boolean;
|
|
2641
|
-
}
|
|
2642
|
-
interface MaskedOrder {
|
|
2643
|
-
/** Order to be updated. */
|
|
2644
|
-
order?: Order;
|
|
2645
|
-
}
|
|
2646
|
-
interface BulkUpdateOrdersResponse {
|
|
2647
|
-
/**
|
|
2648
|
-
* Bulk action results.
|
|
2649
|
-
* @minSize 1
|
|
2650
|
-
* @maxSize 100
|
|
2651
|
-
*/
|
|
2652
|
-
results?: BulkOrderResult[];
|
|
2653
|
-
/** Bulk action metadata. */
|
|
2654
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2655
|
-
}
|
|
2656
|
-
interface BulkOrderResult {
|
|
2657
|
-
/** Item metadata. */
|
|
2658
|
-
itemMetadata?: ItemMetadata;
|
|
2659
|
-
/**
|
|
2660
|
-
* Updated order.
|
|
2661
|
-
*
|
|
2662
|
-
* Returned when `returnFullEntity = true`.
|
|
2663
|
-
*/
|
|
2664
|
-
item?: Order;
|
|
2665
|
-
}
|
|
2666
|
-
interface ItemMetadata {
|
|
2667
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2668
|
-
_id?: string | null;
|
|
2669
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2670
|
-
originalIndex?: number;
|
|
2671
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2672
|
-
success?: boolean;
|
|
2673
|
-
/** Details about the error in case of failure. */
|
|
2674
|
-
error?: ApplicationError;
|
|
4325
|
+
* @maxSize 100
|
|
4326
|
+
*/
|
|
4327
|
+
orders: MaskedOrder[];
|
|
4328
|
+
/**
|
|
4329
|
+
* Whether to return the full order entities.
|
|
4330
|
+
*
|
|
4331
|
+
* Default: `false`
|
|
4332
|
+
*/
|
|
4333
|
+
returnEntity?: boolean;
|
|
2675
4334
|
}
|
|
2676
|
-
interface
|
|
2677
|
-
/**
|
|
2678
|
-
|
|
2679
|
-
/** Description of the error. */
|
|
2680
|
-
description?: string;
|
|
2681
|
-
/** Data related to the error. */
|
|
2682
|
-
data?: Record<string, any> | null;
|
|
4335
|
+
interface MaskedOrder {
|
|
4336
|
+
/** Order to be updated. */
|
|
4337
|
+
order?: Order;
|
|
2683
4338
|
}
|
|
2684
|
-
interface
|
|
2685
|
-
/**
|
|
2686
|
-
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
4339
|
+
interface BulkUpdateOrdersResponse {
|
|
4340
|
+
/**
|
|
4341
|
+
* Bulk action results.
|
|
4342
|
+
* @minSize 1
|
|
4343
|
+
* @maxSize 100
|
|
4344
|
+
*/
|
|
4345
|
+
results?: BulkOrderResult[];
|
|
4346
|
+
/** Bulk action metadata. */
|
|
4347
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2691
4348
|
}
|
|
2692
4349
|
interface CommitDeltasRequest {
|
|
2693
4350
|
/** Order id to be updated */
|
|
@@ -2713,6 +4370,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
2713
4370
|
changedShippingInfo?: V1ShippingInformation;
|
|
2714
4371
|
/** Remove existing shipping info. */
|
|
2715
4372
|
shippingInfoRemoved?: boolean;
|
|
4373
|
+
/**
|
|
4374
|
+
* Buyer info and selected buyer option details.
|
|
4375
|
+
* @internal
|
|
4376
|
+
*/
|
|
4377
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4378
|
+
/**
|
|
4379
|
+
* Remove existing buyer info.
|
|
4380
|
+
* @internal
|
|
4381
|
+
*/
|
|
4382
|
+
buyerInfoRemoved?: boolean;
|
|
4383
|
+
/**
|
|
4384
|
+
* Updated billing info.
|
|
4385
|
+
* @internal
|
|
4386
|
+
*/
|
|
4387
|
+
changedBillingInfo?: AddressWithContact;
|
|
4388
|
+
/**
|
|
4389
|
+
* Remove existing billing info.
|
|
4390
|
+
* @internal
|
|
4391
|
+
*/
|
|
4392
|
+
billingInfoRemoved?: boolean;
|
|
4393
|
+
/**
|
|
4394
|
+
* Updated recipient info.
|
|
4395
|
+
* @internal
|
|
4396
|
+
*/
|
|
4397
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4398
|
+
/**
|
|
4399
|
+
* Remove existing recipient info.
|
|
4400
|
+
* @internal
|
|
4401
|
+
*/
|
|
4402
|
+
recipientInfoRemoved?: boolean;
|
|
2716
4403
|
/**
|
|
2717
4404
|
* Added/updated/removed order line items.
|
|
2718
4405
|
* @maxSize 300
|
|
@@ -2754,12 +4441,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
2754
4441
|
}
|
|
2755
4442
|
/** @oneof */
|
|
2756
4443
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4444
|
+
/**
|
|
4445
|
+
* Buyer info and selected buyer option details.
|
|
4446
|
+
* @internal
|
|
4447
|
+
*/
|
|
4448
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4449
|
+
/**
|
|
4450
|
+
* Remove existing buyer info.
|
|
4451
|
+
* @internal
|
|
4452
|
+
*/
|
|
4453
|
+
buyerInfoRemoved?: boolean;
|
|
2757
4454
|
}
|
|
2758
4455
|
/** @oneof */
|
|
2759
4456
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4457
|
+
/**
|
|
4458
|
+
* Updated billing info.
|
|
4459
|
+
* @internal
|
|
4460
|
+
*/
|
|
4461
|
+
changedBillingInfo?: AddressWithContact;
|
|
4462
|
+
/**
|
|
4463
|
+
* Remove existing billing info.
|
|
4464
|
+
* @internal
|
|
4465
|
+
*/
|
|
4466
|
+
billingInfoRemoved?: boolean;
|
|
2760
4467
|
}
|
|
2761
4468
|
/** @oneof */
|
|
2762
4469
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4470
|
+
/**
|
|
4471
|
+
* Updated recipient info.
|
|
4472
|
+
* @internal
|
|
4473
|
+
*/
|
|
4474
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4475
|
+
/**
|
|
4476
|
+
* Remove existing recipient info.
|
|
4477
|
+
* @internal
|
|
4478
|
+
*/
|
|
4479
|
+
recipientInfoRemoved?: boolean;
|
|
2763
4480
|
}
|
|
2764
4481
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
2765
4482
|
/** The line item was added. */
|
|
@@ -2859,8 +4576,21 @@ interface OrderLineItemChangedDetails {
|
|
|
2859
4576
|
* @maxSize 5
|
|
2860
4577
|
*/
|
|
2861
4578
|
locations?: LocationAndQuantity[];
|
|
4579
|
+
/**
|
|
4580
|
+
* ID of the app managing the inventory.
|
|
4581
|
+
* @internal
|
|
4582
|
+
* @format GUID
|
|
4583
|
+
*/
|
|
4584
|
+
inventoryAppId?: string | null;
|
|
2862
4585
|
/** Subscription info. */
|
|
2863
4586
|
subscriptionInfo?: SubscriptionInfo;
|
|
4587
|
+
/**
|
|
4588
|
+
* Modifier groups that were added to the item.
|
|
4589
|
+
* @internal
|
|
4590
|
+
* @readonly
|
|
4591
|
+
* @maxSize 10
|
|
4592
|
+
*/
|
|
4593
|
+
modifierGroups?: ModifierGroup[];
|
|
2864
4594
|
}
|
|
2865
4595
|
/** Type of selected payment option for catalog item */
|
|
2866
4596
|
declare enum DeltaPaymentOptionType {
|
|
@@ -3247,6 +4977,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3247
4977
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3248
4978
|
/** Payment method is saved for order */
|
|
3249
4979
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
4980
|
+
/**
|
|
4981
|
+
* Details of an initiated refund process.
|
|
4982
|
+
*
|
|
4983
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
4984
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
4985
|
+
* @internal
|
|
4986
|
+
*/
|
|
4987
|
+
refundInitiated?: RefundInitiated;
|
|
4988
|
+
/**
|
|
4989
|
+
* Details of a refunded payment.
|
|
4990
|
+
*
|
|
4991
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
4992
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
4993
|
+
* @internal
|
|
4994
|
+
*/
|
|
4995
|
+
paymentRefunded?: PaymentRefunded;
|
|
4996
|
+
/**
|
|
4997
|
+
* Details of a failed payment refund.
|
|
4998
|
+
*
|
|
4999
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5000
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5001
|
+
* @internal
|
|
5002
|
+
*/
|
|
5003
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5004
|
+
/**
|
|
5005
|
+
* Details of refund to store credit.
|
|
5006
|
+
* @internal
|
|
5007
|
+
*/
|
|
5008
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3250
5009
|
/** Details of a pending payment */
|
|
3251
5010
|
paymentPending?: PaymentPending;
|
|
3252
5011
|
/** Details of a canceled payment */
|
|
@@ -3257,6 +5016,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3257
5016
|
orderPending?: OrderPending;
|
|
3258
5017
|
/** Order rejected */
|
|
3259
5018
|
orderRejected?: OrderRejected;
|
|
5019
|
+
/**
|
|
5020
|
+
* Receipt was added for associated payment
|
|
5021
|
+
* @internal
|
|
5022
|
+
*/
|
|
5023
|
+
receiptCreated?: ReceiptCreated;
|
|
5024
|
+
/**
|
|
5025
|
+
* Receipt sent to customer
|
|
5026
|
+
* @internal
|
|
5027
|
+
*/
|
|
5028
|
+
receiptSent?: ReceiptSent;
|
|
5029
|
+
/**
|
|
5030
|
+
* Chargeback created for one of the order's payments.
|
|
5031
|
+
* @internal
|
|
5032
|
+
*/
|
|
5033
|
+
chargebackCreated?: ChargebackCreated;
|
|
5034
|
+
/**
|
|
5035
|
+
* Chargeback reversed for one of the order's payments.
|
|
5036
|
+
* @internal
|
|
5037
|
+
*/
|
|
5038
|
+
chargebackReversed?: ChargebackReversed;
|
|
3260
5039
|
/**
|
|
3261
5040
|
* Internal activity ID.
|
|
3262
5041
|
* @format GUID
|
|
@@ -3321,6 +5100,35 @@ interface InternalActivityContentOneOf {
|
|
|
3321
5100
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3322
5101
|
/** Payment method is saved for order */
|
|
3323
5102
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5103
|
+
/**
|
|
5104
|
+
* Details of an initiated refund process.
|
|
5105
|
+
*
|
|
5106
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5107
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5108
|
+
* @internal
|
|
5109
|
+
*/
|
|
5110
|
+
refundInitiated?: RefundInitiated;
|
|
5111
|
+
/**
|
|
5112
|
+
* Details of a refunded payment.
|
|
5113
|
+
*
|
|
5114
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5115
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5116
|
+
* @internal
|
|
5117
|
+
*/
|
|
5118
|
+
paymentRefunded?: PaymentRefunded;
|
|
5119
|
+
/**
|
|
5120
|
+
* Details of a failed payment refund.
|
|
5121
|
+
*
|
|
5122
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5123
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5124
|
+
* @internal
|
|
5125
|
+
*/
|
|
5126
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5127
|
+
/**
|
|
5128
|
+
* Details of refund to store credit.
|
|
5129
|
+
* @internal
|
|
5130
|
+
*/
|
|
5131
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3324
5132
|
/** Details of a pending payment */
|
|
3325
5133
|
paymentPending?: PaymentPending;
|
|
3326
5134
|
/** Details of a canceled payment */
|
|
@@ -3331,6 +5139,26 @@ interface InternalActivityContentOneOf {
|
|
|
3331
5139
|
orderPending?: OrderPending;
|
|
3332
5140
|
/** Order rejected */
|
|
3333
5141
|
orderRejected?: OrderRejected;
|
|
5142
|
+
/**
|
|
5143
|
+
* Receipt was added for associated payment
|
|
5144
|
+
* @internal
|
|
5145
|
+
*/
|
|
5146
|
+
receiptCreated?: ReceiptCreated;
|
|
5147
|
+
/**
|
|
5148
|
+
* Receipt sent to customer
|
|
5149
|
+
* @internal
|
|
5150
|
+
*/
|
|
5151
|
+
receiptSent?: ReceiptSent;
|
|
5152
|
+
/**
|
|
5153
|
+
* Chargeback created for one of the order's payments.
|
|
5154
|
+
* @internal
|
|
5155
|
+
*/
|
|
5156
|
+
chargebackCreated?: ChargebackCreated;
|
|
5157
|
+
/**
|
|
5158
|
+
* Chargeback reversed for one of the order's payments.
|
|
5159
|
+
* @internal
|
|
5160
|
+
*/
|
|
5161
|
+
chargebackReversed?: ChargebackReversed;
|
|
3334
5162
|
}
|
|
3335
5163
|
/** Order placed */
|
|
3336
5164
|
interface OrderPlaced {
|
|
@@ -3691,7 +5519,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
3691
5519
|
interface BulkSetBusinessLocationResult {
|
|
3692
5520
|
itemMetadata?: ItemMetadata;
|
|
3693
5521
|
}
|
|
3694
|
-
interface
|
|
5522
|
+
interface V1MarkOrderAsPaidRequest {
|
|
3695
5523
|
/**
|
|
3696
5524
|
* Order ID.
|
|
3697
5525
|
* @minLength 1
|
|
@@ -3699,7 +5527,7 @@ interface MarkOrderAsPaidRequest {
|
|
|
3699
5527
|
*/
|
|
3700
5528
|
_id?: string;
|
|
3701
5529
|
}
|
|
3702
|
-
interface
|
|
5530
|
+
interface V1MarkOrderAsPaidResponse {
|
|
3703
5531
|
/** Updated order. */
|
|
3704
5532
|
order?: Order;
|
|
3705
5533
|
}
|
|
@@ -3710,7 +5538,7 @@ interface PaymentStatusUpdated {
|
|
|
3710
5538
|
/** The previous status (before the update) */
|
|
3711
5539
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
3712
5540
|
}
|
|
3713
|
-
interface
|
|
5541
|
+
interface V1BulkMarkOrdersAsPaidRequest {
|
|
3714
5542
|
/**
|
|
3715
5543
|
* IDs of orders to mark as paid.
|
|
3716
5544
|
* @minSize 1
|
|
@@ -3720,7 +5548,7 @@ interface BulkMarkOrdersAsPaidRequest {
|
|
|
3720
5548
|
*/
|
|
3721
5549
|
ids?: string[];
|
|
3722
5550
|
}
|
|
3723
|
-
interface
|
|
5551
|
+
interface V1BulkMarkOrdersAsPaidResponse {
|
|
3724
5552
|
/**
|
|
3725
5553
|
* Items updated by the bulk action.
|
|
3726
5554
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -3729,7 +5557,7 @@ interface BulkMarkOrdersAsPaidResponse {
|
|
|
3729
5557
|
/** Bulk action metadata. */
|
|
3730
5558
|
bulkActionMetadata?: BulkActionMetadata;
|
|
3731
5559
|
}
|
|
3732
|
-
interface
|
|
5560
|
+
interface V1CreatePaymentGatewayOrderRequest {
|
|
3733
5561
|
/**
|
|
3734
5562
|
* eCom Order ID
|
|
3735
5563
|
* @minLength 1
|
|
@@ -3737,7 +5565,7 @@ interface CreatePaymentGatewayOrderRequest {
|
|
|
3737
5565
|
*/
|
|
3738
5566
|
ecomOrderId?: string;
|
|
3739
5567
|
}
|
|
3740
|
-
interface
|
|
5568
|
+
interface V1CreatePaymentGatewayOrderResponse {
|
|
3741
5569
|
/** ID of the order created in the payment gateway */
|
|
3742
5570
|
paymentGatewayOrderId?: string;
|
|
3743
5571
|
}
|
|
@@ -3827,70 +5655,6 @@ interface BulkUpdateOrderTagsResponse {
|
|
|
3827
5655
|
interface BulkUpdateOrderTagsResult {
|
|
3828
5656
|
itemMetadata?: ItemMetadata;
|
|
3829
5657
|
}
|
|
3830
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3831
|
-
createdEvent?: EntityCreatedEvent;
|
|
3832
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3833
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3834
|
-
actionEvent?: ActionEvent;
|
|
3835
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3836
|
-
_id?: string;
|
|
3837
|
-
/**
|
|
3838
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3839
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3840
|
-
*/
|
|
3841
|
-
entityFqdn?: string;
|
|
3842
|
-
/**
|
|
3843
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3844
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3845
|
-
*/
|
|
3846
|
-
slug?: string;
|
|
3847
|
-
/** ID of the entity associated with the event. */
|
|
3848
|
-
entityId?: string;
|
|
3849
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3850
|
-
eventTime?: Date | null;
|
|
3851
|
-
/**
|
|
3852
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3853
|
-
* (for example, GDPR).
|
|
3854
|
-
*/
|
|
3855
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3856
|
-
/** If present, indicates the action that triggered the event. */
|
|
3857
|
-
originatedFrom?: string | null;
|
|
3858
|
-
/**
|
|
3859
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3860
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3861
|
-
*/
|
|
3862
|
-
entityEventSequence?: string | null;
|
|
3863
|
-
}
|
|
3864
|
-
/** @oneof */
|
|
3865
|
-
interface DomainEventBodyOneOf {
|
|
3866
|
-
createdEvent?: EntityCreatedEvent;
|
|
3867
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3868
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3869
|
-
actionEvent?: ActionEvent;
|
|
3870
|
-
}
|
|
3871
|
-
interface EntityCreatedEvent {
|
|
3872
|
-
entity?: string;
|
|
3873
|
-
}
|
|
3874
|
-
interface RestoreInfo {
|
|
3875
|
-
deletedDate?: Date | null;
|
|
3876
|
-
}
|
|
3877
|
-
interface EntityUpdatedEvent {
|
|
3878
|
-
/**
|
|
3879
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3880
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3881
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3882
|
-
*/
|
|
3883
|
-
currentEntity?: string;
|
|
3884
|
-
}
|
|
3885
|
-
interface EntityDeletedEvent {
|
|
3886
|
-
/** Entity that was deleted. */
|
|
3887
|
-
deletedEntity?: string | null;
|
|
3888
|
-
}
|
|
3889
|
-
interface ActionEvent {
|
|
3890
|
-
body?: string;
|
|
3891
|
-
}
|
|
3892
|
-
interface Empty {
|
|
3893
|
-
}
|
|
3894
5658
|
interface Task {
|
|
3895
5659
|
key?: TaskKey;
|
|
3896
5660
|
executeAt?: Date | null;
|
|
@@ -4209,9 +5973,9 @@ interface CalculatedTax {
|
|
|
4209
5973
|
code?: string | null;
|
|
4210
5974
|
}
|
|
4211
5975
|
interface Payments {
|
|
4212
|
-
payments?:
|
|
5976
|
+
payments?: InvoicesPayment[];
|
|
4213
5977
|
}
|
|
4214
|
-
interface
|
|
5978
|
+
interface InvoicesPayment {
|
|
4215
5979
|
/** document */
|
|
4216
5980
|
_id?: string;
|
|
4217
5981
|
type?: string;
|
|
@@ -4334,90 +6098,137 @@ declare enum InvoiceStatus {
|
|
|
4334
6098
|
Processing = "Processing",
|
|
4335
6099
|
Paid = "Paid",
|
|
4336
6100
|
Overdue = "Overdue",
|
|
4337
|
-
Void = "Void",
|
|
4338
|
-
Deleted = "Deleted",
|
|
4339
|
-
PartiallyPaid = "PartiallyPaid",
|
|
4340
|
-
PartialAndOverdue = "PartialAndOverdue"
|
|
4341
|
-
}
|
|
4342
|
-
/** @enumType */
|
|
4343
|
-
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
4344
|
-
interface TriggerSideEffectsFromLegacyData {
|
|
4345
|
-
storeId?: string;
|
|
4346
|
-
orderId?: string;
|
|
4347
|
-
ordersExperiments?: OrdersExperiments;
|
|
4348
|
-
}
|
|
4349
|
-
interface MessageEnvelope {
|
|
4350
|
-
/**
|
|
4351
|
-
* App instance ID.
|
|
4352
|
-
* @format GUID
|
|
4353
|
-
*/
|
|
4354
|
-
instanceId?: string | null;
|
|
4355
|
-
/**
|
|
4356
|
-
* Event type.
|
|
4357
|
-
* @maxLength 150
|
|
4358
|
-
*/
|
|
4359
|
-
eventType?: string;
|
|
4360
|
-
/** The identification type and identity data. */
|
|
4361
|
-
identity?: IdentificationData;
|
|
4362
|
-
/** Stringify payload. */
|
|
4363
|
-
data?: string;
|
|
4364
|
-
}
|
|
4365
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4366
|
-
/**
|
|
4367
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4368
|
-
* @format GUID
|
|
4369
|
-
*/
|
|
4370
|
-
anonymousVisitorId?: string;
|
|
4371
|
-
/**
|
|
4372
|
-
* ID of a site visitor that has logged in to the site.
|
|
4373
|
-
* @format GUID
|
|
4374
|
-
*/
|
|
4375
|
-
memberId?: string;
|
|
4376
|
-
/**
|
|
4377
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4378
|
-
* @format GUID
|
|
4379
|
-
*/
|
|
4380
|
-
wixUserId?: string;
|
|
4381
|
-
/**
|
|
4382
|
-
* ID of an app.
|
|
4383
|
-
* @format GUID
|
|
4384
|
-
*/
|
|
4385
|
-
appId?: string;
|
|
4386
|
-
/** @readonly */
|
|
4387
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4388
|
-
}
|
|
4389
|
-
/** @oneof */
|
|
4390
|
-
interface IdentificationDataIdOneOf {
|
|
4391
|
-
/**
|
|
4392
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4393
|
-
* @format GUID
|
|
4394
|
-
*/
|
|
4395
|
-
anonymousVisitorId?: string;
|
|
4396
|
-
/**
|
|
4397
|
-
* ID of a site visitor that has logged in to the site.
|
|
4398
|
-
* @format GUID
|
|
4399
|
-
*/
|
|
4400
|
-
memberId?: string;
|
|
4401
|
-
/**
|
|
4402
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4403
|
-
* @format GUID
|
|
4404
|
-
*/
|
|
4405
|
-
wixUserId?: string;
|
|
4406
|
-
/**
|
|
4407
|
-
* ID of an app.
|
|
4408
|
-
* @format GUID
|
|
4409
|
-
*/
|
|
4410
|
-
appId?: string;
|
|
4411
|
-
}
|
|
4412
|
-
declare enum WebhookIdentityType {
|
|
4413
|
-
UNKNOWN = "UNKNOWN",
|
|
4414
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4415
|
-
MEMBER = "MEMBER",
|
|
4416
|
-
WIX_USER = "WIX_USER",
|
|
4417
|
-
APP = "APP"
|
|
6101
|
+
Void = "Void",
|
|
6102
|
+
Deleted = "Deleted",
|
|
6103
|
+
PartiallyPaid = "PartiallyPaid",
|
|
6104
|
+
PartialAndOverdue = "PartialAndOverdue"
|
|
4418
6105
|
}
|
|
4419
6106
|
/** @enumType */
|
|
4420
|
-
type
|
|
6107
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6108
|
+
interface TriggerSideEffectsFromLegacyData {
|
|
6109
|
+
storeId?: string;
|
|
6110
|
+
orderId?: string;
|
|
6111
|
+
ordersExperiments?: OrdersExperiments;
|
|
6112
|
+
}
|
|
6113
|
+
type PreparePaymentCollectionApplicationErrors = {
|
|
6114
|
+
code?: 'PAYMENT_METHODS_NOT_FOUND';
|
|
6115
|
+
description?: string;
|
|
6116
|
+
data?: Record<string, any>;
|
|
6117
|
+
} | {
|
|
6118
|
+
code?: 'ORDER_CANCELED';
|
|
6119
|
+
description?: string;
|
|
6120
|
+
data?: Record<string, any>;
|
|
6121
|
+
} | {
|
|
6122
|
+
code?: 'INVALID_AMOUNT';
|
|
6123
|
+
description?: string;
|
|
6124
|
+
data?: Record<string, any>;
|
|
6125
|
+
} | {
|
|
6126
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6127
|
+
description?: string;
|
|
6128
|
+
data?: Record<string, any>;
|
|
6129
|
+
} | {
|
|
6130
|
+
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
6131
|
+
description?: string;
|
|
6132
|
+
data?: Record<string, any>;
|
|
6133
|
+
};
|
|
6134
|
+
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
6135
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6136
|
+
description?: string;
|
|
6137
|
+
data?: Record<string, any>;
|
|
6138
|
+
} | {
|
|
6139
|
+
code?: 'INVALID_AMOUNT';
|
|
6140
|
+
description?: string;
|
|
6141
|
+
data?: Record<string, any>;
|
|
6142
|
+
} | {
|
|
6143
|
+
code?: 'ORDER_CANCELED';
|
|
6144
|
+
description?: string;
|
|
6145
|
+
data?: Record<string, any>;
|
|
6146
|
+
};
|
|
6147
|
+
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
6148
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6149
|
+
description?: string;
|
|
6150
|
+
data?: Record<string, any>;
|
|
6151
|
+
} | {
|
|
6152
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6153
|
+
description?: string;
|
|
6154
|
+
data?: Record<string, any>;
|
|
6155
|
+
};
|
|
6156
|
+
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
6157
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6158
|
+
description?: string;
|
|
6159
|
+
data?: Record<string, any>;
|
|
6160
|
+
} | {
|
|
6161
|
+
code?: 'ORDER_CANCELED';
|
|
6162
|
+
description?: string;
|
|
6163
|
+
data?: Record<string, any>;
|
|
6164
|
+
};
|
|
6165
|
+
type TriggerRefundApplicationErrors = {
|
|
6166
|
+
code?: 'PAYMENTS_NOT_FOUND';
|
|
6167
|
+
description?: string;
|
|
6168
|
+
data?: Record<string, any>;
|
|
6169
|
+
} | {
|
|
6170
|
+
code?: 'REFUND_NOT_AVAILABLE';
|
|
6171
|
+
description?: string;
|
|
6172
|
+
data?: Record<string, any>;
|
|
6173
|
+
} | {
|
|
6174
|
+
code?: 'INVALID_AMOUNT';
|
|
6175
|
+
description?: string;
|
|
6176
|
+
data?: Record<string, any>;
|
|
6177
|
+
};
|
|
6178
|
+
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
6179
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6180
|
+
description?: string;
|
|
6181
|
+
data?: Record<string, any>;
|
|
6182
|
+
} | {
|
|
6183
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6184
|
+
description?: string;
|
|
6185
|
+
data?: Record<string, any>;
|
|
6186
|
+
} | {
|
|
6187
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6188
|
+
description?: string;
|
|
6189
|
+
data?: Record<string, any>;
|
|
6190
|
+
} | {
|
|
6191
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6192
|
+
description?: string;
|
|
6193
|
+
data?: Record<string, any>;
|
|
6194
|
+
} | {
|
|
6195
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6196
|
+
description?: string;
|
|
6197
|
+
data?: Record<string, any>;
|
|
6198
|
+
};
|
|
6199
|
+
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
6200
|
+
code?: 'INVALID_AMOUNT';
|
|
6201
|
+
description?: string;
|
|
6202
|
+
data?: Record<string, any>;
|
|
6203
|
+
} | {
|
|
6204
|
+
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
6205
|
+
description?: string;
|
|
6206
|
+
data?: Record<string, any>;
|
|
6207
|
+
} | {
|
|
6208
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6209
|
+
description?: string;
|
|
6210
|
+
data?: Record<string, any>;
|
|
6211
|
+
} | {
|
|
6212
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6213
|
+
description?: string;
|
|
6214
|
+
data?: Record<string, any>;
|
|
6215
|
+
} | {
|
|
6216
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6217
|
+
description?: string;
|
|
6218
|
+
data?: Record<string, any>;
|
|
6219
|
+
} | {
|
|
6220
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6221
|
+
description?: string;
|
|
6222
|
+
data?: Record<string, any>;
|
|
6223
|
+
} | {
|
|
6224
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6225
|
+
description?: string;
|
|
6226
|
+
data?: Record<string, any>;
|
|
6227
|
+
} | {
|
|
6228
|
+
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6229
|
+
description?: string;
|
|
6230
|
+
data?: Record<string, any>;
|
|
6231
|
+
};
|
|
4421
6232
|
type GetOrderApplicationErrors = {
|
|
4422
6233
|
code?: 'ORDER_NOT_FOUND';
|
|
4423
6234
|
description?: string;
|
|
@@ -4538,6 +6349,32 @@ interface OrderApprovedEnvelope {
|
|
|
4538
6349
|
* @slug approved
|
|
4539
6350
|
*/
|
|
4540
6351
|
declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
6352
|
+
interface OrderUpdatedEnvelope {
|
|
6353
|
+
entity: Order;
|
|
6354
|
+
metadata: EventMetadata;
|
|
6355
|
+
}
|
|
6356
|
+
/** @permissionScope Manage Stores - all permissions
|
|
6357
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6358
|
+
* @permissionScope Manage Stores
|
|
6359
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6360
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
6361
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6362
|
+
* @permissionScope Read Orders
|
|
6363
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6364
|
+
* @permissionScope Read Stores - all read permissions
|
|
6365
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6366
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
6367
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6368
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
6369
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6370
|
+
* @permissionScope Manage Orders
|
|
6371
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6372
|
+
* @permissionId ECOM.READ_ORDERS
|
|
6373
|
+
* @webhook
|
|
6374
|
+
* @eventType wix.ecom.v1.order_updated
|
|
6375
|
+
* @slug updated
|
|
6376
|
+
*/
|
|
6377
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4541
6378
|
interface OrderCanceledEnvelope {
|
|
4542
6379
|
data: OrderCanceledEventOrderCanceled;
|
|
4543
6380
|
metadata: EventMetadata;
|
|
@@ -4627,33 +6464,226 @@ interface OrderPaymentStatusUpdatedEnvelope {
|
|
|
4627
6464
|
* @slug payment_status_updated
|
|
4628
6465
|
*/
|
|
4629
6466
|
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
4630
|
-
|
|
4631
|
-
|
|
4632
|
-
|
|
6467
|
+
type OrderNonNullablePaths = `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}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `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}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `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.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `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` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
|
|
6468
|
+
/**
|
|
6469
|
+
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6470
|
+
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6471
|
+
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6472
|
+
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6473
|
+
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6474
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6475
|
+
* @param amount - Amount to collect
|
|
6476
|
+
* @public
|
|
6477
|
+
* @documentationMaturity preview
|
|
6478
|
+
* @requiredField amount
|
|
6479
|
+
* @requiredField ecomOrderId
|
|
6480
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6481
|
+
* @applicableIdentity APP
|
|
6482
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6483
|
+
*/
|
|
6484
|
+
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
6485
|
+
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
6486
|
+
}>;
|
|
6487
|
+
interface PreparePaymentCollectionOptions {
|
|
6488
|
+
/**
|
|
6489
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6490
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
6491
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6492
|
+
*/
|
|
6493
|
+
paymentGatewayOrderId?: string | null;
|
|
6494
|
+
/**
|
|
6495
|
+
* Whether to delay capture of the payment.
|
|
6496
|
+
* Default: false
|
|
6497
|
+
* @deprecated Whether to delay capture of the payment.
|
|
6498
|
+
* Default: false
|
|
6499
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6500
|
+
* @targetRemovalDate 2024-09-30
|
|
6501
|
+
*/
|
|
6502
|
+
delayedCapture?: boolean;
|
|
6503
|
+
/** Delayed capture payment settings */
|
|
6504
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4633
6505
|
}
|
|
4634
|
-
/**
|
|
4635
|
-
*
|
|
4636
|
-
*
|
|
4637
|
-
*
|
|
4638
|
-
* @
|
|
4639
|
-
* @
|
|
4640
|
-
* @
|
|
4641
|
-
* @
|
|
4642
|
-
* @
|
|
4643
|
-
* @
|
|
4644
|
-
* @
|
|
4645
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4646
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
4647
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4648
|
-
* @permissionScope Manage Orders
|
|
4649
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4650
|
-
* @permissionId ECOM.READ_ORDERS
|
|
4651
|
-
* @webhook
|
|
4652
|
-
* @eventType wix.ecom.v1.order_updated
|
|
4653
|
-
* @slug updated
|
|
6506
|
+
/**
|
|
6507
|
+
* Provides payment collectability status for given order. If payment collection is possible
|
|
6508
|
+
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6509
|
+
* reason why payment collection is not possible.
|
|
6510
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6511
|
+
* @public
|
|
6512
|
+
* @documentationMaturity preview
|
|
6513
|
+
* @requiredField ecomOrderId
|
|
6514
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6515
|
+
* @applicableIdentity APP
|
|
6516
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
4654
6517
|
*/
|
|
4655
|
-
declare function
|
|
4656
|
-
|
|
6518
|
+
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6519
|
+
/**
|
|
6520
|
+
* Records and approves new manual payment with provided custom amount on given order.
|
|
6521
|
+
* Existing pending payments are ignored.
|
|
6522
|
+
* Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
|
|
6523
|
+
* @param orderId - Order ID.
|
|
6524
|
+
* @param amount - Amount to be recorded as approved manual payment for given order
|
|
6525
|
+
* @internal
|
|
6526
|
+
* @documentationMaturity preview
|
|
6527
|
+
* @requiredField amount
|
|
6528
|
+
* @requiredField orderId
|
|
6529
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6530
|
+
* @applicableIdentity APP
|
|
6531
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
|
|
6532
|
+
*/
|
|
6533
|
+
declare function recordManuallyCollectedPayment(orderId: string, amount: Price): Promise<void & {
|
|
6534
|
+
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
|
|
6535
|
+
}>;
|
|
6536
|
+
/**
|
|
6537
|
+
* Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
6538
|
+
* In case the order already has an offline payment transaction associated with it
|
|
6539
|
+
* (usually when manual payment method is chosen at checkout) - This transaction will become approved.
|
|
6540
|
+
* In case the order has no payment transactions associated with it
|
|
6541
|
+
* (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
|
|
6542
|
+
* will be created and approved.
|
|
6543
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6544
|
+
* @internal
|
|
6545
|
+
* @documentationMaturity preview
|
|
6546
|
+
* @requiredField ecomOrderId
|
|
6547
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6548
|
+
* @applicableIdentity APP
|
|
6549
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
6550
|
+
*/
|
|
6551
|
+
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
6552
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
6553
|
+
}[OrderNonNullablePaths]> & {
|
|
6554
|
+
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
6555
|
+
}>;
|
|
6556
|
+
/**
|
|
6557
|
+
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
6558
|
+
* @param ecomOrderIds - IDs of orders to mark as paid.
|
|
6559
|
+
* @internal
|
|
6560
|
+
* @documentationMaturity preview
|
|
6561
|
+
* @requiredField ecomOrderIds
|
|
6562
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6563
|
+
* @applicableIdentity APP
|
|
6564
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
|
|
6565
|
+
*/
|
|
6566
|
+
declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
6567
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
6568
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
6569
|
+
/**
|
|
6570
|
+
* Checks whether this order can be refunded.
|
|
6571
|
+
* @param ecomOrderId - Order ID.
|
|
6572
|
+
* @internal
|
|
6573
|
+
* @documentationMaturity preview
|
|
6574
|
+
* @requiredField ecomOrderId
|
|
6575
|
+
* @permissionId ECOM.READ_TRANSACTIONS
|
|
6576
|
+
* @applicableIdentity APP
|
|
6577
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
|
|
6578
|
+
*/
|
|
6579
|
+
declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
6580
|
+
/**
|
|
6581
|
+
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
6582
|
+
* 1. An explicit amount provided in the request, or;
|
|
6583
|
+
* 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
|
|
6584
|
+
* As a result, an ID of the created payment gateway order would be returned.
|
|
6585
|
+
* You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
|
|
6586
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6587
|
+
* @internal
|
|
6588
|
+
* @documentationMaturity preview
|
|
6589
|
+
* @requiredField ecomOrderId
|
|
6590
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6591
|
+
* @applicableIdentity APP
|
|
6592
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
|
|
6593
|
+
*/
|
|
6594
|
+
declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
|
|
6595
|
+
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
|
|
6596
|
+
}>;
|
|
6597
|
+
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6598
|
+
/** Information about the user who initiated the payment. */
|
|
6599
|
+
chargedBy?: ChargedBy;
|
|
6600
|
+
}
|
|
6601
|
+
/** @param ecomOrderId - Order ID.
|
|
6602
|
+
* @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
6603
|
+
* but a user which is using the membership on behalf of the a member
|
|
6604
|
+
* @internal
|
|
6605
|
+
* @documentationMaturity preview
|
|
6606
|
+
* @requiredField ecomOrderId
|
|
6607
|
+
* @requiredField memberId
|
|
6608
|
+
* @requiredField options.membershipCharges.appId
|
|
6609
|
+
* @requiredField options.membershipCharges.catalogReference
|
|
6610
|
+
* @requiredField options.membershipCharges.catalogReference.appId
|
|
6611
|
+
* @requiredField options.membershipCharges.catalogReference.catalogItemId
|
|
6612
|
+
* @requiredField options.membershipCharges.membershipId
|
|
6613
|
+
* @requiredField options.membershipCharges.membershipName
|
|
6614
|
+
* @requiredField options.membershipCharges.membershipName.original
|
|
6615
|
+
* @requiredField options.membershipCharges.rootCatalogItemId
|
|
6616
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
6617
|
+
* @applicableIdentity APP
|
|
6618
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
|
|
6619
|
+
*/
|
|
6620
|
+
declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
|
|
6621
|
+
interface ChargeMembershipsOptions {
|
|
6622
|
+
/**
|
|
6623
|
+
* List of items to be paid by memberships
|
|
6624
|
+
* @minSize 1
|
|
6625
|
+
* @maxSize 300
|
|
6626
|
+
*/
|
|
6627
|
+
membershipCharges?: MembershipChargeItem[];
|
|
6628
|
+
}
|
|
6629
|
+
/**
|
|
6630
|
+
* Calls corresponding payment providers and creates refund transactions for requested payments.
|
|
6631
|
+
* Updates order transactions based on refund results.
|
|
6632
|
+
* For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
|
|
6633
|
+
* will only update order transactions.
|
|
6634
|
+
* @param ecomOrderId - The order this refund related to
|
|
6635
|
+
* @param payments - Refund operations information
|
|
6636
|
+
* @internal
|
|
6637
|
+
* @documentationMaturity preview
|
|
6638
|
+
* @requiredField ecomOrderId
|
|
6639
|
+
* @requiredField payments
|
|
6640
|
+
* @requiredField payments.paymentId
|
|
6641
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
6642
|
+
* @applicableIdentity APP
|
|
6643
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
|
|
6644
|
+
*/
|
|
6645
|
+
declare function triggerRefund(ecomOrderId: string, payments: NonNullablePaths<PaymentRefund, `paymentId`>[], options?: TriggerRefundOptions): Promise<NonNullablePaths<TriggerRefundResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`> & {
|
|
6646
|
+
__applicationErrorsType?: TriggerRefundApplicationErrors;
|
|
6647
|
+
}>;
|
|
6648
|
+
interface TriggerRefundOptions {
|
|
6649
|
+
/** Business model of a refund */
|
|
6650
|
+
details?: RefundDetails;
|
|
6651
|
+
/** Side effect details related to refund */
|
|
6652
|
+
sideEffects?: RefundSideEffects;
|
|
6653
|
+
}
|
|
6654
|
+
/**
|
|
6655
|
+
* Void authorized payments
|
|
6656
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6657
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6658
|
+
* @param paymentIds - Payment IDs
|
|
6659
|
+
* @public
|
|
6660
|
+
* @documentationMaturity preview
|
|
6661
|
+
* @requiredField ecomOrderId
|
|
6662
|
+
* @requiredField paymentIds
|
|
6663
|
+
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6664
|
+
* @applicableIdentity APP
|
|
6665
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6666
|
+
*/
|
|
6667
|
+
declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
6668
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
6669
|
+
}>;
|
|
6670
|
+
/**
|
|
6671
|
+
* Capture authorized payments
|
|
6672
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6673
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6674
|
+
* @param payments - Capture payments information
|
|
6675
|
+
* @public
|
|
6676
|
+
* @documentationMaturity preview
|
|
6677
|
+
* @requiredField ecomOrderId
|
|
6678
|
+
* @requiredField payments
|
|
6679
|
+
* @requiredField payments.paymentId
|
|
6680
|
+
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6681
|
+
* @applicableIdentity APP
|
|
6682
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6683
|
+
*/
|
|
6684
|
+
declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
6685
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
6686
|
+
}>;
|
|
4657
6687
|
/**
|
|
4658
6688
|
* Retrieves an order.
|
|
4659
6689
|
*
|
|
@@ -5089,6 +7119,23 @@ interface BulkUpdateOrdersOptions {
|
|
|
5089
7119
|
*/
|
|
5090
7120
|
returnEntity?: boolean;
|
|
5091
7121
|
}
|
|
7122
|
+
/** @param _id - Order id to be updated
|
|
7123
|
+
* @internal
|
|
7124
|
+
* @documentationMaturity preview
|
|
7125
|
+
* @requiredField _id
|
|
7126
|
+
* @requiredField options.changes
|
|
7127
|
+
* @requiredField options.changes.priceSummary.subtotal
|
|
7128
|
+
* @requiredField options.changes.priceSummary.total
|
|
7129
|
+
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
7130
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7131
|
+
* @applicableIdentity APP
|
|
7132
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
7133
|
+
*/
|
|
7134
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
7135
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7136
|
+
}[OrderNonNullablePaths]> & {
|
|
7137
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
7138
|
+
}>;
|
|
5092
7139
|
interface CommitDeltasOptions {
|
|
5093
7140
|
/**
|
|
5094
7141
|
* Draft order Id representing this change.
|
|
@@ -5106,6 +7153,21 @@ interface CommitDeltasOptions {
|
|
|
5106
7153
|
*/
|
|
5107
7154
|
reason?: string | null;
|
|
5108
7155
|
}
|
|
7156
|
+
/** @internal
|
|
7157
|
+
* @documentationMaturity preview
|
|
7158
|
+
* @requiredField identifiers
|
|
7159
|
+
* @requiredField identifiers._id
|
|
7160
|
+
* @requiredField identifiers.lineItemId
|
|
7161
|
+
* @requiredField lineItem
|
|
7162
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7163
|
+
* @applicableIdentity APP
|
|
7164
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
7165
|
+
* @deprecated
|
|
7166
|
+
* @targetRemovalDate 2024-02-15
|
|
7167
|
+
*/
|
|
7168
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
7169
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7170
|
+
}[OrderNonNullablePaths]>>;
|
|
5109
7171
|
interface UpdateOrderLineItemIdentifiers {
|
|
5110
7172
|
/**
|
|
5111
7173
|
* Order ID
|
|
@@ -5229,13 +7291,61 @@ interface UpdateOrderLineItem {
|
|
|
5229
7291
|
locations?: LocationAndQuantity[];
|
|
5230
7292
|
/** Address used for tax calculation. */
|
|
5231
7293
|
taxableAddress?: TaxableAddress;
|
|
7294
|
+
/**
|
|
7295
|
+
* ID of the app managing the inventory.
|
|
7296
|
+
* @internal
|
|
7297
|
+
* @format GUID
|
|
7298
|
+
*/
|
|
7299
|
+
inventoryAppId?: string | null;
|
|
5232
7300
|
/**
|
|
5233
7301
|
* Custom extended fields for the line item object.
|
|
5234
7302
|
*
|
|
5235
7303
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
5236
7304
|
*/
|
|
5237
7305
|
extendedFields?: ExtendedFields;
|
|
7306
|
+
/**
|
|
7307
|
+
* Modifier groups that were added to the item.
|
|
7308
|
+
* @internal
|
|
7309
|
+
* @readonly
|
|
7310
|
+
* @maxSize 10
|
|
7311
|
+
*/
|
|
7312
|
+
modifierGroups?: ModifierGroup[];
|
|
5238
7313
|
}
|
|
7314
|
+
/**
|
|
7315
|
+
* Adds a merchant comment to an order.
|
|
7316
|
+
* > **Note:** Activities with type CustomActivity not supported
|
|
7317
|
+
* @param _id - Order ID.
|
|
7318
|
+
* @param activity - Activity info.
|
|
7319
|
+
* @internal
|
|
7320
|
+
* @documentationMaturity preview
|
|
7321
|
+
* @requiredField _id
|
|
7322
|
+
* @requiredField activity
|
|
7323
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7324
|
+
* @applicableIdentity APP
|
|
7325
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
7326
|
+
* @deprecated
|
|
7327
|
+
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
7328
|
+
* @targetRemovalDate 2024-11-01
|
|
7329
|
+
*/
|
|
7330
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
7331
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7332
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
7333
|
+
/**
|
|
7334
|
+
* Updates an order's activity.
|
|
7335
|
+
* @param activity - Activity info.
|
|
7336
|
+
* @internal
|
|
7337
|
+
* @documentationMaturity preview
|
|
7338
|
+
* @requiredField activity
|
|
7339
|
+
* @requiredField identifiers
|
|
7340
|
+
* @requiredField identifiers._id
|
|
7341
|
+
* @requiredField identifiers.activityId
|
|
7342
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7343
|
+
* @applicableIdentity APP
|
|
7344
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
7345
|
+
*/
|
|
7346
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
7347
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7348
|
+
}[OrderNonNullablePaths]>>;
|
|
5239
7349
|
interface UpdateActivityIdentifiers {
|
|
5240
7350
|
/**
|
|
5241
7351
|
* Order ID.
|
|
@@ -5249,6 +7359,22 @@ interface UpdateActivityIdentifiers {
|
|
|
5249
7359
|
*/
|
|
5250
7360
|
activityId: string;
|
|
5251
7361
|
}
|
|
7362
|
+
/**
|
|
7363
|
+
* Delete's an order's activity.
|
|
7364
|
+
*
|
|
7365
|
+
* Only custom activities and merchant comments can be deleted.
|
|
7366
|
+
* @internal
|
|
7367
|
+
* @documentationMaturity preview
|
|
7368
|
+
* @requiredField identifiers
|
|
7369
|
+
* @requiredField identifiers._id
|
|
7370
|
+
* @requiredField identifiers.activityId
|
|
7371
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7372
|
+
* @applicableIdentity APP
|
|
7373
|
+
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
7374
|
+
*/
|
|
7375
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
7376
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7377
|
+
}[OrderNonNullablePaths]>>;
|
|
5252
7378
|
interface DeleteActivityIdentifiers {
|
|
5253
7379
|
/**
|
|
5254
7380
|
* Order ID.
|
|
@@ -5291,6 +7417,43 @@ interface CancelOrderOptions {
|
|
|
5291
7417
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5292
7418
|
restockAllItems?: boolean;
|
|
5293
7419
|
}
|
|
7420
|
+
/**
|
|
7421
|
+
* Updates order status.
|
|
7422
|
+
*
|
|
7423
|
+
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
7424
|
+
* >Updates into INITIALIZED are not supported.
|
|
7425
|
+
*
|
|
7426
|
+
* Approving order:
|
|
7427
|
+
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
7428
|
+
*
|
|
7429
|
+
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
7430
|
+
* will cause an error.
|
|
7431
|
+
*
|
|
7432
|
+
* Setting PENDING status:
|
|
7433
|
+
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
7434
|
+
* @param orderId - Order ID.
|
|
7435
|
+
* @param status - New order status.
|
|
7436
|
+
* @internal
|
|
7437
|
+
* @documentationMaturity preview
|
|
7438
|
+
* @requiredField orderId
|
|
7439
|
+
* @requiredField status
|
|
7440
|
+
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
7441
|
+
* @applicableIdentity APP
|
|
7442
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
7443
|
+
*/
|
|
7444
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
7445
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7446
|
+
}[OrderNonNullablePaths]> & {
|
|
7447
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
7448
|
+
}>;
|
|
7449
|
+
/** @internal
|
|
7450
|
+
* @documentationMaturity preview
|
|
7451
|
+
* @requiredField options.aggregation
|
|
7452
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7453
|
+
* @applicableIdentity APP
|
|
7454
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
7455
|
+
*/
|
|
7456
|
+
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
5294
7457
|
interface AggregateOrdersOptions {
|
|
5295
7458
|
/** Filter applied to original data */
|
|
5296
7459
|
filter?: Record<string, any> | null;
|
|
@@ -5327,4 +7490,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
5327
7490
|
unassignTags?: Tags;
|
|
5328
7491
|
}
|
|
5329
7492
|
|
|
5330
|
-
export { type ProductName as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, DescriptionLineType as D, InventoryAction as E, FulfillmentStatus as F, type GetOrderApplicationErrors as G, Placement as H, ItemTypeItemType as I, JurisdictionType as J, SubdivisionType as K, LineItemQuantityChangeType as L, type MaskedOrder as M, SourceType as N, type Order as O, PaymentOptionType as P, CustomFieldGroup as Q, ValueType as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, DepositType as X, InvoiceStatus as Y, WebhookIdentityType as Z, type OrderLineItem as _, type OrderSearch as a, type MerchantComment as a$, type CatalogReference as a0, type Price as a1, type DescriptionLine as a2, type DescriptionLineValueOneOf as a3, type DescriptionLineDescriptionLineValueOneOf as a4, type DescriptionLineName as a5, type PlainTextValue as a6, type Color as a7, type FocalPoint as a8, type PhysicalProperties as a9, type Address as aA, type StreetAddress as aB, type AddressLocation as aC, type FullAddressContactDetails as aD, type VatId as aE, type V1ShippingInformation as aF, type DeliveryLogistics as aG, type DeliveryLogisticsAddressOneOf as aH, type PickupDetails as aI, type PickupAddress as aJ, type DeliveryTimeSlot as aK, type ShippingPrice as aL, type ShippingRegion as aM, type TaxSummary as aN, type OrderTaxInfo as aO, type OrderTaxBreakdown as aP, type AppliedDiscount as aQ, type AppliedDiscountDiscountSourceOneOf as aR, type Coupon as aS, type MerchantDiscount as aT, type MerchantDiscountMerchantDiscountReasonOneOf as aU, type DiscountRule as aV, type DiscountRuleName as aW, type LineItemDiscount as aX, type Activity as aY, type ActivityContentOneOf as aZ, type CustomActivity as a_, type ItemType as aa, type ItemTypeItemTypeDataOneOf as ab, type ItemTaxFullDetails as ac, type LineItemTaxInfo as ad, type LineItemTaxBreakdown as ae, type DigitalFile as af, type SubscriptionInfo as ag, type SubscriptionTitle as ah, type SubscriptionDescription as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type BillingAdjustment as al, type BillingAdjustmentPriceSummary as am, type PriceDescription as an, type LocationAndQuantity as ao, type TaxableAddress as ap, type TaxableAddressTaxableAddressDataOneOf as aq, type ExtendedFields as ar, type ModifierGroup as as, type TranslatableString as at, type ItemModifier as au, type BuyerInfo as av, type BuyerInfoIdOneOf as aw, type CurrencyConversionDetails as ax, type PriceSummary as ay, type AddressWithContact as az, type CreateOrderApplicationErrors as b, type SnapshotMessage as b$, type OrderRefunded as b0, type OrderCreatedFromExchange as b1, type NewExchangeOrderCreated as b2, type LineItemExchangeData as b3, type DraftOrderChangesApplied as b4, type OrderChange as b5, type OrderChangeValueOneOf as b6, type LineItemChanges as b7, type LineItemQuantityChange as b8, type LineItemPriceChange as b9, type PaymentCanceled as bA, type PaymentCanceledPaymentDetailsOneOf as bB, type PaymentDeclined as bC, type PaymentDeclinedPaymentDetailsOneOf as bD, type ReceiptCreated as bE, type ReceiptCreatedReceiptInfoOneOf as bF, type WixReceipt as bG, type ExternalReceipt as bH, type ReceiptSent as bI, type ReceiptSentReceiptInfoOneOf as bJ, type ChargebackCreated as bK, type ChargebackReversed as bL, type CreatedBy as bM, type CreatedByStringOneOf as bN, type ChannelInfo as bO, type CustomField as bP, type BalanceSummary as bQ, type Balance as bR, type AdditionalFee as bS, type FulfillmentStatusesAggregate as bT, type Tags as bU, type TagList as bV, type Location as bW, type DiffmatokyPayload as bX, type ErrorInformation as bY, type ContinueSideEffectsFlowInLegacyData as bZ, type OrdersExperiments as b_, type ManagedLineItem as ba, type ManagedDiscount as bb, type TranslatedValue as bc, type LineItemAmount as bd, type ManagedAdditionalFee as be, type TotalPriceChange as bf, type ShippingInformationChange as bg, type ShippingInformation as bh, type SavedPaymentMethod as bi, type AuthorizedPaymentCreated as bj, type AuthorizedPaymentCaptured as bk, type AuthorizedPaymentVoided as bl, type RefundInitiated as bm, type RefundedPayment as bn, type RefundedPaymentKindOneOf as bo, type RegularPaymentRefund as bp, type GiftCardPaymentRefund as bq, type MembershipPaymentRefund as br, type PaymentRefunded as bs, type PaymentRefundFailed as bt, type RefundedAsStoreCredit as bu, type PaymentPending as bv, type PaymentPendingPaymentDetailsOneOf as bw, type RegularPayment as bx, type RegularPaymentPaymentMethodDetailsOneOf as by, type CreditCardDetails as bz, type UpdateOrderApplicationErrors as c, type BulkUnArchiveOrdersRequest as c$, type IndexingMessage as c0, type OrderApproved as c1, type OrderRejectedEventOrderRejected as c2, type OrderItemsRestocked as c3, type RestockItem as c4, type GetOrderRequest as c5, type GetOrderResponse as c6, type InternalQueryOrdersRequest as c7, type PlatformQuery as c8, type PlatformQueryPagingMethodOneOf as c9, type DraftOrderDiffsBuyerUpdateInfoOneOf as cA, type DraftOrderDiffsBillingUpdateInfoOneOf as cB, type DraftOrderDiffsRecipientUpdateInfoOneOf as cC, type V1LineItemDelta as cD, type V1LineItemDeltaDeltaOneOf as cE, type OrderLineItemChangedDetails as cF, type ItemChangedDetails as cG, type AppliedDiscountDelta as cH, type AppliedDiscountDeltaDeltaOneOf as cI, type AdditionalFeeDelta as cJ, type AdditionalFeeDeltaDeltaOneOf as cK, type DraftOrderCommitSettings as cL, type InventoryUpdateDetails as cM, type CommitDeltasResponse as cN, type OrderDeltasCommitted as cO, type CommittedDiffs as cP, type CommittedDiffsShippingUpdateInfoOneOf as cQ, type LineItemDelta as cR, type LineItemDeltaDeltaOneOf as cS, type ArchiveOrderRequest as cT, type ArchiveOrderResponse as cU, type BulkArchiveOrdersRequest as cV, type BulkArchiveOrdersResponse as cW, type BulkArchiveOrdersByFilterRequest as cX, type BulkArchiveOrdersByFilterResponse as cY, type UnArchiveOrderRequest as cZ, type UnArchiveOrderResponse as c_, type Sorting as ca, type PlatformPaging as cb, type CursorPaging as cc, type InternalQueryOrdersResponse as cd, type PlatformPagingMetadata as ce, type Cursors as cf, type QueryOrderRequest as cg, type QueryOrderResponse as ch, type SearchOrdersRequest as ci, type CursorSearch as cj, type CursorSearchPagingMethodOneOf as ck, type CursorPagingMetadata as cl, type CreateOrderRequest as cm, type OrderCreationSettings as cn, type OrderCreateNotifications as co, type CreateOrderResponse as cp, type UpdateOrderRequest as cq, type UpdateOrderResponse as cr, type BulkUpdateOrdersRequest as cs, type BulkOrderResult as ct, type ItemMetadata as cu, type ApplicationError as cv, type BulkActionMetadata as cw, type CommitDeltasRequest as cx, type DraftOrderDiffs as cy, type DraftOrderDiffsShippingUpdateInfoOneOf as cz, type BulkUpdateOrdersResponse as d, type BulkMarkAsFulfilledRequest as d$, type BulkUnArchiveOrdersResponse as d0, type BulkUnArchiveOrdersByFilterRequest as d1, type BulkUnArchiveOrdersByFilterResponse as d2, type UpdateBuyerInfoRequest as d3, type BuyerInfoUpdate as d4, type UpdateBuyerInfoResponse as d5, type UpdateBuyerEmailRequest as d6, type UpdateBuyerEmailResponse as d7, type UpdateOrderShippingAddressRequest as d8, type UpdateOrderShippingAddressResponse as d9, type PickupReadyEmailSent as dA, type OrderPartiallyPaid as dB, type OrderPending as dC, type OrderRejected as dD, type AddInternalActivityResponse as dE, type AddActivityRequest as dF, type PublicActivity as dG, type PublicActivityContentOneOf as dH, type AddActivityResponse as dI, type AddActivitiesRequest as dJ, type AddActivitiesResponse as dK, type UpdateActivityRequest as dL, type UpdateActivityResponse as dM, type DeleteActivityRequest as dN, type DeleteActivityResponse as dO, type UpdateLineItemsDescriptionLinesRequest as dP, type LineItemUpdate as dQ, type UpdateLineItemsDescriptionLinesResponse as dR, type MarkOrderAsSeenByHumanRequest as dS, type MarkOrderAsSeenByHumanResponse as dT, type CancelOrderRequest as dU, type OrderCanceledEventOrderCanceled as dV, type UpdateOrderStatusRequest as dW, type UpdateOrderStatusResponse as dX, type MarkAsFulfilledRequest as dY, type MarkAsFulfilledResponse as dZ, type FulfillmentStatusUpdated as d_, type UpdateBillingContactDetailsRequest as da, type UpdateBillingContactDetailsResponse as db, type UpdateOrderLineItemRequest as dc, type UpdateOrderLineItemResponse as dd, type UpdateOrderLineItemsRequest as de, type MaskedOrderLineItem as df, type UpdateOrderLineItemsResponse as dg, type AddInternalActivityRequest as dh, type InternalActivity as di, type InternalActivityContentOneOf as dj, type OrderPlaced as dk, type OrderPaid as dl, type OrderFulfilled as dm, type OrderNotFulfilled as dn, type OrderCanceled as dp, type DownloadLinkSent as dq, type TrackingNumberAdded as dr, type TrackingNumberEdited as ds, type TrackingLinkAdded as dt, type ShippingConfirmationEmailSent as du, type InvoiceAdded as dv, type InvoiceSent as dw, type FulfillerEmailSent as dx, type ShippingAddressEdited as dy, type EmailEdited as dz, type CancelOrderOptions as e, type Locale as e$, type BulkMarkAsFulfilledResponse as e0, type BulkMarkAsFulfilledByFilterRequest as e1, type BulkMarkAsFulfilledByFilterResponse as e2, type MarkAsUnfulfilledRequest as e3, type MarkAsUnfulfilledResponse as e4, type BulkMarkAsUnfulfilledRequest as e5, type BulkMarkAsUnfulfilledResponse as e6, type BulkMarkAsUnfulfilledByFilterRequest as e7, type BulkMarkAsUnfulfilledByFilterResponse as e8, type BulkSetBusinessLocationRequest as e9, type Task as eA, type TaskKey as eB, type TaskAction as eC, type TaskActionActionOneOf as eD, type Complete as eE, type Cancel as eF, type Reschedule as eG, type InvoiceSentEvent as eH, type IdAndVersion as eI, type InvoiceFields as eJ, type Customer as eK, type Email as eL, type QuotesAddress as eM, type AddressDescription as eN, type Phone as eO, type Company as eP, type CommonAddress as eQ, type CommonAddressStreetOneOf as eR, type Subdivision as eS, type StandardDetails as eT, type InvoiceDates as eU, type LineItems as eV, type LineItem as eW, type BigDecimalWrapper as eX, type LineItemTax as eY, type Source as eZ, type LineItemMetaData as e_, type BulkSetBusinessLocationResponse as ea, type BulkSetBusinessLocationResult as eb, type MarkOrderAsPaidRequest as ec, type MarkOrderAsPaidResponse as ed, type PaymentStatusUpdated as ee, type BulkMarkOrdersAsPaidRequest as ef, type BulkMarkOrdersAsPaidResponse as eg, type CreatePaymentGatewayOrderRequest as eh, type CreatePaymentGatewayOrderResponse as ei, type GetShipmentsRequest as ej, type GetShipmentsResponse as ek, type AggregateOrdersRequest as el, type AggregateOrdersResponse as em, type DecrementItemsQuantityRequest as en, type DecrementData as eo, type DecrementItemsQuantityResponse as ep, type BulkUpdateOrderTagsRequest as eq, type BulkUpdateOrderTagsResult as er, type DomainEvent as es, type DomainEventBodyOneOf as et, type EntityCreatedEvent as eu, type RestoreInfo as ev, type EntityUpdatedEvent as ew, type EntityDeletedEvent as ex, type ActionEvent as ey, type Empty as ez, type CancelOrderResponse as f, onOrderUpdated as f$, type TotalPrice as f0, type ItemizedFee as f1, type Discount as f2, type DiscountOneDiscountTypeOneOf as f3, type CalculatedTaxes as f4, type CalculatedTax as f5, type Payments as f6, type Payment as f7, type MetaData as f8, type InvoiceDynamicPriceTotals as f9, type VatTypeWithLiterals as fA, type PickupMethodWithLiterals as fB, type OrderStatusWithLiterals as fC, type DiscountTypeWithLiterals as fD, type DiscountReasonWithLiterals as fE, type LineItemQuantityChangeTypeWithLiterals as fF, type ActivityTypeWithLiterals as fG, type AttributionSourceWithLiterals as fH, type ChannelTypeWithLiterals as fI, type SortOrderWithLiterals as fJ, type OrderApprovalStrategyWithLiterals as fK, type DeltaPaymentOptionTypeWithLiterals as fL, type InventoryActionWithLiterals as fM, type PlacementWithLiterals as fN, type SubdivisionTypeWithLiterals as fO, type SourceTypeWithLiterals as fP, type CustomFieldGroupWithLiterals as fQ, type ValueTypeWithLiterals as fR, type DepositTypeWithLiterals as fS, type InvoiceStatusWithLiterals as fT, type WebhookIdentityTypeWithLiterals as fU, type CommitDeltasApplicationErrors as fV, type UpdateOrderStatusApplicationErrors as fW, onOrderApproved as fX, onOrderCanceled as fY, onOrderCreated as fZ, onOrderPaymentStatusUpdated as f_, type CustomFieldValue as fa, type Value as fb, type Deposit as fc, type TriggerSideEffectsFromLegacyData as fd, type MessageEnvelope as fe, type IdentificationData as ff, type IdentificationDataIdOneOf as fg, type BaseEventMetadata as fh, type EventMetadata as fi, type OrderSearchSpec as fj, type CommitDeltasOptions as fk, type UpdateOrderLineItemIdentifiers as fl, type UpdateOrderLineItem as fm, type UpdateActivityIdentifiers as fn, type DeleteActivityIdentifiers as fo, type AggregateOrdersOptions as fp, type DescriptionLineTypeWithLiterals as fq, type ItemTypeItemTypeWithLiterals as fr, type PaymentOptionTypeWithLiterals as fs, type JurisdictionTypeWithLiterals as ft, type SubscriptionFrequencyWithLiterals as fu, type AdjustmentTypeWithLiterals as fv, type TaxableAddressTypeWithLiterals as fw, type PaymentStatusWithLiterals as fx, type FulfillmentStatusWithLiterals as fy, type WeightUnitWithLiterals as fz, type CancelOrderApplicationErrors as g, getOrder as g0, type CommonSearchWithEntityContext as g1, createOrder as g2, updateOrder as g3, bulkUpdateOrders as g4, cancelOrder as g5, bulkUpdateOrderTags as g6, type BulkUpdateOrderTagsOptions as h, type BulkUpdateOrderTagsResponse as i, type OrderApprovedEnvelope as j, type OrderCanceledEnvelope as k, type OrderCreatedEnvelope as l, type OrderPaymentStatusUpdatedEnvelope as m, type OrderUpdatedEnvelope as n, SubscriptionFrequency as o, PaymentStatus as p, PickupMethod as q, OrderStatus as r, DiscountType as s, DiscountReason as t, ActivityType as u, AttributionSource as v, ChannelType as w, SortOrder as x, OrderApprovalStrategy as y, DeltaPaymentOptionType as z };
|
|
7493
|
+
export { type AggregateOrdersResponse as $, type UpdateOrderLineItemIdentifiers as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type UpdateOrderLineItem as D, type UpdateOrderLineItemResponse as E, type PublicActivity as F, type GetPaymentCollectabilityStatusResponse as G, type AddActivityResponse as H, type UpdateActivityIdentifiers as I, type UpdateActivityResponse as J, type DeleteActivityIdentifiers as K, type DeleteActivityResponse as L, type MarkOrderAsPaidResponse as M, type CancelOrderOptions as N, type Order as O, type Price as P, type CancelOrderResponse as Q, type RecordManuallyCollectedPaymentApplicationErrors as R, type SearchOrdersResponse as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type CancelOrderApplicationErrors as W, type OrderStatusWithLiterals as X, type UpdateOrderStatusResponse as Y, type UpdateOrderStatusApplicationErrors as Z, type AggregateOrdersOptions as _, type PreparePaymentCollectionOptions as a, type FocalPoint as a$, type BulkUpdateOrderTagsOptions as a0, type BulkUpdateOrderTagsResponse as a1, type OrderApprovedEnvelope as a2, type OrderUpdatedEnvelope as a3, type OrderCanceledEnvelope as a4, type OrderCreatedEnvelope as a5, type OrderPaymentStatusUpdatedEnvelope as a6, DescriptionLineType as a7, ItemTypeItemType as a8, PaymentOptionType as a9, Reason as aA, ActionType as aB, ChargebackStatus as aC, MembershipPaymentStatus as aD, RefundStatus as aE, WebhookIdentityType as aF, VersioningMode as aG, SortOrder as aH, OrderApprovalStrategy as aI, DeltaPaymentOptionType as aJ, InventoryAction as aK, Placement as aL, SubdivisionType as aM, SourceType as aN, CustomFieldGroup as aO, ValueType as aP, DepositType as aQ, InvoiceStatus as aR, type OrderLineItem as aS, type ProductName as aT, type CatalogReference as aU, type DescriptionLine as aV, type DescriptionLineValueOneOf as aW, type DescriptionLineDescriptionLineValueOneOf as aX, type DescriptionLineName as aY, type PlainTextValue as aZ, type Color as a_, JurisdictionType as aa, SubscriptionFrequency as ab, AdjustmentType as ac, TaxableAddressType as ad, PaymentStatus as ae, FulfillmentStatus as af, WeightUnit as ag, VatType as ah, PickupMethod as ai, OrderStatus as aj, DiscountType as ak, DiscountReason as al, LineItemQuantityChangeType as am, ActivityType as an, AttributionSource as ao, ChannelType as ap, ScheduledAction as aq, DurationUnit as ar, PaymentCollectabilityStatus as as, RefundableStatus as at, NonRefundableReason as au, ManuallyRefundableReason as av, RestockType as aw, TransactionStatus as ax, AuthorizationCaptureStatus as ay, AuthorizationVoidStatus as az, type PreparePaymentCollectionResponse as b, type LineItemQuantityChange as b$, type PhysicalProperties as b0, type ItemType as b1, type ItemTypeItemTypeDataOneOf as b2, type ItemTaxFullDetails as b3, type LineItemTaxInfo as b4, type LineItemTaxBreakdown as b5, type DigitalFile as b6, type SubscriptionInfo as b7, type SubscriptionTitle as b8, type SubscriptionDescription as b9, type PickupAddress as bA, type DeliveryTimeSlot as bB, type ShippingPrice as bC, type ShippingRegion as bD, type TaxSummary as bE, type OrderTaxInfo as bF, type OrderTaxBreakdown as bG, type AppliedDiscount as bH, type AppliedDiscountDiscountSourceOneOf as bI, type Coupon as bJ, type MerchantDiscount as bK, type MerchantDiscountMerchantDiscountReasonOneOf as bL, type DiscountRule as bM, type DiscountRuleName as bN, type LineItemDiscount as bO, type Activity as bP, type ActivityContentOneOf as bQ, type CustomActivity as bR, type MerchantComment as bS, type OrderRefunded as bT, type OrderCreatedFromExchange as bU, type NewExchangeOrderCreated as bV, type LineItemExchangeData as bW, type DraftOrderChangesApplied as bX, type OrderChange as bY, type OrderChangeValueOneOf as bZ, type LineItemChanges as b_, type SubscriptionSettings as ba, type FreeTrialPeriod as bb, type BillingAdjustment as bc, type BillingAdjustmentPriceSummary as bd, type PriceDescription as be, type LocationAndQuantity as bf, type TaxableAddress as bg, type TaxableAddressTaxableAddressDataOneOf as bh, type ExtendedFields as bi, type ModifierGroup as bj, type TranslatableString as bk, type ItemModifier as bl, type BuyerInfo as bm, type BuyerInfoIdOneOf as bn, type CurrencyConversionDetails as bo, type PriceSummary as bp, type AddressWithContact as bq, type Address as br, type StreetAddress as bs, type AddressLocation as bt, type FullAddressContactDetails as bu, type VatId as bv, type V1ShippingInformation as bw, type DeliveryLogistics as bx, type DeliveryLogisticsAddressOneOf as by, type PickupDetails as bz, type PreparePaymentCollectionApplicationErrors as c, type BulkMarkOrdersAsPaidRequest as c$, type LineItemPriceChange as c0, type ManagedLineItem as c1, type ManagedDiscount as c2, type TranslatedValue as c3, type LineItemAmount as c4, type ManagedAdditionalFee as c5, type TotalPriceChange as c6, type ShippingInformationChange as c7, type ShippingInformation as c8, type SavedPaymentMethod as c9, type ReceiptSentReceiptInfoOneOf as cA, type ChargebackCreated as cB, type ChargebackReversed as cC, type CreatedBy as cD, type CreatedByStringOneOf as cE, type ChannelInfo as cF, type CustomField as cG, type BalanceSummary as cH, type Balance as cI, type AdditionalFee as cJ, type FulfillmentStatusesAggregate as cK, type Tags as cL, type TagList as cM, type Location as cN, type OrderApproved as cO, type OrdersExperiments as cP, type OrderRejectedEventOrderRejected as cQ, type OrderItemsRestocked as cR, type V1RestockItem as cS, type PreparePaymentCollectionRequest as cT, type RedirectUrls as cU, type DelayedCaptureSettings as cV, type Duration as cW, type GetPaymentCollectabilityStatusRequest as cX, type RecordManuallyCollectedPaymentRequest as cY, type RecordManuallyCollectedPaymentResponse as cZ, type MarkOrderAsPaidRequest as c_, type AuthorizedPaymentCreated as ca, type AuthorizedPaymentCaptured as cb, type AuthorizedPaymentVoided as cc, type RefundInitiated as cd, type RefundedPayment as ce, type RefundedPaymentKindOneOf as cf, type RegularPaymentRefund as cg, type GiftCardPaymentRefund as ch, type MembershipPaymentRefund as ci, type PaymentRefunded as cj, type PaymentRefundFailed as ck, type RefundedAsStoreCredit as cl, type PaymentPending as cm, type PaymentPendingPaymentDetailsOneOf as cn, type RegularPayment as co, type RegularPaymentPaymentMethodDetailsOneOf as cp, type CreditCardDetails as cq, type PaymentCanceled as cr, type PaymentCanceledPaymentDetailsOneOf as cs, type PaymentDeclined as ct, type PaymentDeclinedPaymentDetailsOneOf as cu, type ReceiptCreated as cv, type ReceiptCreatedReceiptInfoOneOf as cw, type WixReceipt as cx, type ExternalReceipt as cy, type ReceiptSent as cz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as d, type MessageEnvelope as d$, type BulkOrderResult as d0, type ItemMetadata as d1, type ApplicationError as d2, type BulkActionMetadata as d3, type GetRefundabilityStatusRequest as d4, type Refundability as d5, type RefundabilityAdditionalRefundabilityInfoOneOf as d6, type CreatePaymentGatewayOrderRequest as d7, type ChargedBy as d8, type ChargeMembershipsRequest as d9, type Chargeback as dA, type GiftCardPaymentDetails as dB, type MembershipPaymentDetails as dC, type WixReceiptInfo as dD, type ExternalReceiptInfo as dE, type Refund as dF, type RefundTransaction as dG, type RefundStatusInfo as dH, type AggregatedRefundSummary as dI, type RefundItemsBreakdown as dJ, type LineItemRefundSummary as dK, type CalculateRefundRequest as dL, type CalculateRefundItemRequest as dM, type CalculateRefundResponse as dN, type CalculateRefundItemResponse as dO, type VoidAuthorizedPaymentsRequest as dP, type CaptureAuthorizedPaymentsRequest as dQ, type ChargeSavedPaymentMethodRequest as dR, type ChargeSavedPaymentMethodResponse as dS, type DomainEvent as dT, type DomainEventBodyOneOf as dU, type EntityCreatedEvent as dV, type RestoreInfo as dW, type EntityUpdatedEvent as dX, type EntityDeletedEvent as dY, type ActionEvent as dZ, type Empty as d_, type MembershipChargeItem as da, type MembershipName as db, type ServiceProperties as dc, type ChargeMembershipsResponse as dd, type TriggerRefundRequest as de, type RefundDetails as df, type RefundItem as dg, type LineItemRefund as dh, type AdditionalFeeRefund as di, type ShippingRefund as dj, type RefundSideEffects as dk, type RestockInfo as dl, type RestockItem as dm, type OrderTransactions as dn, type Payment as dp, type PaymentPaymentDetailsOneOf as dq, type PaymentReceiptInfoOneOf as dr, type RegularPaymentDetails as ds, type RegularPaymentDetailsPaymentMethodDetailsOneOf as dt, type CreditCardPaymentMethodDetails as du, type AuthorizationDetails as dv, type AuthorizationCapture as dw, type AuthorizationActionFailureDetails as dx, type AuthorizationVoid as dy, type V1ScheduledAction as dz, type GetRefundabilityStatusResponse as e, type CommittedDiffs as e$, type IdentificationData as e0, type IdentificationDataIdOneOf as e1, type UpdateInternalDocumentsEvent as e2, type UpdateInternalDocumentsEventOperationOneOf as e3, type InternalDocument as e4, type InternalDocumentUpdateOperation as e5, type DeleteByIdsOperation as e6, type DeleteByFilterOperation as e7, type InternalDocumentUpdateByFilterOperation as e8, type InternalUpdateExistingOperation as e9, type CursorSearch as eA, type CursorSearchPagingMethodOneOf as eB, type CursorPagingMetadata as eC, type CreateOrderRequest as eD, type OrderCreationSettings as eE, type OrderCreateNotifications as eF, type CreateOrderResponse as eG, type UpdateOrderRequest as eH, type UpdateOrderResponse as eI, type BulkUpdateOrdersRequest as eJ, type CommitDeltasRequest as eK, type DraftOrderDiffs as eL, type DraftOrderDiffsShippingUpdateInfoOneOf as eM, type DraftOrderDiffsBuyerUpdateInfoOneOf as eN, type DraftOrderDiffsBillingUpdateInfoOneOf as eO, type DraftOrderDiffsRecipientUpdateInfoOneOf as eP, type V1LineItemDelta as eQ, type V1LineItemDeltaDeltaOneOf as eR, type OrderLineItemChangedDetails as eS, type ItemChangedDetails as eT, type AppliedDiscountDelta as eU, type AppliedDiscountDeltaDeltaOneOf as eV, type AdditionalFeeDelta as eW, type AdditionalFeeDeltaDeltaOneOf as eX, type DraftOrderCommitSettings as eY, type InventoryUpdateDetails as eZ, type OrderDeltasCommitted as e_, type VersionedDocumentUpdateOperation as ea, type VersionedDeleteByIdsOperation as eb, type VersionedDocumentId as ec, type TriggerReindexRequest as ed, type TriggerReindexResponse as ee, type BatchOfTriggerReindexOrderRequest as ef, type TriggerReindexOrderRequest as eg, type DiffmatokyPayload as eh, type ErrorInformation as ei, type ContinueSideEffectsFlowInLegacyData as ej, type SnapshotMessage as ek, type IndexingMessage as el, type GetOrderRequest as em, type GetOrderResponse as en, type InternalQueryOrdersRequest as eo, type PlatformQuery as ep, type PlatformQueryPagingMethodOneOf as eq, type Sorting as er, type PlatformPaging as es, type CursorPaging as et, type InternalQueryOrdersResponse as eu, type PlatformPagingMetadata as ev, type Cursors as ew, type QueryOrderRequest as ex, type QueryOrderResponse as ey, type SearchOrdersRequest as ez, type PaymentCollectionCreatePaymentGatewayOrderOptions as f, type OrderCanceledEventOrderCanceled as f$, type CommittedDiffsShippingUpdateInfoOneOf as f0, type LineItemDelta as f1, type LineItemDeltaDeltaOneOf as f2, type ArchiveOrderRequest as f3, type ArchiveOrderResponse as f4, type BulkArchiveOrdersRequest as f5, type BulkArchiveOrdersResponse as f6, type BulkArchiveOrdersByFilterRequest as f7, type BulkArchiveOrdersByFilterResponse as f8, type UnArchiveOrderRequest as f9, type DownloadLinkSent as fA, type TrackingNumberAdded as fB, type TrackingNumberEdited as fC, type TrackingLinkAdded as fD, type ShippingConfirmationEmailSent as fE, type InvoiceAdded as fF, type InvoiceSent as fG, type FulfillerEmailSent as fH, type ShippingAddressEdited as fI, type EmailEdited as fJ, type PickupReadyEmailSent as fK, type OrderPartiallyPaid as fL, type OrderPending as fM, type OrderRejected as fN, type AddInternalActivityResponse as fO, type AddActivityRequest as fP, type PublicActivityContentOneOf as fQ, type AddActivitiesRequest as fR, type AddActivitiesResponse as fS, type UpdateActivityRequest as fT, type DeleteActivityRequest as fU, type UpdateLineItemsDescriptionLinesRequest as fV, type LineItemUpdate as fW, type UpdateLineItemsDescriptionLinesResponse as fX, type MarkOrderAsSeenByHumanRequest as fY, type MarkOrderAsSeenByHumanResponse as fZ, type CancelOrderRequest as f_, type UnArchiveOrderResponse as fa, type BulkUnArchiveOrdersRequest as fb, type BulkUnArchiveOrdersResponse as fc, type BulkUnArchiveOrdersByFilterRequest as fd, type BulkUnArchiveOrdersByFilterResponse as fe, type UpdateBuyerInfoRequest as ff, type BuyerInfoUpdate as fg, type UpdateBuyerInfoResponse as fh, type UpdateBuyerEmailRequest as fi, type UpdateBuyerEmailResponse as fj, type UpdateOrderShippingAddressRequest as fk, type UpdateOrderShippingAddressResponse as fl, type UpdateBillingContactDetailsRequest as fm, type UpdateBillingContactDetailsResponse as fn, type UpdateOrderLineItemRequest as fo, type UpdateOrderLineItemsRequest as fp, type MaskedOrderLineItem as fq, type UpdateOrderLineItemsResponse as fr, type AddInternalActivityRequest as fs, type InternalActivity as ft, type InternalActivityContentOneOf as fu, type OrderPlaced as fv, type OrderPaid as fw, type OrderFulfilled as fx, type OrderNotFulfilled as fy, type OrderCanceled as fz, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as g, type DiscountOneDiscountTypeOneOf as g$, type UpdateOrderStatusRequest as g0, type MarkAsFulfilledRequest as g1, type MarkAsFulfilledResponse as g2, type FulfillmentStatusUpdated as g3, type BulkMarkAsFulfilledRequest as g4, type BulkMarkAsFulfilledResponse as g5, type BulkMarkAsFulfilledByFilterRequest as g6, type BulkMarkAsFulfilledByFilterResponse as g7, type MarkAsUnfulfilledRequest as g8, type MarkAsUnfulfilledResponse as g9, type Complete as gA, type Cancel as gB, type Reschedule as gC, type InvoiceSentEvent as gD, type IdAndVersion as gE, type InvoiceFields as gF, type Customer as gG, type Email as gH, type QuotesAddress as gI, type AddressDescription as gJ, type Phone as gK, type Company as gL, type CommonAddress as gM, type CommonAddressStreetOneOf as gN, type Subdivision as gO, type StandardDetails as gP, type InvoiceDates as gQ, type LineItems as gR, type LineItem as gS, type BigDecimalWrapper as gT, type LineItemTax as gU, type Source as gV, type LineItemMetaData as gW, type Locale as gX, type TotalPrice as gY, type ItemizedFee as gZ, type Discount as g_, type BulkMarkAsUnfulfilledRequest as ga, type BulkMarkAsUnfulfilledResponse as gb, type BulkMarkAsUnfulfilledByFilterRequest as gc, type BulkMarkAsUnfulfilledByFilterResponse as gd, type BulkSetBusinessLocationRequest as ge, type BulkSetBusinessLocationResponse as gf, type BulkSetBusinessLocationResult as gg, type V1MarkOrderAsPaidRequest as gh, type V1MarkOrderAsPaidResponse as gi, type PaymentStatusUpdated as gj, type V1BulkMarkOrdersAsPaidRequest as gk, type V1BulkMarkOrdersAsPaidResponse as gl, type V1CreatePaymentGatewayOrderRequest as gm, type V1CreatePaymentGatewayOrderResponse as gn, type GetShipmentsRequest as go, type GetShipmentsResponse as gp, type AggregateOrdersRequest as gq, type DecrementItemsQuantityRequest as gr, type DecrementData as gs, type DecrementItemsQuantityResponse as gt, type BulkUpdateOrderTagsRequest as gu, type BulkUpdateOrderTagsResult as gv, type Task as gw, type TaskKey as gx, type TaskAction as gy, type TaskActionActionOneOf as gz, type ChargeMembershipsOptions as h, onOrderPaymentStatusUpdated as h$, type CalculatedTaxes as h0, type CalculatedTax as h1, type Payments as h2, type InvoicesPayment as h3, type MetaData as h4, type InvoiceDynamicPriceTotals as h5, type CustomFieldValue as h6, type Value as h7, type Deposit as h8, type TriggerSideEffectsFromLegacyData as h9, type ManuallyRefundableReasonWithLiterals as hA, type RestockTypeWithLiterals as hB, type TransactionStatusWithLiterals as hC, type AuthorizationCaptureStatusWithLiterals as hD, type AuthorizationVoidStatusWithLiterals as hE, type ReasonWithLiterals as hF, type ActionTypeWithLiterals as hG, type ChargebackStatusWithLiterals as hH, type MembershipPaymentStatusWithLiterals as hI, type RefundStatusWithLiterals as hJ, type WebhookIdentityTypeWithLiterals as hK, type VersioningModeWithLiterals as hL, type SortOrderWithLiterals as hM, type OrderApprovalStrategyWithLiterals as hN, type DeltaPaymentOptionTypeWithLiterals as hO, type InventoryActionWithLiterals as hP, type PlacementWithLiterals as hQ, type SubdivisionTypeWithLiterals as hR, type SourceTypeWithLiterals as hS, type CustomFieldGroupWithLiterals as hT, type ValueTypeWithLiterals as hU, type DepositTypeWithLiterals as hV, type InvoiceStatusWithLiterals as hW, onOrderApproved as hX, onOrderUpdated as hY, onOrderCanceled as hZ, onOrderCreated as h_, type BaseEventMetadata as ha, type EventMetadata as hb, type OrderSearchSpec as hc, type DescriptionLineTypeWithLiterals as hd, type ItemTypeItemTypeWithLiterals as he, type PaymentOptionTypeWithLiterals as hf, type JurisdictionTypeWithLiterals as hg, type SubscriptionFrequencyWithLiterals as hh, type AdjustmentTypeWithLiterals as hi, type TaxableAddressTypeWithLiterals as hj, type PaymentStatusWithLiterals as hk, type FulfillmentStatusWithLiterals as hl, type WeightUnitWithLiterals as hm, type VatTypeWithLiterals as hn, type PickupMethodWithLiterals as ho, type DiscountTypeWithLiterals as hp, type DiscountReasonWithLiterals as hq, type LineItemQuantityChangeTypeWithLiterals as hr, type ActivityTypeWithLiterals as hs, type AttributionSourceWithLiterals as ht, type ChannelTypeWithLiterals as hu, type ScheduledActionWithLiterals as hv, type DurationUnitWithLiterals as hw, type PaymentCollectabilityStatusWithLiterals as hx, type RefundableStatusWithLiterals as hy, type NonRefundableReasonWithLiterals as hz, type PaymentRefund as i, preparePaymentCollection as i0, getPaymentCollectabilityStatus as i1, recordManuallyCollectedPayment as i2, paymentCollectionMarkOrderAsPaid as i3, paymentCollectionBulkMarkOrdersAsPaid as i4, getRefundabilityStatus as i5, paymentCollectionCreatePaymentGatewayOrder as i6, chargeMemberships as i7, triggerRefund as i8, voidAuthorizedPayments as i9, captureAuthorizedPayments as ia, getOrder as ib, type CommonSearchWithEntityContext as ic, createOrder as id, updateOrder as ie, bulkUpdateOrders as ig, commitDeltas as ih, updateOrderLineItem as ii, addActivity as ij, updateActivity as ik, deleteActivity as il, cancelOrder as im, updateOrderStatus as io, aggregateOrders as ip, bulkUpdateOrderTags as iq, type TriggerRefundResponse as j, type TriggerRefundApplicationErrors as k, type VoidAuthorizedPaymentsApplicationErrors as l, type PaymentCapture as m, type CaptureAuthorizedPaymentsResponse as n, type CaptureAuthorizedPaymentsApplicationErrors as o, type GetOrderApplicationErrors as p, type OrderSearch as q, type CreateOrderOptions as r, type CreateOrderApplicationErrors as s, type UpdateOrderApplicationErrors as t, type MaskedOrder as u, type BulkUpdateOrdersOptions as v, type BulkUpdateOrdersResponse as w, type CommitDeltasOptions as x, type CommitDeltasResponse as y, type CommitDeltasApplicationErrors as z };
|