@wix/auto_sdk_ecom_orders 1.0.70 → 1.0.71
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-KCtJReRk.d.ts → cjs/ecom-v1-order-orders.universal-B51dgVhk.d.ts} +223 -2226
- package/build/cjs/index.d.ts +3 -56
- package/build/cjs/index.js +311 -1338
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +112 -1039
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +38 -1006
- package/build/cjs/meta.js +2 -637
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-KCtJReRk.d.mts → es/ecom-v1-order-orders.universal-B51dgVhk.d.mts} +223 -2226
- package/build/es/index.d.mts +3 -56
- package/build/es/index.mjs +310 -1311
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +111 -1012
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +38 -1006
- package/build/es/meta.mjs +1 -625
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-C73TYoI7.d.ts → internal/cjs/ecom-v1-order-orders.universal-BuGgtT93.d.ts} +725 -1537
- package/build/internal/cjs/index.d.ts +3 -162
- package/build/internal/cjs/index.js +311 -1338
- 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 +112 -1039
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +38 -1006
- package/build/internal/cjs/meta.js +2 -637
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-C73TYoI7.d.mts → internal/es/ecom-v1-order-orders.universal-BuGgtT93.d.mts} +725 -1537
- package/build/internal/es/index.d.mts +3 -162
- package/build/internal/es/index.mjs +310 -1311
- 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 +111 -1012
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +38 -1006
- package/build/internal/es/meta.mjs +1 -625
- 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,6 +2557,141 @@ interface Location {
|
|
|
2350
2557
|
*/
|
|
2351
2558
|
name?: string;
|
|
2352
2559
|
}
|
|
2560
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
2561
|
+
/** insert/update documents */
|
|
2562
|
+
update?: InternalDocumentUpdateOperation;
|
|
2563
|
+
/** delete by document ids */
|
|
2564
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
2565
|
+
/** delete documents matching filter */
|
|
2566
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
2567
|
+
/** update internal documents matching filter */
|
|
2568
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2569
|
+
/** update only existing documents */
|
|
2570
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
2571
|
+
/** insert/update documents with versioning */
|
|
2572
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2573
|
+
/** delete by document ids with versioning */
|
|
2574
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2575
|
+
/**
|
|
2576
|
+
* type of the documents
|
|
2577
|
+
* @minLength 2
|
|
2578
|
+
*/
|
|
2579
|
+
documentType?: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* language of the documents (mandatory)
|
|
2582
|
+
* @minLength 2
|
|
2583
|
+
*/
|
|
2584
|
+
language?: string | null;
|
|
2585
|
+
/**
|
|
2586
|
+
* one or more search documents
|
|
2587
|
+
* @deprecated
|
|
2588
|
+
*/
|
|
2589
|
+
addDocuments?: InternalDocument[];
|
|
2590
|
+
/**
|
|
2591
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
2592
|
+
* @deprecated
|
|
2593
|
+
*/
|
|
2594
|
+
removeDocumentIds?: string[];
|
|
2595
|
+
/** id to pass to processing notification */
|
|
2596
|
+
correlationId?: string | null;
|
|
2597
|
+
/** when event was created / issued */
|
|
2598
|
+
issuedAt?: Date | null;
|
|
2599
|
+
}
|
|
2600
|
+
/** @oneof */
|
|
2601
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
2602
|
+
/** insert/update documents */
|
|
2603
|
+
update?: InternalDocumentUpdateOperation;
|
|
2604
|
+
/** delete by document ids */
|
|
2605
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
2606
|
+
/** delete documents matching filter */
|
|
2607
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
2608
|
+
/** update internal documents matching filter */
|
|
2609
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2610
|
+
/** update only existing documents */
|
|
2611
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
2612
|
+
/** insert/update documents with versioning */
|
|
2613
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2614
|
+
/** delete by document ids with versioning */
|
|
2615
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2616
|
+
}
|
|
2617
|
+
interface InternalDocument {
|
|
2618
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
2619
|
+
document?: Record<string, any> | null;
|
|
2620
|
+
}
|
|
2621
|
+
interface InternalDocumentUpdateOperation {
|
|
2622
|
+
/** documents to index or update */
|
|
2623
|
+
documents?: InternalDocument[];
|
|
2624
|
+
}
|
|
2625
|
+
interface DeleteByIdsOperation {
|
|
2626
|
+
/** ids of the documents to delete */
|
|
2627
|
+
documentIds?: string[];
|
|
2628
|
+
/**
|
|
2629
|
+
* tenant id for custom tenancy strategy
|
|
2630
|
+
* @minLength 2
|
|
2631
|
+
* @maxLength 300
|
|
2632
|
+
*/
|
|
2633
|
+
tenantId?: string | null;
|
|
2634
|
+
}
|
|
2635
|
+
interface DeleteByFilterOperation {
|
|
2636
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2637
|
+
filter?: Record<string, any> | null;
|
|
2638
|
+
/**
|
|
2639
|
+
* tenant id for custom tenancy strategy
|
|
2640
|
+
* @minLength 2
|
|
2641
|
+
* @maxLength 300
|
|
2642
|
+
*/
|
|
2643
|
+
tenantId?: string | null;
|
|
2644
|
+
}
|
|
2645
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
2646
|
+
/** documents matching this filter will be updated */
|
|
2647
|
+
filter?: Record<string, any> | null;
|
|
2648
|
+
/** partial document to apply */
|
|
2649
|
+
document?: InternalDocument;
|
|
2650
|
+
/**
|
|
2651
|
+
* tenant id for custom tenancy strategy
|
|
2652
|
+
* @minLength 2
|
|
2653
|
+
* @maxLength 300
|
|
2654
|
+
*/
|
|
2655
|
+
tenantId?: string | null;
|
|
2656
|
+
}
|
|
2657
|
+
interface InternalUpdateExistingOperation {
|
|
2658
|
+
/** documents to update */
|
|
2659
|
+
documents?: InternalDocument[];
|
|
2660
|
+
}
|
|
2661
|
+
interface VersionedDocumentUpdateOperation {
|
|
2662
|
+
/** documents to create or overwrite */
|
|
2663
|
+
documents?: InternalDocument[];
|
|
2664
|
+
/** versioning mode to use instead of default */
|
|
2665
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
2666
|
+
}
|
|
2667
|
+
declare enum VersioningMode {
|
|
2668
|
+
/** use default versioning mode agreed with search team */
|
|
2669
|
+
DEFAULT = "DEFAULT",
|
|
2670
|
+
/** execute only if version is greater than existing */
|
|
2671
|
+
GREATER_THAN = "GREATER_THAN",
|
|
2672
|
+
/** execute only if version is greater or equal to existing */
|
|
2673
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2674
|
+
}
|
|
2675
|
+
/** @enumType */
|
|
2676
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
2677
|
+
interface VersionedDeleteByIdsOperation {
|
|
2678
|
+
/** ids with version of the documents to delete */
|
|
2679
|
+
documentIds?: VersionedDocumentId[];
|
|
2680
|
+
/**
|
|
2681
|
+
* tenant id for custom tenancy strategy
|
|
2682
|
+
* @minLength 2
|
|
2683
|
+
* @maxLength 300
|
|
2684
|
+
*/
|
|
2685
|
+
tenantId?: string | null;
|
|
2686
|
+
}
|
|
2687
|
+
interface VersionedDocumentId {
|
|
2688
|
+
/** document id */
|
|
2689
|
+
documentId?: string;
|
|
2690
|
+
/** document version */
|
|
2691
|
+
version?: string;
|
|
2692
|
+
/** versioning mode to use instead of default */
|
|
2693
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
2694
|
+
}
|
|
2353
2695
|
/** Triggered when the order status changes to approved */
|
|
2354
2696
|
interface OrderApproved {
|
|
2355
2697
|
/** The order that was updated */
|
|
@@ -2371,9 +2713,9 @@ interface OrderItemsRestocked {
|
|
|
2371
2713
|
/** The order which items were restocked */
|
|
2372
2714
|
order?: Order;
|
|
2373
2715
|
/** Restocked items and quantities */
|
|
2374
|
-
restockItems?:
|
|
2716
|
+
restockItems?: RestockItem[];
|
|
2375
2717
|
}
|
|
2376
|
-
interface
|
|
2718
|
+
interface RestockItem {
|
|
2377
2719
|
/**
|
|
2378
2720
|
* ID of the line item being restocked.
|
|
2379
2721
|
* @format GUID
|
|
@@ -2386,1159 +2728,33 @@ interface V1RestockItem {
|
|
|
2386
2728
|
*/
|
|
2387
2729
|
quantity?: number;
|
|
2388
2730
|
}
|
|
2389
|
-
interface
|
|
2731
|
+
interface TriggerReindexRequest {
|
|
2732
|
+
/** @format GUID */
|
|
2733
|
+
metasiteId?: string;
|
|
2390
2734
|
/**
|
|
2391
|
-
* Ecom order ID.
|
|
2392
2735
|
* @minLength 1
|
|
2393
2736
|
* @maxLength 100
|
|
2737
|
+
* @maxSize 100
|
|
2394
2738
|
*/
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
/**
|
|
2399
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
2400
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
2401
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
2402
|
-
*/
|
|
2403
|
-
paymentGatewayOrderId?: string | null;
|
|
2404
|
-
/**
|
|
2405
|
-
* Whether to delay capture of the payment.
|
|
2406
|
-
* Default: false
|
|
2407
|
-
* @deprecated Whether to delay capture of the payment.
|
|
2408
|
-
* Default: false
|
|
2409
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
2410
|
-
* @targetRemovalDate 2024-09-30
|
|
2411
|
-
*/
|
|
2412
|
-
delayedCapture?: boolean;
|
|
2413
|
-
/** Delayed capture payment settings */
|
|
2414
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2739
|
+
orderIds?: string[];
|
|
2740
|
+
}
|
|
2741
|
+
interface TriggerReindexResponse {
|
|
2415
2742
|
}
|
|
2416
|
-
interface
|
|
2743
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2744
|
+
createdEvent?: EntityCreatedEvent;
|
|
2745
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2746
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2747
|
+
actionEvent?: ActionEvent;
|
|
2748
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2749
|
+
_id?: string;
|
|
2417
2750
|
/**
|
|
2418
|
-
*
|
|
2419
|
-
*
|
|
2751
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2752
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2420
2753
|
*/
|
|
2421
|
-
|
|
2754
|
+
entityFqdn?: string;
|
|
2422
2755
|
/**
|
|
2423
|
-
*
|
|
2424
|
-
*
|
|
2425
|
-
*/
|
|
2426
|
-
cancelUrl?: string | null;
|
|
2427
|
-
/**
|
|
2428
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
2429
|
-
* @format WEB_URL
|
|
2430
|
-
*/
|
|
2431
|
-
errorUrl?: string | null;
|
|
2432
|
-
/**
|
|
2433
|
-
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
2434
|
-
* @format WEB_URL
|
|
2435
|
-
*/
|
|
2436
|
-
pendingUrl?: string | null;
|
|
2437
|
-
}
|
|
2438
|
-
interface DelayedCaptureSettings {
|
|
2439
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2440
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
2441
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2442
|
-
delayDuration?: Duration;
|
|
2443
|
-
}
|
|
2444
|
-
declare enum ScheduledAction {
|
|
2445
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
2446
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
2447
|
-
VOID = "VOID",
|
|
2448
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
2449
|
-
CAPTURE = "CAPTURE"
|
|
2450
|
-
}
|
|
2451
|
-
/** @enumType */
|
|
2452
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2453
|
-
interface Duration {
|
|
2454
|
-
/**
|
|
2455
|
-
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2456
|
-
* @min 1
|
|
2457
|
-
*/
|
|
2458
|
-
count?: number;
|
|
2459
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2460
|
-
unit?: DurationUnitWithLiterals;
|
|
2461
|
-
}
|
|
2462
|
-
declare enum DurationUnit {
|
|
2463
|
-
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2464
|
-
MINUTES = "MINUTES",
|
|
2465
|
-
HOURS = "HOURS",
|
|
2466
|
-
DAYS = "DAYS"
|
|
2467
|
-
}
|
|
2468
|
-
/** @enumType */
|
|
2469
|
-
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2470
|
-
interface PreparePaymentCollectionResponse {
|
|
2471
|
-
/** Payment gateway order id which is associated with given payment */
|
|
2472
|
-
paymentGatewayOrderId?: string;
|
|
2473
|
-
}
|
|
2474
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
2475
|
-
/**
|
|
2476
|
-
* Ecom order ID.
|
|
2477
|
-
* @minLength 1
|
|
2478
|
-
* @maxLength 100
|
|
2479
|
-
*/
|
|
2480
|
-
ecomOrderId: string;
|
|
2481
|
-
}
|
|
2482
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
2483
|
-
/** Payment collectability status */
|
|
2484
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2485
|
-
/** Collectable order amount */
|
|
2486
|
-
amount?: Price;
|
|
2487
|
-
}
|
|
2488
|
-
declare enum PaymentCollectabilityStatus {
|
|
2489
|
-
UNKNOWN = "UNKNOWN",
|
|
2490
|
-
COLLECTABLE = "COLLECTABLE",
|
|
2491
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
2492
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
2493
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
2494
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
2495
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2496
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2497
|
-
}
|
|
2498
|
-
/** @enumType */
|
|
2499
|
-
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';
|
|
2500
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
2501
|
-
/**
|
|
2502
|
-
* Order ID.
|
|
2503
|
-
* @minLength 1
|
|
2504
|
-
* @maxLength 100
|
|
2505
|
-
*/
|
|
2506
|
-
orderId: string;
|
|
2507
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
2508
|
-
amount: Price;
|
|
2509
|
-
}
|
|
2510
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
2511
|
-
}
|
|
2512
|
-
interface MarkOrderAsPaidRequest {
|
|
2513
|
-
/**
|
|
2514
|
-
* Ecom order ID.
|
|
2515
|
-
* @minLength 1
|
|
2516
|
-
* @maxLength 100
|
|
2517
|
-
*/
|
|
2518
|
-
ecomOrderId: string;
|
|
2519
|
-
}
|
|
2520
|
-
interface MarkOrderAsPaidResponse {
|
|
2521
|
-
/** Updated order. */
|
|
2522
|
-
order?: Order;
|
|
2523
|
-
}
|
|
2524
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
2525
|
-
/**
|
|
2526
|
-
* IDs of orders to mark as paid.
|
|
2527
|
-
* @minSize 1
|
|
2528
|
-
* @maxSize 100
|
|
2529
|
-
* @minLength 1
|
|
2530
|
-
* @maxLength 100
|
|
2531
|
-
*/
|
|
2532
|
-
ecomOrderIds: string[];
|
|
2533
|
-
}
|
|
2534
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
2535
|
-
/**
|
|
2536
|
-
* Items updated by the bulk action.
|
|
2537
|
-
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
2538
|
-
*/
|
|
2539
|
-
results?: BulkOrderResult[];
|
|
2540
|
-
/** Bulk action metadata. */
|
|
2541
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2542
|
-
}
|
|
2543
|
-
interface BulkOrderResult {
|
|
2544
|
-
/** Item metadata. */
|
|
2545
|
-
itemMetadata?: ItemMetadata;
|
|
2546
|
-
/**
|
|
2547
|
-
* Updated order.
|
|
2548
|
-
*
|
|
2549
|
-
* Returned when `returnFullEntity = true`.
|
|
2550
|
-
*/
|
|
2551
|
-
item?: Order;
|
|
2552
|
-
}
|
|
2553
|
-
interface ItemMetadata {
|
|
2554
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2555
|
-
_id?: string | null;
|
|
2556
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2557
|
-
originalIndex?: number;
|
|
2558
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2559
|
-
success?: boolean;
|
|
2560
|
-
/** Details about the error in case of failure. */
|
|
2561
|
-
error?: ApplicationError;
|
|
2562
|
-
}
|
|
2563
|
-
interface ApplicationError {
|
|
2564
|
-
/** Error code. */
|
|
2565
|
-
code?: string;
|
|
2566
|
-
/** Description of the error. */
|
|
2567
|
-
description?: string;
|
|
2568
|
-
/** Data related to the error. */
|
|
2569
|
-
data?: Record<string, any> | null;
|
|
2570
|
-
}
|
|
2571
|
-
interface BulkActionMetadata {
|
|
2572
|
-
/** Number of items that were successfully processed. */
|
|
2573
|
-
totalSuccesses?: number;
|
|
2574
|
-
/** Number of items that couldn't be processed. */
|
|
2575
|
-
totalFailures?: number;
|
|
2576
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2577
|
-
undetailedFailures?: number;
|
|
2578
|
-
}
|
|
2579
|
-
interface GetRefundabilityStatusRequest {
|
|
2580
|
-
/**
|
|
2581
|
-
* Order ID.
|
|
2582
|
-
* @minLength 1
|
|
2583
|
-
* @maxLength 100
|
|
2584
|
-
*/
|
|
2585
|
-
ecomOrderId: string;
|
|
2586
|
-
}
|
|
2587
|
-
interface GetRefundabilityStatusResponse {
|
|
2588
|
-
/**
|
|
2589
|
-
* Refundability details.
|
|
2590
|
-
* @maxSize 300
|
|
2591
|
-
*/
|
|
2592
|
-
refundabilities?: Refundability[];
|
|
2593
|
-
/**
|
|
2594
|
-
* Whether the order supports refunding per item.
|
|
2595
|
-
* @deprecated
|
|
2596
|
-
*/
|
|
2597
|
-
refundablePerItem?: boolean;
|
|
2598
|
-
}
|
|
2599
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2600
|
-
/** Reason why payment is not refundable. */
|
|
2601
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2602
|
-
/** Reason why payment is only refundable manually. */
|
|
2603
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2604
|
-
/** Payment ID. */
|
|
2605
|
-
paymentId?: string;
|
|
2606
|
-
/** Payment refundability status. */
|
|
2607
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2608
|
-
/** Link to payment provider dashboard. */
|
|
2609
|
-
providerLink?: string | null;
|
|
2610
|
-
}
|
|
2611
|
-
/** @oneof */
|
|
2612
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2613
|
-
/** Reason why payment is not refundable. */
|
|
2614
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2615
|
-
/** Reason why payment is only refundable manually. */
|
|
2616
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2617
|
-
}
|
|
2618
|
-
declare enum RefundableStatus {
|
|
2619
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2620
|
-
MANUAL = "MANUAL",
|
|
2621
|
-
REFUNDABLE = "REFUNDABLE"
|
|
2622
|
-
}
|
|
2623
|
-
/** @enumType */
|
|
2624
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2625
|
-
declare enum NonRefundableReason {
|
|
2626
|
-
NONE = "NONE",
|
|
2627
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2628
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
2629
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
2630
|
-
NOT_PAID = "NOT_PAID",
|
|
2631
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
2632
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
2633
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
2634
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
2635
|
-
FORBIDDEN = "FORBIDDEN",
|
|
2636
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
2637
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2638
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2639
|
-
}
|
|
2640
|
-
/** @enumType */
|
|
2641
|
-
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';
|
|
2642
|
-
declare enum ManuallyRefundableReason {
|
|
2643
|
-
EXPIRED = "EXPIRED",
|
|
2644
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2645
|
-
OFFLINE = "OFFLINE",
|
|
2646
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2647
|
-
}
|
|
2648
|
-
/** @enumType */
|
|
2649
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2650
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
2651
|
-
/**
|
|
2652
|
-
* Ecom order ID.
|
|
2653
|
-
* @minLength 1
|
|
2654
|
-
* @maxLength 100
|
|
2655
|
-
*/
|
|
2656
|
-
ecomOrderId: string;
|
|
2657
|
-
/** Information about the user who initiated the payment. */
|
|
2658
|
-
chargedBy?: ChargedBy;
|
|
2659
|
-
}
|
|
2660
|
-
interface ChargedBy {
|
|
2661
|
-
/**
|
|
2662
|
-
* ID - id of the user who initiated the payment
|
|
2663
|
-
* @format GUID
|
|
2664
|
-
*/
|
|
2665
|
-
_id?: string;
|
|
2666
|
-
/**
|
|
2667
|
-
* Full name - name of the user who initiated the payment
|
|
2668
|
-
* @minLength 1
|
|
2669
|
-
* @maxLength 200
|
|
2670
|
-
*/
|
|
2671
|
-
fullName?: string | null;
|
|
2672
|
-
}
|
|
2673
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
2674
|
-
/** ID of the order created in the payment gateway */
|
|
2675
|
-
paymentGatewayOrderId?: string;
|
|
2676
|
-
}
|
|
2677
|
-
interface ChargeMembershipsRequest {
|
|
2678
|
-
/**
|
|
2679
|
-
* Order ID.
|
|
2680
|
-
* @minLength 1
|
|
2681
|
-
* @maxLength 100
|
|
2682
|
-
*/
|
|
2683
|
-
ecomOrderId: string;
|
|
2684
|
-
/**
|
|
2685
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
2686
|
-
* but a user which is using the membership on behalf of the a member
|
|
2687
|
-
* @format GUID
|
|
2688
|
-
*/
|
|
2689
|
-
memberId: string;
|
|
2690
|
-
/**
|
|
2691
|
-
* List of items to be paid by memberships
|
|
2692
|
-
* @minSize 1
|
|
2693
|
-
* @maxSize 300
|
|
2694
|
-
*/
|
|
2695
|
-
membershipCharges?: MembershipChargeItem[];
|
|
2696
|
-
}
|
|
2697
|
-
interface MembershipChargeItem {
|
|
2698
|
-
/**
|
|
2699
|
-
* The id of used membership
|
|
2700
|
-
* @minLength 1
|
|
2701
|
-
* @maxLength 100
|
|
2702
|
-
*/
|
|
2703
|
-
membershipId?: string;
|
|
2704
|
-
/**
|
|
2705
|
-
* ID of the application providing this payment option
|
|
2706
|
-
* @format GUID
|
|
2707
|
-
*/
|
|
2708
|
-
appId?: string;
|
|
2709
|
-
/** The name of used membership */
|
|
2710
|
-
membershipName?: MembershipName;
|
|
2711
|
-
/** Additional data about this membership */
|
|
2712
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
2713
|
-
/** Catalog and item reference info. */
|
|
2714
|
-
catalogReference?: CatalogReference;
|
|
2715
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2716
|
-
serviceProperties?: ServiceProperties;
|
|
2717
|
-
/**
|
|
2718
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
2719
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2720
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2721
|
-
* @minLength 1
|
|
2722
|
-
* @maxLength 36
|
|
2723
|
-
*/
|
|
2724
|
-
rootCatalogItemId?: string | null;
|
|
2725
|
-
/**
|
|
2726
|
-
* line item id of Checkout/Order line item
|
|
2727
|
-
* @minLength 1
|
|
2728
|
-
* @maxLength 100
|
|
2729
|
-
*/
|
|
2730
|
-
lineItemId?: string;
|
|
2731
|
-
}
|
|
2732
|
-
interface MembershipName {
|
|
2733
|
-
/**
|
|
2734
|
-
* Membership name.
|
|
2735
|
-
* @maxLength 100
|
|
2736
|
-
*/
|
|
2737
|
-
original?: string;
|
|
2738
|
-
/**
|
|
2739
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
2740
|
-
* @maxLength 100
|
|
2741
|
-
*/
|
|
2742
|
-
translated?: string | null;
|
|
2743
|
-
}
|
|
2744
|
-
interface ServiceProperties {
|
|
2745
|
-
/**
|
|
2746
|
-
* 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.
|
|
2747
|
-
* For example, the start time of a class.
|
|
2748
|
-
*/
|
|
2749
|
-
scheduledDate?: Date | null;
|
|
2750
|
-
/**
|
|
2751
|
-
* 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.
|
|
2752
|
-
* @min 1
|
|
2753
|
-
* @max 10000
|
|
2754
|
-
*/
|
|
2755
|
-
numberOfParticipants?: number | null;
|
|
2756
|
-
}
|
|
2757
|
-
interface ChargeMembershipsResponse {
|
|
2758
|
-
}
|
|
2759
|
-
interface TriggerRefundRequest {
|
|
2760
|
-
/**
|
|
2761
|
-
* The order this refund related to
|
|
2762
|
-
* @minLength 1
|
|
2763
|
-
* @maxLength 100
|
|
2764
|
-
*/
|
|
2765
|
-
ecomOrderId: string;
|
|
2766
|
-
/**
|
|
2767
|
-
* Refund operations information
|
|
2768
|
-
* @minSize 1
|
|
2769
|
-
* @maxSize 1
|
|
2770
|
-
*/
|
|
2771
|
-
payments: PaymentRefund[];
|
|
2772
|
-
/** Business model of a refund */
|
|
2773
|
-
details?: RefundDetails;
|
|
2774
|
-
/** Side effect details related to refund */
|
|
2775
|
-
sideEffects?: RefundSideEffects;
|
|
2776
|
-
}
|
|
2777
|
-
interface PaymentRefund {
|
|
2778
|
-
/**
|
|
2779
|
-
* Specific payment within the order to refund
|
|
2780
|
-
* @format GUID
|
|
2781
|
-
*/
|
|
2782
|
-
paymentId?: string;
|
|
2783
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
2784
|
-
amount?: Price;
|
|
2785
|
-
/**
|
|
2786
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
2787
|
-
* 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.
|
|
2788
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
2789
|
-
*/
|
|
2790
|
-
externalRefund?: boolean;
|
|
2791
|
-
}
|
|
2792
|
-
/** Business model of a refund request */
|
|
2793
|
-
interface RefundDetails {
|
|
2794
|
-
/**
|
|
2795
|
-
* Order line item IDs and quantities that were refunded.
|
|
2796
|
-
* @maxSize 300
|
|
2797
|
-
*/
|
|
2798
|
-
items?: RefundItem[];
|
|
2799
|
-
/** Whether the shipping fee was also refunded. */
|
|
2800
|
-
shippingIncluded?: boolean;
|
|
2801
|
-
/**
|
|
2802
|
-
* Reason for the refund, provided by customer (optional).
|
|
2803
|
-
* @maxLength 200
|
|
2804
|
-
*/
|
|
2805
|
-
reason?: string | null;
|
|
2806
|
-
/**
|
|
2807
|
-
* Line items that were refunded.
|
|
2808
|
-
* @maxSize 300
|
|
2809
|
-
*/
|
|
2810
|
-
lineItems?: LineItemRefund[];
|
|
2811
|
-
/**
|
|
2812
|
-
* Additional fees that were refunded.
|
|
2813
|
-
* @maxSize 100
|
|
2814
|
-
*/
|
|
2815
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
2816
|
-
/** Shipping amount that was refunded. */
|
|
2817
|
-
shipping?: ShippingRefund;
|
|
2818
|
-
}
|
|
2819
|
-
interface RefundItem {
|
|
2820
|
-
/**
|
|
2821
|
-
* Line item ID the refunded line item.
|
|
2822
|
-
* @format GUID
|
|
2823
|
-
*/
|
|
2824
|
-
lineItemId?: string;
|
|
2825
|
-
/**
|
|
2826
|
-
* Line item quantity refunded.
|
|
2827
|
-
* @min 1
|
|
2828
|
-
* @max 100000
|
|
2829
|
-
*/
|
|
2830
|
-
quantity?: number;
|
|
2831
|
-
}
|
|
2832
|
-
interface LineItemRefund {
|
|
2833
|
-
/**
|
|
2834
|
-
* Line item ID.
|
|
2835
|
-
* @format GUID
|
|
2836
|
-
* @immutable
|
|
2837
|
-
*/
|
|
2838
|
-
lineItemId?: string;
|
|
2839
|
-
/**
|
|
2840
|
-
* Refund quantity.
|
|
2841
|
-
* @min 1
|
|
2842
|
-
* @max 100000
|
|
2843
|
-
* @immutable
|
|
2844
|
-
*/
|
|
2845
|
-
quantity?: number;
|
|
2846
|
-
}
|
|
2847
|
-
interface AdditionalFeeRefund {
|
|
2848
|
-
/**
|
|
2849
|
-
* Additional fee ID.
|
|
2850
|
-
* @format GUID
|
|
2851
|
-
* @immutable
|
|
2852
|
-
*/
|
|
2853
|
-
additionalFeeId?: string;
|
|
2854
|
-
/**
|
|
2855
|
-
* Refund amount.
|
|
2856
|
-
* @immutable
|
|
2857
|
-
*/
|
|
2858
|
-
amount?: Price;
|
|
2859
|
-
}
|
|
2860
|
-
interface ShippingRefund {
|
|
2861
|
-
/**
|
|
2862
|
-
* Refund amount.
|
|
2863
|
-
* @immutable
|
|
2864
|
-
*/
|
|
2865
|
-
amount?: Price;
|
|
2866
|
-
}
|
|
2867
|
-
interface RefundSideEffects {
|
|
2868
|
-
/** Inventory restock details as part of this refund. */
|
|
2869
|
-
restockInfo?: RestockInfo;
|
|
2870
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
2871
|
-
sendOrderRefundedEmail?: boolean;
|
|
2872
|
-
/**
|
|
2873
|
-
* Custom message added to the refund confirmation email.
|
|
2874
|
-
* @minLength 1
|
|
2875
|
-
* @maxLength 1000
|
|
2876
|
-
*/
|
|
2877
|
-
customMessage?: string | null;
|
|
2878
|
-
}
|
|
2879
|
-
interface RestockInfo {
|
|
2880
|
-
/** Restock type. */
|
|
2881
|
-
type?: RestockTypeWithLiterals;
|
|
2882
|
-
/**
|
|
2883
|
-
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2884
|
-
* @maxSize 300
|
|
2885
|
-
*/
|
|
2886
|
-
items?: RestockItem[];
|
|
2887
|
-
}
|
|
2888
|
-
declare enum RestockType {
|
|
2889
|
-
NO_ITEMS = "NO_ITEMS",
|
|
2890
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
2891
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
2892
|
-
}
|
|
2893
|
-
/** @enumType */
|
|
2894
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2895
|
-
interface RestockItem {
|
|
2896
|
-
/**
|
|
2897
|
-
* ID of the line item being restocked.
|
|
2898
|
-
* @format GUID
|
|
2899
|
-
*/
|
|
2900
|
-
lineItemId?: string;
|
|
2901
|
-
/**
|
|
2902
|
-
* Line item quantity being restocked.
|
|
2903
|
-
* @min 1
|
|
2904
|
-
* @max 100000
|
|
2905
|
-
*/
|
|
2906
|
-
quantity?: number;
|
|
2907
|
-
}
|
|
2908
|
-
interface TriggerRefundResponse {
|
|
2909
|
-
/** All order's transactions after the refunds were added */
|
|
2910
|
-
orderTransactions?: OrderTransactions;
|
|
2911
|
-
/** Created refund ID */
|
|
2912
|
-
refundId?: string | null;
|
|
2913
|
-
/** Payment ID's that the refund execution had failed for */
|
|
2914
|
-
failedPaymentIds?: ItemMetadata[];
|
|
2915
|
-
}
|
|
2916
|
-
interface OrderTransactions {
|
|
2917
|
-
/**
|
|
2918
|
-
* Order ID.
|
|
2919
|
-
* @format GUID
|
|
2920
|
-
*/
|
|
2921
|
-
orderId?: string;
|
|
2922
|
-
/**
|
|
2923
|
-
* Record of payments made to the merchant.
|
|
2924
|
-
* @maxSize 100
|
|
2925
|
-
*/
|
|
2926
|
-
payments?: Payment[];
|
|
2927
|
-
/**
|
|
2928
|
-
* Record of refunds made to the buyer.
|
|
2929
|
-
* @maxSize 300
|
|
2930
|
-
*/
|
|
2931
|
-
refunds?: Refund[];
|
|
2932
|
-
}
|
|
2933
|
-
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2934
|
-
/** Regular payment details. */
|
|
2935
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2936
|
-
/** Gift card payment details. */
|
|
2937
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2938
|
-
/**
|
|
2939
|
-
* Payment ID.
|
|
2940
|
-
* @format GUID
|
|
2941
|
-
* @readonly
|
|
2942
|
-
*/
|
|
2943
|
-
_id?: string | null;
|
|
2944
|
-
/** 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. */
|
|
2945
|
-
_createdDate?: Date | null;
|
|
2946
|
-
/**
|
|
2947
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2948
|
-
* @readonly
|
|
2949
|
-
*/
|
|
2950
|
-
_updatedDate?: Date | null;
|
|
2951
|
-
/** Payment amount. */
|
|
2952
|
-
amount?: Price;
|
|
2953
|
-
/**
|
|
2954
|
-
* Whether refunds for this payment are disabled.
|
|
2955
|
-
* + `true`: This payment is not refundable.
|
|
2956
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2957
|
-
*/
|
|
2958
|
-
refundDisabled?: boolean;
|
|
2959
|
-
}
|
|
2960
|
-
/** @oneof */
|
|
2961
|
-
interface PaymentPaymentDetailsOneOf {
|
|
2962
|
-
/** Regular payment details. */
|
|
2963
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2964
|
-
/** Gift card payment details. */
|
|
2965
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2966
|
-
}
|
|
2967
|
-
/** @oneof */
|
|
2968
|
-
interface PaymentReceiptInfoOneOf {
|
|
2969
|
-
}
|
|
2970
|
-
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2971
|
-
/** Whether regular card used */
|
|
2972
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2973
|
-
/**
|
|
2974
|
-
* Wix Payments order ID.
|
|
2975
|
-
* @maxLength 100
|
|
2976
|
-
*/
|
|
2977
|
-
paymentOrderId?: string | null;
|
|
2978
|
-
/**
|
|
2979
|
-
* Payment gateway's transaction ID.
|
|
2980
|
-
* This field is only returned when the value of `offline_payment` is `false`.
|
|
2981
|
-
* @maxLength 100
|
|
2982
|
-
*/
|
|
2983
|
-
gatewayTransactionId?: string | null;
|
|
2984
|
-
/**
|
|
2985
|
-
* Payment method. Non-exhaustive list of supported values:
|
|
2986
|
-
* + `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`
|
|
2987
|
-
* @maxLength 100
|
|
2988
|
-
*/
|
|
2989
|
-
paymentMethod?: string | null;
|
|
2990
|
-
/**
|
|
2991
|
-
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
2992
|
-
* @maxLength 100
|
|
2993
|
-
*/
|
|
2994
|
-
providerTransactionId?: string | null;
|
|
2995
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
2996
|
-
offlinePayment?: boolean;
|
|
2997
|
-
/** Payment status. */
|
|
2998
|
-
status?: TransactionStatusWithLiterals;
|
|
2999
|
-
/**
|
|
3000
|
-
* Whether there is a payment agreement that allows for future charges.
|
|
3001
|
-
* @immutable
|
|
3002
|
-
*/
|
|
3003
|
-
savedPaymentMethod?: boolean;
|
|
3004
|
-
/** Authorization details. */
|
|
3005
|
-
authorizationDetails?: AuthorizationDetails;
|
|
3006
|
-
/**
|
|
3007
|
-
* Record of chargebacks made by the buyer.
|
|
3008
|
-
* @maxSize 6
|
|
3009
|
-
*/
|
|
3010
|
-
chargebacks?: Chargeback[];
|
|
3011
|
-
}
|
|
3012
|
-
/** @oneof */
|
|
3013
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3014
|
-
/** Whether regular card used */
|
|
3015
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3016
|
-
}
|
|
3017
|
-
declare enum TransactionStatus {
|
|
3018
|
-
UNDEFINED = "UNDEFINED",
|
|
3019
|
-
APPROVED = "APPROVED",
|
|
3020
|
-
PENDING = "PENDING",
|
|
3021
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3022
|
-
CANCELED = "CANCELED",
|
|
3023
|
-
DECLINED = "DECLINED",
|
|
3024
|
-
REFUNDED = "REFUNDED",
|
|
3025
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3026
|
-
AUTHORIZED = "AUTHORIZED",
|
|
3027
|
-
VOIDED = "VOIDED"
|
|
3028
|
-
}
|
|
3029
|
-
/** @enumType */
|
|
3030
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3031
|
-
interface CreditCardPaymentMethodDetails {
|
|
3032
|
-
/**
|
|
3033
|
-
* The last 4 digits of the card number.
|
|
3034
|
-
* @maxLength 4
|
|
3035
|
-
*/
|
|
3036
|
-
lastFourDigits?: string | null;
|
|
3037
|
-
/**
|
|
3038
|
-
* Card issuer's brand.
|
|
3039
|
-
* @maxLength 100
|
|
3040
|
-
*/
|
|
3041
|
-
brand?: string | null;
|
|
3042
|
-
}
|
|
3043
|
-
interface AuthorizationDetails {
|
|
3044
|
-
/**
|
|
3045
|
-
* Whether the authorized payment is of a delayed capture.
|
|
3046
|
-
* @readonly
|
|
3047
|
-
*/
|
|
3048
|
-
delayedCapture?: boolean;
|
|
3049
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3050
|
-
authorizedDate?: Date | null;
|
|
3051
|
-
/**
|
|
3052
|
-
* List of captures associated with payment
|
|
3053
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3054
|
-
* @maxSize 1
|
|
3055
|
-
*/
|
|
3056
|
-
captures?: AuthorizationCapture[];
|
|
3057
|
-
/** Void associated with payment */
|
|
3058
|
-
void?: AuthorizationVoid;
|
|
3059
|
-
/** Scheduled action for this transaction */
|
|
3060
|
-
scheduledAction?: V1ScheduledAction;
|
|
3061
|
-
}
|
|
3062
|
-
interface AuthorizationCapture {
|
|
3063
|
-
/**
|
|
3064
|
-
* Capture ID.
|
|
3065
|
-
* @format GUID
|
|
3066
|
-
* @readonly
|
|
3067
|
-
*/
|
|
3068
|
-
_id?: string | null;
|
|
3069
|
-
/** Status of this capture action */
|
|
3070
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3071
|
-
/**
|
|
3072
|
-
* Amount of this capture
|
|
3073
|
-
* @immutable
|
|
3074
|
-
*/
|
|
3075
|
-
amount?: Price;
|
|
3076
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3077
|
-
_createdDate?: Date | null;
|
|
3078
|
-
/** In case of status is FAILED may contain failure details */
|
|
3079
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3080
|
-
}
|
|
3081
|
-
declare enum AuthorizationCaptureStatus {
|
|
3082
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3083
|
-
/** Capture operation still in progress. */
|
|
3084
|
-
PENDING = "PENDING",
|
|
3085
|
-
/** Capture operation succeeded. */
|
|
3086
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3087
|
-
/** Capture operation failed. */
|
|
3088
|
-
FAILED = "FAILED"
|
|
3089
|
-
}
|
|
3090
|
-
/** @enumType */
|
|
3091
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3092
|
-
interface AuthorizationActionFailureDetails {
|
|
3093
|
-
/** @maxLength 100 */
|
|
3094
|
-
failureCode?: string;
|
|
3095
|
-
}
|
|
3096
|
-
interface AuthorizationVoid {
|
|
3097
|
-
/** Status of this void action */
|
|
3098
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
3099
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3100
|
-
voidedDate?: Date | null;
|
|
3101
|
-
/** In case of status is FAILED may contain failure details */
|
|
3102
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3103
|
-
/** Reason of void action */
|
|
3104
|
-
reason?: ReasonWithLiterals;
|
|
3105
|
-
}
|
|
3106
|
-
declare enum AuthorizationVoidStatus {
|
|
3107
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3108
|
-
/** Void operation still in progress. */
|
|
3109
|
-
PENDING = "PENDING",
|
|
3110
|
-
/** Void operation succeeded. */
|
|
3111
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3112
|
-
/** Void operation failed. */
|
|
3113
|
-
FAILED = "FAILED"
|
|
3114
|
-
}
|
|
3115
|
-
/** @enumType */
|
|
3116
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3117
|
-
/** Reason the authorization was voided. */
|
|
3118
|
-
declare enum Reason {
|
|
3119
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3120
|
-
/** Authorization was voided by user. */
|
|
3121
|
-
MANUAL = "MANUAL",
|
|
3122
|
-
/** Authorization passed execution date. */
|
|
3123
|
-
SCHEDULED = "SCHEDULED"
|
|
3124
|
-
}
|
|
3125
|
-
/** @enumType */
|
|
3126
|
-
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3127
|
-
interface V1ScheduledAction {
|
|
3128
|
-
/** Type of the action. */
|
|
3129
|
-
actionType?: ActionTypeWithLiterals;
|
|
3130
|
-
/** The date and time of the action. */
|
|
3131
|
-
executionDate?: Date | null;
|
|
3132
|
-
}
|
|
3133
|
-
declare enum ActionType {
|
|
3134
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3135
|
-
VOID = "VOID",
|
|
3136
|
-
CAPTURE = "CAPTURE"
|
|
3137
|
-
}
|
|
3138
|
-
/** @enumType */
|
|
3139
|
-
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3140
|
-
interface Chargeback {
|
|
3141
|
-
/**
|
|
3142
|
-
* Chargeback ID.
|
|
3143
|
-
* @format GUID
|
|
3144
|
-
* @readonly
|
|
3145
|
-
* @immutable
|
|
3146
|
-
*/
|
|
3147
|
-
_id?: string;
|
|
3148
|
-
/**
|
|
3149
|
-
* 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.
|
|
3150
|
-
* @readonly
|
|
3151
|
-
* @immutable
|
|
3152
|
-
*/
|
|
3153
|
-
_createdDate?: Date | null;
|
|
3154
|
-
/**
|
|
3155
|
-
* 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.
|
|
3156
|
-
* @readonly
|
|
3157
|
-
*/
|
|
3158
|
-
_updatedDate?: Date | null;
|
|
3159
|
-
/**
|
|
3160
|
-
* Amount.
|
|
3161
|
-
* @readonly
|
|
3162
|
-
* @immutable
|
|
3163
|
-
*/
|
|
3164
|
-
amount?: Price;
|
|
3165
|
-
/**
|
|
3166
|
-
* Reversal amount. Present only when status is REVERSED.
|
|
3167
|
-
* @readonly
|
|
3168
|
-
*/
|
|
3169
|
-
reversalAmount?: Price;
|
|
3170
|
-
/**
|
|
3171
|
-
* Status.
|
|
3172
|
-
*
|
|
3173
|
-
* Default: `"APPROVED"`.
|
|
3174
|
-
*/
|
|
3175
|
-
status?: ChargebackStatusWithLiterals;
|
|
3176
|
-
/**
|
|
3177
|
-
* External chargeback ID.
|
|
3178
|
-
* @format GUID
|
|
3179
|
-
* @readonly
|
|
3180
|
-
* @immutable
|
|
3181
|
-
*/
|
|
3182
|
-
externalId?: string | null;
|
|
3183
|
-
}
|
|
3184
|
-
declare enum ChargebackStatus {
|
|
3185
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
3186
|
-
/** Chargeback was approved. */
|
|
3187
|
-
APPROVED = "APPROVED",
|
|
3188
|
-
/** Chargeback was reversed. */
|
|
3189
|
-
REVERSED = "REVERSED"
|
|
3190
|
-
}
|
|
3191
|
-
/** @enumType */
|
|
3192
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3193
|
-
interface GiftCardPaymentDetails {
|
|
3194
|
-
/**
|
|
3195
|
-
* Gift card payment ID.
|
|
3196
|
-
* @minLength 1
|
|
3197
|
-
* @maxLength 100
|
|
3198
|
-
*/
|
|
3199
|
-
giftCardPaymentId?: string;
|
|
3200
|
-
/**
|
|
3201
|
-
* ID of the app that created the gift card.
|
|
3202
|
-
* @format GUID
|
|
3203
|
-
*/
|
|
3204
|
-
appId?: string;
|
|
3205
|
-
/**
|
|
3206
|
-
* Whether the gift card is voided.
|
|
3207
|
-
* @readonly
|
|
3208
|
-
*/
|
|
3209
|
-
voided?: boolean;
|
|
3210
|
-
}
|
|
3211
|
-
interface MembershipPaymentDetails {
|
|
3212
|
-
/**
|
|
3213
|
-
* Membership ID.
|
|
3214
|
-
* @minLength 1
|
|
3215
|
-
* @maxLength 100
|
|
3216
|
-
*/
|
|
3217
|
-
membershipId?: string;
|
|
3218
|
-
/**
|
|
3219
|
-
* ID of the line item this membership applies to.
|
|
3220
|
-
* @minLength 1
|
|
3221
|
-
* @maxLength 100
|
|
3222
|
-
*/
|
|
3223
|
-
lineItemId?: string;
|
|
3224
|
-
/** Payment status. */
|
|
3225
|
-
status?: MembershipPaymentStatusWithLiterals;
|
|
3226
|
-
/** Membership name. */
|
|
3227
|
-
name?: MembershipName;
|
|
3228
|
-
/**
|
|
3229
|
-
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3230
|
-
* @minLength 1
|
|
3231
|
-
* @maxLength 100
|
|
3232
|
-
*/
|
|
3233
|
-
externalTransactionId?: string | null;
|
|
3234
|
-
/**
|
|
3235
|
-
* Whether the membership is voided.
|
|
3236
|
-
* @readonly
|
|
3237
|
-
*/
|
|
3238
|
-
voided?: boolean;
|
|
3239
|
-
/**
|
|
3240
|
-
* ID of the application providing this payment option.
|
|
3241
|
-
* @format GUID
|
|
3242
|
-
*/
|
|
3243
|
-
providerAppId?: string;
|
|
3244
|
-
}
|
|
3245
|
-
declare enum MembershipPaymentStatus {
|
|
3246
|
-
/** Payment was charged. */
|
|
3247
|
-
CHARGED = "CHARGED",
|
|
3248
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3249
|
-
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3250
|
-
}
|
|
3251
|
-
/** @enumType */
|
|
3252
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3253
|
-
interface WixReceiptInfo {
|
|
3254
|
-
/**
|
|
3255
|
-
* Receipt ID
|
|
3256
|
-
* @format GUID
|
|
3257
|
-
*/
|
|
3258
|
-
receiptId?: string;
|
|
3259
|
-
/**
|
|
3260
|
-
* Display number of receipt
|
|
3261
|
-
* @minLength 1
|
|
3262
|
-
* @maxLength 40
|
|
3263
|
-
*/
|
|
3264
|
-
displayNumber?: string | null;
|
|
3265
|
-
}
|
|
3266
|
-
interface ExternalReceiptInfo {
|
|
3267
|
-
/**
|
|
3268
|
-
* External receipt ID
|
|
3269
|
-
* @maxLength 100
|
|
3270
|
-
*/
|
|
3271
|
-
receiptId?: string | null;
|
|
3272
|
-
/**
|
|
3273
|
-
* ID of the app providing the receipt
|
|
3274
|
-
* @format GUID
|
|
3275
|
-
*/
|
|
3276
|
-
appId?: string | null;
|
|
3277
|
-
/**
|
|
3278
|
-
* Display number of receipt
|
|
3279
|
-
* @minLength 1
|
|
3280
|
-
* @maxLength 40
|
|
3281
|
-
*/
|
|
3282
|
-
displayNumber?: string | null;
|
|
3283
|
-
}
|
|
3284
|
-
interface Refund {
|
|
3285
|
-
/**
|
|
3286
|
-
* Refund ID.
|
|
3287
|
-
* @format GUID
|
|
3288
|
-
* @readonly
|
|
3289
|
-
*/
|
|
3290
|
-
_id?: string;
|
|
3291
|
-
/**
|
|
3292
|
-
* List of transactions.
|
|
3293
|
-
* @maxSize 50
|
|
3294
|
-
*/
|
|
3295
|
-
transactions?: RefundTransaction[];
|
|
3296
|
-
/** Refund business details. */
|
|
3297
|
-
details?: RefundDetails;
|
|
3298
|
-
/**
|
|
3299
|
-
* 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.
|
|
3300
|
-
* @readonly
|
|
3301
|
-
* @immutable
|
|
3302
|
-
*/
|
|
3303
|
-
_createdDate?: Date | null;
|
|
3304
|
-
/**
|
|
3305
|
-
* Aggregated refund summary.
|
|
3306
|
-
* @readonly
|
|
3307
|
-
*/
|
|
3308
|
-
summary?: AggregatedRefundSummary;
|
|
3309
|
-
/**
|
|
3310
|
-
* ID of the app that initiated this refund.
|
|
3311
|
-
* @format GUID
|
|
3312
|
-
* @readonly
|
|
3313
|
-
* @immutable
|
|
3314
|
-
*/
|
|
3315
|
-
requestingServiceAppId?: string | null;
|
|
3316
|
-
}
|
|
3317
|
-
interface RefundTransaction {
|
|
3318
|
-
/**
|
|
3319
|
-
* ID of the payment associated with this refund.
|
|
3320
|
-
* @format GUID
|
|
3321
|
-
* @immutable
|
|
3322
|
-
*/
|
|
3323
|
-
paymentId?: string;
|
|
3324
|
-
/**
|
|
3325
|
-
* Refund amount.
|
|
3326
|
-
* @immutable
|
|
3327
|
-
*/
|
|
3328
|
-
amount?: Price;
|
|
3329
|
-
/** Refund status. */
|
|
3330
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
3331
|
-
/** Optional details of current refund status. */
|
|
3332
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
3333
|
-
/**
|
|
3334
|
-
* Payment gateway's refund ID.
|
|
3335
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
3336
|
-
* @format GUID
|
|
3337
|
-
*/
|
|
3338
|
-
gatewayRefundId?: string | null;
|
|
3339
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3340
|
-
providerRefundId?: string | null;
|
|
3341
|
-
/**
|
|
3342
|
-
* Whether refund was made externally and manually on the payment provider's side.
|
|
3343
|
-
* @immutable
|
|
3344
|
-
*/
|
|
3345
|
-
externalRefund?: boolean;
|
|
3346
|
-
}
|
|
3347
|
-
/** Refund transaction status. */
|
|
3348
|
-
declare enum RefundStatus {
|
|
3349
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3350
|
-
PENDING = "PENDING",
|
|
3351
|
-
/** Refund transaction succeeded. */
|
|
3352
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3353
|
-
/** Refund transaction failed. */
|
|
3354
|
-
FAILED = "FAILED",
|
|
3355
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
3356
|
-
SCHEDULED = "SCHEDULED",
|
|
3357
|
-
/** Refund was initiated on payment provider side. */
|
|
3358
|
-
STARTED = "STARTED"
|
|
3359
|
-
}
|
|
3360
|
-
/** @enumType */
|
|
3361
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3362
|
-
interface RefundStatusInfo {
|
|
3363
|
-
/**
|
|
3364
|
-
* Reason code for the refund's current status.
|
|
3365
|
-
*
|
|
3366
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3367
|
-
* @minLength 1
|
|
3368
|
-
* @maxLength 10
|
|
3369
|
-
*/
|
|
3370
|
-
paymentGatewayReasonCode?: string | null;
|
|
3371
|
-
/**
|
|
3372
|
-
* Free text explanation of current refund status.
|
|
3373
|
-
* @minLength 1
|
|
3374
|
-
* @maxLength 1000
|
|
3375
|
-
*/
|
|
3376
|
-
description?: string | null;
|
|
3377
|
-
}
|
|
3378
|
-
interface AggregatedRefundSummary {
|
|
3379
|
-
/** Total amount requested for refund. */
|
|
3380
|
-
requestedRefund?: Price;
|
|
3381
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3382
|
-
pendingRefund?: Price;
|
|
3383
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3384
|
-
refunded?: Price;
|
|
3385
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3386
|
-
failedRefundAmount?: Price;
|
|
3387
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
3388
|
-
pending?: boolean;
|
|
3389
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3390
|
-
breakdown?: RefundItemsBreakdown;
|
|
3391
|
-
}
|
|
3392
|
-
interface RefundItemsBreakdown {
|
|
3393
|
-
/**
|
|
3394
|
-
* Refunded line items and the amount refunded for each.
|
|
3395
|
-
* @maxSize 300
|
|
3396
|
-
*/
|
|
3397
|
-
lineItems?: LineItemRefundSummary[];
|
|
3398
|
-
}
|
|
3399
|
-
interface LineItemRefundSummary {
|
|
3400
|
-
/**
|
|
3401
|
-
* ID of the refunded line item.
|
|
3402
|
-
* @format GUID
|
|
3403
|
-
*/
|
|
3404
|
-
lineItemId?: string;
|
|
3405
|
-
/** Total refunded amount for the line item. */
|
|
3406
|
-
totalRefundedAmount?: Price;
|
|
3407
|
-
}
|
|
3408
|
-
interface CalculateRefundRequest {
|
|
3409
|
-
/**
|
|
3410
|
-
* Order ID
|
|
3411
|
-
* @minLength 1
|
|
3412
|
-
* @maxLength 100
|
|
3413
|
-
*/
|
|
3414
|
-
ecomOrderId?: string;
|
|
3415
|
-
/**
|
|
3416
|
-
* Refunded line items and quantity
|
|
3417
|
-
* @maxSize 300
|
|
3418
|
-
*/
|
|
3419
|
-
refundItems?: CalculateRefundItemRequest[];
|
|
3420
|
-
/** Should include shipping in refund calculation */
|
|
3421
|
-
refundShipping?: boolean;
|
|
3422
|
-
}
|
|
3423
|
-
interface CalculateRefundItemRequest {
|
|
3424
|
-
/**
|
|
3425
|
-
* ID of the line item being refunded
|
|
3426
|
-
* @format GUID
|
|
3427
|
-
*/
|
|
3428
|
-
_id?: string;
|
|
3429
|
-
/**
|
|
3430
|
-
* How much of that line item is being refunded
|
|
3431
|
-
* @min 1
|
|
3432
|
-
* @max 100000
|
|
3433
|
-
*/
|
|
3434
|
-
quantity?: number;
|
|
3435
|
-
}
|
|
3436
|
-
interface CalculateRefundResponse {
|
|
3437
|
-
/** Total refundable amount */
|
|
3438
|
-
total?: Price;
|
|
3439
|
-
/** Tax cost of the order */
|
|
3440
|
-
tax?: Price;
|
|
3441
|
-
/** Discount given for this order */
|
|
3442
|
-
discount?: Price;
|
|
3443
|
-
/** Total cost of the order (without tax) */
|
|
3444
|
-
subtotal?: Price;
|
|
3445
|
-
/** Total shipping cost for order */
|
|
3446
|
-
shipping?: Price;
|
|
3447
|
-
/** Previous refund given on that order */
|
|
3448
|
-
previouslyRefundedAmount?: Price;
|
|
3449
|
-
/**
|
|
3450
|
-
* The refundable items of that order
|
|
3451
|
-
* @maxSize 300
|
|
3452
|
-
*/
|
|
3453
|
-
items?: CalculateRefundItemResponse[];
|
|
3454
|
-
}
|
|
3455
|
-
interface CalculateRefundItemResponse {
|
|
3456
|
-
/**
|
|
3457
|
-
* Line item ID
|
|
3458
|
-
* @format GUID
|
|
3459
|
-
*/
|
|
3460
|
-
_id?: string;
|
|
3461
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3462
|
-
price?: Price;
|
|
3463
|
-
}
|
|
3464
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
3465
|
-
/**
|
|
3466
|
-
* Wix eCommerce order ID
|
|
3467
|
-
* @minLength 1
|
|
3468
|
-
* @maxLength 100
|
|
3469
|
-
*/
|
|
3470
|
-
ecomOrderId: string;
|
|
3471
|
-
/**
|
|
3472
|
-
* Payment IDs
|
|
3473
|
-
* @minSize 1
|
|
3474
|
-
* @maxSize 100
|
|
3475
|
-
* @format GUID
|
|
3476
|
-
*/
|
|
3477
|
-
paymentIds: string[];
|
|
3478
|
-
}
|
|
3479
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
3480
|
-
/** All order's transactions after the void was triggered */
|
|
3481
|
-
orderTransactions?: OrderTransactions;
|
|
3482
|
-
}
|
|
3483
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
3484
|
-
/**
|
|
3485
|
-
* Wix eCommerce order ID
|
|
3486
|
-
* @minLength 1
|
|
3487
|
-
* @maxLength 100
|
|
3488
|
-
*/
|
|
3489
|
-
ecomOrderId: string;
|
|
3490
|
-
/**
|
|
3491
|
-
* Capture payments information
|
|
3492
|
-
* @minSize 1
|
|
3493
|
-
* @maxSize 100
|
|
3494
|
-
*/
|
|
3495
|
-
payments: PaymentCapture[];
|
|
3496
|
-
}
|
|
3497
|
-
interface PaymentCapture {
|
|
3498
|
-
/**
|
|
3499
|
-
* Payment ID
|
|
3500
|
-
* @format GUID
|
|
3501
|
-
*/
|
|
3502
|
-
paymentId?: string | null;
|
|
3503
|
-
/**
|
|
3504
|
-
* Capture amount.
|
|
3505
|
-
* If not provided - full authorized amount will be captured.
|
|
3506
|
-
*/
|
|
3507
|
-
amount?: Price;
|
|
3508
|
-
}
|
|
3509
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
3510
|
-
/** All order's transactions after the capture was triggered */
|
|
3511
|
-
orderTransactions?: OrderTransactions;
|
|
3512
|
-
}
|
|
3513
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
3514
|
-
/**
|
|
3515
|
-
* Ecom Order ID.
|
|
3516
|
-
* @minLength 1
|
|
3517
|
-
* @maxLength 100
|
|
3518
|
-
*/
|
|
3519
|
-
ecomOrderId?: string;
|
|
3520
|
-
/** Amount to be charged */
|
|
3521
|
-
amount?: Price;
|
|
3522
|
-
}
|
|
3523
|
-
interface ChargeSavedPaymentMethodResponse {
|
|
3524
|
-
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3525
|
-
paymentGatewayOrderId?: string;
|
|
3526
|
-
}
|
|
3527
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3528
|
-
createdEvent?: EntityCreatedEvent;
|
|
3529
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3530
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3531
|
-
actionEvent?: ActionEvent;
|
|
3532
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3533
|
-
_id?: string;
|
|
3534
|
-
/**
|
|
3535
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3536
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3537
|
-
*/
|
|
3538
|
-
entityFqdn?: string;
|
|
3539
|
-
/**
|
|
3540
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3541
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2756
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2757
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3542
2758
|
*/
|
|
3543
2759
|
slug?: string;
|
|
3544
2760
|
/** ID of the entity associated with the event. */
|
|
@@ -3588,6 +2804,19 @@ interface ActionEvent {
|
|
|
3588
2804
|
}
|
|
3589
2805
|
interface Empty {
|
|
3590
2806
|
}
|
|
2807
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
2808
|
+
/** @maxSize 25 */
|
|
2809
|
+
requests?: TriggerReindexOrderRequest[];
|
|
2810
|
+
}
|
|
2811
|
+
interface TriggerReindexOrderRequest {
|
|
2812
|
+
/** @format GUID */
|
|
2813
|
+
metasiteId?: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* @minLength 1
|
|
2816
|
+
* @maxLength 100
|
|
2817
|
+
*/
|
|
2818
|
+
orderId?: string;
|
|
2819
|
+
}
|
|
3591
2820
|
interface MessageEnvelope {
|
|
3592
2821
|
/**
|
|
3593
2822
|
* App instance ID.
|
|
@@ -3660,166 +2889,6 @@ declare enum WebhookIdentityType {
|
|
|
3660
2889
|
}
|
|
3661
2890
|
/** @enumType */
|
|
3662
2891
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3663
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
3664
|
-
/** insert/update documents */
|
|
3665
|
-
update?: InternalDocumentUpdateOperation;
|
|
3666
|
-
/** delete by document ids */
|
|
3667
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
3668
|
-
/** delete documents matching filter */
|
|
3669
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
3670
|
-
/** update internal documents matching filter */
|
|
3671
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3672
|
-
/** update only existing documents */
|
|
3673
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
3674
|
-
/** insert/update documents with versioning */
|
|
3675
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3676
|
-
/** delete by document ids with versioning */
|
|
3677
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3678
|
-
/**
|
|
3679
|
-
* type of the documents
|
|
3680
|
-
* @minLength 2
|
|
3681
|
-
*/
|
|
3682
|
-
documentType?: string;
|
|
3683
|
-
/**
|
|
3684
|
-
* language of the documents (mandatory)
|
|
3685
|
-
* @minLength 2
|
|
3686
|
-
*/
|
|
3687
|
-
language?: string | null;
|
|
3688
|
-
/**
|
|
3689
|
-
* one or more search documents
|
|
3690
|
-
* @deprecated
|
|
3691
|
-
*/
|
|
3692
|
-
addDocuments?: InternalDocument[];
|
|
3693
|
-
/**
|
|
3694
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
3695
|
-
* @deprecated
|
|
3696
|
-
*/
|
|
3697
|
-
removeDocumentIds?: string[];
|
|
3698
|
-
/** id to pass to processing notification */
|
|
3699
|
-
correlationId?: string | null;
|
|
3700
|
-
/** when event was created / issued */
|
|
3701
|
-
issuedAt?: Date | null;
|
|
3702
|
-
}
|
|
3703
|
-
/** @oneof */
|
|
3704
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
3705
|
-
/** insert/update documents */
|
|
3706
|
-
update?: InternalDocumentUpdateOperation;
|
|
3707
|
-
/** delete by document ids */
|
|
3708
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
3709
|
-
/** delete documents matching filter */
|
|
3710
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
3711
|
-
/** update internal documents matching filter */
|
|
3712
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3713
|
-
/** update only existing documents */
|
|
3714
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
3715
|
-
/** insert/update documents with versioning */
|
|
3716
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3717
|
-
/** delete by document ids with versioning */
|
|
3718
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3719
|
-
}
|
|
3720
|
-
interface InternalDocument {
|
|
3721
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
3722
|
-
document?: Record<string, any> | null;
|
|
3723
|
-
}
|
|
3724
|
-
interface InternalDocumentUpdateOperation {
|
|
3725
|
-
/** documents to index or update */
|
|
3726
|
-
documents?: InternalDocument[];
|
|
3727
|
-
}
|
|
3728
|
-
interface DeleteByIdsOperation {
|
|
3729
|
-
/** ids of the documents to delete */
|
|
3730
|
-
documentIds?: string[];
|
|
3731
|
-
/**
|
|
3732
|
-
* tenant id for custom tenancy strategy
|
|
3733
|
-
* @minLength 2
|
|
3734
|
-
* @maxLength 300
|
|
3735
|
-
*/
|
|
3736
|
-
tenantId?: string | null;
|
|
3737
|
-
}
|
|
3738
|
-
interface DeleteByFilterOperation {
|
|
3739
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
3740
|
-
filter?: Record<string, any> | null;
|
|
3741
|
-
/**
|
|
3742
|
-
* tenant id for custom tenancy strategy
|
|
3743
|
-
* @minLength 2
|
|
3744
|
-
* @maxLength 300
|
|
3745
|
-
*/
|
|
3746
|
-
tenantId?: string | null;
|
|
3747
|
-
}
|
|
3748
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
3749
|
-
/** documents matching this filter will be updated */
|
|
3750
|
-
filter?: Record<string, any> | null;
|
|
3751
|
-
/** partial document to apply */
|
|
3752
|
-
document?: InternalDocument;
|
|
3753
|
-
/**
|
|
3754
|
-
* tenant id for custom tenancy strategy
|
|
3755
|
-
* @minLength 2
|
|
3756
|
-
* @maxLength 300
|
|
3757
|
-
*/
|
|
3758
|
-
tenantId?: string | null;
|
|
3759
|
-
}
|
|
3760
|
-
interface InternalUpdateExistingOperation {
|
|
3761
|
-
/** documents to update */
|
|
3762
|
-
documents?: InternalDocument[];
|
|
3763
|
-
}
|
|
3764
|
-
interface VersionedDocumentUpdateOperation {
|
|
3765
|
-
/** documents to create or overwrite */
|
|
3766
|
-
documents?: InternalDocument[];
|
|
3767
|
-
/** versioning mode to use instead of default */
|
|
3768
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
3769
|
-
}
|
|
3770
|
-
declare enum VersioningMode {
|
|
3771
|
-
/** use default versioning mode agreed with search team */
|
|
3772
|
-
DEFAULT = "DEFAULT",
|
|
3773
|
-
/** execute only if version is greater than existing */
|
|
3774
|
-
GREATER_THAN = "GREATER_THAN",
|
|
3775
|
-
/** execute only if version is greater or equal to existing */
|
|
3776
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
3777
|
-
}
|
|
3778
|
-
/** @enumType */
|
|
3779
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
3780
|
-
interface VersionedDeleteByIdsOperation {
|
|
3781
|
-
/** ids with version of the documents to delete */
|
|
3782
|
-
documentIds?: VersionedDocumentId[];
|
|
3783
|
-
/**
|
|
3784
|
-
* tenant id for custom tenancy strategy
|
|
3785
|
-
* @minLength 2
|
|
3786
|
-
* @maxLength 300
|
|
3787
|
-
*/
|
|
3788
|
-
tenantId?: string | null;
|
|
3789
|
-
}
|
|
3790
|
-
interface VersionedDocumentId {
|
|
3791
|
-
/** document id */
|
|
3792
|
-
documentId?: string;
|
|
3793
|
-
/** document version */
|
|
3794
|
-
version?: string;
|
|
3795
|
-
/** versioning mode to use instead of default */
|
|
3796
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
3797
|
-
}
|
|
3798
|
-
interface TriggerReindexRequest {
|
|
3799
|
-
/** @format GUID */
|
|
3800
|
-
metasiteId?: string;
|
|
3801
|
-
/**
|
|
3802
|
-
* @minLength 1
|
|
3803
|
-
* @maxLength 100
|
|
3804
|
-
* @maxSize 100
|
|
3805
|
-
*/
|
|
3806
|
-
orderIds?: string[];
|
|
3807
|
-
}
|
|
3808
|
-
interface TriggerReindexResponse {
|
|
3809
|
-
}
|
|
3810
|
-
interface BatchOfTriggerReindexOrderRequest {
|
|
3811
|
-
/** @maxSize 25 */
|
|
3812
|
-
requests?: TriggerReindexOrderRequest[];
|
|
3813
|
-
}
|
|
3814
|
-
interface TriggerReindexOrderRequest {
|
|
3815
|
-
/** @format GUID */
|
|
3816
|
-
metasiteId?: string;
|
|
3817
|
-
/**
|
|
3818
|
-
* @minLength 1
|
|
3819
|
-
* @maxLength 100
|
|
3820
|
-
*/
|
|
3821
|
-
orderId?: string;
|
|
3822
|
-
}
|
|
3823
2892
|
interface DiffmatokyPayload {
|
|
3824
2893
|
left?: string;
|
|
3825
2894
|
right?: string;
|
|
@@ -4087,6 +3156,42 @@ interface BulkUpdateOrdersResponse {
|
|
|
4087
3156
|
/** Bulk action metadata. */
|
|
4088
3157
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4089
3158
|
}
|
|
3159
|
+
interface BulkOrderResult {
|
|
3160
|
+
/** Item metadata. */
|
|
3161
|
+
itemMetadata?: ItemMetadata;
|
|
3162
|
+
/**
|
|
3163
|
+
* Updated order.
|
|
3164
|
+
*
|
|
3165
|
+
* Returned when `returnFullEntity = true`.
|
|
3166
|
+
*/
|
|
3167
|
+
item?: Order;
|
|
3168
|
+
}
|
|
3169
|
+
interface ItemMetadata {
|
|
3170
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3171
|
+
_id?: string | null;
|
|
3172
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3173
|
+
originalIndex?: number;
|
|
3174
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3175
|
+
success?: boolean;
|
|
3176
|
+
/** Details about the error in case of failure. */
|
|
3177
|
+
error?: ApplicationError;
|
|
3178
|
+
}
|
|
3179
|
+
interface ApplicationError {
|
|
3180
|
+
/** Error code. */
|
|
3181
|
+
code?: string;
|
|
3182
|
+
/** Description of the error. */
|
|
3183
|
+
description?: string;
|
|
3184
|
+
/** Data related to the error. */
|
|
3185
|
+
data?: Record<string, any> | null;
|
|
3186
|
+
}
|
|
3187
|
+
interface BulkActionMetadata {
|
|
3188
|
+
/** Number of items that were successfully processed. */
|
|
3189
|
+
totalSuccesses?: number;
|
|
3190
|
+
/** Number of items that couldn't be processed. */
|
|
3191
|
+
totalFailures?: number;
|
|
3192
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3193
|
+
undetailedFailures?: number;
|
|
3194
|
+
}
|
|
4090
3195
|
interface CommitDeltasRequest {
|
|
4091
3196
|
/** Order id to be updated */
|
|
4092
3197
|
_id: string;
|
|
@@ -4111,6 +3216,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
4111
3216
|
changedShippingInfo?: V1ShippingInformation;
|
|
4112
3217
|
/** Remove existing shipping info. */
|
|
4113
3218
|
shippingInfoRemoved?: boolean;
|
|
3219
|
+
/**
|
|
3220
|
+
* Buyer info and selected buyer option details.
|
|
3221
|
+
* @internal
|
|
3222
|
+
*/
|
|
3223
|
+
changedBuyerInfo?: BuyerInfo;
|
|
3224
|
+
/**
|
|
3225
|
+
* Remove existing buyer info.
|
|
3226
|
+
* @internal
|
|
3227
|
+
*/
|
|
3228
|
+
buyerInfoRemoved?: boolean;
|
|
3229
|
+
/**
|
|
3230
|
+
* Updated billing info.
|
|
3231
|
+
* @internal
|
|
3232
|
+
*/
|
|
3233
|
+
changedBillingInfo?: AddressWithContact;
|
|
3234
|
+
/**
|
|
3235
|
+
* Remove existing billing info.
|
|
3236
|
+
* @internal
|
|
3237
|
+
*/
|
|
3238
|
+
billingInfoRemoved?: boolean;
|
|
3239
|
+
/**
|
|
3240
|
+
* Updated recipient info.
|
|
3241
|
+
* @internal
|
|
3242
|
+
*/
|
|
3243
|
+
changedRecipientInfo?: AddressWithContact;
|
|
3244
|
+
/**
|
|
3245
|
+
* Remove existing recipient info.
|
|
3246
|
+
* @internal
|
|
3247
|
+
*/
|
|
3248
|
+
recipientInfoRemoved?: boolean;
|
|
4114
3249
|
/**
|
|
4115
3250
|
* Added/updated/removed order line items.
|
|
4116
3251
|
* @maxSize 300
|
|
@@ -4152,12 +3287,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
4152
3287
|
}
|
|
4153
3288
|
/** @oneof */
|
|
4154
3289
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
3290
|
+
/**
|
|
3291
|
+
* Buyer info and selected buyer option details.
|
|
3292
|
+
* @internal
|
|
3293
|
+
*/
|
|
3294
|
+
changedBuyerInfo?: BuyerInfo;
|
|
3295
|
+
/**
|
|
3296
|
+
* Remove existing buyer info.
|
|
3297
|
+
* @internal
|
|
3298
|
+
*/
|
|
3299
|
+
buyerInfoRemoved?: boolean;
|
|
4155
3300
|
}
|
|
4156
3301
|
/** @oneof */
|
|
4157
3302
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
3303
|
+
/**
|
|
3304
|
+
* Updated billing info.
|
|
3305
|
+
* @internal
|
|
3306
|
+
*/
|
|
3307
|
+
changedBillingInfo?: AddressWithContact;
|
|
3308
|
+
/**
|
|
3309
|
+
* Remove existing billing info.
|
|
3310
|
+
* @internal
|
|
3311
|
+
*/
|
|
3312
|
+
billingInfoRemoved?: boolean;
|
|
4158
3313
|
}
|
|
4159
3314
|
/** @oneof */
|
|
4160
3315
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
3316
|
+
/**
|
|
3317
|
+
* Updated recipient info.
|
|
3318
|
+
* @internal
|
|
3319
|
+
*/
|
|
3320
|
+
changedRecipientInfo?: AddressWithContact;
|
|
3321
|
+
/**
|
|
3322
|
+
* Remove existing recipient info.
|
|
3323
|
+
* @internal
|
|
3324
|
+
*/
|
|
3325
|
+
recipientInfoRemoved?: boolean;
|
|
4161
3326
|
}
|
|
4162
3327
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4163
3328
|
/** The line item was added. */
|
|
@@ -4257,8 +3422,21 @@ interface OrderLineItemChangedDetails {
|
|
|
4257
3422
|
* @maxSize 5
|
|
4258
3423
|
*/
|
|
4259
3424
|
locations?: LocationAndQuantity[];
|
|
3425
|
+
/**
|
|
3426
|
+
* ID of the app managing the inventory.
|
|
3427
|
+
* @internal
|
|
3428
|
+
* @format GUID
|
|
3429
|
+
*/
|
|
3430
|
+
inventoryAppId?: string | null;
|
|
4260
3431
|
/** Subscription info. */
|
|
4261
3432
|
subscriptionInfo?: SubscriptionInfo;
|
|
3433
|
+
/**
|
|
3434
|
+
* Modifier groups that were added to the item.
|
|
3435
|
+
* @internal
|
|
3436
|
+
* @readonly
|
|
3437
|
+
* @maxSize 10
|
|
3438
|
+
*/
|
|
3439
|
+
modifierGroups?: ModifierGroup[];
|
|
4262
3440
|
}
|
|
4263
3441
|
/** Type of selected payment option for catalog item */
|
|
4264
3442
|
declare enum DeltaPaymentOptionType {
|
|
@@ -4645,6 +3823,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
4645
3823
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
4646
3824
|
/** Payment method is saved for order */
|
|
4647
3825
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3826
|
+
/**
|
|
3827
|
+
* Details of an initiated refund process.
|
|
3828
|
+
*
|
|
3829
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3830
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3831
|
+
* @internal
|
|
3832
|
+
*/
|
|
3833
|
+
refundInitiated?: RefundInitiated;
|
|
3834
|
+
/**
|
|
3835
|
+
* Details of a refunded payment.
|
|
3836
|
+
*
|
|
3837
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3838
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3839
|
+
* @internal
|
|
3840
|
+
*/
|
|
3841
|
+
paymentRefunded?: PaymentRefunded;
|
|
3842
|
+
/**
|
|
3843
|
+
* Details of a failed payment refund.
|
|
3844
|
+
*
|
|
3845
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3846
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3847
|
+
* @internal
|
|
3848
|
+
*/
|
|
3849
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
3850
|
+
/**
|
|
3851
|
+
* Details of refund to store credit.
|
|
3852
|
+
* @internal
|
|
3853
|
+
*/
|
|
3854
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
4648
3855
|
/** Details of a pending payment */
|
|
4649
3856
|
paymentPending?: PaymentPending;
|
|
4650
3857
|
/** Details of a canceled payment */
|
|
@@ -4655,6 +3862,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
4655
3862
|
orderPending?: OrderPending;
|
|
4656
3863
|
/** Order rejected */
|
|
4657
3864
|
orderRejected?: OrderRejected;
|
|
3865
|
+
/**
|
|
3866
|
+
* Receipt was added for associated payment
|
|
3867
|
+
* @internal
|
|
3868
|
+
*/
|
|
3869
|
+
receiptCreated?: ReceiptCreated;
|
|
3870
|
+
/**
|
|
3871
|
+
* Receipt sent to customer
|
|
3872
|
+
* @internal
|
|
3873
|
+
*/
|
|
3874
|
+
receiptSent?: ReceiptSent;
|
|
3875
|
+
/**
|
|
3876
|
+
* Chargeback created for one of the order's payments.
|
|
3877
|
+
* @internal
|
|
3878
|
+
*/
|
|
3879
|
+
chargebackCreated?: ChargebackCreated;
|
|
3880
|
+
/**
|
|
3881
|
+
* Chargeback reversed for one of the order's payments.
|
|
3882
|
+
* @internal
|
|
3883
|
+
*/
|
|
3884
|
+
chargebackReversed?: ChargebackReversed;
|
|
4658
3885
|
/**
|
|
4659
3886
|
* Internal activity ID.
|
|
4660
3887
|
* @format GUID
|
|
@@ -4719,6 +3946,35 @@ interface InternalActivityContentOneOf {
|
|
|
4719
3946
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
4720
3947
|
/** Payment method is saved for order */
|
|
4721
3948
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3949
|
+
/**
|
|
3950
|
+
* Details of an initiated refund process.
|
|
3951
|
+
*
|
|
3952
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3953
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3954
|
+
* @internal
|
|
3955
|
+
*/
|
|
3956
|
+
refundInitiated?: RefundInitiated;
|
|
3957
|
+
/**
|
|
3958
|
+
* Details of a refunded payment.
|
|
3959
|
+
*
|
|
3960
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3961
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3962
|
+
* @internal
|
|
3963
|
+
*/
|
|
3964
|
+
paymentRefunded?: PaymentRefunded;
|
|
3965
|
+
/**
|
|
3966
|
+
* Details of a failed payment refund.
|
|
3967
|
+
*
|
|
3968
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3969
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3970
|
+
* @internal
|
|
3971
|
+
*/
|
|
3972
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
3973
|
+
/**
|
|
3974
|
+
* Details of refund to store credit.
|
|
3975
|
+
* @internal
|
|
3976
|
+
*/
|
|
3977
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
4722
3978
|
/** Details of a pending payment */
|
|
4723
3979
|
paymentPending?: PaymentPending;
|
|
4724
3980
|
/** Details of a canceled payment */
|
|
@@ -4729,6 +3985,26 @@ interface InternalActivityContentOneOf {
|
|
|
4729
3985
|
orderPending?: OrderPending;
|
|
4730
3986
|
/** Order rejected */
|
|
4731
3987
|
orderRejected?: OrderRejected;
|
|
3988
|
+
/**
|
|
3989
|
+
* Receipt was added for associated payment
|
|
3990
|
+
* @internal
|
|
3991
|
+
*/
|
|
3992
|
+
receiptCreated?: ReceiptCreated;
|
|
3993
|
+
/**
|
|
3994
|
+
* Receipt sent to customer
|
|
3995
|
+
* @internal
|
|
3996
|
+
*/
|
|
3997
|
+
receiptSent?: ReceiptSent;
|
|
3998
|
+
/**
|
|
3999
|
+
* Chargeback created for one of the order's payments.
|
|
4000
|
+
* @internal
|
|
4001
|
+
*/
|
|
4002
|
+
chargebackCreated?: ChargebackCreated;
|
|
4003
|
+
/**
|
|
4004
|
+
* Chargeback reversed for one of the order's payments.
|
|
4005
|
+
* @internal
|
|
4006
|
+
*/
|
|
4007
|
+
chargebackReversed?: ChargebackReversed;
|
|
4732
4008
|
}
|
|
4733
4009
|
/** Order placed */
|
|
4734
4010
|
interface OrderPlaced {
|
|
@@ -5089,7 +4365,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
5089
4365
|
interface BulkSetBusinessLocationResult {
|
|
5090
4366
|
itemMetadata?: ItemMetadata;
|
|
5091
4367
|
}
|
|
5092
|
-
interface
|
|
4368
|
+
interface MarkOrderAsPaidRequest {
|
|
5093
4369
|
/**
|
|
5094
4370
|
* Order ID.
|
|
5095
4371
|
* @minLength 1
|
|
@@ -5097,7 +4373,7 @@ interface V1MarkOrderAsPaidRequest {
|
|
|
5097
4373
|
*/
|
|
5098
4374
|
_id?: string;
|
|
5099
4375
|
}
|
|
5100
|
-
interface
|
|
4376
|
+
interface MarkOrderAsPaidResponse {
|
|
5101
4377
|
/** Updated order. */
|
|
5102
4378
|
order?: Order;
|
|
5103
4379
|
}
|
|
@@ -5108,7 +4384,7 @@ interface PaymentStatusUpdated {
|
|
|
5108
4384
|
/** The previous status (before the update) */
|
|
5109
4385
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
5110
4386
|
}
|
|
5111
|
-
interface
|
|
4387
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
5112
4388
|
/**
|
|
5113
4389
|
* IDs of orders to mark as paid.
|
|
5114
4390
|
* @minSize 1
|
|
@@ -5118,7 +4394,7 @@ interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
5118
4394
|
*/
|
|
5119
4395
|
ids?: string[];
|
|
5120
4396
|
}
|
|
5121
|
-
interface
|
|
4397
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
5122
4398
|
/**
|
|
5123
4399
|
* Items updated by the bulk action.
|
|
5124
4400
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -5127,7 +4403,7 @@ interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
5127
4403
|
/** Bulk action metadata. */
|
|
5128
4404
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5129
4405
|
}
|
|
5130
|
-
interface
|
|
4406
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
5131
4407
|
/**
|
|
5132
4408
|
* eCom Order ID
|
|
5133
4409
|
* @minLength 1
|
|
@@ -5135,7 +4411,7 @@ interface V1CreatePaymentGatewayOrderRequest {
|
|
|
5135
4411
|
*/
|
|
5136
4412
|
ecomOrderId?: string;
|
|
5137
4413
|
}
|
|
5138
|
-
interface
|
|
4414
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
5139
4415
|
/** ID of the order created in the payment gateway */
|
|
5140
4416
|
paymentGatewayOrderId?: string;
|
|
5141
4417
|
}
|
|
@@ -5543,9 +4819,9 @@ interface CalculatedTax {
|
|
|
5543
4819
|
code?: string | null;
|
|
5544
4820
|
}
|
|
5545
4821
|
interface Payments {
|
|
5546
|
-
payments?:
|
|
4822
|
+
payments?: Payment[];
|
|
5547
4823
|
}
|
|
5548
|
-
interface
|
|
4824
|
+
interface Payment {
|
|
5549
4825
|
/** document */
|
|
5550
4826
|
_id?: string;
|
|
5551
4827
|
type?: string;
|
|
@@ -5680,125 +4956,6 @@ interface TriggerSideEffectsFromLegacyData {
|
|
|
5680
4956
|
orderId?: string;
|
|
5681
4957
|
ordersExperiments?: OrdersExperiments;
|
|
5682
4958
|
}
|
|
5683
|
-
type PreparePaymentCollectionApplicationErrors = {
|
|
5684
|
-
code?: 'PAYMENT_METHODS_NOT_FOUND';
|
|
5685
|
-
description?: string;
|
|
5686
|
-
data?: Record<string, any>;
|
|
5687
|
-
} | {
|
|
5688
|
-
code?: 'ORDER_CANCELED';
|
|
5689
|
-
description?: string;
|
|
5690
|
-
data?: Record<string, any>;
|
|
5691
|
-
} | {
|
|
5692
|
-
code?: 'INVALID_AMOUNT';
|
|
5693
|
-
description?: string;
|
|
5694
|
-
data?: Record<string, any>;
|
|
5695
|
-
} | {
|
|
5696
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
5697
|
-
description?: string;
|
|
5698
|
-
data?: Record<string, any>;
|
|
5699
|
-
} | {
|
|
5700
|
-
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
5701
|
-
description?: string;
|
|
5702
|
-
data?: Record<string, any>;
|
|
5703
|
-
};
|
|
5704
|
-
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
5705
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
5706
|
-
description?: string;
|
|
5707
|
-
data?: Record<string, any>;
|
|
5708
|
-
} | {
|
|
5709
|
-
code?: 'INVALID_AMOUNT';
|
|
5710
|
-
description?: string;
|
|
5711
|
-
data?: Record<string, any>;
|
|
5712
|
-
} | {
|
|
5713
|
-
code?: 'ORDER_CANCELED';
|
|
5714
|
-
description?: string;
|
|
5715
|
-
data?: Record<string, any>;
|
|
5716
|
-
};
|
|
5717
|
-
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
5718
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
5719
|
-
description?: string;
|
|
5720
|
-
data?: Record<string, any>;
|
|
5721
|
-
} | {
|
|
5722
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5723
|
-
description?: string;
|
|
5724
|
-
data?: Record<string, any>;
|
|
5725
|
-
};
|
|
5726
|
-
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
5727
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
5728
|
-
description?: string;
|
|
5729
|
-
data?: Record<string, any>;
|
|
5730
|
-
} | {
|
|
5731
|
-
code?: 'ORDER_CANCELED';
|
|
5732
|
-
description?: string;
|
|
5733
|
-
data?: Record<string, any>;
|
|
5734
|
-
};
|
|
5735
|
-
type TriggerRefundApplicationErrors = {
|
|
5736
|
-
code?: 'PAYMENTS_NOT_FOUND';
|
|
5737
|
-
description?: string;
|
|
5738
|
-
data?: Record<string, any>;
|
|
5739
|
-
} | {
|
|
5740
|
-
code?: 'REFUND_NOT_AVAILABLE';
|
|
5741
|
-
description?: string;
|
|
5742
|
-
data?: Record<string, any>;
|
|
5743
|
-
} | {
|
|
5744
|
-
code?: 'INVALID_AMOUNT';
|
|
5745
|
-
description?: string;
|
|
5746
|
-
data?: Record<string, any>;
|
|
5747
|
-
};
|
|
5748
|
-
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
5749
|
-
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
5750
|
-
description?: string;
|
|
5751
|
-
data?: Record<string, any>;
|
|
5752
|
-
} | {
|
|
5753
|
-
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
5754
|
-
description?: string;
|
|
5755
|
-
data?: Record<string, any>;
|
|
5756
|
-
} | {
|
|
5757
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
5758
|
-
description?: string;
|
|
5759
|
-
data?: Record<string, any>;
|
|
5760
|
-
} | {
|
|
5761
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
5762
|
-
description?: string;
|
|
5763
|
-
data?: Record<string, any>;
|
|
5764
|
-
} | {
|
|
5765
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5766
|
-
description?: string;
|
|
5767
|
-
data?: Record<string, any>;
|
|
5768
|
-
};
|
|
5769
|
-
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
5770
|
-
code?: 'INVALID_AMOUNT';
|
|
5771
|
-
description?: string;
|
|
5772
|
-
data?: Record<string, any>;
|
|
5773
|
-
} | {
|
|
5774
|
-
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
5775
|
-
description?: string;
|
|
5776
|
-
data?: Record<string, any>;
|
|
5777
|
-
} | {
|
|
5778
|
-
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
5779
|
-
description?: string;
|
|
5780
|
-
data?: Record<string, any>;
|
|
5781
|
-
} | {
|
|
5782
|
-
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
5783
|
-
description?: string;
|
|
5784
|
-
data?: Record<string, any>;
|
|
5785
|
-
} | {
|
|
5786
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
5787
|
-
description?: string;
|
|
5788
|
-
data?: Record<string, any>;
|
|
5789
|
-
} | {
|
|
5790
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
5791
|
-
description?: string;
|
|
5792
|
-
data?: Record<string, any>;
|
|
5793
|
-
} | {
|
|
5794
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
5795
|
-
description?: string;
|
|
5796
|
-
data?: Record<string, any>;
|
|
5797
|
-
} | {
|
|
5798
|
-
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
5799
|
-
description?: string;
|
|
5800
|
-
data?: Record<string, any>;
|
|
5801
|
-
};
|
|
5802
4959
|
type GetOrderApplicationErrors = {
|
|
5803
4960
|
code?: 'ORDER_NOT_FOUND';
|
|
5804
4961
|
description?: string;
|
|
@@ -6035,108 +5192,6 @@ interface OrderPaymentStatusUpdatedEnvelope {
|
|
|
6035
5192
|
*/
|
|
6036
5193
|
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
6037
5194
|
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`;
|
|
6038
|
-
/**
|
|
6039
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6040
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6041
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6042
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6043
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6044
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6045
|
-
* @param amount - Amount to collect
|
|
6046
|
-
* @public
|
|
6047
|
-
* @documentationMaturity preview
|
|
6048
|
-
* @requiredField amount
|
|
6049
|
-
* @requiredField ecomOrderId
|
|
6050
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6051
|
-
* @applicableIdentity APP
|
|
6052
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6053
|
-
*/
|
|
6054
|
-
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
6055
|
-
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
6056
|
-
}>;
|
|
6057
|
-
interface PreparePaymentCollectionOptions {
|
|
6058
|
-
/**
|
|
6059
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6060
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
6061
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6062
|
-
*/
|
|
6063
|
-
paymentGatewayOrderId?: string | null;
|
|
6064
|
-
/**
|
|
6065
|
-
* Whether to delay capture of the payment.
|
|
6066
|
-
* Default: false
|
|
6067
|
-
* @deprecated Whether to delay capture of the payment.
|
|
6068
|
-
* Default: false
|
|
6069
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6070
|
-
* @targetRemovalDate 2024-09-30
|
|
6071
|
-
*/
|
|
6072
|
-
delayedCapture?: boolean;
|
|
6073
|
-
/** Delayed capture payment settings */
|
|
6074
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6075
|
-
}
|
|
6076
|
-
/**
|
|
6077
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
6078
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6079
|
-
* reason why payment collection is not possible.
|
|
6080
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6081
|
-
* @public
|
|
6082
|
-
* @documentationMaturity preview
|
|
6083
|
-
* @requiredField ecomOrderId
|
|
6084
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6085
|
-
* @applicableIdentity APP
|
|
6086
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6087
|
-
*/
|
|
6088
|
-
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6089
|
-
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6090
|
-
/** Information about the user who initiated the payment. */
|
|
6091
|
-
chargedBy?: ChargedBy;
|
|
6092
|
-
}
|
|
6093
|
-
interface ChargeMembershipsOptions {
|
|
6094
|
-
/**
|
|
6095
|
-
* List of items to be paid by memberships
|
|
6096
|
-
* @minSize 1
|
|
6097
|
-
* @maxSize 300
|
|
6098
|
-
*/
|
|
6099
|
-
membershipCharges?: MembershipChargeItem[];
|
|
6100
|
-
}
|
|
6101
|
-
interface TriggerRefundOptions {
|
|
6102
|
-
/** Business model of a refund */
|
|
6103
|
-
details?: RefundDetails;
|
|
6104
|
-
/** Side effect details related to refund */
|
|
6105
|
-
sideEffects?: RefundSideEffects;
|
|
6106
|
-
}
|
|
6107
|
-
/**
|
|
6108
|
-
* Void authorized payments
|
|
6109
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6110
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6111
|
-
* @param paymentIds - Payment IDs
|
|
6112
|
-
* @public
|
|
6113
|
-
* @documentationMaturity preview
|
|
6114
|
-
* @requiredField ecomOrderId
|
|
6115
|
-
* @requiredField paymentIds
|
|
6116
|
-
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6117
|
-
* @applicableIdentity APP
|
|
6118
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6119
|
-
*/
|
|
6120
|
-
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`> & {
|
|
6121
|
-
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
6122
|
-
}>;
|
|
6123
|
-
/**
|
|
6124
|
-
* Capture authorized payments
|
|
6125
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6126
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6127
|
-
* @param payments - Capture payments information
|
|
6128
|
-
* @public
|
|
6129
|
-
* @documentationMaturity preview
|
|
6130
|
-
* @requiredField ecomOrderId
|
|
6131
|
-
* @requiredField payments
|
|
6132
|
-
* @requiredField payments.paymentId
|
|
6133
|
-
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6134
|
-
* @applicableIdentity APP
|
|
6135
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6136
|
-
*/
|
|
6137
|
-
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`> & {
|
|
6138
|
-
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
6139
|
-
}>;
|
|
6140
5195
|
/**
|
|
6141
5196
|
* Retrieves an order.
|
|
6142
5197
|
*
|
|
@@ -6572,6 +5627,23 @@ interface BulkUpdateOrdersOptions {
|
|
|
6572
5627
|
*/
|
|
6573
5628
|
returnEntity?: boolean;
|
|
6574
5629
|
}
|
|
5630
|
+
/** @param _id - Order id to be updated
|
|
5631
|
+
* @internal
|
|
5632
|
+
* @documentationMaturity preview
|
|
5633
|
+
* @requiredField _id
|
|
5634
|
+
* @requiredField options.changes
|
|
5635
|
+
* @requiredField options.changes.priceSummary.subtotal
|
|
5636
|
+
* @requiredField options.changes.priceSummary.total
|
|
5637
|
+
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
5638
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
5639
|
+
* @applicableIdentity APP
|
|
5640
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
5641
|
+
*/
|
|
5642
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
5643
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5644
|
+
}[OrderNonNullablePaths]> & {
|
|
5645
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
5646
|
+
}>;
|
|
6575
5647
|
interface CommitDeltasOptions {
|
|
6576
5648
|
/**
|
|
6577
5649
|
* Draft order Id representing this change.
|
|
@@ -6589,6 +5661,21 @@ interface CommitDeltasOptions {
|
|
|
6589
5661
|
*/
|
|
6590
5662
|
reason?: string | null;
|
|
6591
5663
|
}
|
|
5664
|
+
/** @internal
|
|
5665
|
+
* @documentationMaturity preview
|
|
5666
|
+
* @requiredField identifiers
|
|
5667
|
+
* @requiredField identifiers._id
|
|
5668
|
+
* @requiredField identifiers.lineItemId
|
|
5669
|
+
* @requiredField lineItem
|
|
5670
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5671
|
+
* @applicableIdentity APP
|
|
5672
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
5673
|
+
* @deprecated
|
|
5674
|
+
* @targetRemovalDate 2024-02-15
|
|
5675
|
+
*/
|
|
5676
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
5677
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5678
|
+
}[OrderNonNullablePaths]>>;
|
|
6592
5679
|
interface UpdateOrderLineItemIdentifiers {
|
|
6593
5680
|
/**
|
|
6594
5681
|
* Order ID
|
|
@@ -6712,13 +5799,61 @@ interface UpdateOrderLineItem {
|
|
|
6712
5799
|
locations?: LocationAndQuantity[];
|
|
6713
5800
|
/** Address used for tax calculation. */
|
|
6714
5801
|
taxableAddress?: TaxableAddress;
|
|
5802
|
+
/**
|
|
5803
|
+
* ID of the app managing the inventory.
|
|
5804
|
+
* @internal
|
|
5805
|
+
* @format GUID
|
|
5806
|
+
*/
|
|
5807
|
+
inventoryAppId?: string | null;
|
|
6715
5808
|
/**
|
|
6716
5809
|
* Custom extended fields for the line item object.
|
|
6717
5810
|
*
|
|
6718
5811
|
* [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.
|
|
6719
5812
|
*/
|
|
6720
5813
|
extendedFields?: ExtendedFields;
|
|
5814
|
+
/**
|
|
5815
|
+
* Modifier groups that were added to the item.
|
|
5816
|
+
* @internal
|
|
5817
|
+
* @readonly
|
|
5818
|
+
* @maxSize 10
|
|
5819
|
+
*/
|
|
5820
|
+
modifierGroups?: ModifierGroup[];
|
|
6721
5821
|
}
|
|
5822
|
+
/**
|
|
5823
|
+
* Adds a merchant comment to an order.
|
|
5824
|
+
* > **Note:** Activities with type CustomActivity not supported
|
|
5825
|
+
* @param _id - Order ID.
|
|
5826
|
+
* @param activity - Activity info.
|
|
5827
|
+
* @internal
|
|
5828
|
+
* @documentationMaturity preview
|
|
5829
|
+
* @requiredField _id
|
|
5830
|
+
* @requiredField activity
|
|
5831
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5832
|
+
* @applicableIdentity APP
|
|
5833
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
5834
|
+
* @deprecated
|
|
5835
|
+
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
5836
|
+
* @targetRemovalDate 2024-11-01
|
|
5837
|
+
*/
|
|
5838
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
5839
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5840
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
5841
|
+
/**
|
|
5842
|
+
* Updates an order's activity.
|
|
5843
|
+
* @param activity - Activity info.
|
|
5844
|
+
* @internal
|
|
5845
|
+
* @documentationMaturity preview
|
|
5846
|
+
* @requiredField activity
|
|
5847
|
+
* @requiredField identifiers
|
|
5848
|
+
* @requiredField identifiers._id
|
|
5849
|
+
* @requiredField identifiers.activityId
|
|
5850
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5851
|
+
* @applicableIdentity APP
|
|
5852
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
5853
|
+
*/
|
|
5854
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
5855
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5856
|
+
}[OrderNonNullablePaths]>>;
|
|
6722
5857
|
interface UpdateActivityIdentifiers {
|
|
6723
5858
|
/**
|
|
6724
5859
|
* Order ID.
|
|
@@ -6732,6 +5867,22 @@ interface UpdateActivityIdentifiers {
|
|
|
6732
5867
|
*/
|
|
6733
5868
|
activityId: string;
|
|
6734
5869
|
}
|
|
5870
|
+
/**
|
|
5871
|
+
* Delete's an order's activity.
|
|
5872
|
+
*
|
|
5873
|
+
* Only custom activities and merchant comments can be deleted.
|
|
5874
|
+
* @internal
|
|
5875
|
+
* @documentationMaturity preview
|
|
5876
|
+
* @requiredField identifiers
|
|
5877
|
+
* @requiredField identifiers._id
|
|
5878
|
+
* @requiredField identifiers.activityId
|
|
5879
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5880
|
+
* @applicableIdentity APP
|
|
5881
|
+
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
5882
|
+
*/
|
|
5883
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
5884
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5885
|
+
}[OrderNonNullablePaths]>>;
|
|
6735
5886
|
interface DeleteActivityIdentifiers {
|
|
6736
5887
|
/**
|
|
6737
5888
|
* Order ID.
|
|
@@ -6774,6 +5925,43 @@ interface CancelOrderOptions {
|
|
|
6774
5925
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
6775
5926
|
restockAllItems?: boolean;
|
|
6776
5927
|
}
|
|
5928
|
+
/**
|
|
5929
|
+
* Updates order status.
|
|
5930
|
+
*
|
|
5931
|
+
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
5932
|
+
* >Updates into INITIALIZED are not supported.
|
|
5933
|
+
*
|
|
5934
|
+
* Approving order:
|
|
5935
|
+
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
5936
|
+
*
|
|
5937
|
+
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
5938
|
+
* will cause an error.
|
|
5939
|
+
*
|
|
5940
|
+
* Setting PENDING status:
|
|
5941
|
+
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
5942
|
+
* @param orderId - Order ID.
|
|
5943
|
+
* @param status - New order status.
|
|
5944
|
+
* @internal
|
|
5945
|
+
* @documentationMaturity preview
|
|
5946
|
+
* @requiredField orderId
|
|
5947
|
+
* @requiredField status
|
|
5948
|
+
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
5949
|
+
* @applicableIdentity APP
|
|
5950
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
5951
|
+
*/
|
|
5952
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
5953
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5954
|
+
}[OrderNonNullablePaths]> & {
|
|
5955
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
5956
|
+
}>;
|
|
5957
|
+
/** @internal
|
|
5958
|
+
* @documentationMaturity preview
|
|
5959
|
+
* @requiredField options.aggregation
|
|
5960
|
+
* @permissionId ECOM.READ_ORDERS
|
|
5961
|
+
* @applicableIdentity APP
|
|
5962
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
5963
|
+
*/
|
|
5964
|
+
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
6777
5965
|
interface AggregateOrdersOptions {
|
|
6778
5966
|
/** Filter applied to original data */
|
|
6779
5967
|
filter?: Record<string, any> | null;
|
|
@@ -6810,4 +5998,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
6810
5998
|
unassignTags?: Tags;
|
|
6811
5999
|
}
|
|
6812
6000
|
|
|
6813
|
-
export { RefundableStatus as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PickupMethod as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, OrderStatus as H, ItemTypeItemType as I, JurisdictionType as J, DiscountType as K, DiscountReason as L, type MaskedOrder as M, LineItemQuantityChangeType as N, type Order as O, type Price as P, ActivityType as Q, AttributionSource as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, ChannelType as X, ScheduledAction as Y, DurationUnit as Z, PaymentCollectabilityStatus as _, type PreparePaymentCollectionOptions as a, type AddressLocation as a$, NonRefundableReason as a0, ManuallyRefundableReason as a1, RestockType as a2, TransactionStatus as a3, AuthorizationCaptureStatus as a4, AuthorizationVoidStatus as a5, Reason as a6, ActionType as a7, ChargebackStatus as a8, MembershipPaymentStatus as a9, type ItemTypeItemTypeDataOneOf as aA, type ItemTaxFullDetails as aB, type LineItemTaxInfo as aC, type LineItemTaxBreakdown as aD, type DigitalFile as aE, type SubscriptionInfo as aF, type SubscriptionTitle as aG, type SubscriptionDescription as aH, type SubscriptionSettings as aI, type FreeTrialPeriod as aJ, type BillingAdjustment as aK, type BillingAdjustmentPriceSummary as aL, type PriceDescription as aM, type LocationAndQuantity as aN, type TaxableAddress as aO, type TaxableAddressTaxableAddressDataOneOf as aP, type ExtendedFields as aQ, type ModifierGroup as aR, type TranslatableString as aS, type ItemModifier as aT, type BuyerInfo as aU, type BuyerInfoIdOneOf as aV, type CurrencyConversionDetails as aW, type PriceSummary as aX, type AddressWithContact as aY, type Address as aZ, type StreetAddress as a_, RefundStatus as aa, WebhookIdentityType as ab, VersioningMode as ac, SortOrder as ad, OrderApprovalStrategy as ae, DeltaPaymentOptionType as af, InventoryAction as ag, Placement as ah, SubdivisionType as ai, SourceType as aj, CustomFieldGroup as ak, ValueType as al, DepositType as am, InvoiceStatus as an, type OrderLineItem as ao, type ProductName as ap, type CatalogReference as aq, type DescriptionLine as ar, type DescriptionLineValueOneOf as as, type DescriptionLineDescriptionLineValueOneOf as at, type DescriptionLineName as au, type PlainTextValue as av, type Color as aw, type FocalPoint as ax, type PhysicalProperties as ay, type ItemType as az, type PreparePaymentCollectionResponse as b, type PaymentDeclined as b$, type FullAddressContactDetails as b0, type VatId as b1, type V1ShippingInformation as b2, type DeliveryLogistics as b3, type DeliveryLogisticsAddressOneOf as b4, type PickupDetails as b5, type PickupAddress as b6, type DeliveryTimeSlot as b7, type ShippingPrice as b8, type ShippingRegion as b9, type ManagedDiscount as bA, type TranslatedValue as bB, type LineItemAmount as bC, type ManagedAdditionalFee as bD, type TotalPriceChange as bE, type ShippingInformationChange as bF, type ShippingInformation as bG, type SavedPaymentMethod as bH, type AuthorizedPaymentCreated as bI, type AuthorizedPaymentCaptured as bJ, type AuthorizedPaymentVoided as bK, type RefundInitiated as bL, type RefundedPayment as bM, type RefundedPaymentKindOneOf as bN, type RegularPaymentRefund as bO, type GiftCardPaymentRefund as bP, type MembershipPaymentRefund as bQ, type PaymentRefunded as bR, type PaymentRefundFailed as bS, type RefundedAsStoreCredit as bT, type PaymentPending as bU, type PaymentPendingPaymentDetailsOneOf as bV, type RegularPayment as bW, type RegularPaymentPaymentMethodDetailsOneOf as bX, type CreditCardDetails as bY, type PaymentCanceled as bZ, type PaymentCanceledPaymentDetailsOneOf as b_, type TaxSummary as ba, type OrderTaxInfo as bb, type OrderTaxBreakdown as bc, type AppliedDiscount as bd, type AppliedDiscountDiscountSourceOneOf as be, type Coupon as bf, type MerchantDiscount as bg, type MerchantDiscountMerchantDiscountReasonOneOf as bh, type DiscountRule as bi, type DiscountRuleName as bj, type LineItemDiscount as bk, type Activity as bl, type ActivityContentOneOf as bm, type CustomActivity as bn, type MerchantComment as bo, type OrderRefunded as bp, type OrderCreatedFromExchange as bq, type NewExchangeOrderCreated as br, type LineItemExchangeData as bs, type DraftOrderChangesApplied as bt, type OrderChange as bu, type OrderChangeValueOneOf as bv, type LineItemChanges as bw, type LineItemQuantityChange as bx, type LineItemPriceChange as by, type ManagedLineItem as bz, type PreparePaymentCollectionApplicationErrors as c, type OrderTransactions as c$, type PaymentDeclinedPaymentDetailsOneOf as c0, type ReceiptCreated as c1, type ReceiptCreatedReceiptInfoOneOf as c2, type WixReceipt as c3, type ExternalReceipt as c4, type ReceiptSent as c5, type ReceiptSentReceiptInfoOneOf as c6, type ChargebackCreated as c7, type ChargebackReversed as c8, type CreatedBy as c9, type BulkOrderResult as cA, type ItemMetadata as cB, type ApplicationError as cC, type BulkActionMetadata as cD, type GetRefundabilityStatusRequest as cE, type GetRefundabilityStatusResponse as cF, type Refundability as cG, type RefundabilityAdditionalRefundabilityInfoOneOf as cH, type CreatePaymentGatewayOrderRequest as cI, type ChargedBy as cJ, type CreatePaymentGatewayOrderResponse as cK, type ChargeMembershipsRequest as cL, type MembershipChargeItem as cM, type MembershipName as cN, type ServiceProperties as cO, type ChargeMembershipsResponse as cP, type TriggerRefundRequest as cQ, type PaymentRefund as cR, type RefundDetails as cS, type RefundItem as cT, type LineItemRefund as cU, type AdditionalFeeRefund as cV, type ShippingRefund as cW, type RefundSideEffects as cX, type RestockInfo as cY, type RestockItem as cZ, type TriggerRefundResponse as c_, type CreatedByStringOneOf as ca, type ChannelInfo as cb, type CustomField as cc, type BalanceSummary as cd, type Balance as ce, type AdditionalFee as cf, type FulfillmentStatusesAggregate as cg, type Tags as ch, type TagList as ci, type Location as cj, type OrderApproved as ck, type OrdersExperiments as cl, type OrderRejectedEventOrderRejected as cm, type OrderItemsRestocked as cn, type V1RestockItem as co, type PreparePaymentCollectionRequest as cp, type RedirectUrls as cq, type DelayedCaptureSettings as cr, type Duration as cs, type GetPaymentCollectabilityStatusRequest as ct, type RecordManuallyCollectedPaymentRequest as cu, type RecordManuallyCollectedPaymentResponse as cv, type MarkOrderAsPaidRequest as cw, type MarkOrderAsPaidResponse as cx, type BulkMarkOrdersAsPaidRequest as cy, type BulkMarkOrdersAsPaidResponse as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type GetOrderResponse as d$, type Payment as d0, type PaymentPaymentDetailsOneOf as d1, type PaymentReceiptInfoOneOf as d2, type RegularPaymentDetails as d3, type RegularPaymentDetailsPaymentMethodDetailsOneOf as d4, type CreditCardPaymentMethodDetails as d5, type AuthorizationDetails as d6, type AuthorizationCapture as d7, type AuthorizationActionFailureDetails as d8, type AuthorizationVoid as d9, type EntityDeletedEvent as dA, type ActionEvent as dB, type Empty as dC, type MessageEnvelope as dD, type IdentificationData as dE, type IdentificationDataIdOneOf as dF, type UpdateInternalDocumentsEvent as dG, type UpdateInternalDocumentsEventOperationOneOf as dH, type InternalDocument as dI, type InternalDocumentUpdateOperation as dJ, type DeleteByIdsOperation as dK, type DeleteByFilterOperation as dL, type InternalDocumentUpdateByFilterOperation as dM, type InternalUpdateExistingOperation as dN, type VersionedDocumentUpdateOperation as dO, type VersionedDeleteByIdsOperation as dP, type VersionedDocumentId as dQ, type TriggerReindexRequest as dR, type TriggerReindexResponse as dS, type BatchOfTriggerReindexOrderRequest as dT, type TriggerReindexOrderRequest as dU, type DiffmatokyPayload as dV, type ErrorInformation as dW, type ContinueSideEffectsFlowInLegacyData as dX, type SnapshotMessage as dY, type IndexingMessage as dZ, type GetOrderRequest as d_, type V1ScheduledAction as da, type Chargeback as db, type GiftCardPaymentDetails as dc, type MembershipPaymentDetails as dd, type WixReceiptInfo as de, type ExternalReceiptInfo as df, type Refund as dg, type RefundTransaction as dh, type RefundStatusInfo as di, type AggregatedRefundSummary as dj, type RefundItemsBreakdown as dk, type LineItemRefundSummary as dl, type CalculateRefundRequest as dm, type CalculateRefundItemRequest as dn, type CalculateRefundResponse as dp, type CalculateRefundItemResponse as dq, type VoidAuthorizedPaymentsRequest as dr, type CaptureAuthorizedPaymentsRequest as ds, type ChargeSavedPaymentMethodRequest as dt, type ChargeSavedPaymentMethodResponse as du, type DomainEvent as dv, type DomainEventBodyOneOf as dw, type EntityCreatedEvent as dx, type RestoreInfo as dy, type EntityUpdatedEvent as dz, type PaymentCapture as e, type UpdateBillingContactDetailsRequest as e$, type InternalQueryOrdersRequest as e0, type PlatformQuery as e1, type PlatformQueryPagingMethodOneOf as e2, type Sorting as e3, type PlatformPaging as e4, type CursorPaging as e5, type InternalQueryOrdersResponse as e6, type PlatformPagingMetadata as e7, type Cursors as e8, type QueryOrderRequest as e9, type DraftOrderCommitSettings as eA, type InventoryUpdateDetails as eB, type CommitDeltasResponse as eC, type OrderDeltasCommitted as eD, type CommittedDiffs as eE, type CommittedDiffsShippingUpdateInfoOneOf as eF, type LineItemDelta as eG, type LineItemDeltaDeltaOneOf as eH, type ArchiveOrderRequest as eI, type ArchiveOrderResponse as eJ, type BulkArchiveOrdersRequest as eK, type BulkArchiveOrdersResponse as eL, type BulkArchiveOrdersByFilterRequest as eM, type BulkArchiveOrdersByFilterResponse as eN, type UnArchiveOrderRequest as eO, type UnArchiveOrderResponse as eP, type BulkUnArchiveOrdersRequest as eQ, type BulkUnArchiveOrdersResponse as eR, type BulkUnArchiveOrdersByFilterRequest as eS, type BulkUnArchiveOrdersByFilterResponse as eT, type UpdateBuyerInfoRequest as eU, type BuyerInfoUpdate as eV, type UpdateBuyerInfoResponse as eW, type UpdateBuyerEmailRequest as eX, type UpdateBuyerEmailResponse as eY, type UpdateOrderShippingAddressRequest as eZ, type UpdateOrderShippingAddressResponse as e_, type QueryOrderResponse as ea, type SearchOrdersRequest as eb, type CursorSearch as ec, type CursorSearchPagingMethodOneOf as ed, type CursorPagingMetadata as ee, type CreateOrderRequest as ef, type OrderCreationSettings as eg, type OrderCreateNotifications as eh, type CreateOrderResponse as ei, type UpdateOrderRequest as ej, type UpdateOrderResponse as ek, type BulkUpdateOrdersRequest as el, type CommitDeltasRequest as em, type DraftOrderDiffs as en, type DraftOrderDiffsShippingUpdateInfoOneOf as eo, type DraftOrderDiffsBuyerUpdateInfoOneOf as ep, type DraftOrderDiffsBillingUpdateInfoOneOf as eq, type DraftOrderDiffsRecipientUpdateInfoOneOf as er, type V1LineItemDelta as es, type V1LineItemDeltaDeltaOneOf as et, type OrderLineItemChangedDetails as eu, type ItemChangedDetails as ev, type AppliedDiscountDelta as ew, type AppliedDiscountDeltaDeltaOneOf as ex, type AdditionalFeeDelta as ey, type AdditionalFeeDeltaDeltaOneOf as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type BulkSetBusinessLocationResult as f$, type UpdateBillingContactDetailsResponse as f0, type UpdateOrderLineItemRequest as f1, type UpdateOrderLineItemResponse as f2, type UpdateOrderLineItemsRequest as f3, type MaskedOrderLineItem as f4, type UpdateOrderLineItemsResponse as f5, type AddInternalActivityRequest as f6, type InternalActivity as f7, type InternalActivityContentOneOf as f8, type OrderPlaced as f9, type UpdateActivityResponse as fA, type DeleteActivityRequest as fB, type DeleteActivityResponse as fC, type UpdateLineItemsDescriptionLinesRequest as fD, type LineItemUpdate as fE, type UpdateLineItemsDescriptionLinesResponse as fF, type MarkOrderAsSeenByHumanRequest as fG, type MarkOrderAsSeenByHumanResponse as fH, type CancelOrderRequest as fI, type OrderCanceledEventOrderCanceled as fJ, type UpdateOrderStatusRequest as fK, type UpdateOrderStatusResponse as fL, type MarkAsFulfilledRequest as fM, type MarkAsFulfilledResponse as fN, type FulfillmentStatusUpdated as fO, type BulkMarkAsFulfilledRequest as fP, type BulkMarkAsFulfilledResponse as fQ, type BulkMarkAsFulfilledByFilterRequest as fR, type BulkMarkAsFulfilledByFilterResponse as fS, type MarkAsUnfulfilledRequest as fT, type MarkAsUnfulfilledResponse as fU, type BulkMarkAsUnfulfilledRequest as fV, type BulkMarkAsUnfulfilledResponse as fW, type BulkMarkAsUnfulfilledByFilterRequest as fX, type BulkMarkAsUnfulfilledByFilterResponse as fY, type BulkSetBusinessLocationRequest as fZ, type BulkSetBusinessLocationResponse as f_, type OrderPaid as fa, type OrderFulfilled as fb, type OrderNotFulfilled as fc, type OrderCanceled as fd, type DownloadLinkSent as fe, type TrackingNumberAdded as ff, type TrackingNumberEdited as fg, type TrackingLinkAdded as fh, type ShippingConfirmationEmailSent as fi, type InvoiceAdded as fj, type InvoiceSent as fk, type FulfillerEmailSent as fl, type ShippingAddressEdited as fm, type EmailEdited as fn, type PickupReadyEmailSent as fo, type OrderPartiallyPaid as fp, type OrderPending as fq, type OrderRejected as fr, type AddInternalActivityResponse as fs, type AddActivityRequest as ft, type PublicActivity as fu, type PublicActivityContentOneOf as fv, type AddActivityResponse as fw, type AddActivitiesRequest as fx, type AddActivitiesResponse as fy, type UpdateActivityRequest as fz, type GetOrderApplicationErrors as g, type OrderSearchSpec as g$, type V1MarkOrderAsPaidRequest as g0, type V1MarkOrderAsPaidResponse as g1, type PaymentStatusUpdated as g2, type V1BulkMarkOrdersAsPaidRequest as g3, type V1BulkMarkOrdersAsPaidResponse as g4, type V1CreatePaymentGatewayOrderRequest as g5, type V1CreatePaymentGatewayOrderResponse as g6, type GetShipmentsRequest as g7, type GetShipmentsResponse as g8, type AggregateOrdersRequest as g9, type InvoiceDates as gA, type LineItems as gB, type LineItem as gC, type BigDecimalWrapper as gD, type LineItemTax as gE, type Source as gF, type LineItemMetaData as gG, type Locale as gH, type TotalPrice as gI, type ItemizedFee as gJ, type Discount as gK, type DiscountOneDiscountTypeOneOf as gL, type CalculatedTaxes as gM, type CalculatedTax as gN, type Payments as gO, type InvoicesPayment as gP, type MetaData as gQ, type InvoiceDynamicPriceTotals as gR, type CustomFieldValue as gS, type Value as gT, type Deposit as gU, type TriggerSideEffectsFromLegacyData as gV, type BaseEventMetadata as gW, type EventMetadata as gX, type PaymentCollectionCreatePaymentGatewayOrderOptions as gY, type ChargeMembershipsOptions as gZ, type TriggerRefundOptions as g_, type AggregateOrdersResponse as ga, type DecrementItemsQuantityRequest as gb, type DecrementData as gc, type DecrementItemsQuantityResponse as gd, type BulkUpdateOrderTagsRequest as ge, type BulkUpdateOrderTagsResult as gf, type Task as gg, type TaskKey as gh, type TaskAction as gi, type TaskActionActionOneOf as gj, type Complete as gk, type Cancel as gl, type Reschedule as gm, type InvoiceSentEvent as gn, type IdAndVersion as go, type InvoiceFields as gp, type Customer as gq, type Email as gr, type QuotesAddress as gs, type AddressDescription as gt, type Phone as gu, type Company as gv, type CommonAddress as gw, type CommonAddressStreetOneOf as gx, type Subdivision as gy, type StandardDetails as gz, type OrderSearch as h, onOrderPaymentStatusUpdated as h$, type CommitDeltasOptions as h0, type UpdateOrderLineItemIdentifiers as h1, type UpdateOrderLineItem as h2, type UpdateActivityIdentifiers as h3, type DeleteActivityIdentifiers as h4, type AggregateOrdersOptions as h5, type DescriptionLineTypeWithLiterals as h6, type ItemTypeItemTypeWithLiterals as h7, type PaymentOptionTypeWithLiterals as h8, type JurisdictionTypeWithLiterals as h9, type ActionTypeWithLiterals as hA, type ChargebackStatusWithLiterals as hB, type MembershipPaymentStatusWithLiterals as hC, type RefundStatusWithLiterals as hD, type WebhookIdentityTypeWithLiterals as hE, type VersioningModeWithLiterals as hF, type SortOrderWithLiterals as hG, type OrderApprovalStrategyWithLiterals as hH, type DeltaPaymentOptionTypeWithLiterals as hI, type InventoryActionWithLiterals as hJ, type PlacementWithLiterals as hK, type SubdivisionTypeWithLiterals as hL, type SourceTypeWithLiterals as hM, type CustomFieldGroupWithLiterals as hN, type ValueTypeWithLiterals as hO, type DepositTypeWithLiterals as hP, type InvoiceStatusWithLiterals as hQ, type RecordManuallyCollectedPaymentApplicationErrors as hR, type PaymentCollectionMarkOrderAsPaidApplicationErrors as hS, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as hT, type TriggerRefundApplicationErrors as hU, type CommitDeltasApplicationErrors as hV, type UpdateOrderStatusApplicationErrors as hW, onOrderApproved as hX, onOrderUpdated as hY, onOrderCanceled as hZ, onOrderCreated as h_, type SubscriptionFrequencyWithLiterals as ha, type AdjustmentTypeWithLiterals as hb, type TaxableAddressTypeWithLiterals as hc, type PaymentStatusWithLiterals as hd, type FulfillmentStatusWithLiterals as he, type WeightUnitWithLiterals as hf, type VatTypeWithLiterals as hg, type PickupMethodWithLiterals as hh, type OrderStatusWithLiterals as hi, type DiscountTypeWithLiterals as hj, type DiscountReasonWithLiterals as hk, type LineItemQuantityChangeTypeWithLiterals as hl, type ActivityTypeWithLiterals as hm, type AttributionSourceWithLiterals as hn, type ChannelTypeWithLiterals as ho, type ScheduledActionWithLiterals as hp, type DurationUnitWithLiterals as hq, type PaymentCollectabilityStatusWithLiterals as hr, type RefundableStatusWithLiterals as hs, type NonRefundableReasonWithLiterals as ht, type ManuallyRefundableReasonWithLiterals as hu, type RestockTypeWithLiterals as hv, type TransactionStatusWithLiterals as hw, type AuthorizationCaptureStatusWithLiterals as hx, type AuthorizationVoidStatusWithLiterals as hy, type ReasonWithLiterals as hz, type CreateOrderOptions as i, preparePaymentCollection as i0, getPaymentCollectabilityStatus as i1, voidAuthorizedPayments as i2, captureAuthorizedPayments as i3, getOrder as i4, type CommonSearchWithEntityContext as i5, createOrder as i6, updateOrder as i7, bulkUpdateOrders as i8, cancelOrder as i9, bulkUpdateOrderTags as ia, type CreateOrderApplicationErrors as j, type UpdateOrderApplicationErrors as k, type BulkUpdateOrdersResponse as l, type CancelOrderOptions as m, type CancelOrderResponse as n, type CancelOrderApplicationErrors as o, type BulkUpdateOrderTagsOptions as p, type BulkUpdateOrderTagsResponse as q, type OrderApprovedEnvelope as r, type OrderUpdatedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCreatedEnvelope as u, type OrderPaymentStatusUpdatedEnvelope as v, PaymentOptionType as w, SubscriptionFrequency as x, PaymentStatus as y, VatType as z };
|
|
6001
|
+
export { LineItemQuantityChangeType as $, type AddActivityResponse as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, type DeleteActivityIdentifiers as D, type OrderCreatedEnvelope as E, type OrderPaymentStatusUpdatedEnvelope as F, type GetOrderApplicationErrors as G, DescriptionLineType as H, ItemTypeItemType as I, PaymentOptionType as J, JurisdictionType as K, SubscriptionFrequency as L, type MaskedOrder as M, AdjustmentType as N, type Order as O, type PublicActivity as P, PaymentStatus as Q, FulfillmentStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, PickupMethod as X, OrderStatus as Y, DiscountType as Z, DiscountReason as _, type OrderSearch as a, type PickupAddress as a$, ActivityType as a0, AttributionSource as a1, ChannelType as a2, VersioningMode as a3, WebhookIdentityType as a4, SortOrder as a5, OrderApprovalStrategy as a6, DeltaPaymentOptionType as a7, InventoryAction as a8, Placement as a9, type SubscriptionDescription as aA, type SubscriptionSettings as aB, type FreeTrialPeriod as aC, type BillingAdjustment as aD, type BillingAdjustmentPriceSummary as aE, type PriceDescription as aF, type LocationAndQuantity as aG, type TaxableAddress as aH, type TaxableAddressTaxableAddressDataOneOf as aI, type ExtendedFields as aJ, type ModifierGroup as aK, type TranslatableString as aL, type ItemModifier as aM, type BuyerInfo as aN, type BuyerInfoIdOneOf as aO, type CurrencyConversionDetails as aP, type PriceSummary as aQ, type AddressWithContact as aR, type Address as aS, type StreetAddress as aT, type AddressLocation as aU, type FullAddressContactDetails as aV, type VatId as aW, type V1ShippingInformation as aX, type DeliveryLogistics as aY, type DeliveryLogisticsAddressOneOf as aZ, type PickupDetails as a_, SubdivisionType as aa, SourceType as ab, CustomFieldGroup as ac, ValueType as ad, DepositType as ae, InvoiceStatus as af, type OrderLineItem as ag, type ProductName as ah, type CatalogReference as ai, type Price as aj, type DescriptionLine as ak, type DescriptionLineValueOneOf as al, type DescriptionLineDescriptionLineValueOneOf as am, type DescriptionLineName as an, type PlainTextValue as ao, type Color as ap, type FocalPoint as aq, type PhysicalProperties as ar, type ItemType as as, type ItemTypeItemTypeDataOneOf as at, type ItemTaxFullDetails as au, type LineItemTaxInfo as av, type LineItemTaxBreakdown as aw, type DigitalFile as ax, type SubscriptionInfo as ay, type SubscriptionTitle as az, type CreateOrderApplicationErrors as b, type ReceiptSentReceiptInfoOneOf as b$, type DeliveryTimeSlot as b0, type ShippingPrice as b1, type ShippingRegion as b2, type TaxSummary as b3, type OrderTaxInfo as b4, type OrderTaxBreakdown as b5, type AppliedDiscount as b6, type AppliedDiscountDiscountSourceOneOf as b7, type Coupon as b8, type MerchantDiscount as b9, type SavedPaymentMethod as bA, type AuthorizedPaymentCreated as bB, type AuthorizedPaymentCaptured as bC, type AuthorizedPaymentVoided as bD, type RefundInitiated as bE, type RefundedPayment as bF, type RefundedPaymentKindOneOf as bG, type RegularPaymentRefund as bH, type GiftCardPaymentRefund as bI, type MembershipPaymentRefund as bJ, type PaymentRefunded as bK, type PaymentRefundFailed as bL, type RefundedAsStoreCredit as bM, type PaymentPending as bN, type PaymentPendingPaymentDetailsOneOf as bO, type RegularPayment as bP, type RegularPaymentPaymentMethodDetailsOneOf as bQ, type CreditCardDetails as bR, type PaymentCanceled as bS, type PaymentCanceledPaymentDetailsOneOf as bT, type PaymentDeclined as bU, type PaymentDeclinedPaymentDetailsOneOf as bV, type ReceiptCreated as bW, type ReceiptCreatedReceiptInfoOneOf as bX, type WixReceipt as bY, type ExternalReceipt as bZ, type ReceiptSent as b_, type MerchantDiscountMerchantDiscountReasonOneOf as ba, type DiscountRule as bb, type DiscountRuleName as bc, type LineItemDiscount as bd, type Activity as be, type ActivityContentOneOf as bf, type CustomActivity as bg, type MerchantComment as bh, type OrderRefunded as bi, type OrderCreatedFromExchange as bj, type NewExchangeOrderCreated as bk, type LineItemExchangeData as bl, type DraftOrderChangesApplied as bm, type OrderChange as bn, type OrderChangeValueOneOf as bo, type LineItemChanges as bp, type LineItemQuantityChange as bq, type LineItemPriceChange as br, type ManagedLineItem as bs, type ManagedDiscount as bt, type TranslatedValue as bu, type LineItemAmount as bv, type ManagedAdditionalFee as bw, type TotalPriceChange as bx, type ShippingInformationChange as by, type ShippingInformation as bz, type UpdateOrderApplicationErrors as c, type CursorSearch as c$, type ChargebackCreated as c0, type ChargebackReversed as c1, type CreatedBy as c2, type CreatedByStringOneOf as c3, type ChannelInfo as c4, type CustomField as c5, type BalanceSummary as c6, type Balance as c7, type AdditionalFee as c8, type FulfillmentStatusesAggregate as c9, type EntityDeletedEvent as cA, type ActionEvent as cB, type Empty as cC, type BatchOfTriggerReindexOrderRequest as cD, type TriggerReindexOrderRequest as cE, type MessageEnvelope as cF, type IdentificationData as cG, type IdentificationDataIdOneOf as cH, type DiffmatokyPayload as cI, type ErrorInformation as cJ, type ContinueSideEffectsFlowInLegacyData as cK, type SnapshotMessage as cL, type IndexingMessage as cM, type GetOrderRequest as cN, type GetOrderResponse as cO, type InternalQueryOrdersRequest as cP, type PlatformQuery as cQ, type PlatformQueryPagingMethodOneOf as cR, type Sorting as cS, type PlatformPaging as cT, type CursorPaging as cU, type InternalQueryOrdersResponse as cV, type PlatformPagingMetadata as cW, type Cursors as cX, type QueryOrderRequest as cY, type QueryOrderResponse as cZ, type SearchOrdersRequest as c_, type Tags as ca, type TagList as cb, type Location as cc, type UpdateInternalDocumentsEvent as cd, type UpdateInternalDocumentsEventOperationOneOf as ce, type InternalDocument as cf, type InternalDocumentUpdateOperation as cg, type DeleteByIdsOperation as ch, type DeleteByFilterOperation as ci, type InternalDocumentUpdateByFilterOperation as cj, type InternalUpdateExistingOperation as ck, type VersionedDocumentUpdateOperation as cl, type VersionedDeleteByIdsOperation as cm, type VersionedDocumentId as cn, type OrderApproved as co, type OrdersExperiments as cp, type OrderRejectedEventOrderRejected as cq, type OrderItemsRestocked as cr, type RestockItem as cs, type TriggerReindexRequest as ct, type TriggerReindexResponse as cu, type DomainEvent as cv, type DomainEventBodyOneOf as cw, type EntityCreatedEvent as cx, type RestoreInfo as cy, type EntityUpdatedEvent as cz, type BulkUpdateOrdersResponse as d, type OrderPlaced as d$, type CursorSearchPagingMethodOneOf as d0, type CursorPagingMetadata as d1, type CreateOrderRequest as d2, type OrderCreationSettings as d3, type OrderCreateNotifications as d4, type CreateOrderResponse as d5, type UpdateOrderRequest as d6, type UpdateOrderResponse as d7, type BulkUpdateOrdersRequest as d8, type BulkOrderResult as d9, type ArchiveOrderResponse as dA, type BulkArchiveOrdersRequest as dB, type BulkArchiveOrdersResponse as dC, type BulkArchiveOrdersByFilterRequest as dD, type BulkArchiveOrdersByFilterResponse as dE, type UnArchiveOrderRequest as dF, type UnArchiveOrderResponse as dG, type BulkUnArchiveOrdersRequest as dH, type BulkUnArchiveOrdersResponse as dI, type BulkUnArchiveOrdersByFilterRequest as dJ, type BulkUnArchiveOrdersByFilterResponse as dK, type UpdateBuyerInfoRequest as dL, type BuyerInfoUpdate as dM, type UpdateBuyerInfoResponse as dN, type UpdateBuyerEmailRequest as dO, type UpdateBuyerEmailResponse as dP, type UpdateOrderShippingAddressRequest as dQ, type UpdateOrderShippingAddressResponse as dR, type UpdateBillingContactDetailsRequest as dS, type UpdateBillingContactDetailsResponse as dT, type UpdateOrderLineItemRequest as dU, type UpdateOrderLineItemsRequest as dV, type MaskedOrderLineItem as dW, type UpdateOrderLineItemsResponse as dX, type AddInternalActivityRequest as dY, type InternalActivity as dZ, type InternalActivityContentOneOf as d_, type ItemMetadata as da, type ApplicationError as db, type BulkActionMetadata as dc, type CommitDeltasRequest as dd, type DraftOrderDiffs as de, type DraftOrderDiffsShippingUpdateInfoOneOf as df, type DraftOrderDiffsBuyerUpdateInfoOneOf as dg, type DraftOrderDiffsBillingUpdateInfoOneOf as dh, type DraftOrderDiffsRecipientUpdateInfoOneOf as di, type V1LineItemDelta as dj, type V1LineItemDeltaDeltaOneOf as dk, type OrderLineItemChangedDetails as dl, type ItemChangedDetails as dm, type AppliedDiscountDelta as dn, type AppliedDiscountDeltaDeltaOneOf as dp, type AdditionalFeeDelta as dq, type AdditionalFeeDeltaDeltaOneOf as dr, type DraftOrderCommitSettings as ds, type InventoryUpdateDetails as dt, type OrderDeltasCommitted as du, type CommittedDiffs as dv, type CommittedDiffsShippingUpdateInfoOneOf as dw, type LineItemDelta as dx, type LineItemDeltaDeltaOneOf as dy, type ArchiveOrderRequest as dz, type CommitDeltasOptions as e, type BulkUpdateOrderTagsResult as e$, type OrderPaid as e0, type OrderFulfilled as e1, type OrderNotFulfilled as e2, type OrderCanceled as e3, type DownloadLinkSent as e4, type TrackingNumberAdded as e5, type TrackingNumberEdited as e6, type TrackingLinkAdded as e7, type ShippingConfirmationEmailSent as e8, type InvoiceAdded as e9, type BulkMarkAsFulfilledRequest as eA, type BulkMarkAsFulfilledResponse as eB, type BulkMarkAsFulfilledByFilterRequest as eC, type BulkMarkAsFulfilledByFilterResponse as eD, type MarkAsUnfulfilledRequest as eE, type MarkAsUnfulfilledResponse as eF, type BulkMarkAsUnfulfilledRequest as eG, type BulkMarkAsUnfulfilledResponse as eH, type BulkMarkAsUnfulfilledByFilterRequest as eI, type BulkMarkAsUnfulfilledByFilterResponse as eJ, type BulkSetBusinessLocationRequest as eK, type BulkSetBusinessLocationResponse as eL, type BulkSetBusinessLocationResult as eM, type MarkOrderAsPaidRequest as eN, type MarkOrderAsPaidResponse as eO, type PaymentStatusUpdated as eP, type BulkMarkOrdersAsPaidRequest as eQ, type BulkMarkOrdersAsPaidResponse as eR, type CreatePaymentGatewayOrderRequest as eS, type CreatePaymentGatewayOrderResponse as eT, type GetShipmentsRequest as eU, type GetShipmentsResponse as eV, type AggregateOrdersRequest as eW, type DecrementItemsQuantityRequest as eX, type DecrementData as eY, type DecrementItemsQuantityResponse as eZ, type BulkUpdateOrderTagsRequest as e_, type InvoiceSent as ea, type FulfillerEmailSent as eb, type ShippingAddressEdited as ec, type EmailEdited as ed, type PickupReadyEmailSent as ee, type OrderPartiallyPaid as ef, type OrderPending as eg, type OrderRejected as eh, type AddInternalActivityResponse as ei, type AddActivityRequest as ej, type PublicActivityContentOneOf as ek, type AddActivitiesRequest as el, type AddActivitiesResponse as em, type UpdateActivityRequest as en, type DeleteActivityRequest as eo, type UpdateLineItemsDescriptionLinesRequest as ep, type LineItemUpdate as eq, type UpdateLineItemsDescriptionLinesResponse as er, type MarkOrderAsSeenByHumanRequest as es, type MarkOrderAsSeenByHumanResponse as et, type CancelOrderRequest as eu, type OrderCanceledEventOrderCanceled as ev, type UpdateOrderStatusRequest as ew, type MarkAsFulfilledRequest as ex, type MarkAsFulfilledResponse as ey, type FulfillmentStatusUpdated as ez, type CommitDeltasResponse as f, type VersioningModeWithLiterals as f$, type Task as f0, type TaskKey as f1, type TaskAction as f2, type TaskActionActionOneOf as f3, type Complete as f4, type Cancel as f5, type Reschedule as f6, type InvoiceSentEvent as f7, type IdAndVersion as f8, type InvoiceFields as f9, type MetaData as fA, type InvoiceDynamicPriceTotals as fB, type CustomFieldValue as fC, type Value as fD, type Deposit as fE, type TriggerSideEffectsFromLegacyData as fF, type BaseEventMetadata as fG, type EventMetadata as fH, type OrderSearchSpec as fI, type DescriptionLineTypeWithLiterals as fJ, type ItemTypeItemTypeWithLiterals as fK, type PaymentOptionTypeWithLiterals as fL, type JurisdictionTypeWithLiterals as fM, type SubscriptionFrequencyWithLiterals as fN, type AdjustmentTypeWithLiterals as fO, type TaxableAddressTypeWithLiterals as fP, type PaymentStatusWithLiterals as fQ, type FulfillmentStatusWithLiterals as fR, type WeightUnitWithLiterals as fS, type VatTypeWithLiterals as fT, type PickupMethodWithLiterals as fU, type DiscountTypeWithLiterals as fV, type DiscountReasonWithLiterals as fW, type LineItemQuantityChangeTypeWithLiterals as fX, type ActivityTypeWithLiterals as fY, type AttributionSourceWithLiterals as fZ, type ChannelTypeWithLiterals as f_, type Customer as fa, type Email as fb, type QuotesAddress as fc, type AddressDescription as fd, type Phone as fe, type Company as ff, type CommonAddress as fg, type CommonAddressStreetOneOf as fh, type Subdivision as fi, type StandardDetails as fj, type InvoiceDates as fk, type LineItems as fl, type LineItem as fm, type BigDecimalWrapper as fn, type LineItemTax as fo, type Source as fp, type LineItemMetaData as fq, type Locale as fr, type TotalPrice as fs, type ItemizedFee as ft, type Discount as fu, type DiscountOneDiscountTypeOneOf as fv, type CalculatedTaxes as fw, type CalculatedTax as fx, type Payments as fy, type Payment as fz, type CommitDeltasApplicationErrors as g, type WebhookIdentityTypeWithLiterals as g0, type SortOrderWithLiterals as g1, type OrderApprovalStrategyWithLiterals as g2, type DeltaPaymentOptionTypeWithLiterals as g3, type InventoryActionWithLiterals as g4, type PlacementWithLiterals as g5, type SubdivisionTypeWithLiterals as g6, type SourceTypeWithLiterals as g7, type CustomFieldGroupWithLiterals as g8, type ValueTypeWithLiterals as g9, type DepositTypeWithLiterals as ga, type InvoiceStatusWithLiterals as gb, onOrderApproved as gc, onOrderUpdated as gd, onOrderCanceled as ge, onOrderCreated as gf, onOrderPaymentStatusUpdated as gg, getOrder as gh, type CommonSearchWithEntityContext as gi, createOrder as gj, updateOrder as gk, bulkUpdateOrders as gl, commitDeltas as gm, updateOrderLineItem as gn, addActivity as go, updateActivity as gp, deleteActivity as gq, cancelOrder as gr, updateOrderStatus as gs, aggregateOrders as gt, bulkUpdateOrderTags as gu, type UpdateOrderLineItemIdentifiers as h, type UpdateOrderLineItem as i, type UpdateOrderLineItemResponse as j, type UpdateActivityIdentifiers as k, type UpdateActivityResponse as l, type DeleteActivityResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type OrderStatusWithLiterals as q, type UpdateOrderStatusResponse as r, type UpdateOrderStatusApplicationErrors as s, type AggregateOrdersOptions as t, type AggregateOrdersResponse as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderUpdatedEnvelope as y, type OrderCanceledEnvelope as z };
|