@wix/auto_sdk_ecom_orders 1.0.60 → 1.0.62
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-Dg-mwHfT.d.ts → cjs/ecom-v1-order-orders.universal-CaDvypy_.d.ts} +584 -393
- package/build/cjs/index.d.ts +23 -9
- package/build/cjs/index.js +9 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +31 -0
- package/build/cjs/index.typings.js +3086 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-Dg-mwHfT.d.mts → es/ecom-v1-order-orders.universal-CaDvypy_.d.mts} +584 -393
- package/build/es/index.d.mts +23 -9
- package/build/es/index.mjs +8 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +31 -0
- package/build/es/index.typings.mjs +2986 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-C65mdJbP.d.ts → internal/cjs/ecom-v1-order-orders.universal-EM8BrJdd.d.ts} +1264 -2
- package/build/internal/cjs/index.d.ts +41 -15
- package/build/internal/cjs/index.js +9 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +31 -0
- package/build/internal/cjs/index.typings.js +3086 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -1
- package/build/{es/ecom-v1-order-orders.universal-C65mdJbP.d.mts → internal/es/ecom-v1-order-orders.universal-EM8BrJdd.d.mts} +1264 -2
- package/build/internal/es/index.d.mts +41 -15
- package/build/internal/es/index.mjs +8 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +31 -0
- package/build/internal/es/index.typings.mjs +2986 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { SearchSpec, Search } from '@wix/sdk-types';
|
|
1
|
+
import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
3
|
interface Order {
|
|
4
4
|
/**
|
|
@@ -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 {
|
|
@@ -422,6 +440,8 @@ declare enum DescriptionLineType {
|
|
|
422
440
|
/** Color type. */
|
|
423
441
|
COLOR = "COLOR"
|
|
424
442
|
}
|
|
443
|
+
/** @enumType */
|
|
444
|
+
type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
425
445
|
interface FocalPoint {
|
|
426
446
|
/** X-coordinate of the focal point. */
|
|
427
447
|
x?: number;
|
|
@@ -601,6 +621,11 @@ interface SubscriptionInfo {
|
|
|
601
621
|
* @targetRemovalDate 2025-10-01
|
|
602
622
|
*/
|
|
603
623
|
subscriptionOptionTitle?: string;
|
|
624
|
+
/**
|
|
625
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
title?: SubscriptionTitle;
|
|
604
629
|
/**
|
|
605
630
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
606
631
|
* @maxLength 60
|
|
@@ -609,6 +634,11 @@ interface SubscriptionInfo {
|
|
|
609
634
|
* @targetRemovalDate 2025-10-01
|
|
610
635
|
*/
|
|
611
636
|
subscriptionOptionDescription?: string | null;
|
|
637
|
+
/**
|
|
638
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
639
|
+
* @internal
|
|
640
|
+
*/
|
|
641
|
+
description?: SubscriptionDescription;
|
|
612
642
|
/**
|
|
613
643
|
* Subscription detailed information.
|
|
614
644
|
* @immutable
|
|
@@ -619,6 +649,11 @@ interface SubscriptionInfo {
|
|
|
619
649
|
* @maxLength 1000
|
|
620
650
|
*/
|
|
621
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;
|
|
622
657
|
}
|
|
623
658
|
interface SubscriptionTitle {
|
|
624
659
|
/**
|
|
@@ -668,6 +703,11 @@ interface SubscriptionSettings {
|
|
|
668
703
|
enableCustomerCancellation?: boolean;
|
|
669
704
|
/** Period until first cycle starts. If None => no free trial */
|
|
670
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;
|
|
671
711
|
}
|
|
672
712
|
/** Frequency unit of recurring payment */
|
|
673
713
|
declare enum SubscriptionFrequency {
|
|
@@ -1344,6 +1384,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1344
1384
|
* @immutable
|
|
1345
1385
|
*/
|
|
1346
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;
|
|
1347
1395
|
}
|
|
1348
1396
|
/** @oneof */
|
|
1349
1397
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -1385,6 +1433,13 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1385
1433
|
description?: string | null;
|
|
1386
1434
|
/** Discount amount. */
|
|
1387
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;
|
|
1388
1443
|
}
|
|
1389
1444
|
/** @oneof */
|
|
1390
1445
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -1447,6 +1502,70 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1447
1502
|
merchantComment?: MerchantComment;
|
|
1448
1503
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1449
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;
|
|
1450
1569
|
/**
|
|
1451
1570
|
* Activity ID.
|
|
1452
1571
|
* @format GUID
|
|
@@ -1475,6 +1594,70 @@ interface ActivityContentOneOf {
|
|
|
1475
1594
|
merchantComment?: MerchantComment;
|
|
1476
1595
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1477
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;
|
|
1478
1661
|
}
|
|
1479
1662
|
interface CustomActivity {
|
|
1480
1663
|
/**
|
|
@@ -2011,6 +2194,40 @@ interface ReceiptSentReceiptInfoOneOf {
|
|
|
2011
2194
|
/** Receipt created by an external system. */
|
|
2012
2195
|
externalReceipt?: ExternalReceipt;
|
|
2013
2196
|
}
|
|
2197
|
+
interface ChargebackCreated {
|
|
2198
|
+
/**
|
|
2199
|
+
* ID of the payment that received a chargeback.
|
|
2200
|
+
* @format GUID
|
|
2201
|
+
*/
|
|
2202
|
+
paymentId?: string;
|
|
2203
|
+
/**
|
|
2204
|
+
* Chargeback ID.
|
|
2205
|
+
* @format GUID
|
|
2206
|
+
*/
|
|
2207
|
+
chargebackId?: string;
|
|
2208
|
+
/** Chargeback amount. */
|
|
2209
|
+
amount?: Price;
|
|
2210
|
+
/** Payment details. */
|
|
2211
|
+
paymentDetails?: RegularPayment;
|
|
2212
|
+
}
|
|
2213
|
+
interface ChargebackReversed {
|
|
2214
|
+
/**
|
|
2215
|
+
* ID of the payment involved with the chargeback.
|
|
2216
|
+
* @format GUID
|
|
2217
|
+
*/
|
|
2218
|
+
paymentId?: string;
|
|
2219
|
+
/**
|
|
2220
|
+
* Chargeback ID.
|
|
2221
|
+
* @format GUID
|
|
2222
|
+
*/
|
|
2223
|
+
chargebackId?: string;
|
|
2224
|
+
/** Chargeback amount. */
|
|
2225
|
+
amount?: Price;
|
|
2226
|
+
/** Chargeback reversal amount. */
|
|
2227
|
+
reversalAmount?: Price;
|
|
2228
|
+
/** Payment details. */
|
|
2229
|
+
paymentDetails?: RegularPayment;
|
|
2230
|
+
}
|
|
2014
2231
|
declare enum ActivityType {
|
|
2015
2232
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2016
2233
|
ORDER_PLACED = "ORDER_PLACED",
|
|
@@ -2192,11 +2409,29 @@ interface BalanceSummary {
|
|
|
2192
2409
|
* @readonly
|
|
2193
2410
|
*/
|
|
2194
2411
|
authorized?: Price;
|
|
2412
|
+
/**
|
|
2413
|
+
* Sum of all pending refund transactions.
|
|
2414
|
+
* @internal
|
|
2415
|
+
* @readonly
|
|
2416
|
+
*/
|
|
2417
|
+
pendingRefund?: Price;
|
|
2195
2418
|
/**
|
|
2196
2419
|
* Sum of all pending transactions.
|
|
2197
2420
|
* @readonly
|
|
2198
2421
|
*/
|
|
2199
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;
|
|
2200
2435
|
}
|
|
2201
2436
|
/**
|
|
2202
2437
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2258,6 +2493,14 @@ interface AdditionalFee {
|
|
|
2258
2493
|
* @format GUID
|
|
2259
2494
|
*/
|
|
2260
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;
|
|
2261
2504
|
}
|
|
2262
2505
|
interface FulfillmentStatusesAggregate {
|
|
2263
2506
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -2374,6 +2617,17 @@ interface PreparePaymentCollectionRequest {
|
|
|
2374
2617
|
* @targetRemovalDate 2024-09-30
|
|
2375
2618
|
*/
|
|
2376
2619
|
delayedCapture?: boolean;
|
|
2620
|
+
/**
|
|
2621
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
2622
|
+
* Default: `true`
|
|
2623
|
+
* @internal
|
|
2624
|
+
*/
|
|
2625
|
+
merchantInitiated?: boolean | null;
|
|
2626
|
+
/**
|
|
2627
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
2628
|
+
* @internal
|
|
2629
|
+
*/
|
|
2630
|
+
redirectUrls?: RedirectUrls;
|
|
2377
2631
|
/** Delayed capture payment settings */
|
|
2378
2632
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2379
2633
|
}
|
|
@@ -2899,6 +3153,16 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
|
2899
3153
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2900
3154
|
/** Gift card payment details. */
|
|
2901
3155
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3156
|
+
/**
|
|
3157
|
+
* Receipt created by Wix
|
|
3158
|
+
* @internal
|
|
3159
|
+
*/
|
|
3160
|
+
wixReceipt?: WixReceiptInfo;
|
|
3161
|
+
/**
|
|
3162
|
+
* Receipt created by an external system.
|
|
3163
|
+
* @internal
|
|
3164
|
+
*/
|
|
3165
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
2902
3166
|
/**
|
|
2903
3167
|
* Payment ID.
|
|
2904
3168
|
* @format GUID
|
|
@@ -2920,6 +3184,14 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
|
2920
3184
|
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2921
3185
|
*/
|
|
2922
3186
|
refundDisabled?: boolean;
|
|
3187
|
+
/**
|
|
3188
|
+
* Whether receipt generation for this payment are allowed.
|
|
3189
|
+
* + `true`: This payment supports receipt generation.
|
|
3190
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
3191
|
+
* @internal
|
|
3192
|
+
* @readonly
|
|
3193
|
+
*/
|
|
3194
|
+
supportReceiptGeneration?: boolean;
|
|
2923
3195
|
}
|
|
2924
3196
|
/** @oneof */
|
|
2925
3197
|
interface PaymentPaymentDetailsOneOf {
|
|
@@ -2930,6 +3202,16 @@ interface PaymentPaymentDetailsOneOf {
|
|
|
2930
3202
|
}
|
|
2931
3203
|
/** @oneof */
|
|
2932
3204
|
interface PaymentReceiptInfoOneOf {
|
|
3205
|
+
/**
|
|
3206
|
+
* Receipt created by Wix
|
|
3207
|
+
* @internal
|
|
3208
|
+
*/
|
|
3209
|
+
wixReceipt?: WixReceiptInfo;
|
|
3210
|
+
/**
|
|
3211
|
+
* Receipt created by an external system.
|
|
3212
|
+
* @internal
|
|
3213
|
+
*/
|
|
3214
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
2933
3215
|
}
|
|
2934
3216
|
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2935
3217
|
/** Whether regular card used */
|
|
@@ -2967,6 +3249,12 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
|
|
|
2967
3249
|
savedPaymentMethod?: boolean;
|
|
2968
3250
|
/** Authorization details. */
|
|
2969
3251
|
authorizationDetails?: AuthorizationDetails;
|
|
3252
|
+
/**
|
|
3253
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
3254
|
+
* @internal
|
|
3255
|
+
* @maxLength 300
|
|
3256
|
+
*/
|
|
3257
|
+
paymentProvider?: string | null;
|
|
2970
3258
|
}
|
|
2971
3259
|
/** @oneof */
|
|
2972
3260
|
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
@@ -3096,6 +3384,59 @@ declare enum ActionType {
|
|
|
3096
3384
|
}
|
|
3097
3385
|
/** @enumType */
|
|
3098
3386
|
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3387
|
+
interface Chargeback {
|
|
3388
|
+
/**
|
|
3389
|
+
* Chargeback ID.
|
|
3390
|
+
* @format GUID
|
|
3391
|
+
* @readonly
|
|
3392
|
+
* @immutable
|
|
3393
|
+
*/
|
|
3394
|
+
_id?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* 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.
|
|
3397
|
+
* @readonly
|
|
3398
|
+
* @immutable
|
|
3399
|
+
*/
|
|
3400
|
+
_createdDate?: Date | null;
|
|
3401
|
+
/**
|
|
3402
|
+
* 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.
|
|
3403
|
+
* @readonly
|
|
3404
|
+
*/
|
|
3405
|
+
_updatedDate?: Date | null;
|
|
3406
|
+
/**
|
|
3407
|
+
* Amount.
|
|
3408
|
+
* @readonly
|
|
3409
|
+
* @immutable
|
|
3410
|
+
*/
|
|
3411
|
+
amount?: Price;
|
|
3412
|
+
/**
|
|
3413
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
3414
|
+
* @readonly
|
|
3415
|
+
*/
|
|
3416
|
+
reversalAmount?: Price;
|
|
3417
|
+
/**
|
|
3418
|
+
* Status.
|
|
3419
|
+
*
|
|
3420
|
+
* Default: `"APPROVED"`.
|
|
3421
|
+
*/
|
|
3422
|
+
status?: ChargebackStatusWithLiterals;
|
|
3423
|
+
/**
|
|
3424
|
+
* External chargeback ID.
|
|
3425
|
+
* @format GUID
|
|
3426
|
+
* @readonly
|
|
3427
|
+
* @immutable
|
|
3428
|
+
*/
|
|
3429
|
+
externalId?: string | null;
|
|
3430
|
+
}
|
|
3431
|
+
declare enum ChargebackStatus {
|
|
3432
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3433
|
+
/** Chargeback was approved. */
|
|
3434
|
+
APPROVED = "APPROVED",
|
|
3435
|
+
/** Chargeback was reversed. */
|
|
3436
|
+
REVERSED = "REVERSED"
|
|
3437
|
+
}
|
|
3438
|
+
/** @enumType */
|
|
3439
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3099
3440
|
interface GiftCardPaymentDetails {
|
|
3100
3441
|
/**
|
|
3101
3442
|
* Gift card payment ID.
|
|
@@ -3113,6 +3454,13 @@ interface GiftCardPaymentDetails {
|
|
|
3113
3454
|
* @readonly
|
|
3114
3455
|
*/
|
|
3115
3456
|
voided?: boolean;
|
|
3457
|
+
/**
|
|
3458
|
+
* Gift card obfuscated code.
|
|
3459
|
+
* @internal
|
|
3460
|
+
* @maxLength 30
|
|
3461
|
+
* @immutable
|
|
3462
|
+
*/
|
|
3463
|
+
obfuscatedCode?: string | null;
|
|
3116
3464
|
}
|
|
3117
3465
|
interface MembershipPaymentDetails {
|
|
3118
3466
|
/**
|
|
@@ -4761,6 +5109,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
4761
5109
|
changedShippingInfo?: V1ShippingInformation;
|
|
4762
5110
|
/** Remove existing shipping info. */
|
|
4763
5111
|
shippingInfoRemoved?: boolean;
|
|
5112
|
+
/**
|
|
5113
|
+
* Buyer info and selected buyer option details.
|
|
5114
|
+
* @internal
|
|
5115
|
+
*/
|
|
5116
|
+
changedBuyerInfo?: BuyerInfo;
|
|
5117
|
+
/**
|
|
5118
|
+
* Remove existing buyer info.
|
|
5119
|
+
* @internal
|
|
5120
|
+
*/
|
|
5121
|
+
buyerInfoRemoved?: boolean;
|
|
5122
|
+
/**
|
|
5123
|
+
* Updated billing info.
|
|
5124
|
+
* @internal
|
|
5125
|
+
*/
|
|
5126
|
+
changedBillingInfo?: AddressWithContact;
|
|
5127
|
+
/**
|
|
5128
|
+
* Remove existing billing info.
|
|
5129
|
+
* @internal
|
|
5130
|
+
*/
|
|
5131
|
+
billingInfoRemoved?: boolean;
|
|
5132
|
+
/**
|
|
5133
|
+
* Updated recipient info.
|
|
5134
|
+
* @internal
|
|
5135
|
+
*/
|
|
5136
|
+
changedRecipientInfo?: AddressWithContact;
|
|
5137
|
+
/**
|
|
5138
|
+
* Remove existing recipient info.
|
|
5139
|
+
* @internal
|
|
5140
|
+
*/
|
|
5141
|
+
recipientInfoRemoved?: boolean;
|
|
4764
5142
|
/**
|
|
4765
5143
|
* Added/updated/removed order line items.
|
|
4766
5144
|
* @maxSize 300
|
|
@@ -4802,12 +5180,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
4802
5180
|
}
|
|
4803
5181
|
/** @oneof */
|
|
4804
5182
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
5183
|
+
/**
|
|
5184
|
+
* Buyer info and selected buyer option details.
|
|
5185
|
+
* @internal
|
|
5186
|
+
*/
|
|
5187
|
+
changedBuyerInfo?: BuyerInfo;
|
|
5188
|
+
/**
|
|
5189
|
+
* Remove existing buyer info.
|
|
5190
|
+
* @internal
|
|
5191
|
+
*/
|
|
5192
|
+
buyerInfoRemoved?: boolean;
|
|
4805
5193
|
}
|
|
4806
5194
|
/** @oneof */
|
|
4807
5195
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
5196
|
+
/**
|
|
5197
|
+
* Updated billing info.
|
|
5198
|
+
* @internal
|
|
5199
|
+
*/
|
|
5200
|
+
changedBillingInfo?: AddressWithContact;
|
|
5201
|
+
/**
|
|
5202
|
+
* Remove existing billing info.
|
|
5203
|
+
* @internal
|
|
5204
|
+
*/
|
|
5205
|
+
billingInfoRemoved?: boolean;
|
|
4808
5206
|
}
|
|
4809
5207
|
/** @oneof */
|
|
4810
5208
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
5209
|
+
/**
|
|
5210
|
+
* Updated recipient info.
|
|
5211
|
+
* @internal
|
|
5212
|
+
*/
|
|
5213
|
+
changedRecipientInfo?: AddressWithContact;
|
|
5214
|
+
/**
|
|
5215
|
+
* Remove existing recipient info.
|
|
5216
|
+
* @internal
|
|
5217
|
+
*/
|
|
5218
|
+
recipientInfoRemoved?: boolean;
|
|
4811
5219
|
}
|
|
4812
5220
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4813
5221
|
/** The line item was added. */
|
|
@@ -4907,8 +5315,21 @@ interface OrderLineItemChangedDetails {
|
|
|
4907
5315
|
* @maxSize 5
|
|
4908
5316
|
*/
|
|
4909
5317
|
locations?: LocationAndQuantity[];
|
|
5318
|
+
/**
|
|
5319
|
+
* ID of the app managing the inventory.
|
|
5320
|
+
* @internal
|
|
5321
|
+
* @format GUID
|
|
5322
|
+
*/
|
|
5323
|
+
inventoryAppId?: string | null;
|
|
4910
5324
|
/** Subscription info. */
|
|
4911
5325
|
subscriptionInfo?: SubscriptionInfo;
|
|
5326
|
+
/**
|
|
5327
|
+
* Modifier groups that were added to the item.
|
|
5328
|
+
* @internal
|
|
5329
|
+
* @readonly
|
|
5330
|
+
* @maxSize 10
|
|
5331
|
+
*/
|
|
5332
|
+
modifierGroups?: ModifierGroup[];
|
|
4912
5333
|
}
|
|
4913
5334
|
/** Type of selected payment option for catalog item */
|
|
4914
5335
|
declare enum DeltaPaymentOptionType {
|
|
@@ -5295,6 +5716,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5295
5716
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5296
5717
|
/** Payment method is saved for order */
|
|
5297
5718
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5719
|
+
/**
|
|
5720
|
+
* Details of an initiated refund process.
|
|
5721
|
+
*
|
|
5722
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5723
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5724
|
+
* @internal
|
|
5725
|
+
*/
|
|
5726
|
+
refundInitiated?: RefundInitiated;
|
|
5727
|
+
/**
|
|
5728
|
+
* Details of a refunded payment.
|
|
5729
|
+
*
|
|
5730
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5731
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5732
|
+
* @internal
|
|
5733
|
+
*/
|
|
5734
|
+
paymentRefunded?: PaymentRefunded;
|
|
5735
|
+
/**
|
|
5736
|
+
* Details of a failed payment refund.
|
|
5737
|
+
*
|
|
5738
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5739
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5740
|
+
* @internal
|
|
5741
|
+
*/
|
|
5742
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5743
|
+
/**
|
|
5744
|
+
* Details of refund to store credit.
|
|
5745
|
+
* @internal
|
|
5746
|
+
*/
|
|
5747
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5298
5748
|
/** Details of a pending payment */
|
|
5299
5749
|
paymentPending?: PaymentPending;
|
|
5300
5750
|
/** Details of a canceled payment */
|
|
@@ -5305,6 +5755,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5305
5755
|
orderPending?: OrderPending;
|
|
5306
5756
|
/** Order rejected */
|
|
5307
5757
|
orderRejected?: OrderRejected;
|
|
5758
|
+
/**
|
|
5759
|
+
* Receipt was added for associated payment
|
|
5760
|
+
* @internal
|
|
5761
|
+
*/
|
|
5762
|
+
receiptCreated?: ReceiptCreated;
|
|
5763
|
+
/**
|
|
5764
|
+
* Receipt sent to customer
|
|
5765
|
+
* @internal
|
|
5766
|
+
*/
|
|
5767
|
+
receiptSent?: ReceiptSent;
|
|
5768
|
+
/**
|
|
5769
|
+
* Chargeback created for one of the order's payments.
|
|
5770
|
+
* @internal
|
|
5771
|
+
*/
|
|
5772
|
+
chargebackCreated?: ChargebackCreated;
|
|
5773
|
+
/**
|
|
5774
|
+
* Chargeback reversed for one of the order's payments.
|
|
5775
|
+
* @internal
|
|
5776
|
+
*/
|
|
5777
|
+
chargebackReversed?: ChargebackReversed;
|
|
5308
5778
|
/**
|
|
5309
5779
|
* Internal activity ID.
|
|
5310
5780
|
* @format GUID
|
|
@@ -5369,6 +5839,35 @@ interface InternalActivityContentOneOf {
|
|
|
5369
5839
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5370
5840
|
/** Payment method is saved for order */
|
|
5371
5841
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5842
|
+
/**
|
|
5843
|
+
* Details of an initiated refund process.
|
|
5844
|
+
*
|
|
5845
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5846
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5847
|
+
* @internal
|
|
5848
|
+
*/
|
|
5849
|
+
refundInitiated?: RefundInitiated;
|
|
5850
|
+
/**
|
|
5851
|
+
* Details of a refunded payment.
|
|
5852
|
+
*
|
|
5853
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5854
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5855
|
+
* @internal
|
|
5856
|
+
*/
|
|
5857
|
+
paymentRefunded?: PaymentRefunded;
|
|
5858
|
+
/**
|
|
5859
|
+
* Details of a failed payment refund.
|
|
5860
|
+
*
|
|
5861
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5862
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5863
|
+
* @internal
|
|
5864
|
+
*/
|
|
5865
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5866
|
+
/**
|
|
5867
|
+
* Details of refund to store credit.
|
|
5868
|
+
* @internal
|
|
5869
|
+
*/
|
|
5870
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5372
5871
|
/** Details of a pending payment */
|
|
5373
5872
|
paymentPending?: PaymentPending;
|
|
5374
5873
|
/** Details of a canceled payment */
|
|
@@ -5379,6 +5878,26 @@ interface InternalActivityContentOneOf {
|
|
|
5379
5878
|
orderPending?: OrderPending;
|
|
5380
5879
|
/** Order rejected */
|
|
5381
5880
|
orderRejected?: OrderRejected;
|
|
5881
|
+
/**
|
|
5882
|
+
* Receipt was added for associated payment
|
|
5883
|
+
* @internal
|
|
5884
|
+
*/
|
|
5885
|
+
receiptCreated?: ReceiptCreated;
|
|
5886
|
+
/**
|
|
5887
|
+
* Receipt sent to customer
|
|
5888
|
+
* @internal
|
|
5889
|
+
*/
|
|
5890
|
+
receiptSent?: ReceiptSent;
|
|
5891
|
+
/**
|
|
5892
|
+
* Chargeback created for one of the order's payments.
|
|
5893
|
+
* @internal
|
|
5894
|
+
*/
|
|
5895
|
+
chargebackCreated?: ChargebackCreated;
|
|
5896
|
+
/**
|
|
5897
|
+
* Chargeback reversed for one of the order's payments.
|
|
5898
|
+
* @internal
|
|
5899
|
+
*/
|
|
5900
|
+
chargebackReversed?: ChargebackReversed;
|
|
5382
5901
|
}
|
|
5383
5902
|
/** Order placed */
|
|
5384
5903
|
interface OrderPlaced {
|
|
@@ -6071,6 +6590,8 @@ declare enum SubdivisionType {
|
|
|
6071
6590
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
6072
6591
|
COUNTRY = "COUNTRY"
|
|
6073
6592
|
}
|
|
6593
|
+
/** @enumType */
|
|
6594
|
+
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
6074
6595
|
/** Subdivision Concordance values */
|
|
6075
6596
|
interface StandardDetails {
|
|
6076
6597
|
/**
|
|
@@ -6321,6 +6842,175 @@ interface TriggerSideEffectsFromLegacyData {
|
|
|
6321
6842
|
orderId?: string;
|
|
6322
6843
|
ordersExperiments?: OrdersExperiments;
|
|
6323
6844
|
}
|
|
6845
|
+
type PreparePaymentCollectionApplicationErrors = {
|
|
6846
|
+
code?: 'PAYMENT_METHODS_NOT_FOUND';
|
|
6847
|
+
description?: string;
|
|
6848
|
+
data?: Record<string, any>;
|
|
6849
|
+
} | {
|
|
6850
|
+
code?: 'ORDER_CANCELED';
|
|
6851
|
+
description?: string;
|
|
6852
|
+
data?: Record<string, any>;
|
|
6853
|
+
} | {
|
|
6854
|
+
code?: 'INVALID_AMOUNT';
|
|
6855
|
+
description?: string;
|
|
6856
|
+
data?: Record<string, any>;
|
|
6857
|
+
} | {
|
|
6858
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6859
|
+
description?: string;
|
|
6860
|
+
data?: Record<string, any>;
|
|
6861
|
+
} | {
|
|
6862
|
+
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
6863
|
+
description?: string;
|
|
6864
|
+
data?: Record<string, any>;
|
|
6865
|
+
};
|
|
6866
|
+
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
6867
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6868
|
+
description?: string;
|
|
6869
|
+
data?: Record<string, any>;
|
|
6870
|
+
} | {
|
|
6871
|
+
code?: 'INVALID_AMOUNT';
|
|
6872
|
+
description?: string;
|
|
6873
|
+
data?: Record<string, any>;
|
|
6874
|
+
} | {
|
|
6875
|
+
code?: 'ORDER_CANCELED';
|
|
6876
|
+
description?: string;
|
|
6877
|
+
data?: Record<string, any>;
|
|
6878
|
+
};
|
|
6879
|
+
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
6880
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6881
|
+
description?: string;
|
|
6882
|
+
data?: Record<string, any>;
|
|
6883
|
+
} | {
|
|
6884
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6885
|
+
description?: string;
|
|
6886
|
+
data?: Record<string, any>;
|
|
6887
|
+
};
|
|
6888
|
+
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
6889
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6890
|
+
description?: string;
|
|
6891
|
+
data?: Record<string, any>;
|
|
6892
|
+
} | {
|
|
6893
|
+
code?: 'ORDER_CANCELED';
|
|
6894
|
+
description?: string;
|
|
6895
|
+
data?: Record<string, any>;
|
|
6896
|
+
};
|
|
6897
|
+
type TriggerRefundApplicationErrors = {
|
|
6898
|
+
code?: 'PAYMENTS_NOT_FOUND';
|
|
6899
|
+
description?: string;
|
|
6900
|
+
data?: Record<string, any>;
|
|
6901
|
+
} | {
|
|
6902
|
+
code?: 'REFUND_NOT_AVAILABLE';
|
|
6903
|
+
description?: string;
|
|
6904
|
+
data?: Record<string, any>;
|
|
6905
|
+
} | {
|
|
6906
|
+
code?: 'INVALID_AMOUNT';
|
|
6907
|
+
description?: string;
|
|
6908
|
+
data?: Record<string, any>;
|
|
6909
|
+
};
|
|
6910
|
+
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
6911
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6912
|
+
description?: string;
|
|
6913
|
+
data?: Record<string, any>;
|
|
6914
|
+
} | {
|
|
6915
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6916
|
+
description?: string;
|
|
6917
|
+
data?: Record<string, any>;
|
|
6918
|
+
} | {
|
|
6919
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6920
|
+
description?: string;
|
|
6921
|
+
data?: Record<string, any>;
|
|
6922
|
+
} | {
|
|
6923
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6924
|
+
description?: string;
|
|
6925
|
+
data?: Record<string, any>;
|
|
6926
|
+
} | {
|
|
6927
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6928
|
+
description?: string;
|
|
6929
|
+
data?: Record<string, any>;
|
|
6930
|
+
};
|
|
6931
|
+
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
6932
|
+
code?: 'INVALID_AMOUNT';
|
|
6933
|
+
description?: string;
|
|
6934
|
+
data?: Record<string, any>;
|
|
6935
|
+
} | {
|
|
6936
|
+
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
6937
|
+
description?: string;
|
|
6938
|
+
data?: Record<string, any>;
|
|
6939
|
+
} | {
|
|
6940
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6941
|
+
description?: string;
|
|
6942
|
+
data?: Record<string, any>;
|
|
6943
|
+
} | {
|
|
6944
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6945
|
+
description?: string;
|
|
6946
|
+
data?: Record<string, any>;
|
|
6947
|
+
} | {
|
|
6948
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6949
|
+
description?: string;
|
|
6950
|
+
data?: Record<string, any>;
|
|
6951
|
+
} | {
|
|
6952
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6953
|
+
description?: string;
|
|
6954
|
+
data?: Record<string, any>;
|
|
6955
|
+
} | {
|
|
6956
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6957
|
+
description?: string;
|
|
6958
|
+
data?: Record<string, any>;
|
|
6959
|
+
} | {
|
|
6960
|
+
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6961
|
+
description?: string;
|
|
6962
|
+
data?: Record<string, any>;
|
|
6963
|
+
};
|
|
6964
|
+
type GetOrderApplicationErrors = {
|
|
6965
|
+
code?: 'ORDER_NOT_FOUND';
|
|
6966
|
+
description?: string;
|
|
6967
|
+
data?: Record<string, any>;
|
|
6968
|
+
};
|
|
6969
|
+
type CreateOrderApplicationErrors = {
|
|
6970
|
+
code?: 'PURCHASED_DATE_CANNOT_BE_IN_FUTURE';
|
|
6971
|
+
description?: string;
|
|
6972
|
+
data?: Record<string, any>;
|
|
6973
|
+
};
|
|
6974
|
+
type UpdateOrderApplicationErrors = {
|
|
6975
|
+
code?: 'ORDER_IS_PENDING';
|
|
6976
|
+
description?: string;
|
|
6977
|
+
data?: Record<string, any>;
|
|
6978
|
+
} | {
|
|
6979
|
+
code?: 'ORDER_IS_REJECTED';
|
|
6980
|
+
description?: string;
|
|
6981
|
+
data?: Record<string, any>;
|
|
6982
|
+
};
|
|
6983
|
+
type CommitDeltasApplicationErrors = {
|
|
6984
|
+
code?: 'EMPTY_DELTAS_TO_COMMIT';
|
|
6985
|
+
description?: string;
|
|
6986
|
+
data?: Record<string, any>;
|
|
6987
|
+
};
|
|
6988
|
+
type CancelOrderApplicationErrors = {
|
|
6989
|
+
code?: 'ORDER_HAS_AUTHORIZED_TRANSACTION';
|
|
6990
|
+
description?: string;
|
|
6991
|
+
data?: Record<string, any>;
|
|
6992
|
+
} | {
|
|
6993
|
+
code?: 'ORDER_IS_PENDING';
|
|
6994
|
+
description?: string;
|
|
6995
|
+
data?: Record<string, any>;
|
|
6996
|
+
} | {
|
|
6997
|
+
code?: 'ORDER_IS_REJECTED';
|
|
6998
|
+
description?: string;
|
|
6999
|
+
data?: Record<string, any>;
|
|
7000
|
+
};
|
|
7001
|
+
type UpdateOrderStatusApplicationErrors = {
|
|
7002
|
+
code?: 'STATUS_NOT_SUPPORTED';
|
|
7003
|
+
description?: string;
|
|
7004
|
+
data?: Record<string, any>;
|
|
7005
|
+
} | {
|
|
7006
|
+
code?: 'UNSUPPORTED_TRANSITION';
|
|
7007
|
+
description?: string;
|
|
7008
|
+
data?: Record<string, any>;
|
|
7009
|
+
} | {
|
|
7010
|
+
code?: 'STATUS_ALREADY_SET';
|
|
7011
|
+
description?: string;
|
|
7012
|
+
data?: Record<string, any>;
|
|
7013
|
+
};
|
|
6324
7014
|
interface BaseEventMetadata {
|
|
6325
7015
|
/**
|
|
6326
7016
|
* App instance ID.
|
|
@@ -6369,18 +7059,134 @@ interface OrderApprovedEnvelope {
|
|
|
6369
7059
|
data: OrderApproved;
|
|
6370
7060
|
metadata: EventMetadata;
|
|
6371
7061
|
}
|
|
7062
|
+
/** @permissionScope Manage Stores - all permissions
|
|
7063
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7064
|
+
* @permissionScope Manage Stores
|
|
7065
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7066
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
7067
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
7068
|
+
* @permissionScope Read Orders
|
|
7069
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
7070
|
+
* @permissionScope Read Stores - all read permissions
|
|
7071
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
7072
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
7073
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7074
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
7075
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7076
|
+
* @permissionScope Manage Orders
|
|
7077
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7078
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7079
|
+
* @webhook
|
|
7080
|
+
* @eventType wix.ecom.v1.order_approved
|
|
7081
|
+
* @slug approved
|
|
7082
|
+
*/
|
|
7083
|
+
declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
6372
7084
|
interface OrderUpdatedEnvelope {
|
|
6373
7085
|
entity: Order;
|
|
6374
7086
|
metadata: EventMetadata;
|
|
6375
7087
|
}
|
|
7088
|
+
/** @permissionScope Manage Stores - all permissions
|
|
7089
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7090
|
+
* @permissionScope Manage Stores
|
|
7091
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7092
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
7093
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
7094
|
+
* @permissionScope Read Orders
|
|
7095
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
7096
|
+
* @permissionScope Read Stores - all read permissions
|
|
7097
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
7098
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
7099
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7100
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
7101
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7102
|
+
* @permissionScope Manage Orders
|
|
7103
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7104
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7105
|
+
* @webhook
|
|
7106
|
+
* @eventType wix.ecom.v1.order_updated
|
|
7107
|
+
* @slug updated
|
|
7108
|
+
*/
|
|
7109
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
6376
7110
|
interface OrderCanceledEnvelope {
|
|
6377
7111
|
data: OrderCanceledEventOrderCanceled;
|
|
6378
7112
|
metadata: EventMetadata;
|
|
6379
7113
|
}
|
|
7114
|
+
/**
|
|
7115
|
+
* Triggered when an order is canceled.
|
|
7116
|
+
* Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
7117
|
+
* @permissionScope Manage Stores - all permissions
|
|
7118
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7119
|
+
* @permissionScope Manage Stores
|
|
7120
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7121
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
7122
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
7123
|
+
* @permissionScope Read Orders
|
|
7124
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
7125
|
+
* @permissionScope Read Stores - all read permissions
|
|
7126
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
7127
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
7128
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7129
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
7130
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7131
|
+
* @permissionScope Manage Orders
|
|
7132
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7133
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7134
|
+
* @webhook
|
|
7135
|
+
* @eventType wix.ecom.v1.order_canceled
|
|
7136
|
+
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
7137
|
+
* @slug canceled
|
|
7138
|
+
*/
|
|
7139
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
6380
7140
|
interface OrderCreatedEnvelope {
|
|
6381
7141
|
entity: Order;
|
|
6382
7142
|
metadata: EventMetadata;
|
|
6383
7143
|
}
|
|
7144
|
+
/**
|
|
7145
|
+
* Triggered when an order is created.
|
|
7146
|
+
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
7147
|
+
* @permissionScope Manage Stores - all permissions
|
|
7148
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7149
|
+
* @permissionScope Manage Stores
|
|
7150
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7151
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
7152
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
7153
|
+
* @permissionScope Read Orders
|
|
7154
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
7155
|
+
* @permissionScope Read Stores - all read permissions
|
|
7156
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
7157
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
7158
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7159
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
7160
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7161
|
+
* @permissionScope Manage Orders
|
|
7162
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7163
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7164
|
+
* @webhook
|
|
7165
|
+
* @eventType wix.ecom.v1.order_created
|
|
7166
|
+
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
7167
|
+
* @slug created
|
|
7168
|
+
*/
|
|
7169
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
7170
|
+
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`;
|
|
7171
|
+
/**
|
|
7172
|
+
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
7173
|
+
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
7174
|
+
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
7175
|
+
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
7176
|
+
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
7177
|
+
* @param ecomOrderId - Ecom order ID.
|
|
7178
|
+
* @param amount - Amount to collect
|
|
7179
|
+
* @public
|
|
7180
|
+
* @documentationMaturity preview
|
|
7181
|
+
* @requiredField amount
|
|
7182
|
+
* @requiredField ecomOrderId
|
|
7183
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7184
|
+
* @applicableIdentity APP
|
|
7185
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
7186
|
+
*/
|
|
7187
|
+
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
7188
|
+
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
7189
|
+
}>;
|
|
6384
7190
|
interface PreparePaymentCollectionOptions {
|
|
6385
7191
|
/**
|
|
6386
7192
|
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
@@ -6400,10 +7206,121 @@ interface PreparePaymentCollectionOptions {
|
|
|
6400
7206
|
/** Delayed capture payment settings */
|
|
6401
7207
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6402
7208
|
}
|
|
7209
|
+
/**
|
|
7210
|
+
* Provides payment collectability status for given order. If payment collection is possible
|
|
7211
|
+
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
7212
|
+
* reason why payment collection is not possible.
|
|
7213
|
+
* @param ecomOrderId - Ecom order ID.
|
|
7214
|
+
* @public
|
|
7215
|
+
* @documentationMaturity preview
|
|
7216
|
+
* @requiredField ecomOrderId
|
|
7217
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7218
|
+
* @applicableIdentity APP
|
|
7219
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
7220
|
+
*/
|
|
7221
|
+
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
7222
|
+
/**
|
|
7223
|
+
* Records and approves new manual payment with provided custom amount on given order.
|
|
7224
|
+
* Existing pending payments are ignored.
|
|
7225
|
+
* Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
|
|
7226
|
+
* @param orderId - Order ID.
|
|
7227
|
+
* @param amount - Amount to be recorded as approved manual payment for given order
|
|
7228
|
+
* @internal
|
|
7229
|
+
* @documentationMaturity preview
|
|
7230
|
+
* @requiredField amount
|
|
7231
|
+
* @requiredField orderId
|
|
7232
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7233
|
+
* @applicableIdentity APP
|
|
7234
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
|
|
7235
|
+
*/
|
|
7236
|
+
declare function recordManuallyCollectedPayment(orderId: string, amount: Price): Promise<void & {
|
|
7237
|
+
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
|
|
7238
|
+
}>;
|
|
7239
|
+
/**
|
|
7240
|
+
* Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
7241
|
+
* In case the order already has an offline payment transaction associated with it
|
|
7242
|
+
* (usually when manual payment method is chosen at checkout) - This transaction will become approved.
|
|
7243
|
+
* In case the order has no payment transactions associated with it
|
|
7244
|
+
* (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
|
|
7245
|
+
* will be created and approved.
|
|
7246
|
+
* @param ecomOrderId - Ecom order ID.
|
|
7247
|
+
* @internal
|
|
7248
|
+
* @documentationMaturity preview
|
|
7249
|
+
* @requiredField ecomOrderId
|
|
7250
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7251
|
+
* @applicableIdentity APP
|
|
7252
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
7253
|
+
*/
|
|
7254
|
+
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
7255
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7256
|
+
}[OrderNonNullablePaths]> & {
|
|
7257
|
+
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
7258
|
+
}>;
|
|
7259
|
+
/**
|
|
7260
|
+
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
7261
|
+
* @param ecomOrderIds - IDs of orders to mark as paid.
|
|
7262
|
+
* @internal
|
|
7263
|
+
* @documentationMaturity preview
|
|
7264
|
+
* @requiredField ecomOrderIds
|
|
7265
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7266
|
+
* @applicableIdentity APP
|
|
7267
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
|
|
7268
|
+
*/
|
|
7269
|
+
declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
7270
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
7271
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7272
|
+
/**
|
|
7273
|
+
* Checks whether this order can be refunded.
|
|
7274
|
+
* @param ecomOrderId - Order ID.
|
|
7275
|
+
* @internal
|
|
7276
|
+
* @documentationMaturity preview
|
|
7277
|
+
* @requiredField ecomOrderId
|
|
7278
|
+
* @permissionId ECOM.READ_TRANSACTIONS
|
|
7279
|
+
* @applicableIdentity APP
|
|
7280
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
|
|
7281
|
+
*/
|
|
7282
|
+
declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
7283
|
+
/**
|
|
7284
|
+
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
7285
|
+
* 1. An explicit amount provided in the request, or;
|
|
7286
|
+
* 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
|
|
7287
|
+
* As a result, an ID of the created payment gateway order would be returned.
|
|
7288
|
+
* You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
|
|
7289
|
+
* @param ecomOrderId - Ecom order ID.
|
|
7290
|
+
* @internal
|
|
7291
|
+
* @documentationMaturity preview
|
|
7292
|
+
* @requiredField ecomOrderId
|
|
7293
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7294
|
+
* @applicableIdentity APP
|
|
7295
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
|
|
7296
|
+
*/
|
|
7297
|
+
declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
|
|
7298
|
+
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
|
|
7299
|
+
}>;
|
|
6403
7300
|
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6404
7301
|
/** Information about the user who initiated the payment. */
|
|
6405
7302
|
chargedBy?: ChargedBy;
|
|
6406
7303
|
}
|
|
7304
|
+
/** @param ecomOrderId - Order ID.
|
|
7305
|
+
* @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
7306
|
+
* but a user which is using the membership on behalf of the a member
|
|
7307
|
+
* @internal
|
|
7308
|
+
* @documentationMaturity preview
|
|
7309
|
+
* @requiredField ecomOrderId
|
|
7310
|
+
* @requiredField memberId
|
|
7311
|
+
* @requiredField options.membershipCharges.appId
|
|
7312
|
+
* @requiredField options.membershipCharges.catalogReference
|
|
7313
|
+
* @requiredField options.membershipCharges.catalogReference.appId
|
|
7314
|
+
* @requiredField options.membershipCharges.catalogReference.catalogItemId
|
|
7315
|
+
* @requiredField options.membershipCharges.membershipId
|
|
7316
|
+
* @requiredField options.membershipCharges.membershipName
|
|
7317
|
+
* @requiredField options.membershipCharges.membershipName.original
|
|
7318
|
+
* @requiredField options.membershipCharges.rootCatalogItemId
|
|
7319
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
7320
|
+
* @applicableIdentity APP
|
|
7321
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
|
|
7322
|
+
*/
|
|
7323
|
+
declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
|
|
6407
7324
|
interface ChargeMembershipsOptions {
|
|
6408
7325
|
/**
|
|
6409
7326
|
* List of items to be paid by memberships
|
|
@@ -6412,12 +7329,83 @@ interface ChargeMembershipsOptions {
|
|
|
6412
7329
|
*/
|
|
6413
7330
|
membershipCharges?: MembershipChargeItem[];
|
|
6414
7331
|
}
|
|
7332
|
+
/**
|
|
7333
|
+
* Calls corresponding payment providers and creates refund transactions for requested payments.
|
|
7334
|
+
* Updates order transactions based on refund results.
|
|
7335
|
+
* For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
|
|
7336
|
+
* will only update order transactions.
|
|
7337
|
+
* @param ecomOrderId - The order this refund related to
|
|
7338
|
+
* @param payments - Refund operations information
|
|
7339
|
+
* @internal
|
|
7340
|
+
* @documentationMaturity preview
|
|
7341
|
+
* @requiredField ecomOrderId
|
|
7342
|
+
* @requiredField payments
|
|
7343
|
+
* @requiredField payments.paymentId
|
|
7344
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
7345
|
+
* @applicableIdentity APP
|
|
7346
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
|
|
7347
|
+
*/
|
|
7348
|
+
declare function triggerRefund(ecomOrderId: string, payments: NonNullablePaths<PaymentRefund, `paymentId`>[], options?: TriggerRefundOptions): Promise<NonNullablePaths<TriggerRefundResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`> & {
|
|
7349
|
+
__applicationErrorsType?: TriggerRefundApplicationErrors;
|
|
7350
|
+
}>;
|
|
6415
7351
|
interface TriggerRefundOptions {
|
|
6416
7352
|
/** Business model of a refund */
|
|
6417
7353
|
details?: RefundDetails;
|
|
6418
7354
|
/** Side effect details related to refund */
|
|
6419
7355
|
sideEffects?: RefundSideEffects;
|
|
6420
7356
|
}
|
|
7357
|
+
/**
|
|
7358
|
+
* Void authorized payments
|
|
7359
|
+
* Transaction statuses for related payments will be updated in async way
|
|
7360
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
7361
|
+
* @param paymentIds - Payment IDs
|
|
7362
|
+
* @public
|
|
7363
|
+
* @documentationMaturity preview
|
|
7364
|
+
* @requiredField ecomOrderId
|
|
7365
|
+
* @requiredField paymentIds
|
|
7366
|
+
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
7367
|
+
* @applicableIdentity APP
|
|
7368
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
7369
|
+
*/
|
|
7370
|
+
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`> & {
|
|
7371
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
7372
|
+
}>;
|
|
7373
|
+
/**
|
|
7374
|
+
* Capture authorized payments
|
|
7375
|
+
* Transaction statuses for related payments will be updated in async way
|
|
7376
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
7377
|
+
* @param payments - Capture payments information
|
|
7378
|
+
* @public
|
|
7379
|
+
* @documentationMaturity preview
|
|
7380
|
+
* @requiredField ecomOrderId
|
|
7381
|
+
* @requiredField payments
|
|
7382
|
+
* @requiredField payments.paymentId
|
|
7383
|
+
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
7384
|
+
* @applicableIdentity APP
|
|
7385
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
7386
|
+
*/
|
|
7387
|
+
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`> & {
|
|
7388
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
7389
|
+
}>;
|
|
7390
|
+
/**
|
|
7391
|
+
* Retrieves an order.
|
|
7392
|
+
*
|
|
7393
|
+
*
|
|
7394
|
+
* The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
|
|
7395
|
+
*
|
|
7396
|
+
* To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
|
|
7397
|
+
* @param _id - ID of the order to retrieve.
|
|
7398
|
+
* @public
|
|
7399
|
+
* @requiredField _id
|
|
7400
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7401
|
+
* @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
|
|
7402
|
+
* @applicableIdentity APP
|
|
7403
|
+
* @returns Fulfilled - The requested order.
|
|
7404
|
+
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
7405
|
+
*/
|
|
7406
|
+
declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
7407
|
+
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
7408
|
+
}>;
|
|
6421
7409
|
interface OrderSearchSpec extends SearchSpec {
|
|
6422
7410
|
paging: 'cursor';
|
|
6423
7411
|
wql: [
|
|
@@ -6545,10 +7533,83 @@ type OrderSearch = {
|
|
|
6545
7533
|
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
6546
7534
|
}[];
|
|
6547
7535
|
};
|
|
7536
|
+
/**
|
|
7537
|
+
* Creates an order.
|
|
7538
|
+
*
|
|
7539
|
+
*
|
|
7540
|
+
* The `createOrder()` function returns a Promise that resolves when the order is created.
|
|
7541
|
+
*
|
|
7542
|
+
* > **Notes:**
|
|
7543
|
+
* > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
|
|
7544
|
+
* > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
|
|
7545
|
+
* @param order - Order info.
|
|
7546
|
+
* @public
|
|
7547
|
+
* @requiredField order
|
|
7548
|
+
* @requiredField order.billingInfo.contactDetails
|
|
7549
|
+
* @requiredField order.channelInfo
|
|
7550
|
+
* @requiredField order.currencyConversionDetails.conversionRate
|
|
7551
|
+
* @requiredField order.currencyConversionDetails.originalCurrency
|
|
7552
|
+
* @requiredField order.lineItems
|
|
7553
|
+
* @requiredField order.lineItems.catalogReference.appId
|
|
7554
|
+
* @requiredField order.lineItems.catalogReference.catalogItemId
|
|
7555
|
+
* @requiredField order.lineItems.itemType
|
|
7556
|
+
* @requiredField order.lineItems.price
|
|
7557
|
+
* @requiredField order.lineItems.productName
|
|
7558
|
+
* @requiredField order.lineItems.productName.original
|
|
7559
|
+
* @requiredField order.lineItems.quantity
|
|
7560
|
+
* @requiredField order.priceSummary
|
|
7561
|
+
* @permissionId ECOM.CREATE_ORDERS
|
|
7562
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7563
|
+
* @applicableIdentity APP
|
|
7564
|
+
* @returns Newly created order.
|
|
7565
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
7566
|
+
*/
|
|
7567
|
+
declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
7568
|
+
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
7569
|
+
}>;
|
|
6548
7570
|
interface CreateOrderOptions {
|
|
6549
7571
|
/** Determine order lifecycle */
|
|
6550
7572
|
settings?: OrderCreationSettings;
|
|
6551
7573
|
}
|
|
7574
|
+
/**
|
|
7575
|
+
* Updates an order.
|
|
7576
|
+
*
|
|
7577
|
+
*
|
|
7578
|
+
* The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
|
|
7579
|
+
*
|
|
7580
|
+
* Currently, the following fields can be updated:
|
|
7581
|
+
* + `order.buyerInfo.email`
|
|
7582
|
+
* + `order.buyerLanguage`
|
|
7583
|
+
* + `order.weightUnit`
|
|
7584
|
+
* + `order.billingInfo.address`
|
|
7585
|
+
* + `order.billingInfo.contactDetails`
|
|
7586
|
+
* + `order.archived`
|
|
7587
|
+
* + `order.attributionSource`
|
|
7588
|
+
* + `order.seenByAHuman`
|
|
7589
|
+
* + `order.recipientInfo.address`
|
|
7590
|
+
* + `order.recipientInfo.contactDetails`
|
|
7591
|
+
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
7592
|
+
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
7593
|
+
*
|
|
7594
|
+
* To update a field's value, include the new value in the `order` object in the method parameters.
|
|
7595
|
+
* To remove a field's value, pass `null`.
|
|
7596
|
+
*
|
|
7597
|
+
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
7598
|
+
*
|
|
7599
|
+
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
7600
|
+
* @param _id - Order ID.
|
|
7601
|
+
* @public
|
|
7602
|
+
* @requiredField _id
|
|
7603
|
+
* @requiredField order
|
|
7604
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7605
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7606
|
+
* @applicableIdentity APP
|
|
7607
|
+
* @returns Newly created order.
|
|
7608
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
7609
|
+
*/
|
|
7610
|
+
declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
7611
|
+
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
7612
|
+
}>;
|
|
6552
7613
|
interface UpdateOrder {
|
|
6553
7614
|
/**
|
|
6554
7615
|
* Order ID.
|
|
@@ -6722,6 +7783,44 @@ interface UpdateOrder {
|
|
|
6722
7783
|
*/
|
|
6723
7784
|
payAfterFreeTrial?: PriceSummary;
|
|
6724
7785
|
}
|
|
7786
|
+
/**
|
|
7787
|
+
* Updates up to 100 orders.
|
|
7788
|
+
*
|
|
7789
|
+
*
|
|
7790
|
+
* The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
|
|
7791
|
+
*
|
|
7792
|
+
* Currently, the following fields can be updated:
|
|
7793
|
+
* + `order.buyerInfo.email`
|
|
7794
|
+
* + `order.buyerLanguage`
|
|
7795
|
+
* + `order.weightUnit`
|
|
7796
|
+
* + `order.billingInfo.address`
|
|
7797
|
+
* + `order.billingInfo.contactDetails`
|
|
7798
|
+
* + `order.archived`
|
|
7799
|
+
* + `order.attributionSource`
|
|
7800
|
+
* + `order.seenByAHuman`
|
|
7801
|
+
* + `order.recipientInfo.address`
|
|
7802
|
+
* + `order.recipientInfo.contactDetails`
|
|
7803
|
+
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
7804
|
+
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
7805
|
+
*
|
|
7806
|
+
* To update a field's value, include the new value in the `orders.order` object in the method parameters.
|
|
7807
|
+
* To remove a field's value, pass `null`.
|
|
7808
|
+
*
|
|
7809
|
+
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
7810
|
+
*
|
|
7811
|
+
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
7812
|
+
* @param orders - Orders to update.
|
|
7813
|
+
* @public
|
|
7814
|
+
* @requiredField orders
|
|
7815
|
+
* @requiredField orders.order
|
|
7816
|
+
* @requiredField orders.order._id
|
|
7817
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7818
|
+
* @applicableIdentity APP
|
|
7819
|
+
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
7820
|
+
*/
|
|
7821
|
+
declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
7822
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
7823
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
6725
7824
|
interface BulkUpdateOrdersOptions {
|
|
6726
7825
|
/**
|
|
6727
7826
|
* Whether to return the full order entities.
|
|
@@ -6730,6 +7829,23 @@ interface BulkUpdateOrdersOptions {
|
|
|
6730
7829
|
*/
|
|
6731
7830
|
returnEntity?: boolean;
|
|
6732
7831
|
}
|
|
7832
|
+
/** @param _id - Order id to be updated
|
|
7833
|
+
* @internal
|
|
7834
|
+
* @documentationMaturity preview
|
|
7835
|
+
* @requiredField _id
|
|
7836
|
+
* @requiredField options.changes
|
|
7837
|
+
* @requiredField options.changes.priceSummary.subtotal
|
|
7838
|
+
* @requiredField options.changes.priceSummary.total
|
|
7839
|
+
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
7840
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7841
|
+
* @applicableIdentity APP
|
|
7842
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
7843
|
+
*/
|
|
7844
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
7845
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7846
|
+
}[OrderNonNullablePaths]> & {
|
|
7847
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
7848
|
+
}>;
|
|
6733
7849
|
interface CommitDeltasOptions {
|
|
6734
7850
|
/**
|
|
6735
7851
|
* Draft order Id representing this change.
|
|
@@ -6747,6 +7863,21 @@ interface CommitDeltasOptions {
|
|
|
6747
7863
|
*/
|
|
6748
7864
|
reason?: string | null;
|
|
6749
7865
|
}
|
|
7866
|
+
/** @internal
|
|
7867
|
+
* @documentationMaturity preview
|
|
7868
|
+
* @requiredField identifiers
|
|
7869
|
+
* @requiredField identifiers._id
|
|
7870
|
+
* @requiredField identifiers.lineItemId
|
|
7871
|
+
* @requiredField lineItem
|
|
7872
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7873
|
+
* @applicableIdentity APP
|
|
7874
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
7875
|
+
* @deprecated
|
|
7876
|
+
* @targetRemovalDate 2024-02-15
|
|
7877
|
+
*/
|
|
7878
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
7879
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7880
|
+
}[OrderNonNullablePaths]>>;
|
|
6750
7881
|
interface UpdateOrderLineItemIdentifiers {
|
|
6751
7882
|
/**
|
|
6752
7883
|
* Order ID
|
|
@@ -6870,13 +8001,61 @@ interface UpdateOrderLineItem {
|
|
|
6870
8001
|
locations?: LocationAndQuantity[];
|
|
6871
8002
|
/** Address used for tax calculation. */
|
|
6872
8003
|
taxableAddress?: TaxableAddress;
|
|
8004
|
+
/**
|
|
8005
|
+
* ID of the app managing the inventory.
|
|
8006
|
+
* @internal
|
|
8007
|
+
* @format GUID
|
|
8008
|
+
*/
|
|
8009
|
+
inventoryAppId?: string | null;
|
|
6873
8010
|
/**
|
|
6874
8011
|
* Custom extended fields for the line item object.
|
|
6875
8012
|
*
|
|
6876
8013
|
* [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.
|
|
6877
8014
|
*/
|
|
6878
8015
|
extendedFields?: ExtendedFields;
|
|
8016
|
+
/**
|
|
8017
|
+
* Modifier groups that were added to the item.
|
|
8018
|
+
* @internal
|
|
8019
|
+
* @readonly
|
|
8020
|
+
* @maxSize 10
|
|
8021
|
+
*/
|
|
8022
|
+
modifierGroups?: ModifierGroup[];
|
|
6879
8023
|
}
|
|
8024
|
+
/**
|
|
8025
|
+
* Adds a merchant comment to an order.
|
|
8026
|
+
* > **Note:** Activities with type CustomActivity not supported
|
|
8027
|
+
* @param _id - Order ID.
|
|
8028
|
+
* @param activity - Activity info.
|
|
8029
|
+
* @internal
|
|
8030
|
+
* @documentationMaturity preview
|
|
8031
|
+
* @requiredField _id
|
|
8032
|
+
* @requiredField activity
|
|
8033
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
8034
|
+
* @applicableIdentity APP
|
|
8035
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
8036
|
+
* @deprecated
|
|
8037
|
+
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
8038
|
+
* @targetRemovalDate 2024-11-01
|
|
8039
|
+
*/
|
|
8040
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
8041
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8042
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
8043
|
+
/**
|
|
8044
|
+
* Updates an order's activity.
|
|
8045
|
+
* @param activity - Activity info.
|
|
8046
|
+
* @internal
|
|
8047
|
+
* @documentationMaturity preview
|
|
8048
|
+
* @requiredField activity
|
|
8049
|
+
* @requiredField identifiers
|
|
8050
|
+
* @requiredField identifiers._id
|
|
8051
|
+
* @requiredField identifiers.activityId
|
|
8052
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
8053
|
+
* @applicableIdentity APP
|
|
8054
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
8055
|
+
*/
|
|
8056
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
8057
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8058
|
+
}[OrderNonNullablePaths]>>;
|
|
6880
8059
|
interface UpdateActivityIdentifiers {
|
|
6881
8060
|
/**
|
|
6882
8061
|
* Order ID.
|
|
@@ -6890,6 +8069,22 @@ interface UpdateActivityIdentifiers {
|
|
|
6890
8069
|
*/
|
|
6891
8070
|
activityId: string;
|
|
6892
8071
|
}
|
|
8072
|
+
/**
|
|
8073
|
+
* Delete's an order's activity.
|
|
8074
|
+
*
|
|
8075
|
+
* Only custom activities and merchant comments can be deleted.
|
|
8076
|
+
* @internal
|
|
8077
|
+
* @documentationMaturity preview
|
|
8078
|
+
* @requiredField identifiers
|
|
8079
|
+
* @requiredField identifiers._id
|
|
8080
|
+
* @requiredField identifiers.activityId
|
|
8081
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
8082
|
+
* @applicableIdentity APP
|
|
8083
|
+
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
8084
|
+
*/
|
|
8085
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
8086
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8087
|
+
}[OrderNonNullablePaths]>>;
|
|
6893
8088
|
interface DeleteActivityIdentifiers {
|
|
6894
8089
|
/**
|
|
6895
8090
|
* Order ID.
|
|
@@ -6903,6 +8098,23 @@ interface DeleteActivityIdentifiers {
|
|
|
6903
8098
|
*/
|
|
6904
8099
|
activityId: string;
|
|
6905
8100
|
}
|
|
8101
|
+
/**
|
|
8102
|
+
* Cancels an order.
|
|
8103
|
+
*
|
|
8104
|
+
*
|
|
8105
|
+
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
8106
|
+
* @param _id - Order ID.
|
|
8107
|
+
* @public
|
|
8108
|
+
* @requiredField _id
|
|
8109
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
8110
|
+
* @applicableIdentity APP
|
|
8111
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
8112
|
+
*/
|
|
8113
|
+
declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
8114
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8115
|
+
}[OrderNonNullablePaths]> & {
|
|
8116
|
+
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
8117
|
+
}>;
|
|
6906
8118
|
interface CancelOrderOptions {
|
|
6907
8119
|
/** Whether to send an order canceled email to the buyer. */
|
|
6908
8120
|
sendOrderCanceledEmail?: boolean;
|
|
@@ -6915,6 +8127,43 @@ interface CancelOrderOptions {
|
|
|
6915
8127
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
6916
8128
|
restockAllItems?: boolean;
|
|
6917
8129
|
}
|
|
8130
|
+
/**
|
|
8131
|
+
* Updates order status.
|
|
8132
|
+
*
|
|
8133
|
+
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
8134
|
+
* >Updates into INITIALIZED are not supported.
|
|
8135
|
+
*
|
|
8136
|
+
* Approving order:
|
|
8137
|
+
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
8138
|
+
*
|
|
8139
|
+
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
8140
|
+
* will cause an error.
|
|
8141
|
+
*
|
|
8142
|
+
* Setting PENDING status:
|
|
8143
|
+
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
8144
|
+
* @param orderId - Order ID.
|
|
8145
|
+
* @param status - New order status.
|
|
8146
|
+
* @internal
|
|
8147
|
+
* @documentationMaturity preview
|
|
8148
|
+
* @requiredField orderId
|
|
8149
|
+
* @requiredField status
|
|
8150
|
+
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
8151
|
+
* @applicableIdentity APP
|
|
8152
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
8153
|
+
*/
|
|
8154
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
8155
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8156
|
+
}[OrderNonNullablePaths]> & {
|
|
8157
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
8158
|
+
}>;
|
|
8159
|
+
/** @internal
|
|
8160
|
+
* @documentationMaturity preview
|
|
8161
|
+
* @requiredField options.aggregation
|
|
8162
|
+
* @permissionId ECOM.READ_ORDERS
|
|
8163
|
+
* @applicableIdentity APP
|
|
8164
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
8165
|
+
*/
|
|
8166
|
+
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
6918
8167
|
interface AggregateOrdersOptions {
|
|
6919
8168
|
/** Filter applied to original data */
|
|
6920
8169
|
filter?: Record<string, any> | null;
|
|
@@ -6931,6 +8180,19 @@ interface AggregateOrdersOptions {
|
|
|
6931
8180
|
*/
|
|
6932
8181
|
hierarchySeparatorOverride?: string | null;
|
|
6933
8182
|
}
|
|
8183
|
+
/**
|
|
8184
|
+
* Synchronously update tags on multiple orders, by list of order IDs.
|
|
8185
|
+
*
|
|
8186
|
+
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
8187
|
+
* @param orderIds - IDs of orders to update tags for.
|
|
8188
|
+
* @public
|
|
8189
|
+
* @requiredField orderIds
|
|
8190
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
8191
|
+
* @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
|
|
8192
|
+
* @applicableIdentity APP
|
|
8193
|
+
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
8194
|
+
*/
|
|
8195
|
+
declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
6934
8196
|
interface BulkUpdateOrderTagsOptions {
|
|
6935
8197
|
/** Tags to be added to orders */
|
|
6936
8198
|
assignTags?: Tags;
|
|
@@ -6938,4 +8200,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
6938
8200
|
unassignTags?: Tags;
|
|
6939
8201
|
}
|
|
6940
8202
|
|
|
6941
|
-
export { ActionType as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, DurationUnit as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, PaymentCollectabilityStatus as H, ItemTypeItemType as I, JurisdictionType as J, ManuallyRefundableReason as K, LineItemQuantityChangeType as L, type MaskedOrder as M, NonRefundableReason as N, type Order as O, type Price as P, RestockType as Q, RefundableStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, TransactionStatus as X, AuthorizationCaptureStatus as Y, AuthorizationVoidStatus as Z, Reason as _, type PreparePaymentCollectionOptions as a, type DeliveryLogistics as a$, MembershipPaymentStatus as a0, RefundStatus as a1, WebhookIdentityType as a2, TextDetection as a3, AnimationDetection as a4, PreviewEmailType as a5, State as a6, Namespace as a7, SortOrder as a8, VersioningMode as a9, type DigitalFile as aA, type SubscriptionInfo as aB, type SubscriptionTitle as aC, type SubscriptionDescription as aD, type SubscriptionSettings as aE, type FreeTrialPeriod as aF, type BillingAdjustment as aG, type BillingAdjustmentPriceSummary as aH, type PriceDescription as aI, type LocationAndQuantity as aJ, type TaxableAddress as aK, type TaxableAddressTaxableAddressDataOneOf as aL, type ExtendedFields as aM, type ModifierGroup as aN, type TranslatableString as aO, type ItemModifier as aP, type BuyerInfo as aQ, type BuyerInfoIdOneOf as aR, type CurrencyConversionDetails as aS, type PriceSummary as aT, type AddressWithContact as aU, type Address as aV, type StreetAddress as aW, type AddressLocation as aX, type FullAddressContactDetails as aY, type VatId as aZ, type V1ShippingInformation as a_, OrderApprovalStrategy as aa, DeltaPaymentOptionType as ab, InventoryAction as ac, Placement as ad, SubdivisionType as ae, SourceType as af, CustomFieldGroup as ag, ValueType as ah, DepositType as ai, InvoiceStatus as aj, type OrderLineItem as ak, type ProductName as al, type CatalogReference as am, type DescriptionLine as an, type DescriptionLineValueOneOf as ao, type DescriptionLineDescriptionLineValueOneOf as ap, type DescriptionLineName as aq, type PlainTextValue as ar, type Color as as, type FocalPoint as at, type PhysicalProperties as au, type ItemType as av, type ItemTypeItemTypeDataOneOf as aw, type ItemTaxFullDetails as ax, type LineItemTaxInfo as ay, type LineItemTaxBreakdown as az, type PreparePaymentCollectionResponse as b, type WixReceipt as b$, type DeliveryLogisticsAddressOneOf as b0, type PickupDetails as b1, type PickupAddress as b2, type DeliveryTimeSlot as b3, type ShippingPrice as b4, type ShippingRegion as b5, type TaxSummary as b6, type OrderTaxInfo as b7, type OrderTaxBreakdown as b8, type AppliedDiscount as b9, type TotalPriceChange as bA, type ShippingInformationChange as bB, type ShippingInformation as bC, type SavedPaymentMethod as bD, type AuthorizedPaymentCreated as bE, type AuthorizedPaymentCaptured as bF, type AuthorizedPaymentVoided as bG, type RefundInitiated as bH, type RefundedPayment as bI, type RefundedPaymentKindOneOf as bJ, type RegularPaymentRefund as bK, type GiftCardPaymentRefund as bL, type MembershipPaymentRefund as bM, type PaymentRefunded as bN, type PaymentRefundFailed as bO, type RefundedAsStoreCredit as bP, type PaymentPending as bQ, type PaymentPendingPaymentDetailsOneOf as bR, type RegularPayment as bS, type RegularPaymentPaymentMethodDetailsOneOf as bT, type CreditCardDetails as bU, type PaymentCanceled as bV, type PaymentCanceledPaymentDetailsOneOf as bW, type PaymentDeclined as bX, type PaymentDeclinedPaymentDetailsOneOf as bY, type ReceiptCreated as bZ, type ReceiptCreatedReceiptInfoOneOf as b_, type AppliedDiscountDiscountSourceOneOf as ba, type Coupon as bb, type MerchantDiscount as bc, type MerchantDiscountMerchantDiscountReasonOneOf as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type Activity as bh, type ActivityContentOneOf as bi, type CustomActivity as bj, type MerchantComment as bk, type OrderRefunded as bl, type OrderCreatedFromExchange as bm, type NewExchangeOrderCreated as bn, type LineItemExchangeData as bo, type DraftOrderChangesApplied as bp, type OrderChange as bq, type OrderChangeValueOneOf as br, type LineItemChanges as bs, type LineItemQuantityChange as bt, type LineItemPriceChange as bu, type ManagedLineItem as bv, type ManagedDiscount as bw, type TranslatedValue as bx, type LineItemAmount as by, type ManagedAdditionalFee as bz, type PaymentCapture as c, type CreditCardPaymentMethodDetails as c$, type ExternalReceipt as c0, type ReceiptSent as c1, type ReceiptSentReceiptInfoOneOf as c2, type CreatedBy as c3, type CreatedByStringOneOf as c4, type ChannelInfo as c5, type CustomField as c6, type BalanceSummary as c7, type Balance as c8, type AdditionalFee as c9, type Refundability as cA, type RefundabilityAdditionalRefundabilityInfoOneOf as cB, type CreatePaymentGatewayOrderRequest as cC, type ChargedBy as cD, type CreatePaymentGatewayOrderResponse as cE, type ChargeMembershipsRequest as cF, type MembershipChargeItem as cG, type MembershipName as cH, type ServiceProperties as cI, type ChargeMembershipsResponse as cJ, type TriggerRefundRequest as cK, type PaymentRefund as cL, type RefundDetails as cM, type RefundItem as cN, type LineItemRefund as cO, type AdditionalFeeRefund as cP, type ShippingRefund as cQ, type RefundSideEffects as cR, type RestockInfo as cS, type RestockItem as cT, type TriggerRefundResponse as cU, type OrderTransactions as cV, type Payment as cW, type PaymentPaymentDetailsOneOf as cX, type PaymentReceiptInfoOneOf as cY, type RegularPaymentDetails as cZ, type RegularPaymentDetailsPaymentMethodDetailsOneOf as c_, type FulfillmentStatusesAggregate as ca, type Tags as cb, type TagList as cc, type Location as cd, type OrderApproved as ce, type OrdersExperiments as cf, type OrderRejectedEventOrderRejected as cg, type OrderItemsRestocked as ch, type V1RestockItem as ci, type PreparePaymentCollectionRequest as cj, type RedirectUrls as ck, type DelayedCaptureSettings as cl, type Duration as cm, type GetPaymentCollectabilityStatusRequest as cn, type RecordManuallyCollectedPaymentRequest as co, type RecordManuallyCollectedPaymentResponse as cp, type MarkOrderAsPaidRequest as cq, type MarkOrderAsPaidResponse as cr, type BulkMarkOrdersAsPaidRequest as cs, type BulkMarkOrdersAsPaidResponse as ct, type BulkOrderResult as cu, type ItemMetadata as cv, type ApplicationError as cw, type BulkActionMetadata as cx, type GetRefundabilityStatusRequest as cy, type GetRefundabilityStatusResponse as cz, type OrderSearch as d, type PreviewCancelRefundEmailResponse as d$, type AuthorizationDetails as d0, type AuthorizationCapture as d1, type AuthorizationActionFailureDetails as d2, type AuthorizationVoid as d3, type V1ScheduledAction as d4, type GiftCardPaymentDetails as d5, type MembershipPaymentDetails as d6, type WixReceiptInfo as d7, type ExternalReceiptInfo as d8, type Refund as d9, type SendBuyerConfirmationEmailRequest as dA, type SendBuyerConfirmationEmailResponse as dB, type SendBuyerPaymentsReceivedEmailRequest as dC, type SendBuyerPaymentsReceivedEmailResponse as dD, type SendBuyerPickupConfirmationEmailRequest as dE, type SendBuyerPickupConfirmationEmailResponse as dF, type BulkSendBuyerPickupConfirmationEmailsRequest as dG, type BulkSendBuyerPickupConfirmationEmailsResponse as dH, type SendBuyerShippingConfirmationEmailRequest as dI, type SendBuyerShippingConfirmationEmailResponse as dJ, type BulkSendBuyerShippingConfirmationEmailsRequest as dK, type BulkSendBuyerShippingConfirmationEmailsResponse as dL, type SendMerchantOrderReceivedNotificationRequest as dM, type SendMerchantOrderReceivedNotificationResponse as dN, type SendCancelRefundEmailRequest as dO, type SendCancelRefundEmailResponse as dP, type SendRefundEmailRequest as dQ, type SendRefundEmailResponse as dR, type SendMerchantOrderReceivedPushRequest as dS, type SendMerchantOrderReceivedPushResponse as dT, type PreviewEmailByTypeRequest as dU, type PreviewEmailByTypeResponse as dV, type PreviewRefundEmailRequest as dW, type PreviewRefundEmailResponse as dX, type PreviewCancelEmailRequest as dY, type PreviewCancelEmailResponse as dZ, type PreviewCancelRefundEmailRequest as d_, type RefundTransaction as da, type RefundStatusInfo as db, type AggregatedRefundSummary as dc, type RefundItemsBreakdown as dd, type LineItemRefundSummary as de, type CalculateRefundRequest as df, type CalculateRefundItemRequest as dg, type CalculateRefundResponse as dh, type CalculateRefundItemResponse as di, type VoidAuthorizedPaymentsRequest as dj, type CaptureAuthorizedPaymentsRequest as dk, type ChargeSavedPaymentMethodRequest as dl, type ChargeSavedPaymentMethodResponse as dm, type DomainEvent as dn, type DomainEventBodyOneOf as dp, type EntityCreatedEvent as dq, type RestoreInfo as dr, type EntityUpdatedEvent as ds, type EntityDeletedEvent as dt, type ActionEvent as du, type Empty as dv, type MessageEnvelope as dw, type IdentificationData as dx, type IdentificationDataIdOneOf as dy, type ImageContent as dz, type CreateOrderOptions as e, type IndexingMessage as e$, type PreviewBuyerPaymentsReceivedEmailRequest as e0, type PreviewBuyerPaymentsReceivedEmailResponse as e1, type PreviewBuyerConfirmationEmailRequest as e2, type PreviewBuyerConfirmationEmailResponse as e3, type PreviewBuyerPickupConfirmationEmailRequest as e4, type PreviewBuyerPickupConfirmationEmailResponse as e5, type PreviewShippingConfirmationEmailRequest as e6, type PreviewShippingConfirmationEmailResponse as e7, type PreviewResendDownloadLinksEmailRequest as e8, type PreviewResendDownloadLinksEmailResponse as e9, type UpsertRefundRequest as eA, type UpsertRefundResponse as eB, type GetOrderOutOfBoxRequest as eC, type GetOrderOutOfBoxResponse as eD, type GetOrderAgcRequest as eE, type GetOrderAgcResponse as eF, type GetOrderWithFilterByLocationRequest as eG, type GetOrderWithFilterByLocationResponse as eH, type V1UpdateOrderRequest as eI, type V1UpdateOrderResponse as eJ, type UpdateInternalDocumentsEvent as eK, type UpdateInternalDocumentsEventOperationOneOf as eL, type InternalDocument as eM, type InternalDocumentUpdateOperation as eN, type DeleteByIdsOperation as eO, type DeleteByFilterOperation as eP, type InternalDocumentUpdateByFilterOperation as eQ, type InternalUpdateExistingOperation as eR, type VersionedDocumentUpdateOperation as eS, type VersionedDeleteByIdsOperation as eT, type VersionedDocumentId as eU, type TriggerReindexRequest as eV, type TriggerReindexResponse as eW, type BatchOfTriggerReindexOrderRequest as eX, type DiffmatokyPayload as eY, type ErrorInformation as eZ, type ContinueSideEffectsFlowInLegacyData as e_, type TriggerReindexOrderRequest as ea, type SnapshotMessage as eb, type PaymentStatusUpdated as ec, type GetMetasiteDataRequest as ed, type GetMetasiteDataResponse as ee, type MetaSite as ef, type App as eg, type SeoData as eh, type MetaTag as ei, type HtmlApplication as ej, type ExternalUriMapping as ek, type UserDataResponse as el, type QueryOrdersForMetasiteRequest as em, type InternalQueryOrdersRequest as en, type PlatformQuery as eo, type PlatformQueryPagingMethodOneOf as ep, type Sorting as eq, type PlatformPaging as er, type CursorPaging as es, type QueryOrdersForMetasiteResponse as et, type PlatformPagingMetadata as eu, type Cursors as ev, type GetOrderForMetasiteRequest as ew, type GetOrderForMetasiteResponse as ex, type ListOrderTransactionsForMetasiteRequest as ey, type ListOrderTransactionsForMetasiteResponse as ez, type BulkUpdateOrdersResponse as f, type UpdateOrderLineItemsResponse as f$, type GetOrderRequest as f0, type GetOrderResponse as f1, type InternalQueryOrdersResponse as f2, type QueryOrderRequest as f3, type QueryOrderResponse as f4, type SearchOrdersRequest as f5, type CursorSearch as f6, type CursorSearchPagingMethodOneOf as f7, type CursorPagingMetadata as f8, type CreateOrderRequest as f9, type LineItemDelta as fA, type LineItemDeltaDeltaOneOf as fB, type ArchiveOrderRequest as fC, type ArchiveOrderResponse as fD, type BulkArchiveOrdersRequest as fE, type BulkArchiveOrdersResponse as fF, type BulkArchiveOrdersByFilterRequest as fG, type BulkArchiveOrdersByFilterResponse as fH, type UnArchiveOrderRequest as fI, type UnArchiveOrderResponse as fJ, type BulkUnArchiveOrdersRequest as fK, type BulkUnArchiveOrdersResponse as fL, type BulkUnArchiveOrdersByFilterRequest as fM, type BulkUnArchiveOrdersByFilterResponse as fN, type UpdateBuyerInfoRequest as fO, type BuyerInfoUpdate as fP, type UpdateBuyerInfoResponse as fQ, type UpdateBuyerEmailRequest as fR, type UpdateBuyerEmailResponse as fS, type UpdateOrderShippingAddressRequest as fT, type UpdateOrderShippingAddressResponse as fU, type UpdateBillingContactDetailsRequest as fV, type UpdateBillingContactDetailsResponse as fW, type UpdateOrderLineItemRequest as fX, type UpdateOrderLineItemResponse as fY, type UpdateOrderLineItemsRequest as fZ, type MaskedOrderLineItem as f_, type OrderCreationSettings as fa, type OrderCreateNotifications as fb, type CreateOrderResponse as fc, type UpdateOrderRequest as fd, type UpdateOrderResponse as fe, type BulkUpdateOrdersRequest as ff, type CommitDeltasRequest as fg, type DraftOrderDiffs as fh, type DraftOrderDiffsShippingUpdateInfoOneOf as fi, type DraftOrderDiffsBuyerUpdateInfoOneOf as fj, type DraftOrderDiffsBillingUpdateInfoOneOf as fk, type DraftOrderDiffsRecipientUpdateInfoOneOf as fl, type V1LineItemDelta as fm, type V1LineItemDeltaDeltaOneOf as fn, type OrderLineItemChangedDetails as fo, type ItemChangedDetails as fp, type AppliedDiscountDelta as fq, type AppliedDiscountDeltaDeltaOneOf as fr, type AdditionalFeeDelta as fs, type AdditionalFeeDeltaDeltaOneOf as ft, type DraftOrderCommitSettings as fu, type InventoryUpdateDetails as fv, type CommitDeltasResponse as fw, type OrderDeltasCommitted as fx, type CommittedDiffs as fy, type CommittedDiffsShippingUpdateInfoOneOf as fz, type CancelOrderOptions as g, type V1CreatePaymentGatewayOrderResponse as g$, type AddInternalActivityRequest as g0, type InternalActivity as g1, type InternalActivityContentOneOf as g2, type OrderPlaced as g3, type OrderPaid as g4, type OrderFulfilled as g5, type OrderNotFulfilled as g6, type OrderCanceled as g7, type DownloadLinkSent as g8, type TrackingNumberAdded as g9, type MarkOrderAsSeenByHumanRequest as gA, type MarkOrderAsSeenByHumanResponse as gB, type CancelOrderRequest as gC, type OrderCanceledEventOrderCanceled as gD, type UpdateOrderStatusRequest as gE, type UpdateOrderStatusResponse as gF, type MarkAsFulfilledRequest as gG, type MarkAsFulfilledResponse as gH, type FulfillmentStatusUpdated as gI, type BulkMarkAsFulfilledRequest as gJ, type BulkMarkAsFulfilledResponse as gK, type BulkMarkAsFulfilledByFilterRequest as gL, type BulkMarkAsFulfilledByFilterResponse as gM, type MarkAsUnfulfilledRequest as gN, type MarkAsUnfulfilledResponse as gO, type BulkMarkAsUnfulfilledRequest as gP, type BulkMarkAsUnfulfilledResponse as gQ, type BulkMarkAsUnfulfilledByFilterRequest as gR, type BulkMarkAsUnfulfilledByFilterResponse as gS, type BulkSetBusinessLocationRequest as gT, type BulkSetBusinessLocationResponse as gU, type BulkSetBusinessLocationResult as gV, type V1MarkOrderAsPaidRequest as gW, type V1MarkOrderAsPaidResponse as gX, type V1BulkMarkOrdersAsPaidRequest as gY, type V1BulkMarkOrdersAsPaidResponse as gZ, type V1CreatePaymentGatewayOrderRequest as g_, type TrackingNumberEdited as ga, type TrackingLinkAdded as gb, type ShippingConfirmationEmailSent as gc, type InvoiceAdded as gd, type InvoiceSent as ge, type FulfillerEmailSent as gf, type ShippingAddressEdited as gg, type EmailEdited as gh, type PickupReadyEmailSent as gi, type OrderPartiallyPaid as gj, type OrderPending as gk, type OrderRejected as gl, type AddInternalActivityResponse as gm, type AddActivityRequest as gn, type PublicActivity as go, type PublicActivityContentOneOf as gp, type AddActivityResponse as gq, type AddActivitiesRequest as gr, type AddActivitiesResponse as gs, type UpdateActivityRequest as gt, type UpdateActivityResponse as gu, type DeleteActivityRequest as gv, type DeleteActivityResponse as gw, type UpdateLineItemsDescriptionLinesRequest as gx, type LineItemUpdate as gy, type UpdateLineItemsDescriptionLinesResponse as gz, type CancelOrderResponse as h, type GetShipmentsRequest as h0, type GetShipmentsResponse as h1, type AggregateOrdersRequest as h2, type AggregateOrdersResponse as h3, type DecrementItemsQuantityRequest as h4, type DecrementData as h5, type DecrementItemsQuantityResponse as h6, type BulkUpdateOrderTagsRequest as h7, type BulkUpdateOrderTagsResult as h8, type Task as h9, type Locale as hA, type TotalPrice as hB, type ItemizedFee as hC, type Discount as hD, type DiscountOneDiscountTypeOneOf as hE, type CalculatedTaxes as hF, type CalculatedTax as hG, type Payments as hH, type InvoicesPayment as hI, type MetaData as hJ, type InvoiceDynamicPriceTotals as hK, type CustomFieldValue as hL, type Value as hM, type Deposit as hN, type TriggerSideEffectsFromLegacyData as hO, type BaseEventMetadata as hP, type EventMetadata as hQ, type PaymentCollectionCreatePaymentGatewayOrderOptions as hR, type ChargeMembershipsOptions as hS, type TriggerRefundOptions as hT, type OrderSearchSpec as hU, type CommitDeltasOptions as hV, type UpdateOrderLineItemIdentifiers as hW, type UpdateOrderLineItem as hX, type UpdateActivityIdentifiers as hY, type DeleteActivityIdentifiers as hZ, type AggregateOrdersOptions as h_, type TaskKey as ha, type TaskAction as hb, type TaskActionActionOneOf as hc, type Complete as hd, type Cancel as he, type Reschedule as hf, type InvoiceSentEvent as hg, type IdAndVersion as hh, type InvoiceFields as hi, type Customer as hj, type Email as hk, type QuotesAddress as hl, type AddressDescription as hm, type Phone as hn, type Company as ho, type CommonAddress as hp, type CommonAddressStreetOneOf as hq, type Subdivision as hr, type StandardDetails as hs, type InvoiceDates as ht, type LineItems as hu, type LineItem as hv, type BigDecimalWrapper as hw, type LineItemTax as hx, type Source as hy, type LineItemMetaData as hz, type BulkUpdateOrderTagsOptions as i, type BulkUpdateOrderTagsResponse as j, type OrderApprovedEnvelope as k, type OrderUpdatedEnvelope as l, type OrderCanceledEnvelope as m, type OrderCreatedEnvelope as n, PaymentOptionType as o, SubscriptionFrequency as p, PaymentStatus as q, VatType as r, PickupMethod as s, OrderStatus as t, DiscountType as u, DiscountReason as v, ActivityType as w, AttributionSource as x, ChannelType as y, ScheduledAction as z };
|
|
8203
|
+
export { type AggregateOrdersResponse as $, type UpdateOrderLineItemIdentifiers as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type UpdateOrderLineItem as D, type UpdateOrderLineItemResponse as E, type PublicActivity as F, type GetPaymentCollectabilityStatusResponse as G, type AddActivityResponse as H, type UpdateActivityIdentifiers as I, type UpdateActivityResponse as J, type DeleteActivityIdentifiers as K, type DeleteActivityResponse as L, type MarkOrderAsPaidResponse as M, type CancelOrderOptions as N, type Order as O, type Price as P, type CancelOrderResponse as Q, type RecordManuallyCollectedPaymentApplicationErrors as R, type SearchOrdersResponse as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type CancelOrderApplicationErrors as W, type OrderStatusWithLiterals as X, type UpdateOrderStatusResponse as Y, type UpdateOrderStatusApplicationErrors as Z, type AggregateOrdersOptions as _, type PreparePaymentCollectionOptions as a, type DescriptionLineDescriptionLineValueOneOf as a$, type BulkUpdateOrderTagsOptions as a0, type BulkUpdateOrderTagsResponse as a1, type OrderApprovedEnvelope as a2, type OrderUpdatedEnvelope as a3, type OrderCanceledEnvelope as a4, type OrderCreatedEnvelope as a5, DescriptionLineType as a6, ItemTypeItemType as a7, PaymentOptionType as a8, JurisdictionType as a9, ActionType as aA, ChargebackStatus as aB, MembershipPaymentStatus as aC, RefundStatus as aD, WebhookIdentityType as aE, TextDetection as aF, AnimationDetection as aG, PreviewEmailType as aH, State as aI, Namespace as aJ, SortOrder as aK, VersioningMode as aL, OrderApprovalStrategy as aM, DeltaPaymentOptionType as aN, InventoryAction as aO, Placement as aP, SubdivisionType as aQ, SourceType as aR, CustomFieldGroup as aS, ValueType as aT, DepositType as aU, InvoiceStatus as aV, type OrderLineItem as aW, type ProductName as aX, type CatalogReference as aY, type DescriptionLine as aZ, type DescriptionLineValueOneOf as a_, SubscriptionFrequency as aa, AdjustmentType as ab, TaxableAddressType as ac, PaymentStatus as ad, FulfillmentStatus as ae, WeightUnit as af, VatType as ag, PickupMethod as ah, OrderStatus as ai, DiscountType as aj, DiscountReason as ak, LineItemQuantityChangeType as al, ActivityType as am, AttributionSource as an, ChannelType as ao, ScheduledAction as ap, DurationUnit as aq, PaymentCollectabilityStatus as ar, RefundableStatus as as, NonRefundableReason as at, ManuallyRefundableReason as au, RestockType as av, TransactionStatus as aw, AuthorizationCaptureStatus as ax, AuthorizationVoidStatus as ay, Reason as az, type PreparePaymentCollectionResponse as b, type DraftOrderChangesApplied as b$, type DescriptionLineName as b0, type PlainTextValue as b1, type Color as b2, type FocalPoint as b3, type PhysicalProperties as b4, type ItemType as b5, type ItemTypeItemTypeDataOneOf as b6, type ItemTaxFullDetails as b7, type LineItemTaxInfo as b8, type LineItemTaxBreakdown as b9, type V1ShippingInformation as bA, type DeliveryLogistics as bB, type DeliveryLogisticsAddressOneOf as bC, type PickupDetails as bD, type PickupAddress as bE, type DeliveryTimeSlot as bF, type ShippingPrice as bG, type ShippingRegion as bH, type TaxSummary as bI, type OrderTaxInfo as bJ, type OrderTaxBreakdown as bK, type AppliedDiscount as bL, type AppliedDiscountDiscountSourceOneOf as bM, type Coupon as bN, type MerchantDiscount as bO, type MerchantDiscountMerchantDiscountReasonOneOf as bP, type DiscountRule as bQ, type DiscountRuleName as bR, type LineItemDiscount as bS, type Activity as bT, type ActivityContentOneOf as bU, type CustomActivity as bV, type MerchantComment as bW, type OrderRefunded as bX, type OrderCreatedFromExchange as bY, type NewExchangeOrderCreated as bZ, type LineItemExchangeData as b_, type DigitalFile as ba, type SubscriptionInfo as bb, type SubscriptionTitle as bc, type SubscriptionDescription as bd, type SubscriptionSettings as be, type FreeTrialPeriod as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type PriceDescription as bi, type LocationAndQuantity as bj, type TaxableAddress as bk, type TaxableAddressTaxableAddressDataOneOf as bl, type ExtendedFields as bm, type ModifierGroup as bn, type TranslatableString as bo, type ItemModifier as bp, type BuyerInfo as bq, type BuyerInfoIdOneOf as br, type CurrencyConversionDetails as bs, type PriceSummary as bt, type AddressWithContact as bu, type Address as bv, type StreetAddress as bw, type AddressLocation as bx, type FullAddressContactDetails as by, type VatId as bz, type PreparePaymentCollectionApplicationErrors as c, type GetPaymentCollectabilityStatusRequest as c$, type OrderChange as c0, type OrderChangeValueOneOf as c1, type LineItemChanges as c2, type LineItemQuantityChange as c3, type LineItemPriceChange as c4, type ManagedLineItem as c5, type ManagedDiscount as c6, type TranslatedValue as c7, type LineItemAmount as c8, type ManagedAdditionalFee as c9, type ReceiptCreatedReceiptInfoOneOf as cA, type WixReceipt as cB, type ExternalReceipt as cC, type ReceiptSent as cD, type ReceiptSentReceiptInfoOneOf as cE, type ChargebackCreated as cF, type ChargebackReversed as cG, type CreatedBy as cH, type CreatedByStringOneOf as cI, type ChannelInfo as cJ, type CustomField as cK, type BalanceSummary as cL, type Balance as cM, type AdditionalFee as cN, type FulfillmentStatusesAggregate as cO, type Tags as cP, type TagList as cQ, type Location as cR, type OrderApproved as cS, type OrdersExperiments as cT, type OrderRejectedEventOrderRejected as cU, type OrderItemsRestocked as cV, type V1RestockItem as cW, type PreparePaymentCollectionRequest as cX, type RedirectUrls as cY, type DelayedCaptureSettings as cZ, type Duration as c_, type TotalPriceChange as ca, type ShippingInformationChange as cb, type ShippingInformation as cc, type SavedPaymentMethod as cd, type AuthorizedPaymentCreated as ce, type AuthorizedPaymentCaptured as cf, type AuthorizedPaymentVoided as cg, type RefundInitiated as ch, type RefundedPayment as ci, type RefundedPaymentKindOneOf as cj, type RegularPaymentRefund as ck, type GiftCardPaymentRefund as cl, type MembershipPaymentRefund as cm, type PaymentRefunded as cn, type PaymentRefundFailed as co, type RefundedAsStoreCredit as cp, type PaymentPending as cq, type PaymentPendingPaymentDetailsOneOf as cr, type RegularPayment as cs, type RegularPaymentPaymentMethodDetailsOneOf as ct, type CreditCardDetails as cu, type PaymentCanceled as cv, type PaymentCanceledPaymentDetailsOneOf as cw, type PaymentDeclined as cx, type PaymentDeclinedPaymentDetailsOneOf as cy, type ReceiptCreated as cz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as d, type EntityUpdatedEvent as d$, type RecordManuallyCollectedPaymentRequest as d0, type RecordManuallyCollectedPaymentResponse as d1, type MarkOrderAsPaidRequest as d2, type BulkMarkOrdersAsPaidRequest as d3, type BulkOrderResult as d4, type ItemMetadata as d5, type ApplicationError as d6, type BulkActionMetadata as d7, type GetRefundabilityStatusRequest as d8, type Refundability as d9, type AuthorizationCapture as dA, type AuthorizationActionFailureDetails as dB, type AuthorizationVoid as dC, type V1ScheduledAction as dD, type Chargeback as dE, type GiftCardPaymentDetails as dF, type MembershipPaymentDetails as dG, type WixReceiptInfo as dH, type ExternalReceiptInfo as dI, type Refund as dJ, type RefundTransaction as dK, type RefundStatusInfo as dL, type AggregatedRefundSummary as dM, type RefundItemsBreakdown as dN, type LineItemRefundSummary as dO, type CalculateRefundRequest as dP, type CalculateRefundItemRequest as dQ, type CalculateRefundResponse as dR, type CalculateRefundItemResponse as dS, type VoidAuthorizedPaymentsRequest as dT, type CaptureAuthorizedPaymentsRequest as dU, type ChargeSavedPaymentMethodRequest as dV, type ChargeSavedPaymentMethodResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type RefundabilityAdditionalRefundabilityInfoOneOf as da, type CreatePaymentGatewayOrderRequest as db, type ChargedBy as dc, type ChargeMembershipsRequest as dd, type MembershipChargeItem as de, type MembershipName as df, type ServiceProperties as dg, type ChargeMembershipsResponse as dh, type TriggerRefundRequest as di, type RefundDetails as dj, type RefundItem as dk, type LineItemRefund as dl, type AdditionalFeeRefund as dm, type ShippingRefund as dn, type RefundSideEffects as dp, type RestockInfo as dq, type RestockItem as dr, type OrderTransactions as ds, type Payment as dt, type PaymentPaymentDetailsOneOf as du, type PaymentReceiptInfoOneOf as dv, type RegularPaymentDetails as dw, type RegularPaymentDetailsPaymentMethodDetailsOneOf as dx, type CreditCardPaymentMethodDetails as dy, type AuthorizationDetails as dz, type GetRefundabilityStatusResponse as e, type CursorPaging as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type MessageEnvelope as e3, type IdentificationData as e4, type IdentificationDataIdOneOf as e5, type ImageContent as e6, type SendBuyerConfirmationEmailRequest as e7, type SendBuyerConfirmationEmailResponse as e8, type SendBuyerPaymentsReceivedEmailRequest as e9, type PreviewBuyerPaymentsReceivedEmailResponse as eA, type PreviewBuyerConfirmationEmailRequest as eB, type PreviewBuyerConfirmationEmailResponse as eC, type PreviewBuyerPickupConfirmationEmailRequest as eD, type PreviewBuyerPickupConfirmationEmailResponse as eE, type PreviewShippingConfirmationEmailRequest as eF, type PreviewShippingConfirmationEmailResponse as eG, type PreviewResendDownloadLinksEmailRequest as eH, type PreviewResendDownloadLinksEmailResponse as eI, type TriggerReindexOrderRequest as eJ, type SnapshotMessage as eK, type PaymentStatusUpdated as eL, type GetMetasiteDataRequest as eM, type GetMetasiteDataResponse as eN, type MetaSite as eO, type App as eP, type SeoData as eQ, type MetaTag as eR, type HtmlApplication as eS, type ExternalUriMapping as eT, type UserDataResponse as eU, type QueryOrdersForMetasiteRequest as eV, type InternalQueryOrdersRequest as eW, type PlatformQuery as eX, type PlatformQueryPagingMethodOneOf as eY, type Sorting as eZ, type PlatformPaging as e_, type SendBuyerPaymentsReceivedEmailResponse as ea, type SendBuyerPickupConfirmationEmailRequest as eb, type SendBuyerPickupConfirmationEmailResponse as ec, type BulkSendBuyerPickupConfirmationEmailsRequest as ed, type BulkSendBuyerPickupConfirmationEmailsResponse as ee, type SendBuyerShippingConfirmationEmailRequest as ef, type SendBuyerShippingConfirmationEmailResponse as eg, type BulkSendBuyerShippingConfirmationEmailsRequest as eh, type BulkSendBuyerShippingConfirmationEmailsResponse as ei, type SendMerchantOrderReceivedNotificationRequest as ej, type SendMerchantOrderReceivedNotificationResponse as ek, type SendCancelRefundEmailRequest as el, type SendCancelRefundEmailResponse as em, type SendRefundEmailRequest as en, type SendRefundEmailResponse as eo, type SendMerchantOrderReceivedPushRequest as ep, type SendMerchantOrderReceivedPushResponse as eq, type PreviewEmailByTypeRequest as er, type PreviewEmailByTypeResponse as es, type PreviewRefundEmailRequest as et, type PreviewRefundEmailResponse as eu, type PreviewCancelEmailRequest as ev, type PreviewCancelEmailResponse as ew, type PreviewCancelRefundEmailRequest as ex, type PreviewCancelRefundEmailResponse as ey, type PreviewBuyerPaymentsReceivedEmailRequest as ez, type PaymentCollectionCreatePaymentGatewayOrderOptions as f, type AdditionalFeeDelta as f$, type QueryOrdersForMetasiteResponse as f0, type PlatformPagingMetadata as f1, type Cursors as f2, type GetOrderForMetasiteRequest as f3, type GetOrderForMetasiteResponse as f4, type ListOrderTransactionsForMetasiteRequest as f5, type ListOrderTransactionsForMetasiteResponse as f6, type UpsertRefundRequest as f7, type UpsertRefundResponse as f8, type GetOrderOutOfBoxRequest as f9, type GetOrderResponse as fA, type InternalQueryOrdersResponse as fB, type QueryOrderRequest as fC, type QueryOrderResponse as fD, type SearchOrdersRequest as fE, type CursorSearch as fF, type CursorSearchPagingMethodOneOf as fG, type CursorPagingMetadata as fH, type CreateOrderRequest as fI, type OrderCreationSettings as fJ, type OrderCreateNotifications as fK, type CreateOrderResponse as fL, type UpdateOrderRequest as fM, type UpdateOrderResponse as fN, type BulkUpdateOrdersRequest as fO, type CommitDeltasRequest as fP, type DraftOrderDiffs as fQ, type DraftOrderDiffsShippingUpdateInfoOneOf as fR, type DraftOrderDiffsBuyerUpdateInfoOneOf as fS, type DraftOrderDiffsBillingUpdateInfoOneOf as fT, type DraftOrderDiffsRecipientUpdateInfoOneOf as fU, type V1LineItemDelta as fV, type V1LineItemDeltaDeltaOneOf as fW, type OrderLineItemChangedDetails as fX, type ItemChangedDetails as fY, type AppliedDiscountDelta as fZ, type AppliedDiscountDeltaDeltaOneOf as f_, type GetOrderOutOfBoxResponse as fa, type GetOrderAgcRequest as fb, type GetOrderAgcResponse as fc, type GetOrderWithFilterByLocationRequest as fd, type GetOrderWithFilterByLocationResponse as fe, type V1UpdateOrderRequest as ff, type V1UpdateOrderResponse as fg, type UpdateInternalDocumentsEvent as fh, type UpdateInternalDocumentsEventOperationOneOf as fi, type InternalDocument as fj, type InternalDocumentUpdateOperation as fk, type DeleteByIdsOperation as fl, type DeleteByFilterOperation as fm, type InternalDocumentUpdateByFilterOperation as fn, type InternalUpdateExistingOperation as fo, type VersionedDocumentUpdateOperation as fp, type VersionedDeleteByIdsOperation as fq, type VersionedDocumentId as fr, type TriggerReindexRequest as fs, type TriggerReindexResponse as ft, type BatchOfTriggerReindexOrderRequest as fu, type DiffmatokyPayload as fv, type ErrorInformation as fw, type ContinueSideEffectsFlowInLegacyData as fx, type IndexingMessage as fy, type GetOrderRequest as fz, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as g, type LineItemUpdate as g$, type AdditionalFeeDeltaDeltaOneOf as g0, type DraftOrderCommitSettings as g1, type InventoryUpdateDetails as g2, type OrderDeltasCommitted as g3, type CommittedDiffs as g4, type CommittedDiffsShippingUpdateInfoOneOf as g5, type LineItemDelta as g6, type LineItemDeltaDeltaOneOf as g7, type ArchiveOrderRequest as g8, type ArchiveOrderResponse as g9, type OrderPlaced as gA, type OrderPaid as gB, type OrderFulfilled as gC, type OrderNotFulfilled as gD, type OrderCanceled as gE, type DownloadLinkSent as gF, type TrackingNumberAdded as gG, type TrackingNumberEdited as gH, type TrackingLinkAdded as gI, type ShippingConfirmationEmailSent as gJ, type InvoiceAdded as gK, type InvoiceSent as gL, type FulfillerEmailSent as gM, type ShippingAddressEdited as gN, type EmailEdited as gO, type PickupReadyEmailSent as gP, type OrderPartiallyPaid as gQ, type OrderPending as gR, type OrderRejected as gS, type AddInternalActivityResponse as gT, type AddActivityRequest as gU, type PublicActivityContentOneOf as gV, type AddActivitiesRequest as gW, type AddActivitiesResponse as gX, type UpdateActivityRequest as gY, type DeleteActivityRequest as gZ, type UpdateLineItemsDescriptionLinesRequest as g_, type BulkArchiveOrdersRequest as ga, type BulkArchiveOrdersResponse as gb, type BulkArchiveOrdersByFilterRequest as gc, type BulkArchiveOrdersByFilterResponse as gd, type UnArchiveOrderRequest as ge, type UnArchiveOrderResponse as gf, type BulkUnArchiveOrdersRequest as gg, type BulkUnArchiveOrdersResponse as gh, type BulkUnArchiveOrdersByFilterRequest as gi, type BulkUnArchiveOrdersByFilterResponse as gj, type UpdateBuyerInfoRequest as gk, type BuyerInfoUpdate as gl, type UpdateBuyerInfoResponse as gm, type UpdateBuyerEmailRequest as gn, type UpdateBuyerEmailResponse as go, type UpdateOrderShippingAddressRequest as gp, type UpdateOrderShippingAddressResponse as gq, type UpdateBillingContactDetailsRequest as gr, type UpdateBillingContactDetailsResponse as gs, type UpdateOrderLineItemRequest as gt, type UpdateOrderLineItemsRequest as gu, type MaskedOrderLineItem as gv, type UpdateOrderLineItemsResponse as gw, type AddInternalActivityRequest as gx, type InternalActivity as gy, type InternalActivityContentOneOf as gz, type ChargeMembershipsOptions as h, type Locale as h$, type UpdateLineItemsDescriptionLinesResponse as h0, type MarkOrderAsSeenByHumanRequest as h1, type MarkOrderAsSeenByHumanResponse as h2, type CancelOrderRequest as h3, type OrderCanceledEventOrderCanceled as h4, type UpdateOrderStatusRequest as h5, type MarkAsFulfilledRequest as h6, type MarkAsFulfilledResponse as h7, type FulfillmentStatusUpdated as h8, type BulkMarkAsFulfilledRequest as h9, type Task as hA, type TaskKey as hB, type TaskAction as hC, type TaskActionActionOneOf as hD, type Complete as hE, type Cancel as hF, type Reschedule as hG, type InvoiceSentEvent as hH, type IdAndVersion as hI, type InvoiceFields as hJ, type Customer as hK, type Email as hL, type QuotesAddress as hM, type AddressDescription as hN, type Phone as hO, type Company as hP, type CommonAddress as hQ, type CommonAddressStreetOneOf as hR, type Subdivision as hS, type StandardDetails as hT, type InvoiceDates as hU, type LineItems as hV, type LineItem as hW, type BigDecimalWrapper as hX, type LineItemTax as hY, type Source as hZ, type LineItemMetaData as h_, type BulkMarkAsFulfilledResponse as ha, type BulkMarkAsFulfilledByFilterRequest as hb, type BulkMarkAsFulfilledByFilterResponse as hc, type MarkAsUnfulfilledRequest as hd, type MarkAsUnfulfilledResponse as he, type BulkMarkAsUnfulfilledRequest as hf, type BulkMarkAsUnfulfilledResponse as hg, type BulkMarkAsUnfulfilledByFilterRequest as hh, type BulkMarkAsUnfulfilledByFilterResponse as hi, type BulkSetBusinessLocationRequest as hj, type BulkSetBusinessLocationResponse as hk, type BulkSetBusinessLocationResult as hl, type V1MarkOrderAsPaidRequest as hm, type V1MarkOrderAsPaidResponse as hn, type V1BulkMarkOrdersAsPaidRequest as ho, type V1BulkMarkOrdersAsPaidResponse as hp, type V1CreatePaymentGatewayOrderRequest as hq, type V1CreatePaymentGatewayOrderResponse as hr, type GetShipmentsRequest as hs, type GetShipmentsResponse as ht, type AggregateOrdersRequest as hu, type DecrementItemsQuantityRequest as hv, type DecrementData as hw, type DecrementItemsQuantityResponse as hx, type BulkUpdateOrderTagsRequest as hy, type BulkUpdateOrderTagsResult as hz, type PaymentRefund as i, type PlacementWithLiterals as i$, type TotalPrice as i0, type ItemizedFee as i1, type Discount as i2, type DiscountOneDiscountTypeOneOf as i3, type CalculatedTaxes as i4, type CalculatedTax as i5, type Payments as i6, type InvoicesPayment as i7, type MetaData as i8, type InvoiceDynamicPriceTotals as i9, type ChannelTypeWithLiterals as iA, type ScheduledActionWithLiterals as iB, type DurationUnitWithLiterals as iC, type PaymentCollectabilityStatusWithLiterals as iD, type RefundableStatusWithLiterals as iE, type NonRefundableReasonWithLiterals as iF, type ManuallyRefundableReasonWithLiterals as iG, type RestockTypeWithLiterals as iH, type TransactionStatusWithLiterals as iI, type AuthorizationCaptureStatusWithLiterals as iJ, type AuthorizationVoidStatusWithLiterals as iK, type ReasonWithLiterals as iL, type ActionTypeWithLiterals as iM, type ChargebackStatusWithLiterals as iN, type MembershipPaymentStatusWithLiterals as iO, type RefundStatusWithLiterals as iP, type WebhookIdentityTypeWithLiterals as iQ, type TextDetectionWithLiterals as iR, type AnimationDetectionWithLiterals as iS, type PreviewEmailTypeWithLiterals as iT, type StateWithLiterals as iU, type NamespaceWithLiterals as iV, type SortOrderWithLiterals as iW, type VersioningModeWithLiterals as iX, type OrderApprovalStrategyWithLiterals as iY, type DeltaPaymentOptionTypeWithLiterals as iZ, type InventoryActionWithLiterals as i_, type CustomFieldValue as ia, type Value as ib, type Deposit as ic, type TriggerSideEffectsFromLegacyData as id, type BaseEventMetadata as ie, type EventMetadata as ig, type OrderSearchSpec as ih, type DescriptionLineTypeWithLiterals as ii, type ItemTypeItemTypeWithLiterals as ij, type PaymentOptionTypeWithLiterals as ik, type JurisdictionTypeWithLiterals as il, type SubscriptionFrequencyWithLiterals as im, type AdjustmentTypeWithLiterals as io, type TaxableAddressTypeWithLiterals as ip, type PaymentStatusWithLiterals as iq, type FulfillmentStatusWithLiterals as ir, type WeightUnitWithLiterals as is, type VatTypeWithLiterals as it, type PickupMethodWithLiterals as iu, type DiscountTypeWithLiterals as iv, type DiscountReasonWithLiterals as iw, type LineItemQuantityChangeTypeWithLiterals as ix, type ActivityTypeWithLiterals as iy, type AttributionSourceWithLiterals as iz, type TriggerRefundResponse as j, type SubdivisionTypeWithLiterals as j0, type SourceTypeWithLiterals as j1, type CustomFieldGroupWithLiterals as j2, type ValueTypeWithLiterals as j3, type DepositTypeWithLiterals as j4, type InvoiceStatusWithLiterals as j5, onOrderApproved as j6, onOrderUpdated as j7, onOrderCanceled as j8, onOrderCreated as j9, preparePaymentCollection as ja, getPaymentCollectabilityStatus as jb, recordManuallyCollectedPayment as jc, paymentCollectionMarkOrderAsPaid as jd, paymentCollectionBulkMarkOrdersAsPaid as je, getRefundabilityStatus as jf, paymentCollectionCreatePaymentGatewayOrder as jg, chargeMemberships as jh, triggerRefund as ji, voidAuthorizedPayments as jj, captureAuthorizedPayments as jk, getOrder as jl, type CommonSearchWithEntityContext as jm, createOrder as jn, updateOrder as jo, bulkUpdateOrders as jp, commitDeltas as jq, updateOrderLineItem as jr, addActivity as js, updateActivity as jt, deleteActivity as ju, cancelOrder as jv, updateOrderStatus as jw, aggregateOrders as jx, bulkUpdateOrderTags as jy, type TriggerRefundApplicationErrors as k, type VoidAuthorizedPaymentsApplicationErrors as l, type PaymentCapture as m, type CaptureAuthorizedPaymentsResponse as n, type CaptureAuthorizedPaymentsApplicationErrors as o, type GetOrderApplicationErrors as p, type OrderSearch as q, type CreateOrderOptions as r, type CreateOrderApplicationErrors as s, type UpdateOrderApplicationErrors as t, type MaskedOrder as u, type BulkUpdateOrdersOptions as v, type BulkUpdateOrdersResponse as w, type CommitDeltasOptions as x, type CommitDeltasResponse as y, type CommitDeltasApplicationErrors as z };
|