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