@wix/auto_sdk_ecom_orders 1.0.71 → 1.0.73
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-BuGgtT93.d.ts → cjs/ecom-v1-order-orders.universal-DepMBjXB.d.ts} +1796 -767
- package/build/cjs/index.d.ts +56 -3
- package/build/cjs/index.js +1044 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +1268 -332
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1006 -38
- package/build/cjs/meta.js +637 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-BuGgtT93.d.mts → es/ecom-v1-order-orders.universal-DepMBjXB.d.mts} +1796 -767
- package/build/es/index.d.mts +56 -3
- package/build/es/index.mjs +1016 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +1240 -331
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1006 -38
- package/build/es/meta.mjs +625 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-B51dgVhk.d.ts → internal/cjs/ecom-v1-order-orders.universal-CHeSUY50.d.ts} +2473 -253
- package/build/internal/cjs/index.d.ts +162 -3
- package/build/internal/cjs/index.js +1044 -8
- 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 +1268 -332
- 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 +637 -2
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-B51dgVhk.d.mts → internal/es/ecom-v1-order-orders.universal-CHeSUY50.d.mts} +2473 -253
- package/build/internal/es/index.d.mts +162 -3
- package/build/internal/es/index.mjs +1016 -7
- 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 +1240 -331
- 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 +625 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -283,25 +283,12 @@ 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;
|
|
292
286
|
/**
|
|
293
287
|
* Custom extended fields for the line item object.
|
|
294
288
|
*
|
|
295
289
|
* [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.
|
|
296
290
|
*/
|
|
297
291
|
extendedFields?: ExtendedFields;
|
|
298
|
-
/**
|
|
299
|
-
* Modifier groups that were added to the item.
|
|
300
|
-
* @internal
|
|
301
|
-
* @readonly
|
|
302
|
-
* @maxSize 10
|
|
303
|
-
*/
|
|
304
|
-
modifierGroups?: ModifierGroup[];
|
|
305
292
|
}
|
|
306
293
|
interface ProductName {
|
|
307
294
|
/**
|
|
@@ -372,11 +359,6 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
372
359
|
colorInfo?: Color;
|
|
373
360
|
/** Description line name. */
|
|
374
361
|
name?: DescriptionLineName;
|
|
375
|
-
/**
|
|
376
|
-
* Whether the description line originates from a modifier.
|
|
377
|
-
* @internal
|
|
378
|
-
*/
|
|
379
|
-
modifierDescriptionLine?: boolean;
|
|
380
362
|
}
|
|
381
363
|
/** @oneof */
|
|
382
364
|
interface DescriptionLineValueOneOf {
|
|
@@ -621,11 +603,6 @@ interface SubscriptionInfo {
|
|
|
621
603
|
* @targetRemovalDate 2025-10-01
|
|
622
604
|
*/
|
|
623
605
|
subscriptionOptionTitle?: string;
|
|
624
|
-
/**
|
|
625
|
-
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
626
|
-
* @internal
|
|
627
|
-
*/
|
|
628
|
-
title?: SubscriptionTitle;
|
|
629
606
|
/**
|
|
630
607
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
631
608
|
* @maxLength 60
|
|
@@ -634,11 +611,6 @@ interface SubscriptionInfo {
|
|
|
634
611
|
* @targetRemovalDate 2025-10-01
|
|
635
612
|
*/
|
|
636
613
|
subscriptionOptionDescription?: string | null;
|
|
637
|
-
/**
|
|
638
|
-
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
639
|
-
* @internal
|
|
640
|
-
*/
|
|
641
|
-
description?: SubscriptionDescription;
|
|
642
614
|
/**
|
|
643
615
|
* Subscription detailed information.
|
|
644
616
|
* @immutable
|
|
@@ -649,11 +621,6 @@ interface SubscriptionInfo {
|
|
|
649
621
|
* @maxLength 1000
|
|
650
622
|
*/
|
|
651
623
|
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;
|
|
657
624
|
}
|
|
658
625
|
interface SubscriptionTitle {
|
|
659
626
|
/**
|
|
@@ -703,11 +670,6 @@ interface SubscriptionSettings {
|
|
|
703
670
|
enableCustomerCancellation?: boolean;
|
|
704
671
|
/** Period until first cycle starts. If None => no free trial */
|
|
705
672
|
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;
|
|
711
673
|
}
|
|
712
674
|
/** Frequency unit of recurring payment */
|
|
713
675
|
declare enum SubscriptionFrequency {
|
|
@@ -1384,14 +1346,6 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1384
1346
|
* @immutable
|
|
1385
1347
|
*/
|
|
1386
1348
|
_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;
|
|
1395
1349
|
}
|
|
1396
1350
|
/** @oneof */
|
|
1397
1351
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -1433,13 +1387,6 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1433
1387
|
description?: string | null;
|
|
1434
1388
|
/** Discount amount. */
|
|
1435
1389
|
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;
|
|
1443
1390
|
}
|
|
1444
1391
|
/** @oneof */
|
|
1445
1392
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -1502,70 +1449,6 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1502
1449
|
merchantComment?: MerchantComment;
|
|
1503
1450
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1504
1451
|
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;
|
|
1569
1452
|
/**
|
|
1570
1453
|
* Activity ID.
|
|
1571
1454
|
* @format GUID
|
|
@@ -1594,70 +1477,6 @@ interface ActivityContentOneOf {
|
|
|
1594
1477
|
merchantComment?: MerchantComment;
|
|
1595
1478
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1596
1479
|
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;
|
|
1661
1480
|
}
|
|
1662
1481
|
interface CustomActivity {
|
|
1663
1482
|
/**
|
|
@@ -2409,29 +2228,11 @@ interface BalanceSummary {
|
|
|
2409
2228
|
* @readonly
|
|
2410
2229
|
*/
|
|
2411
2230
|
authorized?: Price;
|
|
2412
|
-
/**
|
|
2413
|
-
* Sum of all pending refund transactions.
|
|
2414
|
-
* @internal
|
|
2415
|
-
* @readonly
|
|
2416
|
-
*/
|
|
2417
|
-
pendingRefund?: Price;
|
|
2418
2231
|
/**
|
|
2419
2232
|
* Sum of all pending transactions.
|
|
2420
2233
|
* @readonly
|
|
2421
2234
|
*/
|
|
2422
2235
|
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;
|
|
2435
2236
|
}
|
|
2436
2237
|
/**
|
|
2437
2238
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2493,14 +2294,6 @@ interface AdditionalFee {
|
|
|
2493
2294
|
* @format GUID
|
|
2494
2295
|
*/
|
|
2495
2296
|
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;
|
|
2504
2297
|
}
|
|
2505
2298
|
interface FulfillmentStatusesAggregate {
|
|
2506
2299
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -2557,141 +2350,6 @@ interface Location {
|
|
|
2557
2350
|
*/
|
|
2558
2351
|
name?: string;
|
|
2559
2352
|
}
|
|
2560
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
2561
|
-
/** insert/update documents */
|
|
2562
|
-
update?: InternalDocumentUpdateOperation;
|
|
2563
|
-
/** delete by document ids */
|
|
2564
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2565
|
-
/** delete documents matching filter */
|
|
2566
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2567
|
-
/** update internal documents matching filter */
|
|
2568
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2569
|
-
/** update only existing documents */
|
|
2570
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2571
|
-
/** insert/update documents with versioning */
|
|
2572
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2573
|
-
/** delete by document ids with versioning */
|
|
2574
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2575
|
-
/**
|
|
2576
|
-
* type of the documents
|
|
2577
|
-
* @minLength 2
|
|
2578
|
-
*/
|
|
2579
|
-
documentType?: string;
|
|
2580
|
-
/**
|
|
2581
|
-
* language of the documents (mandatory)
|
|
2582
|
-
* @minLength 2
|
|
2583
|
-
*/
|
|
2584
|
-
language?: string | null;
|
|
2585
|
-
/**
|
|
2586
|
-
* one or more search documents
|
|
2587
|
-
* @deprecated
|
|
2588
|
-
*/
|
|
2589
|
-
addDocuments?: InternalDocument[];
|
|
2590
|
-
/**
|
|
2591
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
2592
|
-
* @deprecated
|
|
2593
|
-
*/
|
|
2594
|
-
removeDocumentIds?: string[];
|
|
2595
|
-
/** id to pass to processing notification */
|
|
2596
|
-
correlationId?: string | null;
|
|
2597
|
-
/** when event was created / issued */
|
|
2598
|
-
issuedAt?: Date | null;
|
|
2599
|
-
}
|
|
2600
|
-
/** @oneof */
|
|
2601
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
2602
|
-
/** insert/update documents */
|
|
2603
|
-
update?: InternalDocumentUpdateOperation;
|
|
2604
|
-
/** delete by document ids */
|
|
2605
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2606
|
-
/** delete documents matching filter */
|
|
2607
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2608
|
-
/** update internal documents matching filter */
|
|
2609
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2610
|
-
/** update only existing documents */
|
|
2611
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2612
|
-
/** insert/update documents with versioning */
|
|
2613
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2614
|
-
/** delete by document ids with versioning */
|
|
2615
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2616
|
-
}
|
|
2617
|
-
interface InternalDocument {
|
|
2618
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
2619
|
-
document?: Record<string, any> | null;
|
|
2620
|
-
}
|
|
2621
|
-
interface InternalDocumentUpdateOperation {
|
|
2622
|
-
/** documents to index or update */
|
|
2623
|
-
documents?: InternalDocument[];
|
|
2624
|
-
}
|
|
2625
|
-
interface DeleteByIdsOperation {
|
|
2626
|
-
/** ids of the documents to delete */
|
|
2627
|
-
documentIds?: string[];
|
|
2628
|
-
/**
|
|
2629
|
-
* tenant id for custom tenancy strategy
|
|
2630
|
-
* @minLength 2
|
|
2631
|
-
* @maxLength 300
|
|
2632
|
-
*/
|
|
2633
|
-
tenantId?: string | null;
|
|
2634
|
-
}
|
|
2635
|
-
interface DeleteByFilterOperation {
|
|
2636
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2637
|
-
filter?: Record<string, any> | null;
|
|
2638
|
-
/**
|
|
2639
|
-
* tenant id for custom tenancy strategy
|
|
2640
|
-
* @minLength 2
|
|
2641
|
-
* @maxLength 300
|
|
2642
|
-
*/
|
|
2643
|
-
tenantId?: string | null;
|
|
2644
|
-
}
|
|
2645
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
2646
|
-
/** documents matching this filter will be updated */
|
|
2647
|
-
filter?: Record<string, any> | null;
|
|
2648
|
-
/** partial document to apply */
|
|
2649
|
-
document?: InternalDocument;
|
|
2650
|
-
/**
|
|
2651
|
-
* tenant id for custom tenancy strategy
|
|
2652
|
-
* @minLength 2
|
|
2653
|
-
* @maxLength 300
|
|
2654
|
-
*/
|
|
2655
|
-
tenantId?: string | null;
|
|
2656
|
-
}
|
|
2657
|
-
interface InternalUpdateExistingOperation {
|
|
2658
|
-
/** documents to update */
|
|
2659
|
-
documents?: InternalDocument[];
|
|
2660
|
-
}
|
|
2661
|
-
interface VersionedDocumentUpdateOperation {
|
|
2662
|
-
/** documents to create or overwrite */
|
|
2663
|
-
documents?: InternalDocument[];
|
|
2664
|
-
/** versioning mode to use instead of default */
|
|
2665
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2666
|
-
}
|
|
2667
|
-
declare enum VersioningMode {
|
|
2668
|
-
/** use default versioning mode agreed with search team */
|
|
2669
|
-
DEFAULT = "DEFAULT",
|
|
2670
|
-
/** execute only if version is greater than existing */
|
|
2671
|
-
GREATER_THAN = "GREATER_THAN",
|
|
2672
|
-
/** execute only if version is greater or equal to existing */
|
|
2673
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2674
|
-
}
|
|
2675
|
-
/** @enumType */
|
|
2676
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
2677
|
-
interface VersionedDeleteByIdsOperation {
|
|
2678
|
-
/** ids with version of the documents to delete */
|
|
2679
|
-
documentIds?: VersionedDocumentId[];
|
|
2680
|
-
/**
|
|
2681
|
-
* tenant id for custom tenancy strategy
|
|
2682
|
-
* @minLength 2
|
|
2683
|
-
* @maxLength 300
|
|
2684
|
-
*/
|
|
2685
|
-
tenantId?: string | null;
|
|
2686
|
-
}
|
|
2687
|
-
interface VersionedDocumentId {
|
|
2688
|
-
/** document id */
|
|
2689
|
-
documentId?: string;
|
|
2690
|
-
/** document version */
|
|
2691
|
-
version?: string;
|
|
2692
|
-
/** versioning mode to use instead of default */
|
|
2693
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2694
|
-
}
|
|
2695
2353
|
/** Triggered when the order status changes to approved */
|
|
2696
2354
|
interface OrderApproved {
|
|
2697
2355
|
/** The order that was updated */
|
|
@@ -2713,9 +2371,9 @@ interface OrderItemsRestocked {
|
|
|
2713
2371
|
/** The order which items were restocked */
|
|
2714
2372
|
order?: Order;
|
|
2715
2373
|
/** Restocked items and quantities */
|
|
2716
|
-
restockItems?:
|
|
2374
|
+
restockItems?: V1RestockItem[];
|
|
2717
2375
|
}
|
|
2718
|
-
interface
|
|
2376
|
+
interface V1RestockItem {
|
|
2719
2377
|
/**
|
|
2720
2378
|
* ID of the line item being restocked.
|
|
2721
2379
|
* @format GUID
|
|
@@ -2728,33 +2386,313 @@ interface RestockItem {
|
|
|
2728
2386
|
*/
|
|
2729
2387
|
quantity?: number;
|
|
2730
2388
|
}
|
|
2731
|
-
interface
|
|
2389
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
2732
2390
|
/** @format GUID */
|
|
2733
|
-
|
|
2391
|
+
orderId?: string;
|
|
2392
|
+
}
|
|
2393
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
2394
|
+
}
|
|
2395
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
2734
2396
|
/**
|
|
2735
2397
|
* @minLength 1
|
|
2736
2398
|
* @maxLength 100
|
|
2737
|
-
* @maxSize 100
|
|
2738
2399
|
*/
|
|
2739
|
-
|
|
2400
|
+
orderId?: string;
|
|
2740
2401
|
}
|
|
2741
|
-
interface
|
|
2402
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
2742
2403
|
}
|
|
2743
|
-
interface
|
|
2744
|
-
createdEvent?: EntityCreatedEvent;
|
|
2745
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2746
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2747
|
-
actionEvent?: ActionEvent;
|
|
2748
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2749
|
-
_id?: string;
|
|
2404
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
2750
2405
|
/**
|
|
2751
|
-
*
|
|
2752
|
-
*
|
|
2406
|
+
* @minLength 1
|
|
2407
|
+
* @maxLength 100
|
|
2753
2408
|
*/
|
|
2754
|
-
|
|
2409
|
+
orderId?: string;
|
|
2410
|
+
}
|
|
2411
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
2412
|
+
}
|
|
2413
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
2755
2414
|
/**
|
|
2756
|
-
*
|
|
2757
|
-
*
|
|
2415
|
+
* IDs of orders to send pickup emails for.
|
|
2416
|
+
* @minSize 1
|
|
2417
|
+
* @maxSize 300
|
|
2418
|
+
*/
|
|
2419
|
+
orderIds?: string[];
|
|
2420
|
+
}
|
|
2421
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
2422
|
+
}
|
|
2423
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
2424
|
+
/**
|
|
2425
|
+
* @minLength 1
|
|
2426
|
+
* @maxLength 100
|
|
2427
|
+
*/
|
|
2428
|
+
orderId?: string;
|
|
2429
|
+
}
|
|
2430
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
2431
|
+
}
|
|
2432
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
2433
|
+
/**
|
|
2434
|
+
* IDs of orders to send pickup emails for.
|
|
2435
|
+
* @minSize 1
|
|
2436
|
+
* @maxSize 300
|
|
2437
|
+
*/
|
|
2438
|
+
orderIds?: string[];
|
|
2439
|
+
}
|
|
2440
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
2441
|
+
}
|
|
2442
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
2443
|
+
/**
|
|
2444
|
+
* @minLength 1
|
|
2445
|
+
* @maxLength 100
|
|
2446
|
+
*/
|
|
2447
|
+
orderId?: string;
|
|
2448
|
+
}
|
|
2449
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
2450
|
+
}
|
|
2451
|
+
interface SendCancelRefundEmailRequest {
|
|
2452
|
+
/**
|
|
2453
|
+
* The ID of order that is canceled/refunded
|
|
2454
|
+
* @minLength 1
|
|
2455
|
+
* @maxLength 100
|
|
2456
|
+
*/
|
|
2457
|
+
orderId?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* Personal note added to the email (optional)
|
|
2460
|
+
* @minLength 1
|
|
2461
|
+
* @maxLength 1000
|
|
2462
|
+
*/
|
|
2463
|
+
customMessage?: string | null;
|
|
2464
|
+
/** Refund amount */
|
|
2465
|
+
refundAmount?: Price;
|
|
2466
|
+
/**
|
|
2467
|
+
* Refund ID. (Optional)
|
|
2468
|
+
* @format GUID
|
|
2469
|
+
*/
|
|
2470
|
+
refundId?: string | null;
|
|
2471
|
+
}
|
|
2472
|
+
interface SendCancelRefundEmailResponse {
|
|
2473
|
+
}
|
|
2474
|
+
interface SendRefundEmailRequest {
|
|
2475
|
+
/**
|
|
2476
|
+
* The ID of order that is refunded
|
|
2477
|
+
* @format GUID
|
|
2478
|
+
*/
|
|
2479
|
+
orderId?: string;
|
|
2480
|
+
/**
|
|
2481
|
+
* Refund ID
|
|
2482
|
+
* @format GUID
|
|
2483
|
+
*/
|
|
2484
|
+
refundId?: string;
|
|
2485
|
+
/**
|
|
2486
|
+
* Personal note added to the email (optional)
|
|
2487
|
+
* @minLength 1
|
|
2488
|
+
* @maxLength 1000
|
|
2489
|
+
*/
|
|
2490
|
+
customMessage?: string | null;
|
|
2491
|
+
}
|
|
2492
|
+
interface SendRefundEmailResponse {
|
|
2493
|
+
}
|
|
2494
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
2495
|
+
/**
|
|
2496
|
+
* @minLength 1
|
|
2497
|
+
* @maxLength 100
|
|
2498
|
+
*/
|
|
2499
|
+
orderId?: string;
|
|
2500
|
+
}
|
|
2501
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
2502
|
+
}
|
|
2503
|
+
interface PreviewEmailByTypeRequest {
|
|
2504
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
2505
|
+
}
|
|
2506
|
+
declare enum PreviewEmailType {
|
|
2507
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
2508
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
2509
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
2510
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
2511
|
+
}
|
|
2512
|
+
/** @enumType */
|
|
2513
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
2514
|
+
interface PreviewEmailByTypeResponse {
|
|
2515
|
+
emailPreview?: string;
|
|
2516
|
+
}
|
|
2517
|
+
interface PreviewRefundEmailRequest {
|
|
2518
|
+
/**
|
|
2519
|
+
* @minLength 1
|
|
2520
|
+
* @maxLength 100
|
|
2521
|
+
*/
|
|
2522
|
+
orderId?: string;
|
|
2523
|
+
/** Refund amount */
|
|
2524
|
+
refundAmount?: Price;
|
|
2525
|
+
/** Refund business details */
|
|
2526
|
+
details?: RefundDetails;
|
|
2527
|
+
/**
|
|
2528
|
+
* Personal note added to the email (optional)
|
|
2529
|
+
* @minLength 1
|
|
2530
|
+
* @maxLength 1000
|
|
2531
|
+
*/
|
|
2532
|
+
customMessage?: string | null;
|
|
2533
|
+
/**
|
|
2534
|
+
* Refund ID. (Optional)
|
|
2535
|
+
* @format GUID
|
|
2536
|
+
*/
|
|
2537
|
+
refundId?: string | null;
|
|
2538
|
+
}
|
|
2539
|
+
/** Business model of a refund request */
|
|
2540
|
+
interface RefundDetails {
|
|
2541
|
+
/**
|
|
2542
|
+
* Order line item IDs and quantities that were refunded.
|
|
2543
|
+
* @maxSize 300
|
|
2544
|
+
*/
|
|
2545
|
+
items?: RefundItem[];
|
|
2546
|
+
/** Whether the shipping fee was also refunded. */
|
|
2547
|
+
shippingIncluded?: boolean;
|
|
2548
|
+
/**
|
|
2549
|
+
* Reason for the refund, provided by customer (optional).
|
|
2550
|
+
* @maxLength 200
|
|
2551
|
+
*/
|
|
2552
|
+
reason?: string | null;
|
|
2553
|
+
/**
|
|
2554
|
+
* Line items that were refunded.
|
|
2555
|
+
* @maxSize 300
|
|
2556
|
+
*/
|
|
2557
|
+
lineItems?: LineItemRefund[];
|
|
2558
|
+
/**
|
|
2559
|
+
* Additional fees that were refunded.
|
|
2560
|
+
* @maxSize 100
|
|
2561
|
+
*/
|
|
2562
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
2563
|
+
/** Shipping amount that was refunded. */
|
|
2564
|
+
shipping?: ShippingRefund;
|
|
2565
|
+
}
|
|
2566
|
+
interface RefundItem {
|
|
2567
|
+
/**
|
|
2568
|
+
* Line item ID the refunded line item.
|
|
2569
|
+
* @format GUID
|
|
2570
|
+
*/
|
|
2571
|
+
lineItemId?: string;
|
|
2572
|
+
/**
|
|
2573
|
+
* Line item quantity refunded.
|
|
2574
|
+
* @min 1
|
|
2575
|
+
* @max 100000
|
|
2576
|
+
*/
|
|
2577
|
+
quantity?: number;
|
|
2578
|
+
}
|
|
2579
|
+
interface LineItemRefund {
|
|
2580
|
+
/**
|
|
2581
|
+
* Line item ID.
|
|
2582
|
+
* @format GUID
|
|
2583
|
+
* @immutable
|
|
2584
|
+
*/
|
|
2585
|
+
lineItemId?: string;
|
|
2586
|
+
/**
|
|
2587
|
+
* Refund quantity.
|
|
2588
|
+
* @min 1
|
|
2589
|
+
* @max 100000
|
|
2590
|
+
* @immutable
|
|
2591
|
+
*/
|
|
2592
|
+
quantity?: number;
|
|
2593
|
+
}
|
|
2594
|
+
interface AdditionalFeeRefund {
|
|
2595
|
+
/**
|
|
2596
|
+
* Additional fee ID.
|
|
2597
|
+
* @format GUID
|
|
2598
|
+
* @immutable
|
|
2599
|
+
*/
|
|
2600
|
+
additionalFeeId?: string;
|
|
2601
|
+
/**
|
|
2602
|
+
* Refund amount.
|
|
2603
|
+
* @immutable
|
|
2604
|
+
*/
|
|
2605
|
+
amount?: Price;
|
|
2606
|
+
}
|
|
2607
|
+
interface ShippingRefund {
|
|
2608
|
+
/**
|
|
2609
|
+
* Refund amount.
|
|
2610
|
+
* @immutable
|
|
2611
|
+
*/
|
|
2612
|
+
amount?: Price;
|
|
2613
|
+
}
|
|
2614
|
+
interface PreviewRefundEmailResponse {
|
|
2615
|
+
emailPreview?: string;
|
|
2616
|
+
}
|
|
2617
|
+
interface PreviewCancelEmailRequest {
|
|
2618
|
+
/**
|
|
2619
|
+
* @minLength 1
|
|
2620
|
+
* @maxLength 100
|
|
2621
|
+
*/
|
|
2622
|
+
orderId?: string;
|
|
2623
|
+
/**
|
|
2624
|
+
* Personal note added to the email (optional)
|
|
2625
|
+
* @minLength 1
|
|
2626
|
+
* @maxLength 1000
|
|
2627
|
+
*/
|
|
2628
|
+
customMessage?: string | null;
|
|
2629
|
+
}
|
|
2630
|
+
interface PreviewCancelEmailResponse {
|
|
2631
|
+
emailPreview?: string;
|
|
2632
|
+
}
|
|
2633
|
+
interface PreviewCancelRefundEmailRequest {
|
|
2634
|
+
/**
|
|
2635
|
+
* @minLength 1
|
|
2636
|
+
* @maxLength 100
|
|
2637
|
+
*/
|
|
2638
|
+
orderId?: string;
|
|
2639
|
+
/**
|
|
2640
|
+
* Personal note added to the email (optional)
|
|
2641
|
+
* @minLength 1
|
|
2642
|
+
* @maxLength 1000
|
|
2643
|
+
*/
|
|
2644
|
+
customMessage?: string | null;
|
|
2645
|
+
/** Refund amount */
|
|
2646
|
+
refundAmount?: Price;
|
|
2647
|
+
/**
|
|
2648
|
+
* Refund ID. (Optional)
|
|
2649
|
+
* @format GUID
|
|
2650
|
+
*/
|
|
2651
|
+
refundId?: string | null;
|
|
2652
|
+
}
|
|
2653
|
+
interface PreviewCancelRefundEmailResponse {
|
|
2654
|
+
emailPreview?: string;
|
|
2655
|
+
}
|
|
2656
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
2657
|
+
}
|
|
2658
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
2659
|
+
emailPreview?: string;
|
|
2660
|
+
}
|
|
2661
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
2662
|
+
}
|
|
2663
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
2664
|
+
emailPreview?: string;
|
|
2665
|
+
}
|
|
2666
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
2667
|
+
}
|
|
2668
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
2669
|
+
emailPreview?: string;
|
|
2670
|
+
}
|
|
2671
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
2672
|
+
}
|
|
2673
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
2674
|
+
emailPreview?: string;
|
|
2675
|
+
}
|
|
2676
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
2677
|
+
}
|
|
2678
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
2679
|
+
emailPreview?: string;
|
|
2680
|
+
}
|
|
2681
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2682
|
+
createdEvent?: EntityCreatedEvent;
|
|
2683
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2684
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2685
|
+
actionEvent?: ActionEvent;
|
|
2686
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2687
|
+
_id?: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2690
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2691
|
+
*/
|
|
2692
|
+
entityFqdn?: string;
|
|
2693
|
+
/**
|
|
2694
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2695
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2758
2696
|
*/
|
|
2759
2697
|
slug?: string;
|
|
2760
2698
|
/** ID of the entity associated with the event. */
|
|
@@ -2804,91 +2742,1301 @@ interface ActionEvent {
|
|
|
2804
2742
|
}
|
|
2805
2743
|
interface Empty {
|
|
2806
2744
|
}
|
|
2807
|
-
interface
|
|
2808
|
-
/**
|
|
2809
|
-
|
|
2745
|
+
interface MessageEnvelope {
|
|
2746
|
+
/**
|
|
2747
|
+
* App instance ID.
|
|
2748
|
+
* @format GUID
|
|
2749
|
+
*/
|
|
2750
|
+
instanceId?: string | null;
|
|
2751
|
+
/**
|
|
2752
|
+
* Event type.
|
|
2753
|
+
* @maxLength 150
|
|
2754
|
+
*/
|
|
2755
|
+
eventType?: string;
|
|
2756
|
+
/** The identification type and identity data. */
|
|
2757
|
+
identity?: IdentificationData;
|
|
2758
|
+
/** Stringify payload. */
|
|
2759
|
+
data?: string;
|
|
2760
|
+
}
|
|
2761
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2762
|
+
/**
|
|
2763
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2764
|
+
* @format GUID
|
|
2765
|
+
*/
|
|
2766
|
+
anonymousVisitorId?: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* ID of a site visitor that has logged in to the site.
|
|
2769
|
+
* @format GUID
|
|
2770
|
+
*/
|
|
2771
|
+
memberId?: string;
|
|
2772
|
+
/**
|
|
2773
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2774
|
+
* @format GUID
|
|
2775
|
+
*/
|
|
2776
|
+
wixUserId?: string;
|
|
2777
|
+
/**
|
|
2778
|
+
* ID of an app.
|
|
2779
|
+
* @format GUID
|
|
2780
|
+
*/
|
|
2781
|
+
appId?: string;
|
|
2782
|
+
/** @readonly */
|
|
2783
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2784
|
+
}
|
|
2785
|
+
/** @oneof */
|
|
2786
|
+
interface IdentificationDataIdOneOf {
|
|
2787
|
+
/**
|
|
2788
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2789
|
+
* @format GUID
|
|
2790
|
+
*/
|
|
2791
|
+
anonymousVisitorId?: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* ID of a site visitor that has logged in to the site.
|
|
2794
|
+
* @format GUID
|
|
2795
|
+
*/
|
|
2796
|
+
memberId?: string;
|
|
2797
|
+
/**
|
|
2798
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2799
|
+
* @format GUID
|
|
2800
|
+
*/
|
|
2801
|
+
wixUserId?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* ID of an app.
|
|
2804
|
+
* @format GUID
|
|
2805
|
+
*/
|
|
2806
|
+
appId?: string;
|
|
2807
|
+
}
|
|
2808
|
+
declare enum WebhookIdentityType {
|
|
2809
|
+
UNKNOWN = "UNKNOWN",
|
|
2810
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2811
|
+
MEMBER = "MEMBER",
|
|
2812
|
+
WIX_USER = "WIX_USER",
|
|
2813
|
+
APP = "APP"
|
|
2814
|
+
}
|
|
2815
|
+
/** @enumType */
|
|
2816
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2817
|
+
interface PreparePaymentCollectionRequest {
|
|
2818
|
+
/**
|
|
2819
|
+
* Ecom order ID.
|
|
2820
|
+
* @minLength 1
|
|
2821
|
+
* @maxLength 100
|
|
2822
|
+
*/
|
|
2823
|
+
ecomOrderId: string;
|
|
2824
|
+
/** Amount to collect */
|
|
2825
|
+
amount: Price;
|
|
2826
|
+
/**
|
|
2827
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
2828
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
2829
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
2830
|
+
*/
|
|
2831
|
+
paymentGatewayOrderId?: string | null;
|
|
2832
|
+
/**
|
|
2833
|
+
* Whether to delay capture of the payment.
|
|
2834
|
+
* Default: false
|
|
2835
|
+
* @deprecated Whether to delay capture of the payment.
|
|
2836
|
+
* Default: false
|
|
2837
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
2838
|
+
* @targetRemovalDate 2024-09-30
|
|
2839
|
+
*/
|
|
2840
|
+
delayedCapture?: boolean;
|
|
2841
|
+
/** Delayed capture payment settings */
|
|
2842
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2843
|
+
}
|
|
2844
|
+
interface RedirectUrls {
|
|
2845
|
+
/**
|
|
2846
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
2847
|
+
* @format WEB_URL
|
|
2848
|
+
*/
|
|
2849
|
+
successUrl?: string | null;
|
|
2850
|
+
/**
|
|
2851
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
2852
|
+
* @format WEB_URL
|
|
2853
|
+
*/
|
|
2854
|
+
cancelUrl?: string | null;
|
|
2855
|
+
/**
|
|
2856
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
2857
|
+
* @format WEB_URL
|
|
2858
|
+
*/
|
|
2859
|
+
errorUrl?: string | null;
|
|
2860
|
+
/**
|
|
2861
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
2862
|
+
* @format WEB_URL
|
|
2863
|
+
*/
|
|
2864
|
+
pendingUrl?: string | null;
|
|
2865
|
+
}
|
|
2866
|
+
interface DelayedCaptureSettings {
|
|
2867
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2868
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
2869
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2870
|
+
delayDuration?: Duration;
|
|
2871
|
+
}
|
|
2872
|
+
declare enum ScheduledAction {
|
|
2873
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
2874
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
2875
|
+
VOID = "VOID",
|
|
2876
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
2877
|
+
CAPTURE = "CAPTURE"
|
|
2878
|
+
}
|
|
2879
|
+
/** @enumType */
|
|
2880
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2881
|
+
interface Duration {
|
|
2882
|
+
/**
|
|
2883
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2884
|
+
* @min 1
|
|
2885
|
+
*/
|
|
2886
|
+
count?: number;
|
|
2887
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2888
|
+
unit?: DurationUnitWithLiterals;
|
|
2889
|
+
}
|
|
2890
|
+
declare enum DurationUnit {
|
|
2891
|
+
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2892
|
+
MINUTES = "MINUTES",
|
|
2893
|
+
HOURS = "HOURS",
|
|
2894
|
+
DAYS = "DAYS"
|
|
2895
|
+
}
|
|
2896
|
+
/** @enumType */
|
|
2897
|
+
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2898
|
+
interface PreparePaymentCollectionResponse {
|
|
2899
|
+
/** Payment gateway order id which is associated with given payment */
|
|
2900
|
+
paymentGatewayOrderId?: string;
|
|
2901
|
+
}
|
|
2902
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
2903
|
+
/**
|
|
2904
|
+
* Ecom order ID.
|
|
2905
|
+
* @minLength 1
|
|
2906
|
+
* @maxLength 100
|
|
2907
|
+
*/
|
|
2908
|
+
ecomOrderId: string;
|
|
2909
|
+
}
|
|
2910
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
2911
|
+
/** Payment collectability status */
|
|
2912
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2913
|
+
/** Collectable order amount */
|
|
2914
|
+
amount?: Price;
|
|
2915
|
+
}
|
|
2916
|
+
declare enum PaymentCollectabilityStatus {
|
|
2917
|
+
UNKNOWN = "UNKNOWN",
|
|
2918
|
+
COLLECTABLE = "COLLECTABLE",
|
|
2919
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
2920
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
2921
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
2922
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
2923
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2924
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2925
|
+
}
|
|
2926
|
+
/** @enumType */
|
|
2927
|
+
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';
|
|
2928
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
2929
|
+
/**
|
|
2930
|
+
* Order ID.
|
|
2931
|
+
* @minLength 1
|
|
2932
|
+
* @maxLength 100
|
|
2933
|
+
*/
|
|
2934
|
+
orderId: string;
|
|
2935
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
2936
|
+
amount: Price;
|
|
2937
|
+
}
|
|
2938
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
2939
|
+
}
|
|
2940
|
+
interface MarkOrderAsPaidRequest {
|
|
2941
|
+
/**
|
|
2942
|
+
* Ecom order ID.
|
|
2943
|
+
* @minLength 1
|
|
2944
|
+
* @maxLength 100
|
|
2945
|
+
*/
|
|
2946
|
+
ecomOrderId: string;
|
|
2947
|
+
}
|
|
2948
|
+
interface MarkOrderAsPaidResponse {
|
|
2949
|
+
/** Updated order. */
|
|
2950
|
+
order?: Order;
|
|
2951
|
+
}
|
|
2952
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
2953
|
+
/**
|
|
2954
|
+
* IDs of orders to mark as paid.
|
|
2955
|
+
* @minSize 1
|
|
2956
|
+
* @maxSize 100
|
|
2957
|
+
* @minLength 1
|
|
2958
|
+
* @maxLength 100
|
|
2959
|
+
*/
|
|
2960
|
+
ecomOrderIds: string[];
|
|
2961
|
+
}
|
|
2962
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
2963
|
+
/**
|
|
2964
|
+
* Items updated by the bulk action.
|
|
2965
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
2966
|
+
*/
|
|
2967
|
+
results?: BulkOrderResult[];
|
|
2968
|
+
/** Bulk action metadata. */
|
|
2969
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2970
|
+
}
|
|
2971
|
+
interface BulkOrderResult {
|
|
2972
|
+
/** Item metadata. */
|
|
2973
|
+
itemMetadata?: ItemMetadata;
|
|
2974
|
+
/**
|
|
2975
|
+
* Updated order.
|
|
2976
|
+
*
|
|
2977
|
+
* Returned when `returnFullEntity = true`.
|
|
2978
|
+
*/
|
|
2979
|
+
item?: Order;
|
|
2980
|
+
}
|
|
2981
|
+
interface ItemMetadata {
|
|
2982
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2983
|
+
_id?: string | null;
|
|
2984
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2985
|
+
originalIndex?: number;
|
|
2986
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2987
|
+
success?: boolean;
|
|
2988
|
+
/** Details about the error in case of failure. */
|
|
2989
|
+
error?: ApplicationError;
|
|
2990
|
+
}
|
|
2991
|
+
interface ApplicationError {
|
|
2992
|
+
/** Error code. */
|
|
2993
|
+
code?: string;
|
|
2994
|
+
/** Description of the error. */
|
|
2995
|
+
description?: string;
|
|
2996
|
+
/** Data related to the error. */
|
|
2997
|
+
data?: Record<string, any> | null;
|
|
2998
|
+
}
|
|
2999
|
+
interface BulkActionMetadata {
|
|
3000
|
+
/** Number of items that were successfully processed. */
|
|
3001
|
+
totalSuccesses?: number;
|
|
3002
|
+
/** Number of items that couldn't be processed. */
|
|
3003
|
+
totalFailures?: number;
|
|
3004
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3005
|
+
undetailedFailures?: number;
|
|
3006
|
+
}
|
|
3007
|
+
interface GetRefundabilityStatusRequest {
|
|
3008
|
+
/**
|
|
3009
|
+
* Order ID.
|
|
3010
|
+
* @minLength 1
|
|
3011
|
+
* @maxLength 100
|
|
3012
|
+
*/
|
|
3013
|
+
ecomOrderId: string;
|
|
3014
|
+
}
|
|
3015
|
+
interface GetRefundabilityStatusResponse {
|
|
3016
|
+
/**
|
|
3017
|
+
* Refundability details.
|
|
3018
|
+
* @maxSize 300
|
|
3019
|
+
*/
|
|
3020
|
+
refundabilities?: Refundability[];
|
|
3021
|
+
/**
|
|
3022
|
+
* Whether the order supports refunding per item.
|
|
3023
|
+
* @deprecated
|
|
3024
|
+
*/
|
|
3025
|
+
refundablePerItem?: boolean;
|
|
3026
|
+
}
|
|
3027
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
3028
|
+
/** Reason why payment is not refundable. */
|
|
3029
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
3030
|
+
/** Reason why payment is only refundable manually. */
|
|
3031
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3032
|
+
/** Payment ID. */
|
|
3033
|
+
paymentId?: string;
|
|
3034
|
+
/** Payment refundability status. */
|
|
3035
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
3036
|
+
/** Link to payment provider dashboard. */
|
|
3037
|
+
providerLink?: string | null;
|
|
3038
|
+
}
|
|
3039
|
+
/** @oneof */
|
|
3040
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
3041
|
+
/** Reason why payment is not refundable. */
|
|
3042
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
3043
|
+
/** Reason why payment is only refundable manually. */
|
|
3044
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3045
|
+
}
|
|
3046
|
+
declare enum RefundableStatus {
|
|
3047
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
3048
|
+
MANUAL = "MANUAL",
|
|
3049
|
+
REFUNDABLE = "REFUNDABLE"
|
|
3050
|
+
}
|
|
3051
|
+
/** @enumType */
|
|
3052
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
3053
|
+
declare enum NonRefundableReason {
|
|
3054
|
+
NONE = "NONE",
|
|
3055
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
3056
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
3057
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
3058
|
+
NOT_PAID = "NOT_PAID",
|
|
3059
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
3060
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
3061
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
3062
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
3063
|
+
FORBIDDEN = "FORBIDDEN",
|
|
3064
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
3065
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
3066
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
3067
|
+
}
|
|
3068
|
+
/** @enumType */
|
|
3069
|
+
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';
|
|
3070
|
+
declare enum ManuallyRefundableReason {
|
|
3071
|
+
EXPIRED = "EXPIRED",
|
|
3072
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
3073
|
+
OFFLINE = "OFFLINE",
|
|
3074
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
3075
|
+
}
|
|
3076
|
+
/** @enumType */
|
|
3077
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
3078
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
3079
|
+
/**
|
|
3080
|
+
* Ecom order ID.
|
|
3081
|
+
* @minLength 1
|
|
3082
|
+
* @maxLength 100
|
|
3083
|
+
*/
|
|
3084
|
+
ecomOrderId: string;
|
|
3085
|
+
/** Information about the user who initiated the payment. */
|
|
3086
|
+
chargedBy?: ChargedBy;
|
|
3087
|
+
}
|
|
3088
|
+
interface ChargedBy {
|
|
3089
|
+
/**
|
|
3090
|
+
* ID - id of the user who initiated the payment
|
|
3091
|
+
* @format GUID
|
|
3092
|
+
*/
|
|
3093
|
+
_id?: string;
|
|
3094
|
+
/**
|
|
3095
|
+
* Full name - name of the user who initiated the payment
|
|
3096
|
+
* @minLength 1
|
|
3097
|
+
* @maxLength 200
|
|
3098
|
+
*/
|
|
3099
|
+
fullName?: string | null;
|
|
3100
|
+
}
|
|
3101
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
3102
|
+
/** ID of the order created in the payment gateway */
|
|
3103
|
+
paymentGatewayOrderId?: string;
|
|
3104
|
+
}
|
|
3105
|
+
interface ChargeMembershipsRequest {
|
|
3106
|
+
/**
|
|
3107
|
+
* Order ID.
|
|
3108
|
+
* @minLength 1
|
|
3109
|
+
* @maxLength 100
|
|
3110
|
+
*/
|
|
3111
|
+
ecomOrderId: string;
|
|
3112
|
+
/**
|
|
3113
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
3114
|
+
* but a user which is using the membership on behalf of the a member
|
|
3115
|
+
* @format GUID
|
|
3116
|
+
*/
|
|
3117
|
+
memberId: string;
|
|
3118
|
+
/**
|
|
3119
|
+
* List of items to be paid by memberships
|
|
3120
|
+
* @minSize 1
|
|
3121
|
+
* @maxSize 300
|
|
3122
|
+
*/
|
|
3123
|
+
membershipCharges?: MembershipChargeItem[];
|
|
3124
|
+
}
|
|
3125
|
+
interface MembershipChargeItem {
|
|
3126
|
+
/**
|
|
3127
|
+
* The id of used membership
|
|
3128
|
+
* @minLength 1
|
|
3129
|
+
* @maxLength 100
|
|
3130
|
+
*/
|
|
3131
|
+
membershipId?: string;
|
|
3132
|
+
/**
|
|
3133
|
+
* ID of the application providing this payment option
|
|
3134
|
+
* @format GUID
|
|
3135
|
+
*/
|
|
3136
|
+
appId?: string;
|
|
3137
|
+
/** The name of used membership */
|
|
3138
|
+
membershipName?: MembershipName;
|
|
3139
|
+
/** Additional data about this membership */
|
|
3140
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
3141
|
+
/** Catalog and item reference info. */
|
|
3142
|
+
catalogReference?: CatalogReference;
|
|
3143
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
3144
|
+
serviceProperties?: ServiceProperties;
|
|
3145
|
+
/**
|
|
3146
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
3147
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
3148
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
3149
|
+
* @minLength 1
|
|
3150
|
+
* @maxLength 36
|
|
3151
|
+
*/
|
|
3152
|
+
rootCatalogItemId?: string | null;
|
|
3153
|
+
/**
|
|
3154
|
+
* line item id of Checkout/Order line item
|
|
3155
|
+
* @minLength 1
|
|
3156
|
+
* @maxLength 100
|
|
3157
|
+
*/
|
|
3158
|
+
lineItemId?: string;
|
|
3159
|
+
}
|
|
3160
|
+
interface MembershipName {
|
|
3161
|
+
/**
|
|
3162
|
+
* Membership name.
|
|
3163
|
+
* @maxLength 100
|
|
3164
|
+
*/
|
|
3165
|
+
original?: string;
|
|
3166
|
+
/**
|
|
3167
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
3168
|
+
* @maxLength 100
|
|
3169
|
+
*/
|
|
3170
|
+
translated?: string | null;
|
|
3171
|
+
}
|
|
3172
|
+
interface ServiceProperties {
|
|
3173
|
+
/**
|
|
3174
|
+
* 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.
|
|
3175
|
+
* For example, the start time of a class.
|
|
3176
|
+
*/
|
|
3177
|
+
scheduledDate?: Date | null;
|
|
3178
|
+
/**
|
|
3179
|
+
* 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.
|
|
3180
|
+
* @min 1
|
|
3181
|
+
* @max 10000
|
|
3182
|
+
*/
|
|
3183
|
+
numberOfParticipants?: number | null;
|
|
3184
|
+
}
|
|
3185
|
+
interface ChargeMembershipsResponse {
|
|
3186
|
+
}
|
|
3187
|
+
interface TriggerRefundRequest {
|
|
3188
|
+
/**
|
|
3189
|
+
* The order this refund related to
|
|
3190
|
+
* @minLength 1
|
|
3191
|
+
* @maxLength 100
|
|
3192
|
+
*/
|
|
3193
|
+
ecomOrderId: string;
|
|
3194
|
+
/**
|
|
3195
|
+
* Refund operations information
|
|
3196
|
+
* @minSize 1
|
|
3197
|
+
* @maxSize 1
|
|
3198
|
+
*/
|
|
3199
|
+
payments: PaymentRefund[];
|
|
3200
|
+
/** Business model of a refund */
|
|
3201
|
+
details?: RefundDetails;
|
|
3202
|
+
/** Side effect details related to refund */
|
|
3203
|
+
sideEffects?: RefundSideEffects;
|
|
3204
|
+
}
|
|
3205
|
+
interface PaymentRefund {
|
|
3206
|
+
/**
|
|
3207
|
+
* Specific payment within the order to refund
|
|
3208
|
+
* @format GUID
|
|
3209
|
+
*/
|
|
3210
|
+
paymentId?: string;
|
|
3211
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
3212
|
+
amount?: Price;
|
|
3213
|
+
/**
|
|
3214
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
3215
|
+
* 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.
|
|
3216
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
3217
|
+
*/
|
|
3218
|
+
externalRefund?: boolean;
|
|
3219
|
+
}
|
|
3220
|
+
interface RefundSideEffects {
|
|
3221
|
+
/** Inventory restock details as part of this refund. */
|
|
3222
|
+
restockInfo?: RestockInfo;
|
|
3223
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
3224
|
+
sendOrderRefundedEmail?: boolean;
|
|
3225
|
+
/**
|
|
3226
|
+
* Custom message added to the refund confirmation email.
|
|
3227
|
+
* @minLength 1
|
|
3228
|
+
* @maxLength 1000
|
|
3229
|
+
*/
|
|
3230
|
+
customMessage?: string | null;
|
|
3231
|
+
}
|
|
3232
|
+
interface RestockInfo {
|
|
3233
|
+
/** Restock type. */
|
|
3234
|
+
type?: RestockTypeWithLiterals;
|
|
3235
|
+
/**
|
|
3236
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
3237
|
+
* @maxSize 300
|
|
3238
|
+
*/
|
|
3239
|
+
items?: RestockItem[];
|
|
3240
|
+
}
|
|
3241
|
+
declare enum RestockType {
|
|
3242
|
+
NO_ITEMS = "NO_ITEMS",
|
|
3243
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
3244
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
3245
|
+
}
|
|
3246
|
+
/** @enumType */
|
|
3247
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
3248
|
+
interface RestockItem {
|
|
3249
|
+
/**
|
|
3250
|
+
* ID of the line item being restocked.
|
|
3251
|
+
* @format GUID
|
|
3252
|
+
*/
|
|
3253
|
+
lineItemId?: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* Line item quantity being restocked.
|
|
3256
|
+
* @min 1
|
|
3257
|
+
* @max 100000
|
|
3258
|
+
*/
|
|
3259
|
+
quantity?: number;
|
|
3260
|
+
}
|
|
3261
|
+
interface TriggerRefundResponse {
|
|
3262
|
+
/** All order's transactions after the refunds were added */
|
|
3263
|
+
orderTransactions?: OrderTransactions;
|
|
3264
|
+
/** Created refund ID */
|
|
3265
|
+
refundId?: string | null;
|
|
3266
|
+
/** Payment ID's that the refund execution had failed for */
|
|
3267
|
+
failedPaymentIds?: ItemMetadata[];
|
|
3268
|
+
}
|
|
3269
|
+
interface OrderTransactions {
|
|
3270
|
+
/**
|
|
3271
|
+
* Order ID.
|
|
3272
|
+
* @format GUID
|
|
3273
|
+
*/
|
|
3274
|
+
orderId?: string;
|
|
3275
|
+
/**
|
|
3276
|
+
* Record of payments made to the merchant.
|
|
3277
|
+
* @maxSize 100
|
|
3278
|
+
*/
|
|
3279
|
+
payments?: Payment[];
|
|
3280
|
+
/**
|
|
3281
|
+
* Record of refunds made to the buyer.
|
|
3282
|
+
* @maxSize 300
|
|
3283
|
+
*/
|
|
3284
|
+
refunds?: Refund[];
|
|
3285
|
+
}
|
|
3286
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
3287
|
+
/** Regular payment details. */
|
|
3288
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3289
|
+
/** Gift card payment details. */
|
|
3290
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3291
|
+
/**
|
|
3292
|
+
* Payment ID.
|
|
3293
|
+
* @format GUID
|
|
3294
|
+
* @readonly
|
|
3295
|
+
*/
|
|
3296
|
+
_id?: string | null;
|
|
3297
|
+
/** 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. */
|
|
3298
|
+
_createdDate?: Date | null;
|
|
3299
|
+
/**
|
|
3300
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
3301
|
+
* @readonly
|
|
3302
|
+
*/
|
|
3303
|
+
_updatedDate?: Date | null;
|
|
3304
|
+
/** Payment amount. */
|
|
3305
|
+
amount?: Price;
|
|
3306
|
+
/**
|
|
3307
|
+
* Whether refunds for this payment are disabled.
|
|
3308
|
+
* + `true`: This payment is not refundable.
|
|
3309
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
3310
|
+
*/
|
|
3311
|
+
refundDisabled?: boolean;
|
|
3312
|
+
}
|
|
3313
|
+
/** @oneof */
|
|
3314
|
+
interface PaymentPaymentDetailsOneOf {
|
|
3315
|
+
/** Regular payment details. */
|
|
3316
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3317
|
+
/** Gift card payment details. */
|
|
3318
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3319
|
+
}
|
|
3320
|
+
/** @oneof */
|
|
3321
|
+
interface PaymentReceiptInfoOneOf {
|
|
3322
|
+
}
|
|
3323
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3324
|
+
/** Whether regular card used */
|
|
3325
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3326
|
+
/**
|
|
3327
|
+
* Wix Payments order ID.
|
|
3328
|
+
* @maxLength 100
|
|
3329
|
+
*/
|
|
3330
|
+
paymentOrderId?: string | null;
|
|
3331
|
+
/**
|
|
3332
|
+
* Payment gateway's transaction ID.
|
|
3333
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
3334
|
+
* @maxLength 100
|
|
3335
|
+
*/
|
|
3336
|
+
gatewayTransactionId?: string | null;
|
|
3337
|
+
/**
|
|
3338
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
3339
|
+
* + `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`
|
|
3340
|
+
* @maxLength 100
|
|
3341
|
+
*/
|
|
3342
|
+
paymentMethod?: string | null;
|
|
3343
|
+
/**
|
|
3344
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
3345
|
+
* @maxLength 100
|
|
3346
|
+
*/
|
|
3347
|
+
providerTransactionId?: string | null;
|
|
3348
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3349
|
+
offlinePayment?: boolean;
|
|
3350
|
+
/** Payment status. */
|
|
3351
|
+
status?: TransactionStatusWithLiterals;
|
|
3352
|
+
/**
|
|
3353
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
3354
|
+
* @immutable
|
|
3355
|
+
*/
|
|
3356
|
+
savedPaymentMethod?: boolean;
|
|
3357
|
+
/** Authorization details. */
|
|
3358
|
+
authorizationDetails?: AuthorizationDetails;
|
|
3359
|
+
/**
|
|
3360
|
+
* Record of chargebacks made by the buyer.
|
|
3361
|
+
* @maxSize 6
|
|
3362
|
+
*/
|
|
3363
|
+
chargebacks?: Chargeback[];
|
|
3364
|
+
}
|
|
3365
|
+
/** @oneof */
|
|
3366
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3367
|
+
/** Whether regular card used */
|
|
3368
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3369
|
+
}
|
|
3370
|
+
declare enum TransactionStatus {
|
|
3371
|
+
UNDEFINED = "UNDEFINED",
|
|
3372
|
+
APPROVED = "APPROVED",
|
|
3373
|
+
PENDING = "PENDING",
|
|
3374
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3375
|
+
CANCELED = "CANCELED",
|
|
3376
|
+
DECLINED = "DECLINED",
|
|
3377
|
+
REFUNDED = "REFUNDED",
|
|
3378
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3379
|
+
AUTHORIZED = "AUTHORIZED",
|
|
3380
|
+
VOIDED = "VOIDED"
|
|
3381
|
+
}
|
|
3382
|
+
/** @enumType */
|
|
3383
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3384
|
+
interface CreditCardPaymentMethodDetails {
|
|
3385
|
+
/**
|
|
3386
|
+
* The last 4 digits of the card number.
|
|
3387
|
+
* @maxLength 4
|
|
3388
|
+
*/
|
|
3389
|
+
lastFourDigits?: string | null;
|
|
3390
|
+
/**
|
|
3391
|
+
* Card issuer's brand.
|
|
3392
|
+
* @maxLength 100
|
|
3393
|
+
*/
|
|
3394
|
+
brand?: string | null;
|
|
3395
|
+
}
|
|
3396
|
+
interface AuthorizationDetails {
|
|
3397
|
+
/**
|
|
3398
|
+
* Whether the authorized payment is of a delayed capture.
|
|
3399
|
+
* @readonly
|
|
3400
|
+
*/
|
|
3401
|
+
delayedCapture?: boolean;
|
|
3402
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3403
|
+
authorizedDate?: Date | null;
|
|
3404
|
+
/**
|
|
3405
|
+
* List of captures associated with payment
|
|
3406
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3407
|
+
* @maxSize 1
|
|
3408
|
+
*/
|
|
3409
|
+
captures?: AuthorizationCapture[];
|
|
3410
|
+
/** Void associated with payment */
|
|
3411
|
+
void?: AuthorizationVoid;
|
|
3412
|
+
/** Scheduled action for this transaction */
|
|
3413
|
+
scheduledAction?: V1ScheduledAction;
|
|
3414
|
+
}
|
|
3415
|
+
interface AuthorizationCapture {
|
|
3416
|
+
/**
|
|
3417
|
+
* Capture ID.
|
|
3418
|
+
* @format GUID
|
|
3419
|
+
* @readonly
|
|
3420
|
+
*/
|
|
3421
|
+
_id?: string | null;
|
|
3422
|
+
/** Status of this capture action */
|
|
3423
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3424
|
+
/**
|
|
3425
|
+
* Amount of this capture
|
|
3426
|
+
* @immutable
|
|
3427
|
+
*/
|
|
3428
|
+
amount?: Price;
|
|
3429
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3430
|
+
_createdDate?: Date | null;
|
|
3431
|
+
/** In case of status is FAILED may contain failure details */
|
|
3432
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3433
|
+
}
|
|
3434
|
+
declare enum AuthorizationCaptureStatus {
|
|
3435
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3436
|
+
/** Capture operation still in progress. */
|
|
3437
|
+
PENDING = "PENDING",
|
|
3438
|
+
/** Capture operation succeeded. */
|
|
3439
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3440
|
+
/** Capture operation failed. */
|
|
3441
|
+
FAILED = "FAILED"
|
|
3442
|
+
}
|
|
3443
|
+
/** @enumType */
|
|
3444
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3445
|
+
interface AuthorizationActionFailureDetails {
|
|
3446
|
+
/** @maxLength 100 */
|
|
3447
|
+
failureCode?: string;
|
|
3448
|
+
}
|
|
3449
|
+
interface AuthorizationVoid {
|
|
3450
|
+
/** Status of this void action */
|
|
3451
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
3452
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3453
|
+
voidedDate?: Date | null;
|
|
3454
|
+
/** In case of status is FAILED may contain failure details */
|
|
3455
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3456
|
+
/** Reason of void action */
|
|
3457
|
+
reason?: ReasonWithLiterals;
|
|
3458
|
+
}
|
|
3459
|
+
declare enum AuthorizationVoidStatus {
|
|
3460
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3461
|
+
/** Void operation still in progress. */
|
|
3462
|
+
PENDING = "PENDING",
|
|
3463
|
+
/** Void operation succeeded. */
|
|
3464
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3465
|
+
/** Void operation failed. */
|
|
3466
|
+
FAILED = "FAILED"
|
|
3467
|
+
}
|
|
3468
|
+
/** @enumType */
|
|
3469
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3470
|
+
/** Reason the authorization was voided. */
|
|
3471
|
+
declare enum Reason {
|
|
3472
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3473
|
+
/** Authorization was voided by user. */
|
|
3474
|
+
MANUAL = "MANUAL",
|
|
3475
|
+
/** Authorization passed execution date. */
|
|
3476
|
+
SCHEDULED = "SCHEDULED"
|
|
3477
|
+
}
|
|
3478
|
+
/** @enumType */
|
|
3479
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3480
|
+
interface V1ScheduledAction {
|
|
3481
|
+
/** Type of the action. */
|
|
3482
|
+
actionType?: ActionTypeWithLiterals;
|
|
3483
|
+
/** The date and time of the action. */
|
|
3484
|
+
executionDate?: Date | null;
|
|
3485
|
+
}
|
|
3486
|
+
declare enum ActionType {
|
|
3487
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3488
|
+
VOID = "VOID",
|
|
3489
|
+
CAPTURE = "CAPTURE"
|
|
3490
|
+
}
|
|
3491
|
+
/** @enumType */
|
|
3492
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3493
|
+
interface Chargeback {
|
|
3494
|
+
/**
|
|
3495
|
+
* Chargeback ID.
|
|
3496
|
+
* @format GUID
|
|
3497
|
+
* @readonly
|
|
3498
|
+
* @immutable
|
|
3499
|
+
*/
|
|
3500
|
+
_id?: string;
|
|
3501
|
+
/**
|
|
3502
|
+
* 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.
|
|
3503
|
+
* @readonly
|
|
3504
|
+
* @immutable
|
|
3505
|
+
*/
|
|
3506
|
+
_createdDate?: Date | null;
|
|
3507
|
+
/**
|
|
3508
|
+
* 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.
|
|
3509
|
+
* @readonly
|
|
3510
|
+
*/
|
|
3511
|
+
_updatedDate?: Date | null;
|
|
3512
|
+
/**
|
|
3513
|
+
* Amount.
|
|
3514
|
+
* @readonly
|
|
3515
|
+
* @immutable
|
|
3516
|
+
*/
|
|
3517
|
+
amount?: Price;
|
|
3518
|
+
/**
|
|
3519
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
3520
|
+
* @readonly
|
|
3521
|
+
*/
|
|
3522
|
+
reversalAmount?: Price;
|
|
3523
|
+
/**
|
|
3524
|
+
* Status.
|
|
3525
|
+
*
|
|
3526
|
+
* Default: `"APPROVED"`.
|
|
3527
|
+
*/
|
|
3528
|
+
status?: ChargebackStatusWithLiterals;
|
|
3529
|
+
/**
|
|
3530
|
+
* External chargeback ID.
|
|
3531
|
+
* @format GUID
|
|
3532
|
+
* @readonly
|
|
3533
|
+
* @immutable
|
|
3534
|
+
*/
|
|
3535
|
+
externalId?: string | null;
|
|
3536
|
+
}
|
|
3537
|
+
declare enum ChargebackStatus {
|
|
3538
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3539
|
+
/** Chargeback was approved. */
|
|
3540
|
+
APPROVED = "APPROVED",
|
|
3541
|
+
/** Chargeback was reversed. */
|
|
3542
|
+
REVERSED = "REVERSED"
|
|
3543
|
+
}
|
|
3544
|
+
/** @enumType */
|
|
3545
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3546
|
+
interface GiftCardPaymentDetails {
|
|
3547
|
+
/**
|
|
3548
|
+
* Gift card payment ID.
|
|
3549
|
+
* @minLength 1
|
|
3550
|
+
* @maxLength 100
|
|
3551
|
+
*/
|
|
3552
|
+
giftCardPaymentId?: string;
|
|
3553
|
+
/**
|
|
3554
|
+
* ID of the app that created the gift card.
|
|
3555
|
+
* @format GUID
|
|
3556
|
+
*/
|
|
3557
|
+
appId?: string;
|
|
3558
|
+
/**
|
|
3559
|
+
* Whether the gift card is voided.
|
|
3560
|
+
* @readonly
|
|
3561
|
+
*/
|
|
3562
|
+
voided?: boolean;
|
|
3563
|
+
}
|
|
3564
|
+
interface MembershipPaymentDetails {
|
|
3565
|
+
/**
|
|
3566
|
+
* Membership ID.
|
|
3567
|
+
* @minLength 1
|
|
3568
|
+
* @maxLength 100
|
|
3569
|
+
*/
|
|
3570
|
+
membershipId?: string;
|
|
3571
|
+
/**
|
|
3572
|
+
* ID of the line item this membership applies to.
|
|
3573
|
+
* @minLength 1
|
|
3574
|
+
* @maxLength 100
|
|
3575
|
+
*/
|
|
3576
|
+
lineItemId?: string;
|
|
3577
|
+
/** Payment status. */
|
|
3578
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
3579
|
+
/** Membership name. */
|
|
3580
|
+
name?: MembershipName;
|
|
3581
|
+
/**
|
|
3582
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3583
|
+
* @minLength 1
|
|
3584
|
+
* @maxLength 100
|
|
3585
|
+
*/
|
|
3586
|
+
externalTransactionId?: string | null;
|
|
3587
|
+
/**
|
|
3588
|
+
* Whether the membership is voided.
|
|
3589
|
+
* @readonly
|
|
3590
|
+
*/
|
|
3591
|
+
voided?: boolean;
|
|
3592
|
+
/**
|
|
3593
|
+
* ID of the application providing this payment option.
|
|
3594
|
+
* @format GUID
|
|
3595
|
+
*/
|
|
3596
|
+
providerAppId?: string;
|
|
3597
|
+
}
|
|
3598
|
+
declare enum MembershipPaymentStatus {
|
|
3599
|
+
/** Payment was charged. */
|
|
3600
|
+
CHARGED = "CHARGED",
|
|
3601
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3602
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3603
|
+
}
|
|
3604
|
+
/** @enumType */
|
|
3605
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3606
|
+
interface WixReceiptInfo {
|
|
3607
|
+
/**
|
|
3608
|
+
* Receipt ID
|
|
3609
|
+
* @format GUID
|
|
3610
|
+
*/
|
|
3611
|
+
receiptId?: string;
|
|
3612
|
+
/**
|
|
3613
|
+
* Display number of receipt
|
|
3614
|
+
* @minLength 1
|
|
3615
|
+
* @maxLength 40
|
|
3616
|
+
*/
|
|
3617
|
+
displayNumber?: string | null;
|
|
3618
|
+
}
|
|
3619
|
+
interface ExternalReceiptInfo {
|
|
3620
|
+
/**
|
|
3621
|
+
* External receipt ID
|
|
3622
|
+
* @maxLength 100
|
|
3623
|
+
*/
|
|
3624
|
+
receiptId?: string | null;
|
|
3625
|
+
/**
|
|
3626
|
+
* ID of the app providing the receipt
|
|
3627
|
+
* @format GUID
|
|
3628
|
+
*/
|
|
3629
|
+
appId?: string | null;
|
|
3630
|
+
/**
|
|
3631
|
+
* Display number of receipt
|
|
3632
|
+
* @minLength 1
|
|
3633
|
+
* @maxLength 40
|
|
3634
|
+
*/
|
|
3635
|
+
displayNumber?: string | null;
|
|
3636
|
+
}
|
|
3637
|
+
interface Refund {
|
|
3638
|
+
/**
|
|
3639
|
+
* Refund ID.
|
|
3640
|
+
* @format GUID
|
|
3641
|
+
* @readonly
|
|
3642
|
+
*/
|
|
3643
|
+
_id?: string;
|
|
3644
|
+
/**
|
|
3645
|
+
* List of transactions.
|
|
3646
|
+
* @maxSize 50
|
|
3647
|
+
*/
|
|
3648
|
+
transactions?: RefundTransaction[];
|
|
3649
|
+
/** Refund business details. */
|
|
3650
|
+
details?: RefundDetails;
|
|
3651
|
+
/**
|
|
3652
|
+
* 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.
|
|
3653
|
+
* @readonly
|
|
3654
|
+
* @immutable
|
|
3655
|
+
*/
|
|
3656
|
+
_createdDate?: Date | null;
|
|
3657
|
+
/**
|
|
3658
|
+
* Aggregated refund summary.
|
|
3659
|
+
* @readonly
|
|
3660
|
+
*/
|
|
3661
|
+
summary?: AggregatedRefundSummary;
|
|
3662
|
+
/**
|
|
3663
|
+
* ID of the app that initiated this refund.
|
|
3664
|
+
* @format GUID
|
|
3665
|
+
* @readonly
|
|
3666
|
+
* @immutable
|
|
3667
|
+
*/
|
|
3668
|
+
requestingServiceAppId?: string | null;
|
|
3669
|
+
}
|
|
3670
|
+
interface RefundTransaction {
|
|
3671
|
+
/**
|
|
3672
|
+
* ID of the payment associated with this refund.
|
|
3673
|
+
* @format GUID
|
|
3674
|
+
* @immutable
|
|
3675
|
+
*/
|
|
3676
|
+
paymentId?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* Refund amount.
|
|
3679
|
+
* @immutable
|
|
3680
|
+
*/
|
|
3681
|
+
amount?: Price;
|
|
3682
|
+
/** Refund status. */
|
|
3683
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
3684
|
+
/** Optional details of current refund status. */
|
|
3685
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
3686
|
+
/**
|
|
3687
|
+
* Payment gateway's refund ID.
|
|
3688
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
3689
|
+
* @format GUID
|
|
3690
|
+
*/
|
|
3691
|
+
gatewayRefundId?: string | null;
|
|
3692
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3693
|
+
providerRefundId?: string | null;
|
|
3694
|
+
/**
|
|
3695
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
3696
|
+
* @immutable
|
|
3697
|
+
*/
|
|
3698
|
+
externalRefund?: boolean;
|
|
3699
|
+
}
|
|
3700
|
+
/** Refund transaction status. */
|
|
3701
|
+
declare enum RefundStatus {
|
|
3702
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3703
|
+
PENDING = "PENDING",
|
|
3704
|
+
/** Refund transaction succeeded. */
|
|
3705
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3706
|
+
/** Refund transaction failed. */
|
|
3707
|
+
FAILED = "FAILED",
|
|
3708
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
3709
|
+
SCHEDULED = "SCHEDULED",
|
|
3710
|
+
/** Refund was initiated on payment provider side. */
|
|
3711
|
+
STARTED = "STARTED"
|
|
3712
|
+
}
|
|
3713
|
+
/** @enumType */
|
|
3714
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3715
|
+
interface RefundStatusInfo {
|
|
3716
|
+
/**
|
|
3717
|
+
* Reason code for the refund's current status.
|
|
3718
|
+
*
|
|
3719
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3720
|
+
* @minLength 1
|
|
3721
|
+
* @maxLength 10
|
|
3722
|
+
*/
|
|
3723
|
+
paymentGatewayReasonCode?: string | null;
|
|
3724
|
+
/**
|
|
3725
|
+
* Free text explanation of current refund status.
|
|
3726
|
+
* @minLength 1
|
|
3727
|
+
* @maxLength 1000
|
|
3728
|
+
*/
|
|
3729
|
+
description?: string | null;
|
|
3730
|
+
}
|
|
3731
|
+
interface AggregatedRefundSummary {
|
|
3732
|
+
/** Total amount requested for refund. */
|
|
3733
|
+
requestedRefund?: Price;
|
|
3734
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3735
|
+
pendingRefund?: Price;
|
|
3736
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3737
|
+
refunded?: Price;
|
|
3738
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3739
|
+
failedRefundAmount?: Price;
|
|
3740
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
3741
|
+
pending?: boolean;
|
|
3742
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3743
|
+
breakdown?: RefundItemsBreakdown;
|
|
3744
|
+
}
|
|
3745
|
+
interface RefundItemsBreakdown {
|
|
3746
|
+
/**
|
|
3747
|
+
* Refunded line items and the amount refunded for each.
|
|
3748
|
+
* @maxSize 300
|
|
3749
|
+
*/
|
|
3750
|
+
lineItems?: LineItemRefundSummary[];
|
|
3751
|
+
}
|
|
3752
|
+
interface LineItemRefundSummary {
|
|
3753
|
+
/**
|
|
3754
|
+
* ID of the refunded line item.
|
|
3755
|
+
* @format GUID
|
|
3756
|
+
*/
|
|
3757
|
+
lineItemId?: string;
|
|
3758
|
+
/** Total refunded amount for the line item. */
|
|
3759
|
+
totalRefundedAmount?: Price;
|
|
3760
|
+
}
|
|
3761
|
+
interface CalculateRefundRequest {
|
|
3762
|
+
/**
|
|
3763
|
+
* Order ID
|
|
3764
|
+
* @minLength 1
|
|
3765
|
+
* @maxLength 100
|
|
3766
|
+
*/
|
|
3767
|
+
ecomOrderId?: string;
|
|
3768
|
+
/**
|
|
3769
|
+
* Refunded line items and quantity
|
|
3770
|
+
* @maxSize 300
|
|
3771
|
+
*/
|
|
3772
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
3773
|
+
/** Should include shipping in refund calculation */
|
|
3774
|
+
refundShipping?: boolean;
|
|
3775
|
+
}
|
|
3776
|
+
interface CalculateRefundItemRequest {
|
|
3777
|
+
/**
|
|
3778
|
+
* ID of the line item being refunded
|
|
3779
|
+
* @format GUID
|
|
3780
|
+
*/
|
|
3781
|
+
_id?: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* How much of that line item is being refunded
|
|
3784
|
+
* @min 1
|
|
3785
|
+
* @max 100000
|
|
3786
|
+
*/
|
|
3787
|
+
quantity?: number;
|
|
3788
|
+
}
|
|
3789
|
+
interface CalculateRefundResponse {
|
|
3790
|
+
/** Total refundable amount */
|
|
3791
|
+
total?: Price;
|
|
3792
|
+
/** Tax cost of the order */
|
|
3793
|
+
tax?: Price;
|
|
3794
|
+
/** Discount given for this order */
|
|
3795
|
+
discount?: Price;
|
|
3796
|
+
/** Total cost of the order (without tax) */
|
|
3797
|
+
subtotal?: Price;
|
|
3798
|
+
/** Total shipping cost for order */
|
|
3799
|
+
shipping?: Price;
|
|
3800
|
+
/** Previous refund given on that order */
|
|
3801
|
+
previouslyRefundedAmount?: Price;
|
|
3802
|
+
/**
|
|
3803
|
+
* The refundable items of that order
|
|
3804
|
+
* @maxSize 300
|
|
3805
|
+
*/
|
|
3806
|
+
items?: CalculateRefundItemResponse[];
|
|
3807
|
+
}
|
|
3808
|
+
interface CalculateRefundItemResponse {
|
|
3809
|
+
/**
|
|
3810
|
+
* Line item ID
|
|
3811
|
+
* @format GUID
|
|
3812
|
+
*/
|
|
3813
|
+
_id?: string;
|
|
3814
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3815
|
+
price?: Price;
|
|
3816
|
+
}
|
|
3817
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
3818
|
+
/**
|
|
3819
|
+
* Wix eCommerce order ID
|
|
3820
|
+
* @minLength 1
|
|
3821
|
+
* @maxLength 100
|
|
3822
|
+
*/
|
|
3823
|
+
ecomOrderId: string;
|
|
3824
|
+
/**
|
|
3825
|
+
* Payment IDs
|
|
3826
|
+
* @minSize 1
|
|
3827
|
+
* @maxSize 100
|
|
3828
|
+
* @format GUID
|
|
3829
|
+
*/
|
|
3830
|
+
paymentIds: string[];
|
|
3831
|
+
}
|
|
3832
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
3833
|
+
/** All order's transactions after the void was triggered */
|
|
3834
|
+
orderTransactions?: OrderTransactions;
|
|
2810
3835
|
}
|
|
2811
|
-
interface
|
|
2812
|
-
/** @format GUID */
|
|
2813
|
-
metasiteId?: string;
|
|
3836
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
2814
3837
|
/**
|
|
3838
|
+
* Wix eCommerce order ID
|
|
2815
3839
|
* @minLength 1
|
|
2816
3840
|
* @maxLength 100
|
|
2817
3841
|
*/
|
|
2818
|
-
|
|
3842
|
+
ecomOrderId: string;
|
|
3843
|
+
/**
|
|
3844
|
+
* Capture payments information
|
|
3845
|
+
* @minSize 1
|
|
3846
|
+
* @maxSize 100
|
|
3847
|
+
*/
|
|
3848
|
+
payments: PaymentCapture[];
|
|
2819
3849
|
}
|
|
2820
|
-
interface
|
|
3850
|
+
interface PaymentCapture {
|
|
2821
3851
|
/**
|
|
2822
|
-
*
|
|
3852
|
+
* Payment ID
|
|
2823
3853
|
* @format GUID
|
|
2824
3854
|
*/
|
|
2825
|
-
|
|
3855
|
+
paymentId?: string | null;
|
|
2826
3856
|
/**
|
|
2827
|
-
*
|
|
2828
|
-
*
|
|
3857
|
+
* Capture amount.
|
|
3858
|
+
* If not provided - full authorized amount will be captured.
|
|
2829
3859
|
*/
|
|
2830
|
-
|
|
2831
|
-
/** The identification type and identity data. */
|
|
2832
|
-
identity?: IdentificationData;
|
|
2833
|
-
/** Stringify payload. */
|
|
2834
|
-
data?: string;
|
|
3860
|
+
amount?: Price;
|
|
2835
3861
|
}
|
|
2836
|
-
interface
|
|
3862
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
3863
|
+
/** All order's transactions after the capture was triggered */
|
|
3864
|
+
orderTransactions?: OrderTransactions;
|
|
3865
|
+
}
|
|
3866
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
2837
3867
|
/**
|
|
2838
|
-
*
|
|
2839
|
-
* @
|
|
3868
|
+
* Ecom Order ID.
|
|
3869
|
+
* @minLength 1
|
|
3870
|
+
* @maxLength 100
|
|
2840
3871
|
*/
|
|
2841
|
-
|
|
3872
|
+
ecomOrderId?: string;
|
|
3873
|
+
/** Amount to be charged */
|
|
3874
|
+
amount?: Price;
|
|
3875
|
+
}
|
|
3876
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
3877
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3878
|
+
paymentGatewayOrderId?: string;
|
|
3879
|
+
}
|
|
3880
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
3881
|
+
/** insert/update documents */
|
|
3882
|
+
update?: InternalDocumentUpdateOperation;
|
|
3883
|
+
/** delete by document ids */
|
|
3884
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3885
|
+
/** delete documents matching filter */
|
|
3886
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3887
|
+
/** update internal documents matching filter */
|
|
3888
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3889
|
+
/** update only existing documents */
|
|
3890
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3891
|
+
/** insert/update documents with versioning */
|
|
3892
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3893
|
+
/** delete by document ids with versioning */
|
|
3894
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2842
3895
|
/**
|
|
2843
|
-
*
|
|
2844
|
-
* @
|
|
3896
|
+
* type of the documents
|
|
3897
|
+
* @minLength 2
|
|
2845
3898
|
*/
|
|
2846
|
-
|
|
3899
|
+
documentType?: string;
|
|
2847
3900
|
/**
|
|
2848
|
-
*
|
|
2849
|
-
* @
|
|
3901
|
+
* language of the documents (mandatory)
|
|
3902
|
+
* @minLength 2
|
|
2850
3903
|
*/
|
|
2851
|
-
|
|
3904
|
+
language?: string | null;
|
|
2852
3905
|
/**
|
|
2853
|
-
*
|
|
2854
|
-
* @
|
|
3906
|
+
* one or more search documents
|
|
3907
|
+
* @deprecated
|
|
2855
3908
|
*/
|
|
2856
|
-
|
|
2857
|
-
/**
|
|
2858
|
-
|
|
3909
|
+
addDocuments?: InternalDocument[];
|
|
3910
|
+
/**
|
|
3911
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
3912
|
+
* @deprecated
|
|
3913
|
+
*/
|
|
3914
|
+
removeDocumentIds?: string[];
|
|
3915
|
+
/** id to pass to processing notification */
|
|
3916
|
+
correlationId?: string | null;
|
|
3917
|
+
/** when event was created / issued */
|
|
3918
|
+
issuedAt?: Date | null;
|
|
2859
3919
|
}
|
|
2860
3920
|
/** @oneof */
|
|
2861
|
-
interface
|
|
3921
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
3922
|
+
/** insert/update documents */
|
|
3923
|
+
update?: InternalDocumentUpdateOperation;
|
|
3924
|
+
/** delete by document ids */
|
|
3925
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3926
|
+
/** delete documents matching filter */
|
|
3927
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3928
|
+
/** update internal documents matching filter */
|
|
3929
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3930
|
+
/** update only existing documents */
|
|
3931
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3932
|
+
/** insert/update documents with versioning */
|
|
3933
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3934
|
+
/** delete by document ids with versioning */
|
|
3935
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3936
|
+
}
|
|
3937
|
+
interface InternalDocument {
|
|
3938
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
3939
|
+
document?: Record<string, any> | null;
|
|
3940
|
+
}
|
|
3941
|
+
interface InternalDocumentUpdateOperation {
|
|
3942
|
+
/** documents to index or update */
|
|
3943
|
+
documents?: InternalDocument[];
|
|
3944
|
+
}
|
|
3945
|
+
interface DeleteByIdsOperation {
|
|
3946
|
+
/** ids of the documents to delete */
|
|
3947
|
+
documentIds?: string[];
|
|
2862
3948
|
/**
|
|
2863
|
-
*
|
|
2864
|
-
* @
|
|
3949
|
+
* tenant id for custom tenancy strategy
|
|
3950
|
+
* @minLength 2
|
|
3951
|
+
* @maxLength 300
|
|
2865
3952
|
*/
|
|
2866
|
-
|
|
3953
|
+
tenantId?: string | null;
|
|
3954
|
+
}
|
|
3955
|
+
interface DeleteByFilterOperation {
|
|
3956
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
3957
|
+
filter?: Record<string, any> | null;
|
|
2867
3958
|
/**
|
|
2868
|
-
*
|
|
2869
|
-
* @
|
|
3959
|
+
* tenant id for custom tenancy strategy
|
|
3960
|
+
* @minLength 2
|
|
3961
|
+
* @maxLength 300
|
|
2870
3962
|
*/
|
|
2871
|
-
|
|
3963
|
+
tenantId?: string | null;
|
|
3964
|
+
}
|
|
3965
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
3966
|
+
/** documents matching this filter will be updated */
|
|
3967
|
+
filter?: Record<string, any> | null;
|
|
3968
|
+
/** partial document to apply */
|
|
3969
|
+
document?: InternalDocument;
|
|
2872
3970
|
/**
|
|
2873
|
-
*
|
|
2874
|
-
* @
|
|
3971
|
+
* tenant id for custom tenancy strategy
|
|
3972
|
+
* @minLength 2
|
|
3973
|
+
* @maxLength 300
|
|
2875
3974
|
*/
|
|
2876
|
-
|
|
3975
|
+
tenantId?: string | null;
|
|
3976
|
+
}
|
|
3977
|
+
interface InternalUpdateExistingOperation {
|
|
3978
|
+
/** documents to update */
|
|
3979
|
+
documents?: InternalDocument[];
|
|
3980
|
+
}
|
|
3981
|
+
interface VersionedDocumentUpdateOperation {
|
|
3982
|
+
/** documents to create or overwrite */
|
|
3983
|
+
documents?: InternalDocument[];
|
|
3984
|
+
/** versioning mode to use instead of default */
|
|
3985
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
3986
|
+
}
|
|
3987
|
+
declare enum VersioningMode {
|
|
3988
|
+
/** use default versioning mode agreed with search team */
|
|
3989
|
+
DEFAULT = "DEFAULT",
|
|
3990
|
+
/** execute only if version is greater than existing */
|
|
3991
|
+
GREATER_THAN = "GREATER_THAN",
|
|
3992
|
+
/** execute only if version is greater or equal to existing */
|
|
3993
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
3994
|
+
}
|
|
3995
|
+
/** @enumType */
|
|
3996
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
3997
|
+
interface VersionedDeleteByIdsOperation {
|
|
3998
|
+
/** ids with version of the documents to delete */
|
|
3999
|
+
documentIds?: VersionedDocumentId[];
|
|
2877
4000
|
/**
|
|
2878
|
-
*
|
|
2879
|
-
* @
|
|
4001
|
+
* tenant id for custom tenancy strategy
|
|
4002
|
+
* @minLength 2
|
|
4003
|
+
* @maxLength 300
|
|
2880
4004
|
*/
|
|
2881
|
-
|
|
4005
|
+
tenantId?: string | null;
|
|
2882
4006
|
}
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
4007
|
+
interface VersionedDocumentId {
|
|
4008
|
+
/** document id */
|
|
4009
|
+
documentId?: string;
|
|
4010
|
+
/** document version */
|
|
4011
|
+
version?: string;
|
|
4012
|
+
/** versioning mode to use instead of default */
|
|
4013
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4014
|
+
}
|
|
4015
|
+
interface TriggerReindexRequest {
|
|
4016
|
+
/** @format GUID */
|
|
4017
|
+
metasiteId?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* @minLength 1
|
|
4020
|
+
* @maxLength 100
|
|
4021
|
+
* @maxSize 100
|
|
4022
|
+
*/
|
|
4023
|
+
orderIds?: string[];
|
|
4024
|
+
}
|
|
4025
|
+
interface TriggerReindexResponse {
|
|
4026
|
+
}
|
|
4027
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
4028
|
+
/** @maxSize 25 */
|
|
4029
|
+
requests?: TriggerReindexOrderRequest[];
|
|
4030
|
+
}
|
|
4031
|
+
interface TriggerReindexOrderRequest {
|
|
4032
|
+
/** @format GUID */
|
|
4033
|
+
metasiteId?: string;
|
|
4034
|
+
/**
|
|
4035
|
+
* @minLength 1
|
|
4036
|
+
* @maxLength 100
|
|
4037
|
+
*/
|
|
4038
|
+
orderId?: string;
|
|
2889
4039
|
}
|
|
2890
|
-
/** @enumType */
|
|
2891
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2892
4040
|
interface DiffmatokyPayload {
|
|
2893
4041
|
left?: string;
|
|
2894
4042
|
right?: string;
|
|
@@ -3151,46 +4299,10 @@ interface BulkUpdateOrdersResponse {
|
|
|
3151
4299
|
* Bulk action results.
|
|
3152
4300
|
* @minSize 1
|
|
3153
4301
|
* @maxSize 100
|
|
3154
|
-
*/
|
|
3155
|
-
results?: BulkOrderResult[];
|
|
3156
|
-
/** Bulk action metadata. */
|
|
3157
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
3158
|
-
}
|
|
3159
|
-
interface BulkOrderResult {
|
|
3160
|
-
/** Item metadata. */
|
|
3161
|
-
itemMetadata?: ItemMetadata;
|
|
3162
|
-
/**
|
|
3163
|
-
* Updated order.
|
|
3164
|
-
*
|
|
3165
|
-
* Returned when `returnFullEntity = true`.
|
|
3166
|
-
*/
|
|
3167
|
-
item?: Order;
|
|
3168
|
-
}
|
|
3169
|
-
interface ItemMetadata {
|
|
3170
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3171
|
-
_id?: string | null;
|
|
3172
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3173
|
-
originalIndex?: number;
|
|
3174
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3175
|
-
success?: boolean;
|
|
3176
|
-
/** Details about the error in case of failure. */
|
|
3177
|
-
error?: ApplicationError;
|
|
3178
|
-
}
|
|
3179
|
-
interface ApplicationError {
|
|
3180
|
-
/** Error code. */
|
|
3181
|
-
code?: string;
|
|
3182
|
-
/** Description of the error. */
|
|
3183
|
-
description?: string;
|
|
3184
|
-
/** Data related to the error. */
|
|
3185
|
-
data?: Record<string, any> | null;
|
|
3186
|
-
}
|
|
3187
|
-
interface BulkActionMetadata {
|
|
3188
|
-
/** Number of items that were successfully processed. */
|
|
3189
|
-
totalSuccesses?: number;
|
|
3190
|
-
/** Number of items that couldn't be processed. */
|
|
3191
|
-
totalFailures?: number;
|
|
3192
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3193
|
-
undetailedFailures?: number;
|
|
4302
|
+
*/
|
|
4303
|
+
results?: BulkOrderResult[];
|
|
4304
|
+
/** Bulk action metadata. */
|
|
4305
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3194
4306
|
}
|
|
3195
4307
|
interface CommitDeltasRequest {
|
|
3196
4308
|
/** Order id to be updated */
|
|
@@ -3216,36 +4328,6 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
3216
4328
|
changedShippingInfo?: V1ShippingInformation;
|
|
3217
4329
|
/** Remove existing shipping info. */
|
|
3218
4330
|
shippingInfoRemoved?: boolean;
|
|
3219
|
-
/**
|
|
3220
|
-
* Buyer info and selected buyer option details.
|
|
3221
|
-
* @internal
|
|
3222
|
-
*/
|
|
3223
|
-
changedBuyerInfo?: BuyerInfo;
|
|
3224
|
-
/**
|
|
3225
|
-
* Remove existing buyer info.
|
|
3226
|
-
* @internal
|
|
3227
|
-
*/
|
|
3228
|
-
buyerInfoRemoved?: boolean;
|
|
3229
|
-
/**
|
|
3230
|
-
* Updated billing info.
|
|
3231
|
-
* @internal
|
|
3232
|
-
*/
|
|
3233
|
-
changedBillingInfo?: AddressWithContact;
|
|
3234
|
-
/**
|
|
3235
|
-
* Remove existing billing info.
|
|
3236
|
-
* @internal
|
|
3237
|
-
*/
|
|
3238
|
-
billingInfoRemoved?: boolean;
|
|
3239
|
-
/**
|
|
3240
|
-
* Updated recipient info.
|
|
3241
|
-
* @internal
|
|
3242
|
-
*/
|
|
3243
|
-
changedRecipientInfo?: AddressWithContact;
|
|
3244
|
-
/**
|
|
3245
|
-
* Remove existing recipient info.
|
|
3246
|
-
* @internal
|
|
3247
|
-
*/
|
|
3248
|
-
recipientInfoRemoved?: boolean;
|
|
3249
4331
|
/**
|
|
3250
4332
|
* Added/updated/removed order line items.
|
|
3251
4333
|
* @maxSize 300
|
|
@@ -3287,42 +4369,12 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
3287
4369
|
}
|
|
3288
4370
|
/** @oneof */
|
|
3289
4371
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
3290
|
-
/**
|
|
3291
|
-
* Buyer info and selected buyer option details.
|
|
3292
|
-
* @internal
|
|
3293
|
-
*/
|
|
3294
|
-
changedBuyerInfo?: BuyerInfo;
|
|
3295
|
-
/**
|
|
3296
|
-
* Remove existing buyer info.
|
|
3297
|
-
* @internal
|
|
3298
|
-
*/
|
|
3299
|
-
buyerInfoRemoved?: boolean;
|
|
3300
4372
|
}
|
|
3301
4373
|
/** @oneof */
|
|
3302
4374
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
3303
|
-
/**
|
|
3304
|
-
* Updated billing info.
|
|
3305
|
-
* @internal
|
|
3306
|
-
*/
|
|
3307
|
-
changedBillingInfo?: AddressWithContact;
|
|
3308
|
-
/**
|
|
3309
|
-
* Remove existing billing info.
|
|
3310
|
-
* @internal
|
|
3311
|
-
*/
|
|
3312
|
-
billingInfoRemoved?: boolean;
|
|
3313
4375
|
}
|
|
3314
4376
|
/** @oneof */
|
|
3315
4377
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
3316
|
-
/**
|
|
3317
|
-
* Updated recipient info.
|
|
3318
|
-
* @internal
|
|
3319
|
-
*/
|
|
3320
|
-
changedRecipientInfo?: AddressWithContact;
|
|
3321
|
-
/**
|
|
3322
|
-
* Remove existing recipient info.
|
|
3323
|
-
* @internal
|
|
3324
|
-
*/
|
|
3325
|
-
recipientInfoRemoved?: boolean;
|
|
3326
4378
|
}
|
|
3327
4379
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
3328
4380
|
/** The line item was added. */
|
|
@@ -3422,21 +4474,8 @@ interface OrderLineItemChangedDetails {
|
|
|
3422
4474
|
* @maxSize 5
|
|
3423
4475
|
*/
|
|
3424
4476
|
locations?: LocationAndQuantity[];
|
|
3425
|
-
/**
|
|
3426
|
-
* ID of the app managing the inventory.
|
|
3427
|
-
* @internal
|
|
3428
|
-
* @format GUID
|
|
3429
|
-
*/
|
|
3430
|
-
inventoryAppId?: string | null;
|
|
3431
4477
|
/** Subscription info. */
|
|
3432
4478
|
subscriptionInfo?: SubscriptionInfo;
|
|
3433
|
-
/**
|
|
3434
|
-
* Modifier groups that were added to the item.
|
|
3435
|
-
* @internal
|
|
3436
|
-
* @readonly
|
|
3437
|
-
* @maxSize 10
|
|
3438
|
-
*/
|
|
3439
|
-
modifierGroups?: ModifierGroup[];
|
|
3440
4479
|
}
|
|
3441
4480
|
/** Type of selected payment option for catalog item */
|
|
3442
4481
|
declare enum DeltaPaymentOptionType {
|
|
@@ -3823,35 +4862,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3823
4862
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3824
4863
|
/** Payment method is saved for order */
|
|
3825
4864
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3826
|
-
/**
|
|
3827
|
-
* Details of an initiated refund process.
|
|
3828
|
-
*
|
|
3829
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3830
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3831
|
-
* @internal
|
|
3832
|
-
*/
|
|
3833
|
-
refundInitiated?: RefundInitiated;
|
|
3834
|
-
/**
|
|
3835
|
-
* Details of a refunded payment.
|
|
3836
|
-
*
|
|
3837
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3838
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3839
|
-
* @internal
|
|
3840
|
-
*/
|
|
3841
|
-
paymentRefunded?: PaymentRefunded;
|
|
3842
|
-
/**
|
|
3843
|
-
* Details of a failed payment refund.
|
|
3844
|
-
*
|
|
3845
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3846
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3847
|
-
* @internal
|
|
3848
|
-
*/
|
|
3849
|
-
paymentRefundFailed?: PaymentRefundFailed;
|
|
3850
|
-
/**
|
|
3851
|
-
* Details of refund to store credit.
|
|
3852
|
-
* @internal
|
|
3853
|
-
*/
|
|
3854
|
-
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3855
4865
|
/** Details of a pending payment */
|
|
3856
4866
|
paymentPending?: PaymentPending;
|
|
3857
4867
|
/** Details of a canceled payment */
|
|
@@ -3862,26 +4872,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3862
4872
|
orderPending?: OrderPending;
|
|
3863
4873
|
/** Order rejected */
|
|
3864
4874
|
orderRejected?: OrderRejected;
|
|
3865
|
-
/**
|
|
3866
|
-
* Receipt was added for associated payment
|
|
3867
|
-
* @internal
|
|
3868
|
-
*/
|
|
3869
|
-
receiptCreated?: ReceiptCreated;
|
|
3870
|
-
/**
|
|
3871
|
-
* Receipt sent to customer
|
|
3872
|
-
* @internal
|
|
3873
|
-
*/
|
|
3874
|
-
receiptSent?: ReceiptSent;
|
|
3875
|
-
/**
|
|
3876
|
-
* Chargeback created for one of the order's payments.
|
|
3877
|
-
* @internal
|
|
3878
|
-
*/
|
|
3879
|
-
chargebackCreated?: ChargebackCreated;
|
|
3880
|
-
/**
|
|
3881
|
-
* Chargeback reversed for one of the order's payments.
|
|
3882
|
-
* @internal
|
|
3883
|
-
*/
|
|
3884
|
-
chargebackReversed?: ChargebackReversed;
|
|
3885
4875
|
/**
|
|
3886
4876
|
* Internal activity ID.
|
|
3887
4877
|
* @format GUID
|
|
@@ -3946,35 +4936,6 @@ interface InternalActivityContentOneOf {
|
|
|
3946
4936
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3947
4937
|
/** Payment method is saved for order */
|
|
3948
4938
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3949
|
-
/**
|
|
3950
|
-
* Details of an initiated refund process.
|
|
3951
|
-
*
|
|
3952
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3953
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3954
|
-
* @internal
|
|
3955
|
-
*/
|
|
3956
|
-
refundInitiated?: RefundInitiated;
|
|
3957
|
-
/**
|
|
3958
|
-
* Details of a refunded payment.
|
|
3959
|
-
*
|
|
3960
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3961
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3962
|
-
* @internal
|
|
3963
|
-
*/
|
|
3964
|
-
paymentRefunded?: PaymentRefunded;
|
|
3965
|
-
/**
|
|
3966
|
-
* Details of a failed payment refund.
|
|
3967
|
-
*
|
|
3968
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3969
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3970
|
-
* @internal
|
|
3971
|
-
*/
|
|
3972
|
-
paymentRefundFailed?: PaymentRefundFailed;
|
|
3973
|
-
/**
|
|
3974
|
-
* Details of refund to store credit.
|
|
3975
|
-
* @internal
|
|
3976
|
-
*/
|
|
3977
|
-
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3978
4939
|
/** Details of a pending payment */
|
|
3979
4940
|
paymentPending?: PaymentPending;
|
|
3980
4941
|
/** Details of a canceled payment */
|
|
@@ -3985,26 +4946,6 @@ interface InternalActivityContentOneOf {
|
|
|
3985
4946
|
orderPending?: OrderPending;
|
|
3986
4947
|
/** Order rejected */
|
|
3987
4948
|
orderRejected?: OrderRejected;
|
|
3988
|
-
/**
|
|
3989
|
-
* Receipt was added for associated payment
|
|
3990
|
-
* @internal
|
|
3991
|
-
*/
|
|
3992
|
-
receiptCreated?: ReceiptCreated;
|
|
3993
|
-
/**
|
|
3994
|
-
* Receipt sent to customer
|
|
3995
|
-
* @internal
|
|
3996
|
-
*/
|
|
3997
|
-
receiptSent?: ReceiptSent;
|
|
3998
|
-
/**
|
|
3999
|
-
* Chargeback created for one of the order's payments.
|
|
4000
|
-
* @internal
|
|
4001
|
-
*/
|
|
4002
|
-
chargebackCreated?: ChargebackCreated;
|
|
4003
|
-
/**
|
|
4004
|
-
* Chargeback reversed for one of the order's payments.
|
|
4005
|
-
* @internal
|
|
4006
|
-
*/
|
|
4007
|
-
chargebackReversed?: ChargebackReversed;
|
|
4008
4949
|
}
|
|
4009
4950
|
/** Order placed */
|
|
4010
4951
|
interface OrderPlaced {
|
|
@@ -4365,7 +5306,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
4365
5306
|
interface BulkSetBusinessLocationResult {
|
|
4366
5307
|
itemMetadata?: ItemMetadata;
|
|
4367
5308
|
}
|
|
4368
|
-
interface
|
|
5309
|
+
interface V1MarkOrderAsPaidRequest {
|
|
4369
5310
|
/**
|
|
4370
5311
|
* Order ID.
|
|
4371
5312
|
* @minLength 1
|
|
@@ -4373,7 +5314,7 @@ interface MarkOrderAsPaidRequest {
|
|
|
4373
5314
|
*/
|
|
4374
5315
|
_id?: string;
|
|
4375
5316
|
}
|
|
4376
|
-
interface
|
|
5317
|
+
interface V1MarkOrderAsPaidResponse {
|
|
4377
5318
|
/** Updated order. */
|
|
4378
5319
|
order?: Order;
|
|
4379
5320
|
}
|
|
@@ -4384,7 +5325,7 @@ interface PaymentStatusUpdated {
|
|
|
4384
5325
|
/** The previous status (before the update) */
|
|
4385
5326
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
4386
5327
|
}
|
|
4387
|
-
interface
|
|
5328
|
+
interface V1BulkMarkOrdersAsPaidRequest {
|
|
4388
5329
|
/**
|
|
4389
5330
|
* IDs of orders to mark as paid.
|
|
4390
5331
|
* @minSize 1
|
|
@@ -4394,7 +5335,7 @@ interface BulkMarkOrdersAsPaidRequest {
|
|
|
4394
5335
|
*/
|
|
4395
5336
|
ids?: string[];
|
|
4396
5337
|
}
|
|
4397
|
-
interface
|
|
5338
|
+
interface V1BulkMarkOrdersAsPaidResponse {
|
|
4398
5339
|
/**
|
|
4399
5340
|
* Items updated by the bulk action.
|
|
4400
5341
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -4403,7 +5344,7 @@ interface BulkMarkOrdersAsPaidResponse {
|
|
|
4403
5344
|
/** Bulk action metadata. */
|
|
4404
5345
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4405
5346
|
}
|
|
4406
|
-
interface
|
|
5347
|
+
interface V1CreatePaymentGatewayOrderRequest {
|
|
4407
5348
|
/**
|
|
4408
5349
|
* eCom Order ID
|
|
4409
5350
|
* @minLength 1
|
|
@@ -4411,7 +5352,7 @@ interface CreatePaymentGatewayOrderRequest {
|
|
|
4411
5352
|
*/
|
|
4412
5353
|
ecomOrderId?: string;
|
|
4413
5354
|
}
|
|
4414
|
-
interface
|
|
5355
|
+
interface V1CreatePaymentGatewayOrderResponse {
|
|
4415
5356
|
/** ID of the order created in the payment gateway */
|
|
4416
5357
|
paymentGatewayOrderId?: string;
|
|
4417
5358
|
}
|
|
@@ -4819,9 +5760,9 @@ interface CalculatedTax {
|
|
|
4819
5760
|
code?: string | null;
|
|
4820
5761
|
}
|
|
4821
5762
|
interface Payments {
|
|
4822
|
-
payments?:
|
|
5763
|
+
payments?: InvoicesPayment[];
|
|
4823
5764
|
}
|
|
4824
|
-
interface
|
|
5765
|
+
interface InvoicesPayment {
|
|
4825
5766
|
/** document */
|
|
4826
5767
|
_id?: string;
|
|
4827
5768
|
type?: string;
|
|
@@ -4956,6 +5897,125 @@ interface TriggerSideEffectsFromLegacyData {
|
|
|
4956
5897
|
orderId?: string;
|
|
4957
5898
|
ordersExperiments?: OrdersExperiments;
|
|
4958
5899
|
}
|
|
5900
|
+
type PreparePaymentCollectionApplicationErrors = {
|
|
5901
|
+
code?: 'PAYMENT_METHODS_NOT_FOUND';
|
|
5902
|
+
description?: string;
|
|
5903
|
+
data?: Record<string, any>;
|
|
5904
|
+
} | {
|
|
5905
|
+
code?: 'ORDER_CANCELED';
|
|
5906
|
+
description?: string;
|
|
5907
|
+
data?: Record<string, any>;
|
|
5908
|
+
} | {
|
|
5909
|
+
code?: 'INVALID_AMOUNT';
|
|
5910
|
+
description?: string;
|
|
5911
|
+
data?: Record<string, any>;
|
|
5912
|
+
} | {
|
|
5913
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
5914
|
+
description?: string;
|
|
5915
|
+
data?: Record<string, any>;
|
|
5916
|
+
} | {
|
|
5917
|
+
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
5918
|
+
description?: string;
|
|
5919
|
+
data?: Record<string, any>;
|
|
5920
|
+
};
|
|
5921
|
+
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
5922
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
5923
|
+
description?: string;
|
|
5924
|
+
data?: Record<string, any>;
|
|
5925
|
+
} | {
|
|
5926
|
+
code?: 'INVALID_AMOUNT';
|
|
5927
|
+
description?: string;
|
|
5928
|
+
data?: Record<string, any>;
|
|
5929
|
+
} | {
|
|
5930
|
+
code?: 'ORDER_CANCELED';
|
|
5931
|
+
description?: string;
|
|
5932
|
+
data?: Record<string, any>;
|
|
5933
|
+
};
|
|
5934
|
+
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
5935
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
5936
|
+
description?: string;
|
|
5937
|
+
data?: Record<string, any>;
|
|
5938
|
+
} | {
|
|
5939
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5940
|
+
description?: string;
|
|
5941
|
+
data?: Record<string, any>;
|
|
5942
|
+
};
|
|
5943
|
+
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
5944
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
5945
|
+
description?: string;
|
|
5946
|
+
data?: Record<string, any>;
|
|
5947
|
+
} | {
|
|
5948
|
+
code?: 'ORDER_CANCELED';
|
|
5949
|
+
description?: string;
|
|
5950
|
+
data?: Record<string, any>;
|
|
5951
|
+
};
|
|
5952
|
+
type TriggerRefundApplicationErrors = {
|
|
5953
|
+
code?: 'PAYMENTS_NOT_FOUND';
|
|
5954
|
+
description?: string;
|
|
5955
|
+
data?: Record<string, any>;
|
|
5956
|
+
} | {
|
|
5957
|
+
code?: 'REFUND_NOT_AVAILABLE';
|
|
5958
|
+
description?: string;
|
|
5959
|
+
data?: Record<string, any>;
|
|
5960
|
+
} | {
|
|
5961
|
+
code?: 'INVALID_AMOUNT';
|
|
5962
|
+
description?: string;
|
|
5963
|
+
data?: Record<string, any>;
|
|
5964
|
+
};
|
|
5965
|
+
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
5966
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
5967
|
+
description?: string;
|
|
5968
|
+
data?: Record<string, any>;
|
|
5969
|
+
} | {
|
|
5970
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
5971
|
+
description?: string;
|
|
5972
|
+
data?: Record<string, any>;
|
|
5973
|
+
} | {
|
|
5974
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
5975
|
+
description?: string;
|
|
5976
|
+
data?: Record<string, any>;
|
|
5977
|
+
} | {
|
|
5978
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
5979
|
+
description?: string;
|
|
5980
|
+
data?: Record<string, any>;
|
|
5981
|
+
} | {
|
|
5982
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5983
|
+
description?: string;
|
|
5984
|
+
data?: Record<string, any>;
|
|
5985
|
+
};
|
|
5986
|
+
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
5987
|
+
code?: 'INVALID_AMOUNT';
|
|
5988
|
+
description?: string;
|
|
5989
|
+
data?: Record<string, any>;
|
|
5990
|
+
} | {
|
|
5991
|
+
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
5992
|
+
description?: string;
|
|
5993
|
+
data?: Record<string, any>;
|
|
5994
|
+
} | {
|
|
5995
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
5996
|
+
description?: string;
|
|
5997
|
+
data?: Record<string, any>;
|
|
5998
|
+
} | {
|
|
5999
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6000
|
+
description?: string;
|
|
6001
|
+
data?: Record<string, any>;
|
|
6002
|
+
} | {
|
|
6003
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6004
|
+
description?: string;
|
|
6005
|
+
data?: Record<string, any>;
|
|
6006
|
+
} | {
|
|
6007
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6008
|
+
description?: string;
|
|
6009
|
+
data?: Record<string, any>;
|
|
6010
|
+
} | {
|
|
6011
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6012
|
+
description?: string;
|
|
6013
|
+
data?: Record<string, any>;
|
|
6014
|
+
} | {
|
|
6015
|
+
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6016
|
+
description?: string;
|
|
6017
|
+
data?: Record<string, any>;
|
|
6018
|
+
};
|
|
4959
6019
|
type GetOrderApplicationErrors = {
|
|
4960
6020
|
code?: 'ORDER_NOT_FOUND';
|
|
4961
6021
|
description?: string;
|
|
@@ -5192,6 +6252,108 @@ interface OrderPaymentStatusUpdatedEnvelope {
|
|
|
5192
6252
|
*/
|
|
5193
6253
|
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
5194
6254
|
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`;
|
|
6255
|
+
/**
|
|
6256
|
+
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6257
|
+
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6258
|
+
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6259
|
+
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6260
|
+
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6261
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6262
|
+
* @param amount - Amount to collect
|
|
6263
|
+
* @public
|
|
6264
|
+
* @documentationMaturity preview
|
|
6265
|
+
* @requiredField amount
|
|
6266
|
+
* @requiredField ecomOrderId
|
|
6267
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6268
|
+
* @applicableIdentity APP
|
|
6269
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6270
|
+
*/
|
|
6271
|
+
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
6272
|
+
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
6273
|
+
}>;
|
|
6274
|
+
interface PreparePaymentCollectionOptions {
|
|
6275
|
+
/**
|
|
6276
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6277
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
6278
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6279
|
+
*/
|
|
6280
|
+
paymentGatewayOrderId?: string | null;
|
|
6281
|
+
/**
|
|
6282
|
+
* Whether to delay capture of the payment.
|
|
6283
|
+
* Default: false
|
|
6284
|
+
* @deprecated Whether to delay capture of the payment.
|
|
6285
|
+
* Default: false
|
|
6286
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6287
|
+
* @targetRemovalDate 2024-09-30
|
|
6288
|
+
*/
|
|
6289
|
+
delayedCapture?: boolean;
|
|
6290
|
+
/** Delayed capture payment settings */
|
|
6291
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6292
|
+
}
|
|
6293
|
+
/**
|
|
6294
|
+
* Provides payment collectability status for given order. If payment collection is possible
|
|
6295
|
+
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6296
|
+
* reason why payment collection is not possible.
|
|
6297
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6298
|
+
* @public
|
|
6299
|
+
* @documentationMaturity preview
|
|
6300
|
+
* @requiredField ecomOrderId
|
|
6301
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6302
|
+
* @applicableIdentity APP
|
|
6303
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6304
|
+
*/
|
|
6305
|
+
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6306
|
+
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6307
|
+
/** Information about the user who initiated the payment. */
|
|
6308
|
+
chargedBy?: ChargedBy;
|
|
6309
|
+
}
|
|
6310
|
+
interface ChargeMembershipsOptions {
|
|
6311
|
+
/**
|
|
6312
|
+
* List of items to be paid by memberships
|
|
6313
|
+
* @minSize 1
|
|
6314
|
+
* @maxSize 300
|
|
6315
|
+
*/
|
|
6316
|
+
membershipCharges?: MembershipChargeItem[];
|
|
6317
|
+
}
|
|
6318
|
+
interface TriggerRefundOptions {
|
|
6319
|
+
/** Business model of a refund */
|
|
6320
|
+
details?: RefundDetails;
|
|
6321
|
+
/** Side effect details related to refund */
|
|
6322
|
+
sideEffects?: RefundSideEffects;
|
|
6323
|
+
}
|
|
6324
|
+
/**
|
|
6325
|
+
* Void authorized payments
|
|
6326
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6327
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6328
|
+
* @param paymentIds - Payment IDs
|
|
6329
|
+
* @public
|
|
6330
|
+
* @documentationMaturity preview
|
|
6331
|
+
* @requiredField ecomOrderId
|
|
6332
|
+
* @requiredField paymentIds
|
|
6333
|
+
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6334
|
+
* @applicableIdentity APP
|
|
6335
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6336
|
+
*/
|
|
6337
|
+
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`> & {
|
|
6338
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
6339
|
+
}>;
|
|
6340
|
+
/**
|
|
6341
|
+
* Capture authorized payments
|
|
6342
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6343
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6344
|
+
* @param payments - Capture payments information
|
|
6345
|
+
* @public
|
|
6346
|
+
* @documentationMaturity preview
|
|
6347
|
+
* @requiredField ecomOrderId
|
|
6348
|
+
* @requiredField payments
|
|
6349
|
+
* @requiredField payments.paymentId
|
|
6350
|
+
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6351
|
+
* @applicableIdentity APP
|
|
6352
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6353
|
+
*/
|
|
6354
|
+
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`> & {
|
|
6355
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
6356
|
+
}>;
|
|
5195
6357
|
/**
|
|
5196
6358
|
* Retrieves an order.
|
|
5197
6359
|
*
|
|
@@ -5627,23 +6789,6 @@ interface BulkUpdateOrdersOptions {
|
|
|
5627
6789
|
*/
|
|
5628
6790
|
returnEntity?: boolean;
|
|
5629
6791
|
}
|
|
5630
|
-
/** @param _id - Order id to be updated
|
|
5631
|
-
* @internal
|
|
5632
|
-
* @documentationMaturity preview
|
|
5633
|
-
* @requiredField _id
|
|
5634
|
-
* @requiredField options.changes
|
|
5635
|
-
* @requiredField options.changes.priceSummary.subtotal
|
|
5636
|
-
* @requiredField options.changes.priceSummary.total
|
|
5637
|
-
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
5638
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
5639
|
-
* @applicableIdentity APP
|
|
5640
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
5641
|
-
*/
|
|
5642
|
-
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
5643
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5644
|
-
}[OrderNonNullablePaths]> & {
|
|
5645
|
-
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
5646
|
-
}>;
|
|
5647
6792
|
interface CommitDeltasOptions {
|
|
5648
6793
|
/**
|
|
5649
6794
|
* Draft order Id representing this change.
|
|
@@ -5661,21 +6806,6 @@ interface CommitDeltasOptions {
|
|
|
5661
6806
|
*/
|
|
5662
6807
|
reason?: string | null;
|
|
5663
6808
|
}
|
|
5664
|
-
/** @internal
|
|
5665
|
-
* @documentationMaturity preview
|
|
5666
|
-
* @requiredField identifiers
|
|
5667
|
-
* @requiredField identifiers._id
|
|
5668
|
-
* @requiredField identifiers.lineItemId
|
|
5669
|
-
* @requiredField lineItem
|
|
5670
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
5671
|
-
* @applicableIdentity APP
|
|
5672
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
5673
|
-
* @deprecated
|
|
5674
|
-
* @targetRemovalDate 2024-02-15
|
|
5675
|
-
*/
|
|
5676
|
-
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
5677
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5678
|
-
}[OrderNonNullablePaths]>>;
|
|
5679
6809
|
interface UpdateOrderLineItemIdentifiers {
|
|
5680
6810
|
/**
|
|
5681
6811
|
* Order ID
|
|
@@ -5799,61 +6929,13 @@ interface UpdateOrderLineItem {
|
|
|
5799
6929
|
locations?: LocationAndQuantity[];
|
|
5800
6930
|
/** Address used for tax calculation. */
|
|
5801
6931
|
taxableAddress?: TaxableAddress;
|
|
5802
|
-
/**
|
|
5803
|
-
* ID of the app managing the inventory.
|
|
5804
|
-
* @internal
|
|
5805
|
-
* @format GUID
|
|
5806
|
-
*/
|
|
5807
|
-
inventoryAppId?: string | null;
|
|
5808
6932
|
/**
|
|
5809
6933
|
* Custom extended fields for the line item object.
|
|
5810
6934
|
*
|
|
5811
6935
|
* [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.
|
|
5812
6936
|
*/
|
|
5813
6937
|
extendedFields?: ExtendedFields;
|
|
5814
|
-
/**
|
|
5815
|
-
* Modifier groups that were added to the item.
|
|
5816
|
-
* @internal
|
|
5817
|
-
* @readonly
|
|
5818
|
-
* @maxSize 10
|
|
5819
|
-
*/
|
|
5820
|
-
modifierGroups?: ModifierGroup[];
|
|
5821
6938
|
}
|
|
5822
|
-
/**
|
|
5823
|
-
* Adds a merchant comment to an order.
|
|
5824
|
-
* > **Note:** Activities with type CustomActivity not supported
|
|
5825
|
-
* @param _id - Order ID.
|
|
5826
|
-
* @param activity - Activity info.
|
|
5827
|
-
* @internal
|
|
5828
|
-
* @documentationMaturity preview
|
|
5829
|
-
* @requiredField _id
|
|
5830
|
-
* @requiredField activity
|
|
5831
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
5832
|
-
* @applicableIdentity APP
|
|
5833
|
-
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
5834
|
-
* @deprecated
|
|
5835
|
-
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
5836
|
-
* @targetRemovalDate 2024-11-01
|
|
5837
|
-
*/
|
|
5838
|
-
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
5839
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5840
|
-
}[OrderNonNullablePaths] | `activityId`>>;
|
|
5841
|
-
/**
|
|
5842
|
-
* Updates an order's activity.
|
|
5843
|
-
* @param activity - Activity info.
|
|
5844
|
-
* @internal
|
|
5845
|
-
* @documentationMaturity preview
|
|
5846
|
-
* @requiredField activity
|
|
5847
|
-
* @requiredField identifiers
|
|
5848
|
-
* @requiredField identifiers._id
|
|
5849
|
-
* @requiredField identifiers.activityId
|
|
5850
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
5851
|
-
* @applicableIdentity APP
|
|
5852
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
5853
|
-
*/
|
|
5854
|
-
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
5855
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5856
|
-
}[OrderNonNullablePaths]>>;
|
|
5857
6939
|
interface UpdateActivityIdentifiers {
|
|
5858
6940
|
/**
|
|
5859
6941
|
* Order ID.
|
|
@@ -5867,22 +6949,6 @@ interface UpdateActivityIdentifiers {
|
|
|
5867
6949
|
*/
|
|
5868
6950
|
activityId: string;
|
|
5869
6951
|
}
|
|
5870
|
-
/**
|
|
5871
|
-
* Delete's an order's activity.
|
|
5872
|
-
*
|
|
5873
|
-
* Only custom activities and merchant comments can be deleted.
|
|
5874
|
-
* @internal
|
|
5875
|
-
* @documentationMaturity preview
|
|
5876
|
-
* @requiredField identifiers
|
|
5877
|
-
* @requiredField identifiers._id
|
|
5878
|
-
* @requiredField identifiers.activityId
|
|
5879
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
5880
|
-
* @applicableIdentity APP
|
|
5881
|
-
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
5882
|
-
*/
|
|
5883
|
-
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
5884
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5885
|
-
}[OrderNonNullablePaths]>>;
|
|
5886
6952
|
interface DeleteActivityIdentifiers {
|
|
5887
6953
|
/**
|
|
5888
6954
|
* Order ID.
|
|
@@ -5925,43 +6991,6 @@ interface CancelOrderOptions {
|
|
|
5925
6991
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5926
6992
|
restockAllItems?: boolean;
|
|
5927
6993
|
}
|
|
5928
|
-
/**
|
|
5929
|
-
* Updates order status.
|
|
5930
|
-
*
|
|
5931
|
-
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
5932
|
-
* >Updates into INITIALIZED are not supported.
|
|
5933
|
-
*
|
|
5934
|
-
* Approving order:
|
|
5935
|
-
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
5936
|
-
*
|
|
5937
|
-
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
5938
|
-
* will cause an error.
|
|
5939
|
-
*
|
|
5940
|
-
* Setting PENDING status:
|
|
5941
|
-
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
5942
|
-
* @param orderId - Order ID.
|
|
5943
|
-
* @param status - New order status.
|
|
5944
|
-
* @internal
|
|
5945
|
-
* @documentationMaturity preview
|
|
5946
|
-
* @requiredField orderId
|
|
5947
|
-
* @requiredField status
|
|
5948
|
-
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
5949
|
-
* @applicableIdentity APP
|
|
5950
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
5951
|
-
*/
|
|
5952
|
-
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
5953
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5954
|
-
}[OrderNonNullablePaths]> & {
|
|
5955
|
-
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
5956
|
-
}>;
|
|
5957
|
-
/** @internal
|
|
5958
|
-
* @documentationMaturity preview
|
|
5959
|
-
* @requiredField options.aggregation
|
|
5960
|
-
* @permissionId ECOM.READ_ORDERS
|
|
5961
|
-
* @applicableIdentity APP
|
|
5962
|
-
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
5963
|
-
*/
|
|
5964
|
-
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
5965
6994
|
interface AggregateOrdersOptions {
|
|
5966
6995
|
/** Filter applied to original data */
|
|
5967
6996
|
filter?: Record<string, any> | null;
|
|
@@ -5998,4 +7027,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
5998
7027
|
unassignTags?: Tags;
|
|
5999
7028
|
}
|
|
6000
7029
|
|
|
6001
|
-
export { LineItemQuantityChangeType as $, type AddActivityResponse as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, type DeleteActivityIdentifiers as D, type OrderCreatedEnvelope as E, type OrderPaymentStatusUpdatedEnvelope as F, type GetOrderApplicationErrors as G, DescriptionLineType as H, ItemTypeItemType as I, PaymentOptionType as J, JurisdictionType as K, SubscriptionFrequency as L, type MaskedOrder as M, AdjustmentType as N, type Order as O, type PublicActivity as P, PaymentStatus as Q, FulfillmentStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, PickupMethod as X, OrderStatus as Y, DiscountType as Z, DiscountReason as _, type OrderSearch as a, type PickupAddress as a$, ActivityType as a0, AttributionSource as a1, ChannelType as a2, VersioningMode as a3, WebhookIdentityType as a4, SortOrder as a5, OrderApprovalStrategy as a6, DeltaPaymentOptionType as a7, InventoryAction as a8, Placement as a9, type SubscriptionDescription as aA, type SubscriptionSettings as aB, type FreeTrialPeriod as aC, type BillingAdjustment as aD, type BillingAdjustmentPriceSummary as aE, type PriceDescription as aF, type LocationAndQuantity as aG, type TaxableAddress as aH, type TaxableAddressTaxableAddressDataOneOf as aI, type ExtendedFields as aJ, type ModifierGroup as aK, type TranslatableString as aL, type ItemModifier as aM, type BuyerInfo as aN, type BuyerInfoIdOneOf as aO, type CurrencyConversionDetails as aP, type PriceSummary as aQ, type AddressWithContact as aR, type Address as aS, type StreetAddress as aT, type AddressLocation as aU, type FullAddressContactDetails as aV, type VatId as aW, type V1ShippingInformation as aX, type DeliveryLogistics as aY, type DeliveryLogisticsAddressOneOf as aZ, type PickupDetails as a_, SubdivisionType as aa, SourceType as ab, CustomFieldGroup as ac, ValueType as ad, DepositType as ae, InvoiceStatus as af, type OrderLineItem as ag, type ProductName as ah, type CatalogReference as ai, type Price as aj, type DescriptionLine as ak, type DescriptionLineValueOneOf as al, type DescriptionLineDescriptionLineValueOneOf as am, type DescriptionLineName as an, type PlainTextValue as ao, type Color as ap, type FocalPoint as aq, type PhysicalProperties as ar, type ItemType as as, type ItemTypeItemTypeDataOneOf as at, type ItemTaxFullDetails as au, type LineItemTaxInfo as av, type LineItemTaxBreakdown as aw, type DigitalFile as ax, type SubscriptionInfo as ay, type SubscriptionTitle as az, type CreateOrderApplicationErrors as b, type ReceiptSentReceiptInfoOneOf as b$, type DeliveryTimeSlot as b0, type ShippingPrice as b1, type ShippingRegion as b2, type TaxSummary as b3, type OrderTaxInfo as b4, type OrderTaxBreakdown as b5, type AppliedDiscount as b6, type AppliedDiscountDiscountSourceOneOf as b7, type Coupon as b8, type MerchantDiscount as b9, type SavedPaymentMethod as bA, type AuthorizedPaymentCreated as bB, type AuthorizedPaymentCaptured as bC, type AuthorizedPaymentVoided as bD, type RefundInitiated as bE, type RefundedPayment as bF, type RefundedPaymentKindOneOf as bG, type RegularPaymentRefund as bH, type GiftCardPaymentRefund as bI, type MembershipPaymentRefund as bJ, type PaymentRefunded as bK, type PaymentRefundFailed as bL, type RefundedAsStoreCredit as bM, type PaymentPending as bN, type PaymentPendingPaymentDetailsOneOf as bO, type RegularPayment as bP, type RegularPaymentPaymentMethodDetailsOneOf as bQ, type CreditCardDetails as bR, type PaymentCanceled as bS, type PaymentCanceledPaymentDetailsOneOf as bT, type PaymentDeclined as bU, type PaymentDeclinedPaymentDetailsOneOf as bV, type ReceiptCreated as bW, type ReceiptCreatedReceiptInfoOneOf as bX, type WixReceipt as bY, type ExternalReceipt as bZ, type ReceiptSent as b_, type MerchantDiscountMerchantDiscountReasonOneOf as ba, type DiscountRule as bb, type DiscountRuleName as bc, type LineItemDiscount as bd, type Activity as be, type ActivityContentOneOf as bf, type CustomActivity as bg, type MerchantComment as bh, type OrderRefunded as bi, type OrderCreatedFromExchange as bj, type NewExchangeOrderCreated as bk, type LineItemExchangeData as bl, type DraftOrderChangesApplied as bm, type OrderChange as bn, type OrderChangeValueOneOf as bo, type LineItemChanges as bp, type LineItemQuantityChange as bq, type LineItemPriceChange as br, type ManagedLineItem as bs, type ManagedDiscount as bt, type TranslatedValue as bu, type LineItemAmount as bv, type ManagedAdditionalFee as bw, type TotalPriceChange as bx, type ShippingInformationChange as by, type ShippingInformation as bz, type UpdateOrderApplicationErrors as c, type CursorSearch as c$, type ChargebackCreated as c0, type ChargebackReversed as c1, type CreatedBy as c2, type CreatedByStringOneOf as c3, type ChannelInfo as c4, type CustomField as c5, type BalanceSummary as c6, type Balance as c7, type AdditionalFee as c8, type FulfillmentStatusesAggregate as c9, type EntityDeletedEvent as cA, type ActionEvent as cB, type Empty as cC, type BatchOfTriggerReindexOrderRequest as cD, type TriggerReindexOrderRequest as cE, type MessageEnvelope as cF, type IdentificationData as cG, type IdentificationDataIdOneOf as cH, type DiffmatokyPayload as cI, type ErrorInformation as cJ, type ContinueSideEffectsFlowInLegacyData as cK, type SnapshotMessage as cL, type IndexingMessage as cM, type GetOrderRequest as cN, type GetOrderResponse as cO, type InternalQueryOrdersRequest as cP, type PlatformQuery as cQ, type PlatformQueryPagingMethodOneOf as cR, type Sorting as cS, type PlatformPaging as cT, type CursorPaging as cU, type InternalQueryOrdersResponse as cV, type PlatformPagingMetadata as cW, type Cursors as cX, type QueryOrderRequest as cY, type QueryOrderResponse as cZ, type SearchOrdersRequest as c_, type Tags as ca, type TagList as cb, type Location as cc, type UpdateInternalDocumentsEvent as cd, type UpdateInternalDocumentsEventOperationOneOf as ce, type InternalDocument as cf, type InternalDocumentUpdateOperation as cg, type DeleteByIdsOperation as ch, type DeleteByFilterOperation as ci, type InternalDocumentUpdateByFilterOperation as cj, type InternalUpdateExistingOperation as ck, type VersionedDocumentUpdateOperation as cl, type VersionedDeleteByIdsOperation as cm, type VersionedDocumentId as cn, type OrderApproved as co, type OrdersExperiments as cp, type OrderRejectedEventOrderRejected as cq, type OrderItemsRestocked as cr, type RestockItem as cs, type TriggerReindexRequest as ct, type TriggerReindexResponse as cu, type DomainEvent as cv, type DomainEventBodyOneOf as cw, type EntityCreatedEvent as cx, type RestoreInfo as cy, type EntityUpdatedEvent as cz, type BulkUpdateOrdersResponse as d, type OrderPlaced as d$, type CursorSearchPagingMethodOneOf as d0, type CursorPagingMetadata as d1, type CreateOrderRequest as d2, type OrderCreationSettings as d3, type OrderCreateNotifications as d4, type CreateOrderResponse as d5, type UpdateOrderRequest as d6, type UpdateOrderResponse as d7, type BulkUpdateOrdersRequest as d8, type BulkOrderResult as d9, type ArchiveOrderResponse as dA, type BulkArchiveOrdersRequest as dB, type BulkArchiveOrdersResponse as dC, type BulkArchiveOrdersByFilterRequest as dD, type BulkArchiveOrdersByFilterResponse as dE, type UnArchiveOrderRequest as dF, type UnArchiveOrderResponse as dG, type BulkUnArchiveOrdersRequest as dH, type BulkUnArchiveOrdersResponse as dI, type BulkUnArchiveOrdersByFilterRequest as dJ, type BulkUnArchiveOrdersByFilterResponse as dK, type UpdateBuyerInfoRequest as dL, type BuyerInfoUpdate as dM, type UpdateBuyerInfoResponse as dN, type UpdateBuyerEmailRequest as dO, type UpdateBuyerEmailResponse as dP, type UpdateOrderShippingAddressRequest as dQ, type UpdateOrderShippingAddressResponse as dR, type UpdateBillingContactDetailsRequest as dS, type UpdateBillingContactDetailsResponse as dT, type UpdateOrderLineItemRequest as dU, type UpdateOrderLineItemsRequest as dV, type MaskedOrderLineItem as dW, type UpdateOrderLineItemsResponse as dX, type AddInternalActivityRequest as dY, type InternalActivity as dZ, type InternalActivityContentOneOf as d_, type ItemMetadata as da, type ApplicationError as db, type BulkActionMetadata as dc, type CommitDeltasRequest as dd, type DraftOrderDiffs as de, type DraftOrderDiffsShippingUpdateInfoOneOf as df, type DraftOrderDiffsBuyerUpdateInfoOneOf as dg, type DraftOrderDiffsBillingUpdateInfoOneOf as dh, type DraftOrderDiffsRecipientUpdateInfoOneOf as di, type V1LineItemDelta as dj, type V1LineItemDeltaDeltaOneOf as dk, type OrderLineItemChangedDetails as dl, type ItemChangedDetails as dm, type AppliedDiscountDelta as dn, type AppliedDiscountDeltaDeltaOneOf as dp, type AdditionalFeeDelta as dq, type AdditionalFeeDeltaDeltaOneOf as dr, type DraftOrderCommitSettings as ds, type InventoryUpdateDetails as dt, type OrderDeltasCommitted as du, type CommittedDiffs as dv, type CommittedDiffsShippingUpdateInfoOneOf as dw, type LineItemDelta as dx, type LineItemDeltaDeltaOneOf as dy, type ArchiveOrderRequest as dz, type CommitDeltasOptions as e, type BulkUpdateOrderTagsResult as e$, type OrderPaid as e0, type OrderFulfilled as e1, type OrderNotFulfilled as e2, type OrderCanceled as e3, type DownloadLinkSent as e4, type TrackingNumberAdded as e5, type TrackingNumberEdited as e6, type TrackingLinkAdded as e7, type ShippingConfirmationEmailSent as e8, type InvoiceAdded as e9, type BulkMarkAsFulfilledRequest as eA, type BulkMarkAsFulfilledResponse as eB, type BulkMarkAsFulfilledByFilterRequest as eC, type BulkMarkAsFulfilledByFilterResponse as eD, type MarkAsUnfulfilledRequest as eE, type MarkAsUnfulfilledResponse as eF, type BulkMarkAsUnfulfilledRequest as eG, type BulkMarkAsUnfulfilledResponse as eH, type BulkMarkAsUnfulfilledByFilterRequest as eI, type BulkMarkAsUnfulfilledByFilterResponse as eJ, type BulkSetBusinessLocationRequest as eK, type BulkSetBusinessLocationResponse as eL, type BulkSetBusinessLocationResult as eM, type MarkOrderAsPaidRequest as eN, type MarkOrderAsPaidResponse as eO, type PaymentStatusUpdated as eP, type BulkMarkOrdersAsPaidRequest as eQ, type BulkMarkOrdersAsPaidResponse as eR, type CreatePaymentGatewayOrderRequest as eS, type CreatePaymentGatewayOrderResponse as eT, type GetShipmentsRequest as eU, type GetShipmentsResponse as eV, type AggregateOrdersRequest as eW, type DecrementItemsQuantityRequest as eX, type DecrementData as eY, type DecrementItemsQuantityResponse as eZ, type BulkUpdateOrderTagsRequest as e_, type InvoiceSent as ea, type FulfillerEmailSent as eb, type ShippingAddressEdited as ec, type EmailEdited as ed, type PickupReadyEmailSent as ee, type OrderPartiallyPaid as ef, type OrderPending as eg, type OrderRejected as eh, type AddInternalActivityResponse as ei, type AddActivityRequest as ej, type PublicActivityContentOneOf as ek, type AddActivitiesRequest as el, type AddActivitiesResponse as em, type UpdateActivityRequest as en, type DeleteActivityRequest as eo, type UpdateLineItemsDescriptionLinesRequest as ep, type LineItemUpdate as eq, type UpdateLineItemsDescriptionLinesResponse as er, type MarkOrderAsSeenByHumanRequest as es, type MarkOrderAsSeenByHumanResponse as et, type CancelOrderRequest as eu, type OrderCanceledEventOrderCanceled as ev, type UpdateOrderStatusRequest as ew, type MarkAsFulfilledRequest as ex, type MarkAsFulfilledResponse as ey, type FulfillmentStatusUpdated as ez, type CommitDeltasResponse as f, type VersioningModeWithLiterals as f$, type Task as f0, type TaskKey as f1, type TaskAction as f2, type TaskActionActionOneOf as f3, type Complete as f4, type Cancel as f5, type Reschedule as f6, type InvoiceSentEvent as f7, type IdAndVersion as f8, type InvoiceFields as f9, type MetaData as fA, type InvoiceDynamicPriceTotals as fB, type CustomFieldValue as fC, type Value as fD, type Deposit as fE, type TriggerSideEffectsFromLegacyData as fF, type BaseEventMetadata as fG, type EventMetadata as fH, type OrderSearchSpec as fI, type DescriptionLineTypeWithLiterals as fJ, type ItemTypeItemTypeWithLiterals as fK, type PaymentOptionTypeWithLiterals as fL, type JurisdictionTypeWithLiterals as fM, type SubscriptionFrequencyWithLiterals as fN, type AdjustmentTypeWithLiterals as fO, type TaxableAddressTypeWithLiterals as fP, type PaymentStatusWithLiterals as fQ, type FulfillmentStatusWithLiterals as fR, type WeightUnitWithLiterals as fS, type VatTypeWithLiterals as fT, type PickupMethodWithLiterals as fU, type DiscountTypeWithLiterals as fV, type DiscountReasonWithLiterals as fW, type LineItemQuantityChangeTypeWithLiterals as fX, type ActivityTypeWithLiterals as fY, type AttributionSourceWithLiterals as fZ, type ChannelTypeWithLiterals as f_, type Customer as fa, type Email as fb, type QuotesAddress as fc, type AddressDescription as fd, type Phone as fe, type Company as ff, type CommonAddress as fg, type CommonAddressStreetOneOf as fh, type Subdivision as fi, type StandardDetails as fj, type InvoiceDates as fk, type LineItems as fl, type LineItem as fm, type BigDecimalWrapper as fn, type LineItemTax as fo, type Source as fp, type LineItemMetaData as fq, type Locale as fr, type TotalPrice as fs, type ItemizedFee as ft, type Discount as fu, type DiscountOneDiscountTypeOneOf as fv, type CalculatedTaxes as fw, type CalculatedTax as fx, type Payments as fy, type Payment as fz, type CommitDeltasApplicationErrors as g, type WebhookIdentityTypeWithLiterals as g0, type SortOrderWithLiterals as g1, type OrderApprovalStrategyWithLiterals as g2, type DeltaPaymentOptionTypeWithLiterals as g3, type InventoryActionWithLiterals as g4, type PlacementWithLiterals as g5, type SubdivisionTypeWithLiterals as g6, type SourceTypeWithLiterals as g7, type CustomFieldGroupWithLiterals as g8, type ValueTypeWithLiterals as g9, type DepositTypeWithLiterals as ga, type InvoiceStatusWithLiterals as gb, onOrderApproved as gc, onOrderUpdated as gd, onOrderCanceled as ge, onOrderCreated as gf, onOrderPaymentStatusUpdated as gg, getOrder as gh, type CommonSearchWithEntityContext as gi, createOrder as gj, updateOrder as gk, bulkUpdateOrders as gl, commitDeltas as gm, updateOrderLineItem as gn, addActivity as go, updateActivity as gp, deleteActivity as gq, cancelOrder as gr, updateOrderStatus as gs, aggregateOrders as gt, bulkUpdateOrderTags as gu, type UpdateOrderLineItemIdentifiers as h, type UpdateOrderLineItem as i, type UpdateOrderLineItemResponse as j, type UpdateActivityIdentifiers as k, type UpdateActivityResponse as l, type DeleteActivityResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type OrderStatusWithLiterals as q, type UpdateOrderStatusResponse as r, type UpdateOrderStatusApplicationErrors as s, type AggregateOrdersOptions as t, type AggregateOrdersResponse as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderUpdatedEnvelope as y, type OrderCanceledEnvelope as z };
|
|
7030
|
+
export { DurationUnit as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PickupMethod as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, OrderStatus as H, ItemTypeItemType as I, JurisdictionType as J, DiscountType as K, DiscountReason as L, type MaskedOrder as M, LineItemQuantityChangeType as N, type Order as O, type Price as P, ActivityType as Q, AttributionSource as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, ChannelType as X, PreviewEmailType as Y, WebhookIdentityType as Z, ScheduledAction as _, type PreparePaymentCollectionOptions as a, type StreetAddress as a$, PaymentCollectabilityStatus as a0, RefundableStatus as a1, NonRefundableReason as a2, ManuallyRefundableReason as a3, RestockType as a4, TransactionStatus as a5, AuthorizationCaptureStatus as a6, AuthorizationVoidStatus as a7, Reason as a8, ActionType as a9, 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 Address as a_, ChargebackStatus as aa, MembershipPaymentStatus as ab, RefundStatus as ac, VersioningMode as ad, SortOrder as ae, OrderApprovalStrategy as af, DeltaPaymentOptionType as ag, InventoryAction as ah, Placement as ai, SubdivisionType as aj, SourceType as ak, CustomFieldGroup as al, ValueType as am, DepositType as an, InvoiceStatus as ao, type OrderLineItem as ap, type ProductName as aq, type CatalogReference as ar, type DescriptionLine as as, type DescriptionLineValueOneOf as at, type DescriptionLineDescriptionLineValueOneOf as au, type DescriptionLineName as av, type PlainTextValue as aw, type Color as ax, type FocalPoint as ay, type PhysicalProperties as az, type PreparePaymentCollectionResponse as b, type PaymentCanceledPaymentDetailsOneOf as b$, type AddressLocation as b0, type FullAddressContactDetails as b1, type VatId as b2, type V1ShippingInformation as b3, type DeliveryLogistics as b4, type DeliveryLogisticsAddressOneOf as b5, type PickupDetails as b6, type PickupAddress as b7, type DeliveryTimeSlot as b8, type ShippingPrice as b9, 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 PaymentCanceled as b_, type ShippingRegion as ba, type TaxSummary as bb, type OrderTaxInfo as bc, type OrderTaxBreakdown as bd, type AppliedDiscount as be, type AppliedDiscountDiscountSourceOneOf as bf, type Coupon as bg, type MerchantDiscount as bh, type MerchantDiscountMerchantDiscountReasonOneOf as bi, type DiscountRule as bj, type DiscountRuleName as bk, type LineItemDiscount as bl, type Activity as bm, type ActivityContentOneOf as bn, type CustomActivity as bo, type MerchantComment as bp, type OrderRefunded as bq, type OrderCreatedFromExchange as br, type NewExchangeOrderCreated as bs, type LineItemExchangeData as bt, type DraftOrderChangesApplied as bu, type OrderChange as bv, type OrderChangeValueOneOf as bw, type LineItemChanges as bx, type LineItemQuantityChange as by, type LineItemPriceChange as bz, type PreparePaymentCollectionApplicationErrors as c, type PreviewBuyerPickupConfirmationEmailRequest as c$, type PaymentDeclined as c0, type PaymentDeclinedPaymentDetailsOneOf as c1, type ReceiptCreated as c2, type ReceiptCreatedReceiptInfoOneOf as c3, type WixReceipt as c4, type ExternalReceipt as c5, type ReceiptSent as c6, type ReceiptSentReceiptInfoOneOf as c7, type ChargebackCreated as c8, type ChargebackReversed as c9, type BulkSendBuyerShippingConfirmationEmailsRequest as cA, type BulkSendBuyerShippingConfirmationEmailsResponse as cB, type SendMerchantOrderReceivedNotificationRequest as cC, type SendMerchantOrderReceivedNotificationResponse as cD, type SendCancelRefundEmailRequest as cE, type SendCancelRefundEmailResponse as cF, type SendRefundEmailRequest as cG, type SendRefundEmailResponse as cH, type SendMerchantOrderReceivedPushRequest as cI, type SendMerchantOrderReceivedPushResponse as cJ, type PreviewEmailByTypeRequest as cK, type PreviewEmailByTypeResponse as cL, type PreviewRefundEmailRequest as cM, type RefundDetails as cN, type RefundItem as cO, type LineItemRefund as cP, type AdditionalFeeRefund as cQ, type ShippingRefund as cR, type PreviewRefundEmailResponse as cS, type PreviewCancelEmailRequest as cT, type PreviewCancelEmailResponse as cU, type PreviewCancelRefundEmailRequest as cV, type PreviewCancelRefundEmailResponse as cW, type PreviewBuyerPaymentsReceivedEmailRequest as cX, type PreviewBuyerPaymentsReceivedEmailResponse as cY, type PreviewBuyerConfirmationEmailRequest as cZ, type PreviewBuyerConfirmationEmailResponse as c_, type CreatedBy as ca, type CreatedByStringOneOf as cb, type ChannelInfo as cc, type CustomField as cd, type BalanceSummary as ce, type Balance as cf, type AdditionalFee as cg, type FulfillmentStatusesAggregate as ch, type Tags as ci, type TagList as cj, type Location as ck, type OrderApproved as cl, type OrdersExperiments as cm, type OrderRejectedEventOrderRejected as cn, type OrderItemsRestocked as co, type V1RestockItem as cp, type SendBuyerConfirmationEmailRequest as cq, type SendBuyerConfirmationEmailResponse as cr, type SendBuyerPaymentsReceivedEmailRequest as cs, type SendBuyerPaymentsReceivedEmailResponse as ct, type SendBuyerPickupConfirmationEmailRequest as cu, type SendBuyerPickupConfirmationEmailResponse as cv, type BulkSendBuyerPickupConfirmationEmailsRequest as cw, type BulkSendBuyerPickupConfirmationEmailsResponse as cx, type SendBuyerShippingConfirmationEmailRequest as cy, type SendBuyerShippingConfirmationEmailResponse as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type GiftCardPaymentDetails as d$, type PreviewBuyerPickupConfirmationEmailResponse as d0, type PreviewShippingConfirmationEmailRequest as d1, type PreviewShippingConfirmationEmailResponse as d2, type PreviewResendDownloadLinksEmailRequest as d3, type PreviewResendDownloadLinksEmailResponse as d4, type DomainEvent as d5, type DomainEventBodyOneOf as d6, type EntityCreatedEvent as d7, type RestoreInfo as d8, type EntityUpdatedEvent as d9, type CreatePaymentGatewayOrderRequest as dA, type ChargedBy as dB, type CreatePaymentGatewayOrderResponse as dC, type ChargeMembershipsRequest as dD, type MembershipChargeItem as dE, type MembershipName as dF, type ServiceProperties as dG, type ChargeMembershipsResponse as dH, type TriggerRefundRequest as dI, type PaymentRefund as dJ, type RefundSideEffects as dK, type RestockInfo as dL, type RestockItem as dM, type TriggerRefundResponse as dN, type OrderTransactions as dO, 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 Chargeback as d_, type EntityDeletedEvent as da, type ActionEvent as db, type Empty as dc, type MessageEnvelope as dd, type IdentificationData as de, type IdentificationDataIdOneOf as df, type PreparePaymentCollectionRequest as dg, type RedirectUrls as dh, type DelayedCaptureSettings as di, type Duration as dj, type GetPaymentCollectabilityStatusRequest as dk, type RecordManuallyCollectedPaymentRequest as dl, type RecordManuallyCollectedPaymentResponse as dm, type MarkOrderAsPaidRequest as dn, type MarkOrderAsPaidResponse as dp, type BulkMarkOrdersAsPaidRequest as dq, type BulkMarkOrdersAsPaidResponse as dr, type BulkOrderResult as ds, type ItemMetadata as dt, type ApplicationError as du, type BulkActionMetadata as dv, type GetRefundabilityStatusRequest as dw, type GetRefundabilityStatusResponse as dx, type Refundability as dy, type RefundabilityAdditionalRefundabilityInfoOneOf as dz, type PaymentCapture as e, type DraftOrderDiffsShippingUpdateInfoOneOf as e$, type MembershipPaymentDetails as e0, type WixReceiptInfo as e1, type ExternalReceiptInfo as e2, type Refund as e3, type RefundTransaction as e4, type RefundStatusInfo as e5, type AggregatedRefundSummary as e6, type RefundItemsBreakdown as e7, type LineItemRefundSummary as e8, type CalculateRefundRequest as e9, type IndexingMessage as eA, type GetOrderRequest as eB, type GetOrderResponse as eC, type InternalQueryOrdersRequest as eD, type PlatformQuery as eE, type PlatformQueryPagingMethodOneOf as eF, type Sorting as eG, type PlatformPaging as eH, type CursorPaging as eI, type InternalQueryOrdersResponse as eJ, type PlatformPagingMetadata as eK, type Cursors as eL, type QueryOrderRequest as eM, type QueryOrderResponse as eN, type SearchOrdersRequest as eO, type CursorSearch as eP, type CursorSearchPagingMethodOneOf as eQ, type CursorPagingMetadata as eR, type CreateOrderRequest as eS, type OrderCreationSettings as eT, type OrderCreateNotifications as eU, type CreateOrderResponse as eV, type UpdateOrderRequest as eW, type UpdateOrderResponse as eX, type BulkUpdateOrdersRequest as eY, type CommitDeltasRequest as eZ, type DraftOrderDiffs as e_, type CalculateRefundItemRequest as ea, type CalculateRefundResponse as eb, type CalculateRefundItemResponse as ec, type VoidAuthorizedPaymentsRequest as ed, type CaptureAuthorizedPaymentsRequest as ee, type ChargeSavedPaymentMethodRequest as ef, type ChargeSavedPaymentMethodResponse as eg, type UpdateInternalDocumentsEvent as eh, type UpdateInternalDocumentsEventOperationOneOf as ei, type InternalDocument as ej, type InternalDocumentUpdateOperation as ek, type DeleteByIdsOperation as el, type DeleteByFilterOperation as em, type InternalDocumentUpdateByFilterOperation as en, type InternalUpdateExistingOperation as eo, type VersionedDocumentUpdateOperation as ep, type VersionedDeleteByIdsOperation as eq, type VersionedDocumentId as er, type TriggerReindexRequest as es, type TriggerReindexResponse as et, type BatchOfTriggerReindexOrderRequest as eu, type TriggerReindexOrderRequest as ev, type DiffmatokyPayload as ew, type ErrorInformation as ex, type ContinueSideEffectsFlowInLegacyData as ey, type SnapshotMessage as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type PickupReadyEmailSent as f$, type DraftOrderDiffsBuyerUpdateInfoOneOf as f0, type DraftOrderDiffsBillingUpdateInfoOneOf as f1, type DraftOrderDiffsRecipientUpdateInfoOneOf as f2, type V1LineItemDelta as f3, type V1LineItemDeltaDeltaOneOf as f4, type OrderLineItemChangedDetails as f5, type ItemChangedDetails as f6, type AppliedDiscountDelta as f7, type AppliedDiscountDeltaDeltaOneOf as f8, type AdditionalFeeDelta as f9, type UpdateOrderShippingAddressRequest as fA, type UpdateOrderShippingAddressResponse as fB, type UpdateBillingContactDetailsRequest as fC, type UpdateBillingContactDetailsResponse as fD, type UpdateOrderLineItemRequest as fE, type UpdateOrderLineItemResponse as fF, type UpdateOrderLineItemsRequest as fG, type MaskedOrderLineItem as fH, type UpdateOrderLineItemsResponse as fI, type AddInternalActivityRequest as fJ, type InternalActivity as fK, type InternalActivityContentOneOf as fL, type OrderPlaced as fM, type OrderPaid as fN, type OrderFulfilled as fO, type OrderNotFulfilled as fP, type OrderCanceled as fQ, type DownloadLinkSent as fR, type TrackingNumberAdded as fS, type TrackingNumberEdited as fT, type TrackingLinkAdded as fU, type ShippingConfirmationEmailSent as fV, type InvoiceAdded as fW, type InvoiceSent as fX, type FulfillerEmailSent as fY, type ShippingAddressEdited as fZ, type EmailEdited as f_, type AdditionalFeeDeltaDeltaOneOf as fa, type DraftOrderCommitSettings as fb, type InventoryUpdateDetails as fc, type CommitDeltasResponse as fd, type OrderDeltasCommitted as fe, type CommittedDiffs as ff, type CommittedDiffsShippingUpdateInfoOneOf as fg, type LineItemDelta as fh, type LineItemDeltaDeltaOneOf as fi, type ArchiveOrderRequest as fj, type ArchiveOrderResponse as fk, type BulkArchiveOrdersRequest as fl, type BulkArchiveOrdersResponse as fm, type BulkArchiveOrdersByFilterRequest as fn, type BulkArchiveOrdersByFilterResponse as fo, type UnArchiveOrderRequest as fp, type UnArchiveOrderResponse as fq, type BulkUnArchiveOrdersRequest as fr, type BulkUnArchiveOrdersResponse as fs, type BulkUnArchiveOrdersByFilterRequest as ft, type BulkUnArchiveOrdersByFilterResponse as fu, type UpdateBuyerInfoRequest as fv, type BuyerInfoUpdate as fw, type UpdateBuyerInfoResponse as fx, type UpdateBuyerEmailRequest as fy, type UpdateBuyerEmailResponse as fz, type GetOrderApplicationErrors as g, type IdAndVersion as g$, type OrderPartiallyPaid as g0, type OrderPending as g1, type OrderRejected as g2, type AddInternalActivityResponse as g3, type AddActivityRequest as g4, type PublicActivity as g5, type PublicActivityContentOneOf as g6, type AddActivityResponse as g7, type AddActivitiesRequest as g8, type AddActivitiesResponse as g9, type BulkSetBusinessLocationRequest as gA, type BulkSetBusinessLocationResponse as gB, type BulkSetBusinessLocationResult as gC, type V1MarkOrderAsPaidRequest as gD, type V1MarkOrderAsPaidResponse as gE, type PaymentStatusUpdated as gF, type V1BulkMarkOrdersAsPaidRequest as gG, type V1BulkMarkOrdersAsPaidResponse as gH, type V1CreatePaymentGatewayOrderRequest as gI, type V1CreatePaymentGatewayOrderResponse as gJ, type GetShipmentsRequest as gK, type GetShipmentsResponse as gL, type AggregateOrdersRequest as gM, type AggregateOrdersResponse as gN, type DecrementItemsQuantityRequest as gO, type DecrementData as gP, type DecrementItemsQuantityResponse as gQ, type BulkUpdateOrderTagsRequest as gR, type BulkUpdateOrderTagsResult as gS, type Task as gT, type TaskKey as gU, type TaskAction as gV, type TaskActionActionOneOf as gW, type Complete as gX, type Cancel as gY, type Reschedule as gZ, type InvoiceSentEvent as g_, type UpdateActivityRequest as ga, type UpdateActivityResponse as gb, type DeleteActivityRequest as gc, type DeleteActivityResponse as gd, type UpdateLineItemsDescriptionLinesRequest as ge, type LineItemUpdate as gf, type UpdateLineItemsDescriptionLinesResponse as gg, type MarkOrderAsSeenByHumanRequest as gh, type MarkOrderAsSeenByHumanResponse as gi, type CancelOrderRequest as gj, type OrderCanceledEventOrderCanceled as gk, type UpdateOrderStatusRequest as gl, type UpdateOrderStatusResponse as gm, type MarkAsFulfilledRequest as gn, type MarkAsFulfilledResponse as go, type FulfillmentStatusUpdated as gp, type BulkMarkAsFulfilledRequest as gq, type BulkMarkAsFulfilledResponse as gr, type BulkMarkAsFulfilledByFilterRequest as gs, type BulkMarkAsFulfilledByFilterResponse as gt, type MarkAsUnfulfilledRequest as gu, type MarkAsUnfulfilledResponse as gv, type BulkMarkAsUnfulfilledRequest as gw, type BulkMarkAsUnfulfilledResponse as gx, type BulkMarkAsUnfulfilledByFilterRequest as gy, type BulkMarkAsUnfulfilledByFilterResponse as gz, type OrderSearch as h, type ChannelTypeWithLiterals as h$, type InvoiceFields as h0, type Customer as h1, type Email as h2, type QuotesAddress as h3, type AddressDescription as h4, type Phone as h5, type Company as h6, type CommonAddress as h7, type CommonAddressStreetOneOf as h8, type Subdivision as h9, type ChargeMembershipsOptions as hA, type TriggerRefundOptions as hB, type OrderSearchSpec as hC, type CommitDeltasOptions as hD, type UpdateOrderLineItemIdentifiers as hE, type UpdateOrderLineItem as hF, type UpdateActivityIdentifiers as hG, type DeleteActivityIdentifiers as hH, type AggregateOrdersOptions as hI, type DescriptionLineTypeWithLiterals as hJ, type ItemTypeItemTypeWithLiterals as hK, type PaymentOptionTypeWithLiterals as hL, type JurisdictionTypeWithLiterals as hM, type SubscriptionFrequencyWithLiterals as hN, type AdjustmentTypeWithLiterals as hO, type TaxableAddressTypeWithLiterals as hP, type PaymentStatusWithLiterals as hQ, type FulfillmentStatusWithLiterals as hR, type WeightUnitWithLiterals as hS, type VatTypeWithLiterals as hT, type PickupMethodWithLiterals as hU, type OrderStatusWithLiterals as hV, type DiscountTypeWithLiterals as hW, type DiscountReasonWithLiterals as hX, type LineItemQuantityChangeTypeWithLiterals as hY, type ActivityTypeWithLiterals as hZ, type AttributionSourceWithLiterals as h_, type StandardDetails as ha, type InvoiceDates as hb, type LineItems as hc, type LineItem as hd, type BigDecimalWrapper as he, type LineItemTax as hf, type Source as hg, type LineItemMetaData as hh, type Locale as hi, type TotalPrice as hj, type ItemizedFee as hk, type Discount as hl, type DiscountOneDiscountTypeOneOf as hm, type CalculatedTaxes as hn, type CalculatedTax as ho, type Payments as hp, type InvoicesPayment as hq, type MetaData as hr, type InvoiceDynamicPriceTotals as hs, type CustomFieldValue as ht, type Value as hu, type Deposit as hv, type TriggerSideEffectsFromLegacyData as hw, type BaseEventMetadata as hx, type EventMetadata as hy, type PaymentCollectionCreatePaymentGatewayOrderOptions as hz, type CreateOrderOptions as i, type PreviewEmailTypeWithLiterals as i0, type WebhookIdentityTypeWithLiterals as i1, type ScheduledActionWithLiterals as i2, type DurationUnitWithLiterals as i3, type PaymentCollectabilityStatusWithLiterals as i4, type RefundableStatusWithLiterals as i5, type NonRefundableReasonWithLiterals as i6, type ManuallyRefundableReasonWithLiterals as i7, type RestockTypeWithLiterals as i8, type TransactionStatusWithLiterals as i9, type UpdateOrderStatusApplicationErrors as iA, onOrderApproved as iB, onOrderUpdated as iC, onOrderCanceled as iD, onOrderCreated as iE, onOrderPaymentStatusUpdated as iF, preparePaymentCollection as iG, getPaymentCollectabilityStatus as iH, voidAuthorizedPayments as iI, captureAuthorizedPayments as iJ, getOrder as iK, type CommonSearchWithEntityContext as iL, createOrder as iM, updateOrder as iN, bulkUpdateOrders as iO, cancelOrder as iP, bulkUpdateOrderTags as iQ, type AuthorizationCaptureStatusWithLiterals as ia, type AuthorizationVoidStatusWithLiterals as ib, type ReasonWithLiterals as ic, type ActionTypeWithLiterals as id, type ChargebackStatusWithLiterals as ie, type MembershipPaymentStatusWithLiterals as ig, type RefundStatusWithLiterals as ih, type VersioningModeWithLiterals as ii, type SortOrderWithLiterals as ij, type OrderApprovalStrategyWithLiterals as ik, type DeltaPaymentOptionTypeWithLiterals as il, type InventoryActionWithLiterals as im, type PlacementWithLiterals as io, type SubdivisionTypeWithLiterals as ip, type SourceTypeWithLiterals as iq, type CustomFieldGroupWithLiterals as ir, type ValueTypeWithLiterals as is, type DepositTypeWithLiterals as it, type InvoiceStatusWithLiterals as iu, type RecordManuallyCollectedPaymentApplicationErrors as iv, type PaymentCollectionMarkOrderAsPaidApplicationErrors as iw, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as ix, type TriggerRefundApplicationErrors as iy, type CommitDeltasApplicationErrors as iz, type CreateOrderApplicationErrors as j, type UpdateOrderApplicationErrors as k, type BulkUpdateOrdersResponse as l, type CancelOrderOptions as m, type CancelOrderResponse as n, type CancelOrderApplicationErrors as o, type BulkUpdateOrderTagsOptions as p, type BulkUpdateOrderTagsResponse as q, type OrderApprovedEnvelope as r, type OrderUpdatedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCreatedEnvelope as u, type OrderPaymentStatusUpdatedEnvelope as v, PaymentOptionType as w, SubscriptionFrequency as x, PaymentStatus as y, VatType as z };
|