@wix/auto_sdk_ecom_orders 1.0.68 → 1.0.69
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-Dt_KjUcw.d.ts → cjs/ecom-v1-order-orders.universal-Br3Nippn.d.ts} +351 -3211
- package/build/cjs/index.d.ts +11 -59
- package/build/cjs/index.js +310 -1377
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +113 -1127
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +43 -953
- package/build/cjs/meta.js +3 -647
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-Dt_KjUcw.d.mts → es/ecom-v1-order-orders.universal-Br3Nippn.d.mts} +351 -3211
- package/build/es/index.d.mts +11 -59
- package/build/es/index.mjs +308 -1344
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +112 -1094
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +43 -953
- package/build/es/meta.mjs +2 -635
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-D9sENjnN.d.ts → internal/cjs/ecom-v1-order-orders.universal-BAE6DVkA.d.ts} +857 -2526
- package/build/internal/cjs/index.d.ts +11 -165
- package/build/internal/cjs/index.js +310 -1377
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +113 -1127
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +43 -953
- package/build/internal/cjs/meta.js +3 -647
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-D9sENjnN.d.mts → internal/es/ecom-v1-order-orders.universal-BAE6DVkA.d.mts} +857 -2526
- package/build/internal/es/index.d.mts +11 -165
- package/build/internal/es/index.mjs +308 -1344
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +112 -1094
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +43 -953
- package/build/internal/es/meta.mjs +2 -635
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -283,12 +283,25 @@ interface OrderLineItem {
|
|
|
283
283
|
locations?: LocationAndQuantity[];
|
|
284
284
|
/** Address used for tax calculation. */
|
|
285
285
|
taxableAddress?: TaxableAddress;
|
|
286
|
+
/**
|
|
287
|
+
* ID of the app managing the inventory.
|
|
288
|
+
* @internal
|
|
289
|
+
* @format GUID
|
|
290
|
+
*/
|
|
291
|
+
inventoryAppId?: string | null;
|
|
286
292
|
/**
|
|
287
293
|
* Custom extended fields for the line item object.
|
|
288
294
|
*
|
|
289
295
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
290
296
|
*/
|
|
291
297
|
extendedFields?: ExtendedFields;
|
|
298
|
+
/**
|
|
299
|
+
* Modifier groups that were added to the item.
|
|
300
|
+
* @internal
|
|
301
|
+
* @readonly
|
|
302
|
+
* @maxSize 10
|
|
303
|
+
*/
|
|
304
|
+
modifierGroups?: ModifierGroup[];
|
|
292
305
|
}
|
|
293
306
|
interface ProductName {
|
|
294
307
|
/**
|
|
@@ -359,6 +372,11 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
359
372
|
colorInfo?: Color;
|
|
360
373
|
/** Description line name. */
|
|
361
374
|
name?: DescriptionLineName;
|
|
375
|
+
/**
|
|
376
|
+
* Whether the description line originates from a modifier.
|
|
377
|
+
* @internal
|
|
378
|
+
*/
|
|
379
|
+
modifierDescriptionLine?: boolean;
|
|
362
380
|
}
|
|
363
381
|
/** @oneof */
|
|
364
382
|
interface DescriptionLineValueOneOf {
|
|
@@ -603,6 +621,11 @@ interface SubscriptionInfo {
|
|
|
603
621
|
* @targetRemovalDate 2025-10-01
|
|
604
622
|
*/
|
|
605
623
|
subscriptionOptionTitle?: string;
|
|
624
|
+
/**
|
|
625
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
title?: SubscriptionTitle;
|
|
606
629
|
/**
|
|
607
630
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
608
631
|
* @maxLength 60
|
|
@@ -611,6 +634,11 @@ interface SubscriptionInfo {
|
|
|
611
634
|
* @targetRemovalDate 2025-10-01
|
|
612
635
|
*/
|
|
613
636
|
subscriptionOptionDescription?: string | null;
|
|
637
|
+
/**
|
|
638
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
639
|
+
* @internal
|
|
640
|
+
*/
|
|
641
|
+
description?: SubscriptionDescription;
|
|
614
642
|
/**
|
|
615
643
|
* Subscription detailed information.
|
|
616
644
|
* @immutable
|
|
@@ -621,6 +649,11 @@ interface SubscriptionInfo {
|
|
|
621
649
|
* @maxLength 1000
|
|
622
650
|
*/
|
|
623
651
|
chargesDescription?: string | null;
|
|
652
|
+
/**
|
|
653
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
654
|
+
* @internal
|
|
655
|
+
*/
|
|
656
|
+
billingAdjustment?: BillingAdjustment;
|
|
624
657
|
}
|
|
625
658
|
interface SubscriptionTitle {
|
|
626
659
|
/**
|
|
@@ -670,6 +703,11 @@ interface SubscriptionSettings {
|
|
|
670
703
|
enableCustomerCancellation?: boolean;
|
|
671
704
|
/** Period until first cycle starts. If None => no free trial */
|
|
672
705
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
706
|
+
/**
|
|
707
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
708
|
+
* @internal
|
|
709
|
+
*/
|
|
710
|
+
startDate?: Date | null;
|
|
673
711
|
}
|
|
674
712
|
/** Frequency unit of recurring payment */
|
|
675
713
|
declare enum SubscriptionFrequency {
|
|
@@ -1346,6 +1384,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1346
1384
|
* @immutable
|
|
1347
1385
|
*/
|
|
1348
1386
|
_id?: string | null;
|
|
1387
|
+
/**
|
|
1388
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1389
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1390
|
+
* @internal
|
|
1391
|
+
* @min 1
|
|
1392
|
+
* @max 999
|
|
1393
|
+
*/
|
|
1394
|
+
subscriptionCycles?: number | null;
|
|
1349
1395
|
}
|
|
1350
1396
|
/** @oneof */
|
|
1351
1397
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -1387,6 +1433,13 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1387
1433
|
description?: string | null;
|
|
1388
1434
|
/** Discount amount. */
|
|
1389
1435
|
amount?: Price;
|
|
1436
|
+
/**
|
|
1437
|
+
* Discount percentage.
|
|
1438
|
+
* @internal
|
|
1439
|
+
* @format DECIMAL_VALUE
|
|
1440
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1441
|
+
*/
|
|
1442
|
+
percentage?: string | null;
|
|
1390
1443
|
}
|
|
1391
1444
|
/** @oneof */
|
|
1392
1445
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -1449,6 +1502,70 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1449
1502
|
merchantComment?: MerchantComment;
|
|
1450
1503
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1451
1504
|
orderRefunded?: OrderRefunded;
|
|
1505
|
+
/**
|
|
1506
|
+
* Details of an initiated refund process.
|
|
1507
|
+
*
|
|
1508
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1509
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1510
|
+
* @internal
|
|
1511
|
+
*/
|
|
1512
|
+
refundInitiated?: RefundInitiated;
|
|
1513
|
+
/**
|
|
1514
|
+
* Details of a refunded payment.
|
|
1515
|
+
*
|
|
1516
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1517
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1518
|
+
* @internal
|
|
1519
|
+
*/
|
|
1520
|
+
paymentRefunded?: PaymentRefunded;
|
|
1521
|
+
/**
|
|
1522
|
+
* Details of a failed payment refund.
|
|
1523
|
+
*
|
|
1524
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1525
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1526
|
+
* @internal
|
|
1527
|
+
*/
|
|
1528
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1529
|
+
/**
|
|
1530
|
+
* Details of refund to store credit.
|
|
1531
|
+
* @internal
|
|
1532
|
+
*/
|
|
1533
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1534
|
+
/**
|
|
1535
|
+
* Details of a pending payment
|
|
1536
|
+
* @internal
|
|
1537
|
+
*/
|
|
1538
|
+
paymentPending?: PaymentPending;
|
|
1539
|
+
/**
|
|
1540
|
+
* Details of a canceled payment
|
|
1541
|
+
* @internal
|
|
1542
|
+
*/
|
|
1543
|
+
paymentCanceled?: PaymentCanceled;
|
|
1544
|
+
/**
|
|
1545
|
+
* Details of a declined payment
|
|
1546
|
+
* @internal
|
|
1547
|
+
*/
|
|
1548
|
+
paymentDeclined?: PaymentDeclined;
|
|
1549
|
+
/**
|
|
1550
|
+
* Receipt was added for associated payment
|
|
1551
|
+
* @internal
|
|
1552
|
+
*/
|
|
1553
|
+
receiptCreated?: ReceiptCreated;
|
|
1554
|
+
/**
|
|
1555
|
+
* Receipt sent to customer
|
|
1556
|
+
* @internal
|
|
1557
|
+
*/
|
|
1558
|
+
receiptSent?: ReceiptSent;
|
|
1559
|
+
/**
|
|
1560
|
+
* Order received a chargeback for one of its' payments.
|
|
1561
|
+
* @internal
|
|
1562
|
+
*/
|
|
1563
|
+
chargebackCreated?: ChargebackCreated;
|
|
1564
|
+
/**
|
|
1565
|
+
* Chargeback reversed for one of the order's payments.
|
|
1566
|
+
* @internal
|
|
1567
|
+
*/
|
|
1568
|
+
chargebackReversed?: ChargebackReversed;
|
|
1452
1569
|
/**
|
|
1453
1570
|
* Activity ID.
|
|
1454
1571
|
* @format GUID
|
|
@@ -1477,6 +1594,70 @@ interface ActivityContentOneOf {
|
|
|
1477
1594
|
merchantComment?: MerchantComment;
|
|
1478
1595
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1479
1596
|
orderRefunded?: OrderRefunded;
|
|
1597
|
+
/**
|
|
1598
|
+
* Details of an initiated refund process.
|
|
1599
|
+
*
|
|
1600
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1601
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1602
|
+
* @internal
|
|
1603
|
+
*/
|
|
1604
|
+
refundInitiated?: RefundInitiated;
|
|
1605
|
+
/**
|
|
1606
|
+
* Details of a refunded payment.
|
|
1607
|
+
*
|
|
1608
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1609
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1610
|
+
* @internal
|
|
1611
|
+
*/
|
|
1612
|
+
paymentRefunded?: PaymentRefunded;
|
|
1613
|
+
/**
|
|
1614
|
+
* Details of a failed payment refund.
|
|
1615
|
+
*
|
|
1616
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1617
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1618
|
+
* @internal
|
|
1619
|
+
*/
|
|
1620
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1621
|
+
/**
|
|
1622
|
+
* Details of refund to store credit.
|
|
1623
|
+
* @internal
|
|
1624
|
+
*/
|
|
1625
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1626
|
+
/**
|
|
1627
|
+
* Details of a pending payment
|
|
1628
|
+
* @internal
|
|
1629
|
+
*/
|
|
1630
|
+
paymentPending?: PaymentPending;
|
|
1631
|
+
/**
|
|
1632
|
+
* Details of a canceled payment
|
|
1633
|
+
* @internal
|
|
1634
|
+
*/
|
|
1635
|
+
paymentCanceled?: PaymentCanceled;
|
|
1636
|
+
/**
|
|
1637
|
+
* Details of a declined payment
|
|
1638
|
+
* @internal
|
|
1639
|
+
*/
|
|
1640
|
+
paymentDeclined?: PaymentDeclined;
|
|
1641
|
+
/**
|
|
1642
|
+
* Receipt was added for associated payment
|
|
1643
|
+
* @internal
|
|
1644
|
+
*/
|
|
1645
|
+
receiptCreated?: ReceiptCreated;
|
|
1646
|
+
/**
|
|
1647
|
+
* Receipt sent to customer
|
|
1648
|
+
* @internal
|
|
1649
|
+
*/
|
|
1650
|
+
receiptSent?: ReceiptSent;
|
|
1651
|
+
/**
|
|
1652
|
+
* Order received a chargeback for one of its' payments.
|
|
1653
|
+
* @internal
|
|
1654
|
+
*/
|
|
1655
|
+
chargebackCreated?: ChargebackCreated;
|
|
1656
|
+
/**
|
|
1657
|
+
* Chargeback reversed for one of the order's payments.
|
|
1658
|
+
* @internal
|
|
1659
|
+
*/
|
|
1660
|
+
chargebackReversed?: ChargebackReversed;
|
|
1480
1661
|
}
|
|
1481
1662
|
interface CustomActivity {
|
|
1482
1663
|
/**
|
|
@@ -2228,11 +2409,29 @@ interface BalanceSummary {
|
|
|
2228
2409
|
* @readonly
|
|
2229
2410
|
*/
|
|
2230
2411
|
authorized?: Price;
|
|
2412
|
+
/**
|
|
2413
|
+
* Sum of all pending refund transactions.
|
|
2414
|
+
* @internal
|
|
2415
|
+
* @readonly
|
|
2416
|
+
*/
|
|
2417
|
+
pendingRefund?: Price;
|
|
2231
2418
|
/**
|
|
2232
2419
|
* Sum of all pending transactions.
|
|
2233
2420
|
* @readonly
|
|
2234
2421
|
*/
|
|
2235
2422
|
pending?: Price;
|
|
2423
|
+
/**
|
|
2424
|
+
* Sum of all transaction chargebacks.
|
|
2425
|
+
* @internal
|
|
2426
|
+
* @readonly
|
|
2427
|
+
*/
|
|
2428
|
+
chargeback?: Price;
|
|
2429
|
+
/**
|
|
2430
|
+
* Sum of all chargeback reversals.
|
|
2431
|
+
* @internal
|
|
2432
|
+
* @readonly
|
|
2433
|
+
*/
|
|
2434
|
+
chargebackReversal?: Price;
|
|
2236
2435
|
}
|
|
2237
2436
|
/**
|
|
2238
2437
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2294,6 +2493,14 @@ interface AdditionalFee {
|
|
|
2294
2493
|
* @format GUID
|
|
2295
2494
|
*/
|
|
2296
2495
|
lineItemIds?: string[];
|
|
2496
|
+
/**
|
|
2497
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
2498
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
2499
|
+
* @internal
|
|
2500
|
+
* @min 1
|
|
2501
|
+
* @max 999
|
|
2502
|
+
*/
|
|
2503
|
+
subscriptionCycles?: number | null;
|
|
2297
2504
|
}
|
|
2298
2505
|
interface FulfillmentStatusesAggregate {
|
|
2299
2506
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -2350,10 +2557,21 @@ interface Location {
|
|
|
2350
2557
|
*/
|
|
2351
2558
|
name?: string;
|
|
2352
2559
|
}
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2560
|
+
interface DiffmatokyPayload {
|
|
2561
|
+
left?: string;
|
|
2562
|
+
right?: string;
|
|
2563
|
+
compareChannel?: string;
|
|
2564
|
+
entityId?: string;
|
|
2565
|
+
errorInformation?: ErrorInformation;
|
|
2566
|
+
tags?: string[];
|
|
2567
|
+
}
|
|
2568
|
+
interface ErrorInformation {
|
|
2569
|
+
stackTrace?: string;
|
|
2570
|
+
}
|
|
2571
|
+
interface ContinueSideEffectsFlowInLegacyData {
|
|
2572
|
+
storeId?: string;
|
|
2573
|
+
orderId?: string;
|
|
2574
|
+
ordersExperiments?: OrdersExperiments;
|
|
2357
2575
|
}
|
|
2358
2576
|
interface OrdersExperiments {
|
|
2359
2577
|
epCommitTax?: boolean;
|
|
@@ -2362,6 +2580,20 @@ interface OrdersExperiments {
|
|
|
2362
2580
|
producedByEpBridge?: boolean;
|
|
2363
2581
|
enableRewrittenSideEffects?: boolean;
|
|
2364
2582
|
}
|
|
2583
|
+
interface SnapshotMessage {
|
|
2584
|
+
_id?: string;
|
|
2585
|
+
opType?: number;
|
|
2586
|
+
}
|
|
2587
|
+
interface IndexingMessage {
|
|
2588
|
+
_id?: string;
|
|
2589
|
+
opType?: number;
|
|
2590
|
+
requiredVersions?: string[];
|
|
2591
|
+
}
|
|
2592
|
+
/** Triggered when the order status changes to approved */
|
|
2593
|
+
interface OrderApproved {
|
|
2594
|
+
/** The order that was updated */
|
|
2595
|
+
order?: Order;
|
|
2596
|
+
}
|
|
2365
2597
|
interface OrderRejectedEventOrderRejected {
|
|
2366
2598
|
/** The order that was rejected */
|
|
2367
2599
|
order?: Order;
|
|
@@ -2371,9 +2603,9 @@ interface OrderItemsRestocked {
|
|
|
2371
2603
|
/** The order which items were restocked */
|
|
2372
2604
|
order?: Order;
|
|
2373
2605
|
/** Restocked items and quantities */
|
|
2374
|
-
restockItems?:
|
|
2606
|
+
restockItems?: RestockItem[];
|
|
2375
2607
|
}
|
|
2376
|
-
interface
|
|
2608
|
+
interface RestockItem {
|
|
2377
2609
|
/**
|
|
2378
2610
|
* ID of the line item being restocked.
|
|
2379
2611
|
* @format GUID
|
|
@@ -2386,2297 +2618,105 @@ interface V1RestockItem {
|
|
|
2386
2618
|
*/
|
|
2387
2619
|
quantity?: number;
|
|
2388
2620
|
}
|
|
2389
|
-
interface
|
|
2621
|
+
interface GetOrderRequest {
|
|
2390
2622
|
/**
|
|
2391
|
-
*
|
|
2623
|
+
* ID of the order to retrieve.
|
|
2392
2624
|
* @minLength 1
|
|
2393
2625
|
* @maxLength 100
|
|
2394
2626
|
*/
|
|
2395
|
-
|
|
2396
|
-
/** Amount to collect */
|
|
2397
|
-
amount: Price;
|
|
2398
|
-
/**
|
|
2399
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
2400
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
2401
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
2402
|
-
*/
|
|
2403
|
-
paymentGatewayOrderId?: string | null;
|
|
2404
|
-
/**
|
|
2405
|
-
* Whether to delay capture of the payment.
|
|
2406
|
-
* Default: false
|
|
2407
|
-
* @deprecated Whether to delay capture of the payment.
|
|
2408
|
-
* Default: false
|
|
2409
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
2410
|
-
* @targetRemovalDate 2024-09-30
|
|
2411
|
-
*/
|
|
2412
|
-
delayedCapture?: boolean;
|
|
2413
|
-
/** Delayed capture payment settings */
|
|
2414
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2627
|
+
_id: string;
|
|
2415
2628
|
}
|
|
2416
|
-
interface
|
|
2417
|
-
/**
|
|
2418
|
-
|
|
2419
|
-
* @format WEB_URL
|
|
2420
|
-
*/
|
|
2421
|
-
successUrl?: string | null;
|
|
2422
|
-
/**
|
|
2423
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
2424
|
-
* @format WEB_URL
|
|
2425
|
-
*/
|
|
2426
|
-
cancelUrl?: string | null;
|
|
2427
|
-
/**
|
|
2428
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
2429
|
-
* @format WEB_URL
|
|
2430
|
-
*/
|
|
2431
|
-
errorUrl?: string | null;
|
|
2432
|
-
/**
|
|
2433
|
-
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
2434
|
-
* @format WEB_URL
|
|
2435
|
-
*/
|
|
2436
|
-
pendingUrl?: string | null;
|
|
2629
|
+
interface GetOrderResponse {
|
|
2630
|
+
/** The requested order. */
|
|
2631
|
+
order?: Order;
|
|
2437
2632
|
}
|
|
2438
|
-
interface
|
|
2439
|
-
/**
|
|
2440
|
-
|
|
2441
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2442
|
-
delayDuration?: Duration;
|
|
2633
|
+
interface InternalQueryOrdersRequest {
|
|
2634
|
+
/** Query options. */
|
|
2635
|
+
query?: PlatformQuery;
|
|
2443
2636
|
}
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2637
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2638
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2639
|
+
paging?: PlatformPaging;
|
|
2640
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2641
|
+
cursorPaging?: CursorPaging;
|
|
2642
|
+
/** Filter object. */
|
|
2643
|
+
filter?: Record<string, any> | null;
|
|
2644
|
+
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
2645
|
+
sort?: Sorting[];
|
|
2450
2646
|
}
|
|
2451
|
-
/** @
|
|
2452
|
-
|
|
2453
|
-
|
|
2647
|
+
/** @oneof */
|
|
2648
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
2649
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2650
|
+
paging?: PlatformPaging;
|
|
2651
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2652
|
+
cursorPaging?: CursorPaging;
|
|
2653
|
+
}
|
|
2654
|
+
interface Sorting {
|
|
2454
2655
|
/**
|
|
2455
|
-
*
|
|
2456
|
-
* @
|
|
2656
|
+
* Name of the field to sort by.
|
|
2657
|
+
* @maxLength 512
|
|
2457
2658
|
*/
|
|
2458
|
-
|
|
2459
|
-
/**
|
|
2460
|
-
|
|
2659
|
+
fieldName?: string;
|
|
2660
|
+
/** Sort order. */
|
|
2661
|
+
order?: SortOrderWithLiterals;
|
|
2461
2662
|
}
|
|
2462
|
-
declare enum
|
|
2463
|
-
|
|
2464
|
-
|
|
2465
|
-
HOURS = "HOURS",
|
|
2466
|
-
DAYS = "DAYS"
|
|
2663
|
+
declare enum SortOrder {
|
|
2664
|
+
ASC = "ASC",
|
|
2665
|
+
DESC = "DESC"
|
|
2467
2666
|
}
|
|
2468
2667
|
/** @enumType */
|
|
2469
|
-
type
|
|
2470
|
-
interface
|
|
2471
|
-
/** Payment gateway order id which is associated with given payment */
|
|
2472
|
-
paymentGatewayOrderId?: string;
|
|
2473
|
-
}
|
|
2474
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
2668
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2669
|
+
interface PlatformPaging {
|
|
2475
2670
|
/**
|
|
2476
|
-
*
|
|
2477
|
-
* @
|
|
2478
|
-
* @maxLength 100
|
|
2671
|
+
* Number of items to load.
|
|
2672
|
+
* @max 100
|
|
2479
2673
|
*/
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
/** Payment collectability status */
|
|
2484
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2485
|
-
/** Collectable order amount */
|
|
2486
|
-
amount?: Price;
|
|
2487
|
-
}
|
|
2488
|
-
declare enum PaymentCollectabilityStatus {
|
|
2489
|
-
UNKNOWN = "UNKNOWN",
|
|
2490
|
-
COLLECTABLE = "COLLECTABLE",
|
|
2491
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
2492
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
2493
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
2494
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
2495
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2496
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2674
|
+
limit?: number | null;
|
|
2675
|
+
/** Number of items to skip in the current sort order. */
|
|
2676
|
+
offset?: number | null;
|
|
2497
2677
|
}
|
|
2498
|
-
|
|
2499
|
-
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
|
|
2500
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
2678
|
+
interface CursorPaging {
|
|
2501
2679
|
/**
|
|
2502
|
-
*
|
|
2503
|
-
* @
|
|
2504
|
-
* @maxLength 100
|
|
2680
|
+
* Maximum number of items to return in the results.
|
|
2681
|
+
* @max 100
|
|
2505
2682
|
*/
|
|
2506
|
-
|
|
2507
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
2508
|
-
amount: Price;
|
|
2509
|
-
}
|
|
2510
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
2511
|
-
}
|
|
2512
|
-
interface MarkOrderAsPaidRequest {
|
|
2683
|
+
limit?: number | null;
|
|
2513
2684
|
/**
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2516
|
-
*
|
|
2685
|
+
* Pointer to the next or previous page in the list of results.
|
|
2686
|
+
*
|
|
2687
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2688
|
+
* Not relevant for the first request.
|
|
2689
|
+
* @maxLength 16000
|
|
2517
2690
|
*/
|
|
2518
|
-
|
|
2691
|
+
cursor?: string | null;
|
|
2519
2692
|
}
|
|
2520
|
-
interface
|
|
2521
|
-
/**
|
|
2522
|
-
|
|
2693
|
+
interface InternalQueryOrdersResponse {
|
|
2694
|
+
/** List of orders. */
|
|
2695
|
+
orders?: Order[];
|
|
2696
|
+
/** Details on the paged set of results returned. */
|
|
2697
|
+
metadata?: PlatformPagingMetadata;
|
|
2523
2698
|
}
|
|
2524
|
-
interface
|
|
2699
|
+
interface PlatformPagingMetadata {
|
|
2700
|
+
/** The number of items returned in this response. */
|
|
2701
|
+
count?: number | null;
|
|
2702
|
+
/** The offset which was requested. Returned if offset paging was used. */
|
|
2703
|
+
offset?: number | null;
|
|
2704
|
+
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
2705
|
+
total?: number | null;
|
|
2706
|
+
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
2707
|
+
cursors?: Cursors;
|
|
2708
|
+
}
|
|
2709
|
+
interface Cursors {
|
|
2525
2710
|
/**
|
|
2526
|
-
*
|
|
2527
|
-
* @
|
|
2528
|
-
* @maxSize 100
|
|
2529
|
-
* @minLength 1
|
|
2530
|
-
* @maxLength 100
|
|
2711
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2712
|
+
* @maxLength 16000
|
|
2531
2713
|
*/
|
|
2532
|
-
|
|
2533
|
-
}
|
|
2534
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
2714
|
+
next?: string | null;
|
|
2535
2715
|
/**
|
|
2536
|
-
*
|
|
2537
|
-
*
|
|
2716
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2717
|
+
* @maxLength 16000
|
|
2538
2718
|
*/
|
|
2539
|
-
|
|
2540
|
-
/** Bulk action metadata. */
|
|
2541
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2542
|
-
}
|
|
2543
|
-
interface BulkOrderResult {
|
|
2544
|
-
/** Item metadata. */
|
|
2545
|
-
itemMetadata?: ItemMetadata;
|
|
2546
|
-
/**
|
|
2547
|
-
* Updated order.
|
|
2548
|
-
*
|
|
2549
|
-
* Returned when `returnFullEntity = true`.
|
|
2550
|
-
*/
|
|
2551
|
-
item?: Order;
|
|
2552
|
-
}
|
|
2553
|
-
interface ItemMetadata {
|
|
2554
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2555
|
-
_id?: string | null;
|
|
2556
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2557
|
-
originalIndex?: number;
|
|
2558
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2559
|
-
success?: boolean;
|
|
2560
|
-
/** Details about the error in case of failure. */
|
|
2561
|
-
error?: ApplicationError;
|
|
2562
|
-
}
|
|
2563
|
-
interface ApplicationError {
|
|
2564
|
-
/** Error code. */
|
|
2565
|
-
code?: string;
|
|
2566
|
-
/** Description of the error. */
|
|
2567
|
-
description?: string;
|
|
2568
|
-
/** Data related to the error. */
|
|
2569
|
-
data?: Record<string, any> | null;
|
|
2570
|
-
}
|
|
2571
|
-
interface BulkActionMetadata {
|
|
2572
|
-
/** Number of items that were successfully processed. */
|
|
2573
|
-
totalSuccesses?: number;
|
|
2574
|
-
/** Number of items that couldn't be processed. */
|
|
2575
|
-
totalFailures?: number;
|
|
2576
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2577
|
-
undetailedFailures?: number;
|
|
2578
|
-
}
|
|
2579
|
-
interface GetRefundabilityStatusRequest {
|
|
2580
|
-
/**
|
|
2581
|
-
* Order ID.
|
|
2582
|
-
* @minLength 1
|
|
2583
|
-
* @maxLength 100
|
|
2584
|
-
*/
|
|
2585
|
-
ecomOrderId: string;
|
|
2586
|
-
}
|
|
2587
|
-
interface GetRefundabilityStatusResponse {
|
|
2588
|
-
/**
|
|
2589
|
-
* Refundability details.
|
|
2590
|
-
* @maxSize 300
|
|
2591
|
-
*/
|
|
2592
|
-
refundabilities?: Refundability[];
|
|
2593
|
-
/**
|
|
2594
|
-
* Whether the order supports refunding per item.
|
|
2595
|
-
* @deprecated
|
|
2596
|
-
*/
|
|
2597
|
-
refundablePerItem?: boolean;
|
|
2598
|
-
}
|
|
2599
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2600
|
-
/** Reason why payment is not refundable. */
|
|
2601
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2602
|
-
/** Reason why payment is only refundable manually. */
|
|
2603
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2604
|
-
/** Payment ID. */
|
|
2605
|
-
paymentId?: string;
|
|
2606
|
-
/** Payment refundability status. */
|
|
2607
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2608
|
-
/** Link to payment provider dashboard. */
|
|
2609
|
-
providerLink?: string | null;
|
|
2610
|
-
}
|
|
2611
|
-
/** @oneof */
|
|
2612
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2613
|
-
/** Reason why payment is not refundable. */
|
|
2614
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2615
|
-
/** Reason why payment is only refundable manually. */
|
|
2616
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2617
|
-
}
|
|
2618
|
-
declare enum RefundableStatus {
|
|
2619
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2620
|
-
MANUAL = "MANUAL",
|
|
2621
|
-
REFUNDABLE = "REFUNDABLE"
|
|
2622
|
-
}
|
|
2623
|
-
/** @enumType */
|
|
2624
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2625
|
-
declare enum NonRefundableReason {
|
|
2626
|
-
NONE = "NONE",
|
|
2627
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2628
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
2629
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
2630
|
-
NOT_PAID = "NOT_PAID",
|
|
2631
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
2632
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
2633
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
2634
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
2635
|
-
FORBIDDEN = "FORBIDDEN",
|
|
2636
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
2637
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2638
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2639
|
-
}
|
|
2640
|
-
/** @enumType */
|
|
2641
|
-
type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
|
|
2642
|
-
declare enum ManuallyRefundableReason {
|
|
2643
|
-
EXPIRED = "EXPIRED",
|
|
2644
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2645
|
-
OFFLINE = "OFFLINE",
|
|
2646
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2647
|
-
}
|
|
2648
|
-
/** @enumType */
|
|
2649
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2650
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
2651
|
-
/**
|
|
2652
|
-
* Ecom order ID.
|
|
2653
|
-
* @minLength 1
|
|
2654
|
-
* @maxLength 100
|
|
2655
|
-
*/
|
|
2656
|
-
ecomOrderId: string;
|
|
2657
|
-
/** Information about the user who initiated the payment. */
|
|
2658
|
-
chargedBy?: ChargedBy;
|
|
2659
|
-
}
|
|
2660
|
-
interface ChargedBy {
|
|
2661
|
-
/**
|
|
2662
|
-
* ID - id of the user who initiated the payment
|
|
2663
|
-
* @format GUID
|
|
2664
|
-
*/
|
|
2665
|
-
_id?: string;
|
|
2666
|
-
/**
|
|
2667
|
-
* Full name - name of the user who initiated the payment
|
|
2668
|
-
* @minLength 1
|
|
2669
|
-
* @maxLength 200
|
|
2670
|
-
*/
|
|
2671
|
-
fullName?: string | null;
|
|
2672
|
-
}
|
|
2673
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
2674
|
-
/** ID of the order created in the payment gateway */
|
|
2675
|
-
paymentGatewayOrderId?: string;
|
|
2676
|
-
}
|
|
2677
|
-
interface ChargeMembershipsRequest {
|
|
2678
|
-
/**
|
|
2679
|
-
* Order ID.
|
|
2680
|
-
* @minLength 1
|
|
2681
|
-
* @maxLength 100
|
|
2682
|
-
*/
|
|
2683
|
-
ecomOrderId: string;
|
|
2684
|
-
/**
|
|
2685
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
2686
|
-
* but a user which is using the membership on behalf of the a member
|
|
2687
|
-
* @format GUID
|
|
2688
|
-
*/
|
|
2689
|
-
memberId: string;
|
|
2690
|
-
/**
|
|
2691
|
-
* List of items to be paid by memberships
|
|
2692
|
-
* @minSize 1
|
|
2693
|
-
* @maxSize 300
|
|
2694
|
-
*/
|
|
2695
|
-
membershipCharges?: MembershipChargeItem[];
|
|
2696
|
-
}
|
|
2697
|
-
interface MembershipChargeItem {
|
|
2698
|
-
/**
|
|
2699
|
-
* The id of used membership
|
|
2700
|
-
* @minLength 1
|
|
2701
|
-
* @maxLength 100
|
|
2702
|
-
*/
|
|
2703
|
-
membershipId?: string;
|
|
2704
|
-
/**
|
|
2705
|
-
* ID of the application providing this payment option
|
|
2706
|
-
* @format GUID
|
|
2707
|
-
*/
|
|
2708
|
-
appId?: string;
|
|
2709
|
-
/** The name of used membership */
|
|
2710
|
-
membershipName?: MembershipName;
|
|
2711
|
-
/** Additional data about this membership */
|
|
2712
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
2713
|
-
/** Catalog and item reference info. */
|
|
2714
|
-
catalogReference?: CatalogReference;
|
|
2715
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2716
|
-
serviceProperties?: ServiceProperties;
|
|
2717
|
-
/**
|
|
2718
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
2719
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2720
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2721
|
-
* @minLength 1
|
|
2722
|
-
* @maxLength 36
|
|
2723
|
-
*/
|
|
2724
|
-
rootCatalogItemId?: string | null;
|
|
2725
|
-
/**
|
|
2726
|
-
* line item id of Checkout/Order line item
|
|
2727
|
-
* @minLength 1
|
|
2728
|
-
* @maxLength 100
|
|
2729
|
-
*/
|
|
2730
|
-
lineItemId?: string;
|
|
2731
|
-
}
|
|
2732
|
-
interface MembershipName {
|
|
2733
|
-
/**
|
|
2734
|
-
* Membership name.
|
|
2735
|
-
* @maxLength 100
|
|
2736
|
-
*/
|
|
2737
|
-
original?: string;
|
|
2738
|
-
/**
|
|
2739
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
2740
|
-
* @maxLength 100
|
|
2741
|
-
*/
|
|
2742
|
-
translated?: string | null;
|
|
2743
|
-
}
|
|
2744
|
-
interface ServiceProperties {
|
|
2745
|
-
/**
|
|
2746
|
-
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2747
|
-
* For example, the start time of a class.
|
|
2748
|
-
*/
|
|
2749
|
-
scheduledDate?: Date | null;
|
|
2750
|
-
/**
|
|
2751
|
-
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
2752
|
-
* @min 1
|
|
2753
|
-
* @max 10000
|
|
2754
|
-
*/
|
|
2755
|
-
numberOfParticipants?: number | null;
|
|
2756
|
-
}
|
|
2757
|
-
interface ChargeMembershipsResponse {
|
|
2758
|
-
}
|
|
2759
|
-
interface TriggerRefundRequest {
|
|
2760
|
-
/**
|
|
2761
|
-
* The order this refund related to
|
|
2762
|
-
* @minLength 1
|
|
2763
|
-
* @maxLength 100
|
|
2764
|
-
*/
|
|
2765
|
-
ecomOrderId: string;
|
|
2766
|
-
/**
|
|
2767
|
-
* Refund operations information
|
|
2768
|
-
* @minSize 1
|
|
2769
|
-
* @maxSize 1
|
|
2770
|
-
*/
|
|
2771
|
-
payments: PaymentRefund[];
|
|
2772
|
-
/** Business model of a refund */
|
|
2773
|
-
details?: RefundDetails;
|
|
2774
|
-
/** Side effect details related to refund */
|
|
2775
|
-
sideEffects?: RefundSideEffects;
|
|
2776
|
-
}
|
|
2777
|
-
interface PaymentRefund {
|
|
2778
|
-
/**
|
|
2779
|
-
* Specific payment within the order to refund
|
|
2780
|
-
* @format GUID
|
|
2781
|
-
*/
|
|
2782
|
-
paymentId?: string;
|
|
2783
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
2784
|
-
amount?: Price;
|
|
2785
|
-
/**
|
|
2786
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
2787
|
-
* When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
|
|
2788
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
2789
|
-
*/
|
|
2790
|
-
externalRefund?: boolean;
|
|
2791
|
-
}
|
|
2792
|
-
/** Business model of a refund request */
|
|
2793
|
-
interface RefundDetails {
|
|
2794
|
-
/**
|
|
2795
|
-
* Order line item IDs and quantities that were refunded.
|
|
2796
|
-
* @maxSize 300
|
|
2797
|
-
*/
|
|
2798
|
-
items?: RefundItem[];
|
|
2799
|
-
/** Whether the shipping fee was also refunded. */
|
|
2800
|
-
shippingIncluded?: boolean;
|
|
2801
|
-
/**
|
|
2802
|
-
* Reason for the refund, provided by customer (optional).
|
|
2803
|
-
* @maxLength 200
|
|
2804
|
-
*/
|
|
2805
|
-
reason?: string | null;
|
|
2806
|
-
/**
|
|
2807
|
-
* Line items that were refunded.
|
|
2808
|
-
* @maxSize 300
|
|
2809
|
-
*/
|
|
2810
|
-
lineItems?: LineItemRefund[];
|
|
2811
|
-
/**
|
|
2812
|
-
* Additional fees that were refunded.
|
|
2813
|
-
* @maxSize 100
|
|
2814
|
-
*/
|
|
2815
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
2816
|
-
/** Shipping amount that was refunded. */
|
|
2817
|
-
shipping?: ShippingRefund;
|
|
2818
|
-
}
|
|
2819
|
-
interface RefundItem {
|
|
2820
|
-
/**
|
|
2821
|
-
* Line item ID the refunded line item.
|
|
2822
|
-
* @format GUID
|
|
2823
|
-
*/
|
|
2824
|
-
lineItemId?: string;
|
|
2825
|
-
/**
|
|
2826
|
-
* Line item quantity refunded.
|
|
2827
|
-
* @min 1
|
|
2828
|
-
* @max 100000
|
|
2829
|
-
*/
|
|
2830
|
-
quantity?: number;
|
|
2831
|
-
}
|
|
2832
|
-
interface LineItemRefund {
|
|
2833
|
-
/**
|
|
2834
|
-
* Line item ID.
|
|
2835
|
-
* @format GUID
|
|
2836
|
-
* @immutable
|
|
2837
|
-
*/
|
|
2838
|
-
lineItemId?: string;
|
|
2839
|
-
/**
|
|
2840
|
-
* Refund quantity.
|
|
2841
|
-
* @min 1
|
|
2842
|
-
* @max 100000
|
|
2843
|
-
* @immutable
|
|
2844
|
-
*/
|
|
2845
|
-
quantity?: number;
|
|
2846
|
-
}
|
|
2847
|
-
interface AdditionalFeeRefund {
|
|
2848
|
-
/**
|
|
2849
|
-
* Additional fee ID.
|
|
2850
|
-
* @format GUID
|
|
2851
|
-
* @immutable
|
|
2852
|
-
*/
|
|
2853
|
-
additionalFeeId?: string;
|
|
2854
|
-
/**
|
|
2855
|
-
* Refund amount.
|
|
2856
|
-
* @immutable
|
|
2857
|
-
*/
|
|
2858
|
-
amount?: Price;
|
|
2859
|
-
}
|
|
2860
|
-
interface ShippingRefund {
|
|
2861
|
-
/**
|
|
2862
|
-
* Refund amount.
|
|
2863
|
-
* @immutable
|
|
2864
|
-
*/
|
|
2865
|
-
amount?: Price;
|
|
2866
|
-
}
|
|
2867
|
-
interface RefundSideEffects {
|
|
2868
|
-
/** Inventory restock details as part of this refund. */
|
|
2869
|
-
restockInfo?: RestockInfo;
|
|
2870
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
2871
|
-
sendOrderRefundedEmail?: boolean;
|
|
2872
|
-
/**
|
|
2873
|
-
* Custom message added to the refund confirmation email.
|
|
2874
|
-
* @minLength 1
|
|
2875
|
-
* @maxLength 1000
|
|
2876
|
-
*/
|
|
2877
|
-
customMessage?: string | null;
|
|
2878
|
-
}
|
|
2879
|
-
interface RestockInfo {
|
|
2880
|
-
/** Restock type. */
|
|
2881
|
-
type?: RestockTypeWithLiterals;
|
|
2882
|
-
/**
|
|
2883
|
-
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2884
|
-
* @maxSize 300
|
|
2885
|
-
*/
|
|
2886
|
-
items?: RestockItem[];
|
|
2887
|
-
}
|
|
2888
|
-
declare enum RestockType {
|
|
2889
|
-
NO_ITEMS = "NO_ITEMS",
|
|
2890
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
2891
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
2892
|
-
}
|
|
2893
|
-
/** @enumType */
|
|
2894
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2895
|
-
interface RestockItem {
|
|
2896
|
-
/**
|
|
2897
|
-
* ID of the line item being restocked.
|
|
2898
|
-
* @format GUID
|
|
2899
|
-
*/
|
|
2900
|
-
lineItemId?: string;
|
|
2901
|
-
/**
|
|
2902
|
-
* Line item quantity being restocked.
|
|
2903
|
-
* @min 1
|
|
2904
|
-
* @max 100000
|
|
2905
|
-
*/
|
|
2906
|
-
quantity?: number;
|
|
2907
|
-
}
|
|
2908
|
-
interface TriggerRefundResponse {
|
|
2909
|
-
/** All order's transactions after the refunds were added */
|
|
2910
|
-
orderTransactions?: OrderTransactions;
|
|
2911
|
-
/** Created refund ID */
|
|
2912
|
-
refundId?: string | null;
|
|
2913
|
-
/** Payment ID's that the refund execution had failed for */
|
|
2914
|
-
failedPaymentIds?: ItemMetadata[];
|
|
2915
|
-
}
|
|
2916
|
-
interface OrderTransactions {
|
|
2917
|
-
/**
|
|
2918
|
-
* Order ID.
|
|
2919
|
-
* @format GUID
|
|
2920
|
-
*/
|
|
2921
|
-
orderId?: string;
|
|
2922
|
-
/**
|
|
2923
|
-
* Record of payments made to the merchant.
|
|
2924
|
-
* @maxSize 100
|
|
2925
|
-
*/
|
|
2926
|
-
payments?: Payment[];
|
|
2927
|
-
/**
|
|
2928
|
-
* Record of refunds made to the buyer.
|
|
2929
|
-
* @maxSize 300
|
|
2930
|
-
*/
|
|
2931
|
-
refunds?: Refund[];
|
|
2932
|
-
}
|
|
2933
|
-
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2934
|
-
/** Regular payment details. */
|
|
2935
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2936
|
-
/** Gift card payment details. */
|
|
2937
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2938
|
-
/**
|
|
2939
|
-
* Payment ID.
|
|
2940
|
-
* @format GUID
|
|
2941
|
-
* @readonly
|
|
2942
|
-
*/
|
|
2943
|
-
_id?: string | null;
|
|
2944
|
-
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
2945
|
-
_createdDate?: Date | null;
|
|
2946
|
-
/**
|
|
2947
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2948
|
-
* @readonly
|
|
2949
|
-
*/
|
|
2950
|
-
_updatedDate?: Date | null;
|
|
2951
|
-
/** Payment amount. */
|
|
2952
|
-
amount?: Price;
|
|
2953
|
-
/**
|
|
2954
|
-
* Whether refunds for this payment are disabled.
|
|
2955
|
-
* + `true`: This payment is not refundable.
|
|
2956
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2957
|
-
*/
|
|
2958
|
-
refundDisabled?: boolean;
|
|
2959
|
-
}
|
|
2960
|
-
/** @oneof */
|
|
2961
|
-
interface PaymentPaymentDetailsOneOf {
|
|
2962
|
-
/** Regular payment details. */
|
|
2963
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2964
|
-
/** Gift card payment details. */
|
|
2965
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2966
|
-
}
|
|
2967
|
-
/** @oneof */
|
|
2968
|
-
interface PaymentReceiptInfoOneOf {
|
|
2969
|
-
}
|
|
2970
|
-
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2971
|
-
/** Whether regular card used */
|
|
2972
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2973
|
-
/**
|
|
2974
|
-
* Wix Payments order ID.
|
|
2975
|
-
* @maxLength 100
|
|
2976
|
-
*/
|
|
2977
|
-
paymentOrderId?: string | null;
|
|
2978
|
-
/**
|
|
2979
|
-
* Payment gateway's transaction ID.
|
|
2980
|
-
* This field is only returned when the value of `offline_payment` is `false`.
|
|
2981
|
-
* @maxLength 100
|
|
2982
|
-
*/
|
|
2983
|
-
gatewayTransactionId?: string | null;
|
|
2984
|
-
/**
|
|
2985
|
-
* Payment method. Non-exhaustive list of supported values:
|
|
2986
|
-
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
2987
|
-
* @maxLength 100
|
|
2988
|
-
*/
|
|
2989
|
-
paymentMethod?: string | null;
|
|
2990
|
-
/**
|
|
2991
|
-
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
2992
|
-
* @maxLength 100
|
|
2993
|
-
*/
|
|
2994
|
-
providerTransactionId?: string | null;
|
|
2995
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
2996
|
-
offlinePayment?: boolean;
|
|
2997
|
-
/** Payment status. */
|
|
2998
|
-
status?: TransactionStatusWithLiterals;
|
|
2999
|
-
/**
|
|
3000
|
-
* Whether there is a payment agreement that allows for future charges.
|
|
3001
|
-
* @immutable
|
|
3002
|
-
*/
|
|
3003
|
-
savedPaymentMethod?: boolean;
|
|
3004
|
-
/** Authorization details. */
|
|
3005
|
-
authorizationDetails?: AuthorizationDetails;
|
|
3006
|
-
}
|
|
3007
|
-
/** @oneof */
|
|
3008
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3009
|
-
/** Whether regular card used */
|
|
3010
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3011
|
-
}
|
|
3012
|
-
declare enum TransactionStatus {
|
|
3013
|
-
UNDEFINED = "UNDEFINED",
|
|
3014
|
-
APPROVED = "APPROVED",
|
|
3015
|
-
PENDING = "PENDING",
|
|
3016
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3017
|
-
CANCELED = "CANCELED",
|
|
3018
|
-
DECLINED = "DECLINED",
|
|
3019
|
-
REFUNDED = "REFUNDED",
|
|
3020
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3021
|
-
AUTHORIZED = "AUTHORIZED",
|
|
3022
|
-
VOIDED = "VOIDED"
|
|
3023
|
-
}
|
|
3024
|
-
/** @enumType */
|
|
3025
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3026
|
-
interface CreditCardPaymentMethodDetails {
|
|
3027
|
-
/**
|
|
3028
|
-
* The last 4 digits of the card number.
|
|
3029
|
-
* @maxLength 4
|
|
3030
|
-
*/
|
|
3031
|
-
lastFourDigits?: string | null;
|
|
3032
|
-
/**
|
|
3033
|
-
* Card issuer's brand.
|
|
3034
|
-
* @maxLength 100
|
|
3035
|
-
*/
|
|
3036
|
-
brand?: string | null;
|
|
3037
|
-
}
|
|
3038
|
-
interface AuthorizationDetails {
|
|
3039
|
-
/**
|
|
3040
|
-
* Whether the authorized payment is of a delayed capture.
|
|
3041
|
-
* @readonly
|
|
3042
|
-
*/
|
|
3043
|
-
delayedCapture?: boolean;
|
|
3044
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3045
|
-
authorizedDate?: Date | null;
|
|
3046
|
-
/**
|
|
3047
|
-
* List of captures associated with payment
|
|
3048
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3049
|
-
* @maxSize 1
|
|
3050
|
-
*/
|
|
3051
|
-
captures?: AuthorizationCapture[];
|
|
3052
|
-
/** Void associated with payment */
|
|
3053
|
-
void?: AuthorizationVoid;
|
|
3054
|
-
/** Scheduled action for this transaction */
|
|
3055
|
-
scheduledAction?: V1ScheduledAction;
|
|
3056
|
-
}
|
|
3057
|
-
interface AuthorizationCapture {
|
|
3058
|
-
/**
|
|
3059
|
-
* Capture ID.
|
|
3060
|
-
* @format GUID
|
|
3061
|
-
* @readonly
|
|
3062
|
-
*/
|
|
3063
|
-
_id?: string | null;
|
|
3064
|
-
/** Status of this capture action */
|
|
3065
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3066
|
-
/**
|
|
3067
|
-
* Amount of this capture
|
|
3068
|
-
* @immutable
|
|
3069
|
-
*/
|
|
3070
|
-
amount?: Price;
|
|
3071
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3072
|
-
_createdDate?: Date | null;
|
|
3073
|
-
/** In case of status is FAILED may contain failure details */
|
|
3074
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3075
|
-
}
|
|
3076
|
-
declare enum AuthorizationCaptureStatus {
|
|
3077
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3078
|
-
/** Capture operation still in progress. */
|
|
3079
|
-
PENDING = "PENDING",
|
|
3080
|
-
/** Capture operation succeeded. */
|
|
3081
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3082
|
-
/** Capture operation failed. */
|
|
3083
|
-
FAILED = "FAILED"
|
|
3084
|
-
}
|
|
3085
|
-
/** @enumType */
|
|
3086
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3087
|
-
interface AuthorizationActionFailureDetails {
|
|
3088
|
-
/** @maxLength 100 */
|
|
3089
|
-
failureCode?: string;
|
|
3090
|
-
}
|
|
3091
|
-
interface AuthorizationVoid {
|
|
3092
|
-
/** Status of this void action */
|
|
3093
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
3094
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3095
|
-
voidedDate?: Date | null;
|
|
3096
|
-
/** In case of status is FAILED may contain failure details */
|
|
3097
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3098
|
-
/** Reason of void action */
|
|
3099
|
-
reason?: ReasonWithLiterals;
|
|
3100
|
-
}
|
|
3101
|
-
declare enum AuthorizationVoidStatus {
|
|
3102
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3103
|
-
/** Void operation still in progress. */
|
|
3104
|
-
PENDING = "PENDING",
|
|
3105
|
-
/** Void operation succeeded. */
|
|
3106
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3107
|
-
/** Void operation failed. */
|
|
3108
|
-
FAILED = "FAILED"
|
|
3109
|
-
}
|
|
3110
|
-
/** @enumType */
|
|
3111
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3112
|
-
/** Reason the authorization was voided. */
|
|
3113
|
-
declare enum Reason {
|
|
3114
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3115
|
-
/** Authorization was voided by user. */
|
|
3116
|
-
MANUAL = "MANUAL",
|
|
3117
|
-
/** Authorization passed execution date. */
|
|
3118
|
-
SCHEDULED = "SCHEDULED"
|
|
3119
|
-
}
|
|
3120
|
-
/** @enumType */
|
|
3121
|
-
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3122
|
-
interface V1ScheduledAction {
|
|
3123
|
-
/** Type of the action. */
|
|
3124
|
-
actionType?: ActionTypeWithLiterals;
|
|
3125
|
-
/** The date and time of the action. */
|
|
3126
|
-
executionDate?: Date | null;
|
|
3127
|
-
}
|
|
3128
|
-
declare enum ActionType {
|
|
3129
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3130
|
-
VOID = "VOID",
|
|
3131
|
-
CAPTURE = "CAPTURE"
|
|
3132
|
-
}
|
|
3133
|
-
/** @enumType */
|
|
3134
|
-
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3135
|
-
interface Chargeback {
|
|
3136
|
-
/**
|
|
3137
|
-
* Chargeback ID.
|
|
3138
|
-
* @format GUID
|
|
3139
|
-
* @readonly
|
|
3140
|
-
* @immutable
|
|
3141
|
-
*/
|
|
3142
|
-
_id?: string;
|
|
3143
|
-
/**
|
|
3144
|
-
* 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.
|
|
3145
|
-
* @readonly
|
|
3146
|
-
* @immutable
|
|
3147
|
-
*/
|
|
3148
|
-
_createdDate?: Date | null;
|
|
3149
|
-
/**
|
|
3150
|
-
* 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.
|
|
3151
|
-
* @readonly
|
|
3152
|
-
*/
|
|
3153
|
-
_updatedDate?: Date | null;
|
|
3154
|
-
/**
|
|
3155
|
-
* Amount.
|
|
3156
|
-
* @readonly
|
|
3157
|
-
* @immutable
|
|
3158
|
-
*/
|
|
3159
|
-
amount?: Price;
|
|
3160
|
-
/**
|
|
3161
|
-
* Reversal amount. Present only when status is REVERSED.
|
|
3162
|
-
* @readonly
|
|
3163
|
-
*/
|
|
3164
|
-
reversalAmount?: Price;
|
|
3165
|
-
/**
|
|
3166
|
-
* Status.
|
|
3167
|
-
*
|
|
3168
|
-
* Default: `"APPROVED"`.
|
|
3169
|
-
*/
|
|
3170
|
-
status?: ChargebackStatusWithLiterals;
|
|
3171
|
-
/**
|
|
3172
|
-
* External chargeback ID.
|
|
3173
|
-
* @format GUID
|
|
3174
|
-
* @readonly
|
|
3175
|
-
* @immutable
|
|
3176
|
-
*/
|
|
3177
|
-
externalId?: string | null;
|
|
3178
|
-
}
|
|
3179
|
-
declare enum ChargebackStatus {
|
|
3180
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
3181
|
-
/** Chargeback was approved. */
|
|
3182
|
-
APPROVED = "APPROVED",
|
|
3183
|
-
/** Chargeback was reversed. */
|
|
3184
|
-
REVERSED = "REVERSED"
|
|
3185
|
-
}
|
|
3186
|
-
/** @enumType */
|
|
3187
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3188
|
-
interface GiftCardPaymentDetails {
|
|
3189
|
-
/**
|
|
3190
|
-
* Gift card payment ID.
|
|
3191
|
-
* @minLength 1
|
|
3192
|
-
* @maxLength 100
|
|
3193
|
-
*/
|
|
3194
|
-
giftCardPaymentId?: string;
|
|
3195
|
-
/**
|
|
3196
|
-
* ID of the app that created the gift card.
|
|
3197
|
-
* @format GUID
|
|
3198
|
-
*/
|
|
3199
|
-
appId?: string;
|
|
3200
|
-
/**
|
|
3201
|
-
* Whether the gift card is voided.
|
|
3202
|
-
* @readonly
|
|
3203
|
-
*/
|
|
3204
|
-
voided?: boolean;
|
|
3205
|
-
}
|
|
3206
|
-
interface MembershipPaymentDetails {
|
|
3207
|
-
/**
|
|
3208
|
-
* Membership ID.
|
|
3209
|
-
* @minLength 1
|
|
3210
|
-
* @maxLength 100
|
|
3211
|
-
*/
|
|
3212
|
-
membershipId?: string;
|
|
3213
|
-
/**
|
|
3214
|
-
* ID of the line item this membership applies to.
|
|
3215
|
-
* @minLength 1
|
|
3216
|
-
* @maxLength 100
|
|
3217
|
-
*/
|
|
3218
|
-
lineItemId?: string;
|
|
3219
|
-
/** Payment status. */
|
|
3220
|
-
status?: MembershipPaymentStatusWithLiterals;
|
|
3221
|
-
/** Membership name. */
|
|
3222
|
-
name?: MembershipName;
|
|
3223
|
-
/**
|
|
3224
|
-
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3225
|
-
* @minLength 1
|
|
3226
|
-
* @maxLength 100
|
|
3227
|
-
*/
|
|
3228
|
-
externalTransactionId?: string | null;
|
|
3229
|
-
/**
|
|
3230
|
-
* Whether the membership is voided.
|
|
3231
|
-
* @readonly
|
|
3232
|
-
*/
|
|
3233
|
-
voided?: boolean;
|
|
3234
|
-
/**
|
|
3235
|
-
* ID of the application providing this payment option.
|
|
3236
|
-
* @format GUID
|
|
3237
|
-
*/
|
|
3238
|
-
providerAppId?: string;
|
|
3239
|
-
}
|
|
3240
|
-
declare enum MembershipPaymentStatus {
|
|
3241
|
-
/** Payment was charged. */
|
|
3242
|
-
CHARGED = "CHARGED",
|
|
3243
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3244
|
-
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3245
|
-
}
|
|
3246
|
-
/** @enumType */
|
|
3247
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3248
|
-
interface WixReceiptInfo {
|
|
3249
|
-
/**
|
|
3250
|
-
* Receipt ID
|
|
3251
|
-
* @format GUID
|
|
3252
|
-
*/
|
|
3253
|
-
receiptId?: string;
|
|
3254
|
-
/**
|
|
3255
|
-
* Display number of receipt
|
|
3256
|
-
* @minLength 1
|
|
3257
|
-
* @maxLength 40
|
|
3258
|
-
*/
|
|
3259
|
-
displayNumber?: string | null;
|
|
3260
|
-
}
|
|
3261
|
-
interface ExternalReceiptInfo {
|
|
3262
|
-
/**
|
|
3263
|
-
* External receipt ID
|
|
3264
|
-
* @maxLength 100
|
|
3265
|
-
*/
|
|
3266
|
-
receiptId?: string | null;
|
|
3267
|
-
/**
|
|
3268
|
-
* ID of the app providing the receipt
|
|
3269
|
-
* @format GUID
|
|
3270
|
-
*/
|
|
3271
|
-
appId?: string | null;
|
|
3272
|
-
/**
|
|
3273
|
-
* Display number of receipt
|
|
3274
|
-
* @minLength 1
|
|
3275
|
-
* @maxLength 40
|
|
3276
|
-
*/
|
|
3277
|
-
displayNumber?: string | null;
|
|
3278
|
-
}
|
|
3279
|
-
interface Refund {
|
|
3280
|
-
/**
|
|
3281
|
-
* Refund ID.
|
|
3282
|
-
* @format GUID
|
|
3283
|
-
* @readonly
|
|
3284
|
-
*/
|
|
3285
|
-
_id?: string;
|
|
3286
|
-
/**
|
|
3287
|
-
* List of transactions.
|
|
3288
|
-
* @maxSize 50
|
|
3289
|
-
*/
|
|
3290
|
-
transactions?: RefundTransaction[];
|
|
3291
|
-
/** Refund business details. */
|
|
3292
|
-
details?: RefundDetails;
|
|
3293
|
-
/**
|
|
3294
|
-
* Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
3295
|
-
* @readonly
|
|
3296
|
-
* @immutable
|
|
3297
|
-
*/
|
|
3298
|
-
_createdDate?: Date | null;
|
|
3299
|
-
/**
|
|
3300
|
-
* Aggregated refund summary.
|
|
3301
|
-
* @readonly
|
|
3302
|
-
*/
|
|
3303
|
-
summary?: AggregatedRefundSummary;
|
|
3304
|
-
/**
|
|
3305
|
-
* ID of the app that initiated this refund.
|
|
3306
|
-
* @format GUID
|
|
3307
|
-
* @readonly
|
|
3308
|
-
* @immutable
|
|
3309
|
-
*/
|
|
3310
|
-
requestingServiceAppId?: string | null;
|
|
3311
|
-
}
|
|
3312
|
-
interface RefundTransaction {
|
|
3313
|
-
/**
|
|
3314
|
-
* ID of the payment associated with this refund.
|
|
3315
|
-
* @format GUID
|
|
3316
|
-
* @immutable
|
|
3317
|
-
*/
|
|
3318
|
-
paymentId?: string;
|
|
3319
|
-
/**
|
|
3320
|
-
* Refund amount.
|
|
3321
|
-
* @immutable
|
|
3322
|
-
*/
|
|
3323
|
-
amount?: Price;
|
|
3324
|
-
/** Refund status. */
|
|
3325
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
3326
|
-
/** Optional details of current refund status. */
|
|
3327
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
3328
|
-
/**
|
|
3329
|
-
* Payment gateway's refund ID.
|
|
3330
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
3331
|
-
* @format GUID
|
|
3332
|
-
*/
|
|
3333
|
-
gatewayRefundId?: string | null;
|
|
3334
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3335
|
-
providerRefundId?: string | null;
|
|
3336
|
-
/**
|
|
3337
|
-
* Whether refund was made externally and manually on the payment provider's side.
|
|
3338
|
-
* @immutable
|
|
3339
|
-
*/
|
|
3340
|
-
externalRefund?: boolean;
|
|
3341
|
-
}
|
|
3342
|
-
/** Refund transaction status. */
|
|
3343
|
-
declare enum RefundStatus {
|
|
3344
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3345
|
-
PENDING = "PENDING",
|
|
3346
|
-
/** Refund transaction succeeded. */
|
|
3347
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3348
|
-
/** Refund transaction failed. */
|
|
3349
|
-
FAILED = "FAILED",
|
|
3350
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
3351
|
-
SCHEDULED = "SCHEDULED",
|
|
3352
|
-
/** Refund was initiated on payment provider side. */
|
|
3353
|
-
STARTED = "STARTED"
|
|
3354
|
-
}
|
|
3355
|
-
/** @enumType */
|
|
3356
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3357
|
-
interface RefundStatusInfo {
|
|
3358
|
-
/**
|
|
3359
|
-
* Reason code for the refund's current status.
|
|
3360
|
-
*
|
|
3361
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3362
|
-
* @minLength 1
|
|
3363
|
-
* @maxLength 10
|
|
3364
|
-
*/
|
|
3365
|
-
paymentGatewayReasonCode?: string | null;
|
|
3366
|
-
/**
|
|
3367
|
-
* Free text explanation of current refund status.
|
|
3368
|
-
* @minLength 1
|
|
3369
|
-
* @maxLength 1000
|
|
3370
|
-
*/
|
|
3371
|
-
description?: string | null;
|
|
3372
|
-
}
|
|
3373
|
-
interface AggregatedRefundSummary {
|
|
3374
|
-
/** Total amount requested for refund. */
|
|
3375
|
-
requestedRefund?: Price;
|
|
3376
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3377
|
-
pendingRefund?: Price;
|
|
3378
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3379
|
-
refunded?: Price;
|
|
3380
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3381
|
-
failedRefundAmount?: Price;
|
|
3382
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
3383
|
-
pending?: boolean;
|
|
3384
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3385
|
-
breakdown?: RefundItemsBreakdown;
|
|
3386
|
-
}
|
|
3387
|
-
interface RefundItemsBreakdown {
|
|
3388
|
-
/**
|
|
3389
|
-
* Refunded line items and the amount refunded for each.
|
|
3390
|
-
* @maxSize 300
|
|
3391
|
-
*/
|
|
3392
|
-
lineItems?: LineItemRefundSummary[];
|
|
3393
|
-
}
|
|
3394
|
-
interface LineItemRefundSummary {
|
|
3395
|
-
/**
|
|
3396
|
-
* ID of the refunded line item.
|
|
3397
|
-
* @format GUID
|
|
3398
|
-
*/
|
|
3399
|
-
lineItemId?: string;
|
|
3400
|
-
/** Total refunded amount for the line item. */
|
|
3401
|
-
totalRefundedAmount?: Price;
|
|
3402
|
-
}
|
|
3403
|
-
interface CalculateRefundRequest {
|
|
3404
|
-
/**
|
|
3405
|
-
* Order ID
|
|
3406
|
-
* @minLength 1
|
|
3407
|
-
* @maxLength 100
|
|
3408
|
-
*/
|
|
3409
|
-
ecomOrderId?: string;
|
|
3410
|
-
/**
|
|
3411
|
-
* Refunded line items and quantity
|
|
3412
|
-
* @maxSize 300
|
|
3413
|
-
*/
|
|
3414
|
-
refundItems?: CalculateRefundItemRequest[];
|
|
3415
|
-
/** Should include shipping in refund calculation */
|
|
3416
|
-
refundShipping?: boolean;
|
|
3417
|
-
}
|
|
3418
|
-
interface CalculateRefundItemRequest {
|
|
3419
|
-
/**
|
|
3420
|
-
* ID of the line item being refunded
|
|
3421
|
-
* @format GUID
|
|
3422
|
-
*/
|
|
3423
|
-
_id?: string;
|
|
3424
|
-
/**
|
|
3425
|
-
* How much of that line item is being refunded
|
|
3426
|
-
* @min 1
|
|
3427
|
-
* @max 100000
|
|
3428
|
-
*/
|
|
3429
|
-
quantity?: number;
|
|
3430
|
-
}
|
|
3431
|
-
interface CalculateRefundResponse {
|
|
3432
|
-
/** Total refundable amount */
|
|
3433
|
-
total?: Price;
|
|
3434
|
-
/** Tax cost of the order */
|
|
3435
|
-
tax?: Price;
|
|
3436
|
-
/** Discount given for this order */
|
|
3437
|
-
discount?: Price;
|
|
3438
|
-
/** Total cost of the order (without tax) */
|
|
3439
|
-
subtotal?: Price;
|
|
3440
|
-
/** Total shipping cost for order */
|
|
3441
|
-
shipping?: Price;
|
|
3442
|
-
/** Previous refund given on that order */
|
|
3443
|
-
previouslyRefundedAmount?: Price;
|
|
3444
|
-
/**
|
|
3445
|
-
* The refundable items of that order
|
|
3446
|
-
* @maxSize 300
|
|
3447
|
-
*/
|
|
3448
|
-
items?: CalculateRefundItemResponse[];
|
|
3449
|
-
}
|
|
3450
|
-
interface CalculateRefundItemResponse {
|
|
3451
|
-
/**
|
|
3452
|
-
* Line item ID
|
|
3453
|
-
* @format GUID
|
|
3454
|
-
*/
|
|
3455
|
-
_id?: string;
|
|
3456
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3457
|
-
price?: Price;
|
|
3458
|
-
}
|
|
3459
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
3460
|
-
/**
|
|
3461
|
-
* Wix eCommerce order ID
|
|
3462
|
-
* @minLength 1
|
|
3463
|
-
* @maxLength 100
|
|
3464
|
-
*/
|
|
3465
|
-
ecomOrderId: string;
|
|
3466
|
-
/**
|
|
3467
|
-
* Payment IDs
|
|
3468
|
-
* @minSize 1
|
|
3469
|
-
* @maxSize 100
|
|
3470
|
-
* @format GUID
|
|
3471
|
-
*/
|
|
3472
|
-
paymentIds: string[];
|
|
3473
|
-
}
|
|
3474
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
3475
|
-
/** All order's transactions after the void was triggered */
|
|
3476
|
-
orderTransactions?: OrderTransactions;
|
|
3477
|
-
}
|
|
3478
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
3479
|
-
/**
|
|
3480
|
-
* Wix eCommerce order ID
|
|
3481
|
-
* @minLength 1
|
|
3482
|
-
* @maxLength 100
|
|
3483
|
-
*/
|
|
3484
|
-
ecomOrderId: string;
|
|
3485
|
-
/**
|
|
3486
|
-
* Capture payments information
|
|
3487
|
-
* @minSize 1
|
|
3488
|
-
* @maxSize 100
|
|
3489
|
-
*/
|
|
3490
|
-
payments: PaymentCapture[];
|
|
3491
|
-
}
|
|
3492
|
-
interface PaymentCapture {
|
|
3493
|
-
/**
|
|
3494
|
-
* Payment ID
|
|
3495
|
-
* @format GUID
|
|
3496
|
-
*/
|
|
3497
|
-
paymentId?: string | null;
|
|
3498
|
-
/**
|
|
3499
|
-
* Capture amount.
|
|
3500
|
-
* If not provided - full authorized amount will be captured.
|
|
3501
|
-
*/
|
|
3502
|
-
amount?: Price;
|
|
3503
|
-
}
|
|
3504
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
3505
|
-
/** All order's transactions after the capture was triggered */
|
|
3506
|
-
orderTransactions?: OrderTransactions;
|
|
3507
|
-
}
|
|
3508
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
3509
|
-
/**
|
|
3510
|
-
* Ecom Order ID.
|
|
3511
|
-
* @minLength 1
|
|
3512
|
-
* @maxLength 100
|
|
3513
|
-
*/
|
|
3514
|
-
ecomOrderId?: string;
|
|
3515
|
-
/** Amount to be charged */
|
|
3516
|
-
amount?: Price;
|
|
3517
|
-
}
|
|
3518
|
-
interface ChargeSavedPaymentMethodResponse {
|
|
3519
|
-
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3520
|
-
paymentGatewayOrderId?: string;
|
|
3521
|
-
}
|
|
3522
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3523
|
-
createdEvent?: EntityCreatedEvent;
|
|
3524
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3525
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3526
|
-
actionEvent?: ActionEvent;
|
|
3527
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3528
|
-
_id?: string;
|
|
3529
|
-
/**
|
|
3530
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3531
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3532
|
-
*/
|
|
3533
|
-
entityFqdn?: string;
|
|
3534
|
-
/**
|
|
3535
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3536
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3537
|
-
*/
|
|
3538
|
-
slug?: string;
|
|
3539
|
-
/** ID of the entity associated with the event. */
|
|
3540
|
-
entityId?: string;
|
|
3541
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3542
|
-
eventTime?: Date | null;
|
|
3543
|
-
/**
|
|
3544
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3545
|
-
* (for example, GDPR).
|
|
3546
|
-
*/
|
|
3547
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3548
|
-
/** If present, indicates the action that triggered the event. */
|
|
3549
|
-
originatedFrom?: string | null;
|
|
3550
|
-
/**
|
|
3551
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3552
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3553
|
-
*/
|
|
3554
|
-
entityEventSequence?: string | null;
|
|
3555
|
-
}
|
|
3556
|
-
/** @oneof */
|
|
3557
|
-
interface DomainEventBodyOneOf {
|
|
3558
|
-
createdEvent?: EntityCreatedEvent;
|
|
3559
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3560
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3561
|
-
actionEvent?: ActionEvent;
|
|
3562
|
-
}
|
|
3563
|
-
interface EntityCreatedEvent {
|
|
3564
|
-
entity?: string;
|
|
3565
|
-
}
|
|
3566
|
-
interface RestoreInfo {
|
|
3567
|
-
deletedDate?: Date | null;
|
|
3568
|
-
}
|
|
3569
|
-
interface EntityUpdatedEvent {
|
|
3570
|
-
/**
|
|
3571
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3572
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3573
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3574
|
-
*/
|
|
3575
|
-
currentEntity?: string;
|
|
3576
|
-
}
|
|
3577
|
-
interface EntityDeletedEvent {
|
|
3578
|
-
/** Entity that was deleted. */
|
|
3579
|
-
deletedEntity?: string | null;
|
|
3580
|
-
}
|
|
3581
|
-
interface ActionEvent {
|
|
3582
|
-
body?: string;
|
|
3583
|
-
}
|
|
3584
|
-
interface Empty {
|
|
3585
|
-
}
|
|
3586
|
-
interface MessageEnvelope {
|
|
3587
|
-
/**
|
|
3588
|
-
* App instance ID.
|
|
3589
|
-
* @format GUID
|
|
3590
|
-
*/
|
|
3591
|
-
instanceId?: string | null;
|
|
3592
|
-
/**
|
|
3593
|
-
* Event type.
|
|
3594
|
-
* @maxLength 150
|
|
3595
|
-
*/
|
|
3596
|
-
eventType?: string;
|
|
3597
|
-
/** The identification type and identity data. */
|
|
3598
|
-
identity?: IdentificationData;
|
|
3599
|
-
/** Stringify payload. */
|
|
3600
|
-
data?: string;
|
|
3601
|
-
}
|
|
3602
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3603
|
-
/**
|
|
3604
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3605
|
-
* @format GUID
|
|
3606
|
-
*/
|
|
3607
|
-
anonymousVisitorId?: string;
|
|
3608
|
-
/**
|
|
3609
|
-
* ID of a site visitor that has logged in to the site.
|
|
3610
|
-
* @format GUID
|
|
3611
|
-
*/
|
|
3612
|
-
memberId?: string;
|
|
3613
|
-
/**
|
|
3614
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3615
|
-
* @format GUID
|
|
3616
|
-
*/
|
|
3617
|
-
wixUserId?: string;
|
|
3618
|
-
/**
|
|
3619
|
-
* ID of an app.
|
|
3620
|
-
* @format GUID
|
|
3621
|
-
*/
|
|
3622
|
-
appId?: string;
|
|
3623
|
-
/** @readonly */
|
|
3624
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3625
|
-
}
|
|
3626
|
-
/** @oneof */
|
|
3627
|
-
interface IdentificationDataIdOneOf {
|
|
3628
|
-
/**
|
|
3629
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3630
|
-
* @format GUID
|
|
3631
|
-
*/
|
|
3632
|
-
anonymousVisitorId?: string;
|
|
3633
|
-
/**
|
|
3634
|
-
* ID of a site visitor that has logged in to the site.
|
|
3635
|
-
* @format GUID
|
|
3636
|
-
*/
|
|
3637
|
-
memberId?: string;
|
|
3638
|
-
/**
|
|
3639
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3640
|
-
* @format GUID
|
|
3641
|
-
*/
|
|
3642
|
-
wixUserId?: string;
|
|
3643
|
-
/**
|
|
3644
|
-
* ID of an app.
|
|
3645
|
-
* @format GUID
|
|
3646
|
-
*/
|
|
3647
|
-
appId?: string;
|
|
3648
|
-
}
|
|
3649
|
-
declare enum WebhookIdentityType {
|
|
3650
|
-
UNKNOWN = "UNKNOWN",
|
|
3651
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3652
|
-
MEMBER = "MEMBER",
|
|
3653
|
-
WIX_USER = "WIX_USER",
|
|
3654
|
-
APP = "APP"
|
|
3655
|
-
}
|
|
3656
|
-
/** @enumType */
|
|
3657
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3658
|
-
declare enum TextDetection {
|
|
3659
|
-
/** No detection was made */
|
|
3660
|
-
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
3661
|
-
/** The image contains text */
|
|
3662
|
-
CONTAINS_TEXT = "CONTAINS_TEXT",
|
|
3663
|
-
/** The image does not contain text */
|
|
3664
|
-
NO_TEXT = "NO_TEXT"
|
|
3665
|
-
}
|
|
3666
|
-
/** @enumType */
|
|
3667
|
-
type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
|
|
3668
|
-
declare enum AnimationDetection {
|
|
3669
|
-
/** No detection was made */
|
|
3670
|
-
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
3671
|
-
/** The image contains animation */
|
|
3672
|
-
CONTAINS_ANIMATION = "CONTAINS_ANIMATION",
|
|
3673
|
-
/** The image does not contain animation */
|
|
3674
|
-
NO_ANIMATION = "NO_ANIMATION"
|
|
3675
|
-
}
|
|
3676
|
-
/** @enumType */
|
|
3677
|
-
type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
|
|
3678
|
-
interface ImageContent {
|
|
3679
|
-
/** Text detection */
|
|
3680
|
-
text?: TextDetectionWithLiterals;
|
|
3681
|
-
/** Animation detection */
|
|
3682
|
-
animation?: AnimationDetectionWithLiterals;
|
|
3683
|
-
}
|
|
3684
|
-
interface SendBuyerConfirmationEmailRequest {
|
|
3685
|
-
/** @format GUID */
|
|
3686
|
-
orderId?: string;
|
|
3687
|
-
}
|
|
3688
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
3689
|
-
}
|
|
3690
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3691
|
-
/**
|
|
3692
|
-
* @minLength 1
|
|
3693
|
-
* @maxLength 100
|
|
3694
|
-
*/
|
|
3695
|
-
orderId?: string;
|
|
3696
|
-
}
|
|
3697
|
-
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3698
|
-
}
|
|
3699
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3700
|
-
/**
|
|
3701
|
-
* @minLength 1
|
|
3702
|
-
* @maxLength 100
|
|
3703
|
-
*/
|
|
3704
|
-
orderId?: string;
|
|
3705
|
-
}
|
|
3706
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3707
|
-
}
|
|
3708
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3709
|
-
/**
|
|
3710
|
-
* IDs of orders to send pickup emails for.
|
|
3711
|
-
* @minSize 1
|
|
3712
|
-
* @maxSize 300
|
|
3713
|
-
*/
|
|
3714
|
-
orderIds?: string[];
|
|
3715
|
-
}
|
|
3716
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3717
|
-
}
|
|
3718
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3719
|
-
/**
|
|
3720
|
-
* @minLength 1
|
|
3721
|
-
* @maxLength 100
|
|
3722
|
-
*/
|
|
3723
|
-
orderId?: string;
|
|
3724
|
-
}
|
|
3725
|
-
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3726
|
-
}
|
|
3727
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3728
|
-
/**
|
|
3729
|
-
* IDs of orders to send pickup emails for.
|
|
3730
|
-
* @minSize 1
|
|
3731
|
-
* @maxSize 300
|
|
3732
|
-
*/
|
|
3733
|
-
orderIds?: string[];
|
|
3734
|
-
}
|
|
3735
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3736
|
-
}
|
|
3737
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3738
|
-
/**
|
|
3739
|
-
* @minLength 1
|
|
3740
|
-
* @maxLength 100
|
|
3741
|
-
*/
|
|
3742
|
-
orderId?: string;
|
|
3743
|
-
}
|
|
3744
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3745
|
-
}
|
|
3746
|
-
interface SendCancelRefundEmailRequest {
|
|
3747
|
-
/**
|
|
3748
|
-
* The ID of order that is canceled/refunded
|
|
3749
|
-
* @minLength 1
|
|
3750
|
-
* @maxLength 100
|
|
3751
|
-
*/
|
|
3752
|
-
orderId?: string;
|
|
3753
|
-
/**
|
|
3754
|
-
* Personal note added to the email (optional)
|
|
3755
|
-
* @minLength 1
|
|
3756
|
-
* @maxLength 1000
|
|
3757
|
-
*/
|
|
3758
|
-
customMessage?: string | null;
|
|
3759
|
-
/** Refund amount */
|
|
3760
|
-
refundAmount?: Price;
|
|
3761
|
-
/**
|
|
3762
|
-
* Refund ID. (Optional)
|
|
3763
|
-
* @format GUID
|
|
3764
|
-
*/
|
|
3765
|
-
refundId?: string | null;
|
|
3766
|
-
}
|
|
3767
|
-
interface SendCancelRefundEmailResponse {
|
|
3768
|
-
}
|
|
3769
|
-
interface SendRefundEmailRequest {
|
|
3770
|
-
/**
|
|
3771
|
-
* The ID of order that is refunded
|
|
3772
|
-
* @format GUID
|
|
3773
|
-
*/
|
|
3774
|
-
orderId?: string;
|
|
3775
|
-
/**
|
|
3776
|
-
* Refund ID
|
|
3777
|
-
* @format GUID
|
|
3778
|
-
*/
|
|
3779
|
-
refundId?: string;
|
|
3780
|
-
/**
|
|
3781
|
-
* Personal note added to the email (optional)
|
|
3782
|
-
* @minLength 1
|
|
3783
|
-
* @maxLength 1000
|
|
3784
|
-
*/
|
|
3785
|
-
customMessage?: string | null;
|
|
3786
|
-
}
|
|
3787
|
-
interface SendRefundEmailResponse {
|
|
3788
|
-
}
|
|
3789
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
3790
|
-
/**
|
|
3791
|
-
* @minLength 1
|
|
3792
|
-
* @maxLength 100
|
|
3793
|
-
*/
|
|
3794
|
-
orderId?: string;
|
|
3795
|
-
}
|
|
3796
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
3797
|
-
}
|
|
3798
|
-
interface PreviewEmailByTypeRequest {
|
|
3799
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
3800
|
-
}
|
|
3801
|
-
declare enum PreviewEmailType {
|
|
3802
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
3803
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3804
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3805
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3806
|
-
}
|
|
3807
|
-
/** @enumType */
|
|
3808
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3809
|
-
interface PreviewEmailByTypeResponse {
|
|
3810
|
-
emailPreview?: string;
|
|
3811
|
-
}
|
|
3812
|
-
interface PreviewRefundEmailRequest {
|
|
3813
|
-
/**
|
|
3814
|
-
* @minLength 1
|
|
3815
|
-
* @maxLength 100
|
|
3816
|
-
*/
|
|
3817
|
-
orderId?: string;
|
|
3818
|
-
/** Refund amount */
|
|
3819
|
-
refundAmount?: Price;
|
|
3820
|
-
/** Refund business details */
|
|
3821
|
-
details?: RefundDetails;
|
|
3822
|
-
/**
|
|
3823
|
-
* Personal note added to the email (optional)
|
|
3824
|
-
* @minLength 1
|
|
3825
|
-
* @maxLength 1000
|
|
3826
|
-
*/
|
|
3827
|
-
customMessage?: string | null;
|
|
3828
|
-
/**
|
|
3829
|
-
* Refund ID. (Optional)
|
|
3830
|
-
* @format GUID
|
|
3831
|
-
*/
|
|
3832
|
-
refundId?: string | null;
|
|
3833
|
-
}
|
|
3834
|
-
interface PreviewRefundEmailResponse {
|
|
3835
|
-
emailPreview?: string;
|
|
3836
|
-
}
|
|
3837
|
-
interface PreviewCancelEmailRequest {
|
|
3838
|
-
/**
|
|
3839
|
-
* @minLength 1
|
|
3840
|
-
* @maxLength 100
|
|
3841
|
-
*/
|
|
3842
|
-
orderId?: string;
|
|
3843
|
-
/**
|
|
3844
|
-
* Personal note added to the email (optional)
|
|
3845
|
-
* @minLength 1
|
|
3846
|
-
* @maxLength 1000
|
|
3847
|
-
*/
|
|
3848
|
-
customMessage?: string | null;
|
|
3849
|
-
}
|
|
3850
|
-
interface PreviewCancelEmailResponse {
|
|
3851
|
-
emailPreview?: string;
|
|
3852
|
-
}
|
|
3853
|
-
interface PreviewCancelRefundEmailRequest {
|
|
3854
|
-
/**
|
|
3855
|
-
* @minLength 1
|
|
3856
|
-
* @maxLength 100
|
|
3857
|
-
*/
|
|
3858
|
-
orderId?: string;
|
|
3859
|
-
/**
|
|
3860
|
-
* Personal note added to the email (optional)
|
|
3861
|
-
* @minLength 1
|
|
3862
|
-
* @maxLength 1000
|
|
3863
|
-
*/
|
|
3864
|
-
customMessage?: string | null;
|
|
3865
|
-
/** Refund amount */
|
|
3866
|
-
refundAmount?: Price;
|
|
3867
|
-
/**
|
|
3868
|
-
* Refund ID. (Optional)
|
|
3869
|
-
* @format GUID
|
|
3870
|
-
*/
|
|
3871
|
-
refundId?: string | null;
|
|
3872
|
-
}
|
|
3873
|
-
interface PreviewCancelRefundEmailResponse {
|
|
3874
|
-
emailPreview?: string;
|
|
3875
|
-
}
|
|
3876
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
3877
|
-
}
|
|
3878
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
3879
|
-
emailPreview?: string;
|
|
3880
|
-
}
|
|
3881
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
3882
|
-
}
|
|
3883
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
3884
|
-
emailPreview?: string;
|
|
3885
|
-
}
|
|
3886
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
3887
|
-
}
|
|
3888
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
3889
|
-
emailPreview?: string;
|
|
3890
|
-
}
|
|
3891
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
3892
|
-
}
|
|
3893
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
3894
|
-
emailPreview?: string;
|
|
3895
|
-
}
|
|
3896
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
3897
|
-
}
|
|
3898
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
3899
|
-
emailPreview?: string;
|
|
3900
|
-
}
|
|
3901
|
-
interface TriggerReindexOrderRequest {
|
|
3902
|
-
/** @format GUID */
|
|
3903
|
-
metasiteId?: string;
|
|
3904
|
-
/**
|
|
3905
|
-
* @minLength 1
|
|
3906
|
-
* @maxLength 100
|
|
3907
|
-
*/
|
|
3908
|
-
orderId?: string;
|
|
3909
|
-
}
|
|
3910
|
-
interface SnapshotMessage {
|
|
3911
|
-
_id?: string;
|
|
3912
|
-
opType?: number;
|
|
3913
|
-
}
|
|
3914
|
-
/** Triggered when the payment status of an order is updated */
|
|
3915
|
-
interface PaymentStatusUpdated {
|
|
3916
|
-
/** The order that was updated */
|
|
3917
|
-
order?: Order;
|
|
3918
|
-
/** The previous status (before the update) */
|
|
3919
|
-
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
3920
|
-
}
|
|
3921
|
-
interface GetMetasiteDataRequest {
|
|
3922
|
-
/**
|
|
3923
|
-
* meta site Id for data to retrieve
|
|
3924
|
-
* @format GUID
|
|
3925
|
-
*/
|
|
3926
|
-
metasiteId?: string;
|
|
3927
|
-
}
|
|
3928
|
-
interface GetMetasiteDataResponse {
|
|
3929
|
-
/** meta site data */
|
|
3930
|
-
metasite?: MetaSite;
|
|
3931
|
-
/** is metasite added to new SDL population via population manager */
|
|
3932
|
-
isInNewPopulation?: boolean;
|
|
3933
|
-
/** metasite url */
|
|
3934
|
-
metasiteUrl?: string;
|
|
3935
|
-
/** owner data */
|
|
3936
|
-
userDataResponse?: UserDataResponse;
|
|
3937
|
-
}
|
|
3938
|
-
/**
|
|
3939
|
-
* Represents Meta Site.
|
|
3940
|
-
*
|
|
3941
|
-
* Meta Site is a legacy concept, it aggregates data from several domains. Generally, it contains and manages
|
|
3942
|
-
* relations between different entities related to the site (or, as a new concept, to the container).
|
|
3943
|
-
*
|
|
3944
|
-
* We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
|
|
3945
|
-
*/
|
|
3946
|
-
interface MetaSite {
|
|
3947
|
-
/**
|
|
3948
|
-
* Identifier of meta site.
|
|
3949
|
-
* @format GUID
|
|
3950
|
-
* @readonly
|
|
3951
|
-
*/
|
|
3952
|
-
metaSiteId?: string;
|
|
3953
|
-
/**
|
|
3954
|
-
* Internal version of meta site. Monotonically increasing number.
|
|
3955
|
-
*
|
|
3956
|
-
* If passed within update request, it will be used for optimistic locking. In this case,
|
|
3957
|
-
* StaleStateException will be thrown if current version doesn't match.
|
|
3958
|
-
*
|
|
3959
|
-
* In old MetaSiteDTO -- revision.
|
|
3960
|
-
* @readonly
|
|
3961
|
-
*/
|
|
3962
|
-
version?: string;
|
|
3963
|
-
/**
|
|
3964
|
-
* Identifier of account that owns this meta site.
|
|
3965
|
-
* @readonly
|
|
3966
|
-
*/
|
|
3967
|
-
ownerId?: string;
|
|
3968
|
-
/**
|
|
3969
|
-
* Date and time when meta site was created.
|
|
3970
|
-
* @readonly
|
|
3971
|
-
*/
|
|
3972
|
-
dateCreated?: Date | null;
|
|
3973
|
-
/**
|
|
3974
|
-
* Date and time when meta site was updated for the last time.
|
|
3975
|
-
* @readonly
|
|
3976
|
-
*/
|
|
3977
|
-
dateUpdated?: Date | null;
|
|
3978
|
-
/**
|
|
3979
|
-
* All "applications" of this meta site.
|
|
3980
|
-
*
|
|
3981
|
-
* In old MetaSiteDTO -- embeddedServices.
|
|
3982
|
-
*/
|
|
3983
|
-
apps?: App[];
|
|
3984
|
-
/** Namespace of meta site. */
|
|
3985
|
-
namespace?: NamespaceWithLiterals;
|
|
3986
|
-
/**
|
|
3987
|
-
* Indicates whether https should be used for viewing a site.
|
|
3988
|
-
*
|
|
3989
|
-
* In old MetaSiteDTO -- flags.UseHttps.
|
|
3990
|
-
*/
|
|
3991
|
-
useHttps?: boolean;
|
|
3992
|
-
defaultSeoData?: SeoData;
|
|
3993
|
-
/**
|
|
3994
|
-
* Information about HTML application.
|
|
3995
|
-
*
|
|
3996
|
-
* In old MetaSiteDTO -- appplications.find(_.applicationType == HtmlWeb).
|
|
3997
|
-
*/
|
|
3998
|
-
htmlApp?: HtmlApplication;
|
|
3999
|
-
/**
|
|
4000
|
-
* @maxSize 10000
|
|
4001
|
-
* @deprecated
|
|
4002
|
-
*/
|
|
4003
|
-
externalUriMappings?: ExternalUriMapping[];
|
|
4004
|
-
/** Indicates whether meta site was published. If true - site should be accessible for viewing. */
|
|
4005
|
-
published?: boolean;
|
|
4006
|
-
/**
|
|
4007
|
-
* The name of meta site.
|
|
4008
|
-
*
|
|
4009
|
-
* Matches this regular expression: [a-z0-9_\-]{4,20} (but for some legacy sites might be shorted/longer).
|
|
4010
|
-
*/
|
|
4011
|
-
name?: string;
|
|
4012
|
-
/**
|
|
4013
|
-
* Indicates whether this site is managed by ADI editor
|
|
4014
|
-
*
|
|
4015
|
-
* Values:
|
|
4016
|
-
* None - not managed.
|
|
4017
|
-
* Some(false) - site was created via ADI editor, but later on user switched to regular editor.
|
|
4018
|
-
* Some(true) - site was created and still is managed by ADI editor.
|
|
4019
|
-
*
|
|
4020
|
-
* In old MetaSiteDTO: embeddedService[embeddedServiceType=Onboarding].attributes.isInUse.
|
|
4021
|
-
*/
|
|
4022
|
-
adi?: boolean | null;
|
|
4023
|
-
/**
|
|
4024
|
-
* Indicates whether this meta site is template.
|
|
4025
|
-
*
|
|
4026
|
-
* In old MetaSiteDTO: documentType == Template.
|
|
4027
|
-
* @readonly
|
|
4028
|
-
*/
|
|
4029
|
-
template?: boolean | null;
|
|
4030
|
-
/**
|
|
4031
|
-
* Identifier of a template (meta site) from which this site was created.
|
|
4032
|
-
*
|
|
4033
|
-
* If it's empty it either means that site wasn't created from a template OR it's very old, so we didn't store
|
|
4034
|
-
* it back then.
|
|
4035
|
-
*
|
|
4036
|
-
* For example, if "site" was created from "template", then "template"'s id will be in origin_template_id.
|
|
4037
|
-
* When "site" is cloned, clone will also have "template"'s id in origin_instance_id.
|
|
4038
|
-
* @format GUID
|
|
4039
|
-
* @readonly
|
|
4040
|
-
*/
|
|
4041
|
-
originTemplateId?: string | null;
|
|
4042
|
-
/**
|
|
4043
|
-
* Indicates meta site blocked from publishing and added additional filtering in listing API (MSS). READ_ONLY.
|
|
4044
|
-
* @readonly
|
|
4045
|
-
*/
|
|
4046
|
-
blocked?: boolean;
|
|
4047
|
-
/**
|
|
4048
|
-
* If true - default meta site routing (connected domains, free url, ML) is not used for this meta site.
|
|
4049
|
-
*
|
|
4050
|
-
* Meaning, that if `example.org` is connected to this meta site, `router-server` will return 404 for `example.org`
|
|
4051
|
-
* anyway.
|
|
4052
|
-
*
|
|
4053
|
-
* This flag is set for some sites that have custom mapping in Routes API / wix-pages-bo.
|
|
4054
|
-
*/
|
|
4055
|
-
dontUseDefaultRouting?: boolean;
|
|
4056
|
-
/**
|
|
4057
|
-
* Indicates the site is used as critical asset and as such is protected. You would be only able to provision applications to this meta site. READ_ONLY.
|
|
4058
|
-
* @readonly
|
|
4059
|
-
*/
|
|
4060
|
-
criticalAsset?: boolean;
|
|
4061
|
-
/**
|
|
4062
|
-
* Date and time when the account that owns this meta site was created.
|
|
4063
|
-
* @readonly
|
|
4064
|
-
*/
|
|
4065
|
-
accountCreatedDate?: Date | null;
|
|
4066
|
-
}
|
|
4067
|
-
interface App {
|
|
4068
|
-
/**
|
|
4069
|
-
* Identifier of application type (application definition id).
|
|
4070
|
-
*
|
|
4071
|
-
* Can be both UUID and non-UUID, for example: SiteMembers, Onboarding, CloudSiteExtension etc.
|
|
4072
|
-
* @maxLength 36
|
|
4073
|
-
*/
|
|
4074
|
-
appDefId?: string;
|
|
4075
|
-
/**
|
|
4076
|
-
* Identifier of the instance (concrete application, installed on a site).
|
|
4077
|
-
*
|
|
4078
|
-
* Mostly UUID, but for some specific legacy cases might be something else.
|
|
4079
|
-
* @maxLength 36
|
|
4080
|
-
*/
|
|
4081
|
-
instanceId?: string;
|
|
4082
|
-
/**
|
|
4083
|
-
* State of this app (see docs for state).
|
|
4084
|
-
* @readonly
|
|
4085
|
-
*/
|
|
4086
|
-
state?: StateWithLiterals;
|
|
4087
|
-
/**
|
|
4088
|
-
* Identifier of the originating application. For example, if this app was part of a template,
|
|
4089
|
-
* then an app will get instance_id of that app as origin instance id.
|
|
4090
|
-
*
|
|
4091
|
-
* If application was provisioned not from some template, it should be empty.
|
|
4092
|
-
*
|
|
4093
|
-
* Note, it could be == to instance_id (for old sites).
|
|
4094
|
-
* @maxLength 36
|
|
4095
|
-
*/
|
|
4096
|
-
originInstanceId?: string;
|
|
4097
|
-
}
|
|
4098
|
-
/**
|
|
4099
|
-
* Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
|
|
4100
|
-
* which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
|
|
4101
|
-
*/
|
|
4102
|
-
declare enum State {
|
|
4103
|
-
UNKNOWN = "UNKNOWN",
|
|
4104
|
-
/** App is installed on a site. */
|
|
4105
|
-
ENABLED = "ENABLED",
|
|
4106
|
-
/** App is removed from a site (but we preserve it just in case). */
|
|
4107
|
-
DISABLED = "DISABLED",
|
|
4108
|
-
/** App is in "demo" mode, meaning that it's in read-only mode (it's in a template OR not installed yet). */
|
|
4109
|
-
TEMPLATE = "TEMPLATE",
|
|
4110
|
-
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
4111
|
-
PENDING = "PENDING"
|
|
4112
|
-
}
|
|
4113
|
-
/** @enumType */
|
|
4114
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
|
|
4115
|
-
declare enum Namespace {
|
|
4116
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4117
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4118
|
-
WIX = "WIX",
|
|
4119
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4120
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4121
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4122
|
-
ALBUMS = "ALBUMS",
|
|
4123
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4124
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4125
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4126
|
-
HOTELS = "HOTELS",
|
|
4127
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4128
|
-
CLUBS = "CLUBS",
|
|
4129
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4130
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4131
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4132
|
-
DEV_SITE = "DEV_SITE",
|
|
4133
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4134
|
-
LOGOS = "LOGOS",
|
|
4135
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4136
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4137
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4138
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4139
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4140
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4141
|
-
/**
|
|
4142
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4143
|
-
*
|
|
4144
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4145
|
-
*/
|
|
4146
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
4147
|
-
/**
|
|
4148
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4149
|
-
* Will be accessible from Site List and will not have a website app.
|
|
4150
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4151
|
-
*/
|
|
4152
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4153
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4154
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4155
|
-
/** It is to be used in the Business First efforts. */
|
|
4156
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4157
|
-
/** Bookings business flow with no site. */
|
|
4158
|
-
ANYWHERE = "ANYWHERE",
|
|
4159
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4160
|
-
HEADLESS = "HEADLESS",
|
|
4161
|
-
/**
|
|
4162
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4163
|
-
* The site will be used for account level CSM feature for enterprise
|
|
4164
|
-
*/
|
|
4165
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4166
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4167
|
-
RISE = "RISE",
|
|
4168
|
-
/**
|
|
4169
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4170
|
-
* There's a blank site behind the scene but it's blank).
|
|
4171
|
-
* The Mobile company will be the owner of this namespace.
|
|
4172
|
-
*/
|
|
4173
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4174
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4175
|
-
NOWNIA = "NOWNIA",
|
|
4176
|
-
/**
|
|
4177
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4178
|
-
* The Partners company owns this namespace.
|
|
4179
|
-
*/
|
|
4180
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4181
|
-
/** Codux Headless Sites */
|
|
4182
|
-
CODUX = "CODUX",
|
|
4183
|
-
/** Bobb - AI Design Creator. */
|
|
4184
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4185
|
-
/**
|
|
4186
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4187
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
4188
|
-
*/
|
|
4189
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4190
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4191
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4192
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4193
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4194
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4195
|
-
MIMIR = "MIMIR"
|
|
4196
|
-
}
|
|
4197
|
-
/** @enumType */
|
|
4198
|
-
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
4199
|
-
interface SeoData {
|
|
4200
|
-
/**
|
|
4201
|
-
* A title.
|
|
4202
|
-
* @maxLength 255
|
|
4203
|
-
*/
|
|
4204
|
-
title?: string | null;
|
|
4205
|
-
/** Indicates whether the site should be indexable by bots. */
|
|
4206
|
-
indexable?: boolean;
|
|
4207
|
-
/** TDB. */
|
|
4208
|
-
suppressTrackingCookies?: boolean;
|
|
4209
|
-
/**
|
|
4210
|
-
* TDB.
|
|
4211
|
-
* @maxLength 300
|
|
4212
|
-
*/
|
|
4213
|
-
ogImage?: string | null;
|
|
4214
|
-
/**
|
|
4215
|
-
* A list of meta tags.
|
|
4216
|
-
* @maxSize 100
|
|
4217
|
-
*/
|
|
4218
|
-
metaTags?: MetaTag[];
|
|
4219
|
-
/**
|
|
4220
|
-
* A canonical URL for a site.
|
|
4221
|
-
* @maxLength 4000
|
|
4222
|
-
*/
|
|
4223
|
-
canonicalUrl?: string | null;
|
|
4224
|
-
}
|
|
4225
|
-
interface MetaTag {
|
|
4226
|
-
/**
|
|
4227
|
-
* A name.
|
|
4228
|
-
* @maxLength 50
|
|
4229
|
-
*/
|
|
4230
|
-
name?: string;
|
|
4231
|
-
/**
|
|
4232
|
-
* A value.
|
|
4233
|
-
* @maxLength 500
|
|
4234
|
-
*/
|
|
4235
|
-
value?: string;
|
|
4236
|
-
/** Indicates whether should be rendered as property. */
|
|
4237
|
-
property?: boolean;
|
|
4238
|
-
}
|
|
4239
|
-
/** Represents an HTML application (HTML site). */
|
|
4240
|
-
interface HtmlApplication {
|
|
4241
|
-
/** Legacy, don't use it if you can. */
|
|
4242
|
-
intId?: number;
|
|
4243
|
-
/** Identifier of the instance. */
|
|
4244
|
-
instanceId?: string;
|
|
4245
|
-
seoData?: SeoData;
|
|
4246
|
-
/** Language of this site. */
|
|
4247
|
-
languageCode?: string;
|
|
4248
|
-
/** File name for thumbnail. */
|
|
4249
|
-
thumbnail?: string | null;
|
|
4250
|
-
/** Indicates whether this site is managed by EditorX. */
|
|
4251
|
-
editorX?: boolean;
|
|
4252
|
-
/** Indicates whether this site is managed by Wix Studio. */
|
|
4253
|
-
studio?: boolean;
|
|
4254
|
-
/** Indicates that site is managed by Odeditor */
|
|
4255
|
-
odeditor?: boolean;
|
|
4256
|
-
/** Indicates that site is managed by Picasso */
|
|
4257
|
-
picasso?: boolean;
|
|
4258
|
-
}
|
|
4259
|
-
interface ExternalUriMapping {
|
|
4260
|
-
/**
|
|
4261
|
-
* Deprecated.
|
|
4262
|
-
* @maxLength 255
|
|
4263
|
-
*/
|
|
4264
|
-
fromExternalUri?: string;
|
|
4265
|
-
/**
|
|
4266
|
-
* Deprecated.
|
|
4267
|
-
* @maxLength 255
|
|
4268
|
-
*/
|
|
4269
|
-
toWixUri?: string;
|
|
4270
|
-
/**
|
|
4271
|
-
* Deprecated.
|
|
4272
|
-
* @maxLength 255
|
|
4273
|
-
*/
|
|
4274
|
-
oldToWixUri?: string | null;
|
|
4275
|
-
/** Deprecated. */
|
|
4276
|
-
requireDomain?: boolean | null;
|
|
4277
|
-
}
|
|
4278
|
-
interface UserDataResponse {
|
|
4279
|
-
userEmail?: string;
|
|
4280
|
-
/** owner name */
|
|
4281
|
-
userName?: string;
|
|
4282
|
-
/** owner status */
|
|
4283
|
-
userStatus?: string;
|
|
4284
|
-
/** owner language */
|
|
4285
|
-
userLanguage?: string;
|
|
4286
|
-
}
|
|
4287
|
-
interface QueryOrdersForMetasiteRequest {
|
|
4288
|
-
/**
|
|
4289
|
-
* meta site Id for EP orders to retrieve
|
|
4290
|
-
* @format GUID
|
|
4291
|
-
*/
|
|
4292
|
-
metasiteId?: string;
|
|
4293
|
-
/** paginated internal orders query request */
|
|
4294
|
-
internalQueryOrdersRequest?: InternalQueryOrdersRequest;
|
|
4295
|
-
}
|
|
4296
|
-
interface InternalQueryOrdersRequest {
|
|
4297
|
-
/** Query options. */
|
|
4298
|
-
query?: PlatformQuery;
|
|
4299
|
-
}
|
|
4300
|
-
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4301
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4302
|
-
paging?: PlatformPaging;
|
|
4303
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4304
|
-
cursorPaging?: CursorPaging;
|
|
4305
|
-
/** Filter object. */
|
|
4306
|
-
filter?: Record<string, any> | null;
|
|
4307
|
-
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
4308
|
-
sort?: Sorting[];
|
|
4309
|
-
}
|
|
4310
|
-
/** @oneof */
|
|
4311
|
-
interface PlatformQueryPagingMethodOneOf {
|
|
4312
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4313
|
-
paging?: PlatformPaging;
|
|
4314
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4315
|
-
cursorPaging?: CursorPaging;
|
|
4316
|
-
}
|
|
4317
|
-
interface Sorting {
|
|
4318
|
-
/**
|
|
4319
|
-
* Name of the field to sort by.
|
|
4320
|
-
* @maxLength 512
|
|
4321
|
-
*/
|
|
4322
|
-
fieldName?: string;
|
|
4323
|
-
/** Sort order. */
|
|
4324
|
-
order?: SortOrderWithLiterals;
|
|
4325
|
-
}
|
|
4326
|
-
declare enum SortOrder {
|
|
4327
|
-
ASC = "ASC",
|
|
4328
|
-
DESC = "DESC"
|
|
4329
|
-
}
|
|
4330
|
-
/** @enumType */
|
|
4331
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4332
|
-
interface PlatformPaging {
|
|
4333
|
-
/**
|
|
4334
|
-
* Number of items to load.
|
|
4335
|
-
* @max 100
|
|
4336
|
-
*/
|
|
4337
|
-
limit?: number | null;
|
|
4338
|
-
/** Number of items to skip in the current sort order. */
|
|
4339
|
-
offset?: number | null;
|
|
4340
|
-
}
|
|
4341
|
-
interface CursorPaging {
|
|
4342
|
-
/**
|
|
4343
|
-
* Maximum number of items to return in the results.
|
|
4344
|
-
* @max 100
|
|
4345
|
-
*/
|
|
4346
|
-
limit?: number | null;
|
|
4347
|
-
/**
|
|
4348
|
-
* Pointer to the next or previous page in the list of results.
|
|
4349
|
-
*
|
|
4350
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
4351
|
-
* Not relevant for the first request.
|
|
4352
|
-
* @maxLength 16000
|
|
4353
|
-
*/
|
|
4354
|
-
cursor?: string | null;
|
|
4355
|
-
}
|
|
4356
|
-
interface QueryOrdersForMetasiteResponse {
|
|
4357
|
-
/** found exisitng orders according to pagination and query provided. */
|
|
4358
|
-
orders?: Order[];
|
|
4359
|
-
/** Details on the paged set of results returned. */
|
|
4360
|
-
pagingMetadata?: PlatformPagingMetadata;
|
|
4361
|
-
}
|
|
4362
|
-
interface PlatformPagingMetadata {
|
|
4363
|
-
/** The number of items returned in this response. */
|
|
4364
|
-
count?: number | null;
|
|
4365
|
-
/** The offset which was requested. Returned if offset paging was used. */
|
|
4366
|
-
offset?: number | null;
|
|
4367
|
-
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
4368
|
-
total?: number | null;
|
|
4369
|
-
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4370
|
-
cursors?: Cursors;
|
|
4371
|
-
}
|
|
4372
|
-
interface Cursors {
|
|
4373
|
-
/**
|
|
4374
|
-
* Cursor string pointing to the next page in the list of results.
|
|
4375
|
-
* @maxLength 16000
|
|
4376
|
-
*/
|
|
4377
|
-
next?: string | null;
|
|
4378
|
-
/**
|
|
4379
|
-
* Cursor pointing to the previous page in the list of results.
|
|
4380
|
-
* @maxLength 16000
|
|
4381
|
-
*/
|
|
4382
|
-
prev?: string | null;
|
|
4383
|
-
}
|
|
4384
|
-
interface GetOrderForMetasiteRequest {
|
|
4385
|
-
/**
|
|
4386
|
-
* meta site Id for EP order to retrieve
|
|
4387
|
-
* @format GUID
|
|
4388
|
-
*/
|
|
4389
|
-
metasiteId?: string;
|
|
4390
|
-
/**
|
|
4391
|
-
* Order Id for EP order to retrieve
|
|
4392
|
-
* @minLength 1
|
|
4393
|
-
* @maxLength 100
|
|
4394
|
-
*/
|
|
4395
|
-
orderId?: string;
|
|
4396
|
-
}
|
|
4397
|
-
interface GetOrderForMetasiteResponse {
|
|
4398
|
-
/** Existing EP order */
|
|
4399
|
-
order?: Order;
|
|
4400
|
-
}
|
|
4401
|
-
interface ListOrderTransactionsForMetasiteRequest {
|
|
4402
|
-
/**
|
|
4403
|
-
* meta site Id for EP order transactions to retrieve
|
|
4404
|
-
* @format GUID
|
|
4405
|
-
*/
|
|
4406
|
-
metasiteId?: string;
|
|
4407
|
-
/**
|
|
4408
|
-
* Order Id for EP order transactions to retrieve
|
|
4409
|
-
* @format GUID
|
|
4410
|
-
*/
|
|
4411
|
-
orderId?: string;
|
|
4412
|
-
}
|
|
4413
|
-
interface ListOrderTransactionsForMetasiteResponse {
|
|
4414
|
-
/** Order ID and its associated transactions. */
|
|
4415
|
-
orderTransactions?: OrderTransactions;
|
|
4416
|
-
}
|
|
4417
|
-
interface UpsertRefundRequest {
|
|
4418
|
-
/**
|
|
4419
|
-
* Meta site ID.
|
|
4420
|
-
* @format GUID
|
|
4421
|
-
*/
|
|
4422
|
-
metasiteId?: string;
|
|
4423
|
-
/**
|
|
4424
|
-
* Order ID associated with refund.
|
|
4425
|
-
* @format GUID
|
|
4426
|
-
*/
|
|
4427
|
-
orderId?: string;
|
|
4428
|
-
/** Refund to upsert. */
|
|
4429
|
-
refund?: Refund;
|
|
4430
|
-
}
|
|
4431
|
-
interface UpsertRefundResponse {
|
|
4432
|
-
/** Updated order transactions. */
|
|
4433
|
-
orderTransactions?: OrderTransactions;
|
|
4434
|
-
}
|
|
4435
|
-
interface GetOrderOutOfBoxRequest {
|
|
4436
|
-
/**
|
|
4437
|
-
* Order Id for EP order to retrieve
|
|
4438
|
-
* @minLength 1
|
|
4439
|
-
* @maxLength 100
|
|
4440
|
-
*/
|
|
4441
|
-
_id?: string;
|
|
4442
|
-
}
|
|
4443
|
-
interface GetOrderOutOfBoxResponse {
|
|
4444
|
-
/**
|
|
4445
|
-
* Order id if found
|
|
4446
|
-
* @minLength 1
|
|
4447
|
-
* @maxLength 100
|
|
4448
|
-
*/
|
|
4449
|
-
orderId?: string;
|
|
4450
|
-
}
|
|
4451
|
-
interface GetOrderAgcRequest {
|
|
4452
|
-
/**
|
|
4453
|
-
* Order Id for EP order to retrieve
|
|
4454
|
-
* @minLength 1
|
|
4455
|
-
* @maxLength 100
|
|
4456
|
-
*/
|
|
4457
|
-
_id?: string;
|
|
4458
|
-
}
|
|
4459
|
-
interface GetOrderAgcResponse {
|
|
4460
|
-
/**
|
|
4461
|
-
* Order id if found
|
|
4462
|
-
* @minLength 1
|
|
4463
|
-
* @maxLength 100
|
|
4464
|
-
*/
|
|
4465
|
-
orderId?: string;
|
|
4466
|
-
}
|
|
4467
|
-
interface GetOrderWithFilterByLocationRequest {
|
|
4468
|
-
/**
|
|
4469
|
-
* Order Id for EP order to retrieve
|
|
4470
|
-
* @minLength 1
|
|
4471
|
-
* @maxLength 100
|
|
4472
|
-
*/
|
|
4473
|
-
_id?: string;
|
|
4474
|
-
}
|
|
4475
|
-
interface GetOrderWithFilterByLocationResponse {
|
|
4476
|
-
/**
|
|
4477
|
-
* Order id if found
|
|
4478
|
-
* @minLength 1
|
|
4479
|
-
* @maxLength 100
|
|
4480
|
-
*/
|
|
4481
|
-
orderId?: string;
|
|
4482
|
-
}
|
|
4483
|
-
interface V1UpdateOrderRequest {
|
|
4484
|
-
/** Order to be updated. */
|
|
4485
|
-
order?: Order;
|
|
4486
|
-
}
|
|
4487
|
-
interface V1UpdateOrderResponse {
|
|
4488
|
-
/** Updated order. */
|
|
4489
|
-
order?: Order;
|
|
4490
|
-
}
|
|
4491
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4492
|
-
/** insert/update documents */
|
|
4493
|
-
update?: InternalDocumentUpdateOperation;
|
|
4494
|
-
/** delete by document ids */
|
|
4495
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
4496
|
-
/** delete documents matching filter */
|
|
4497
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
4498
|
-
/** update internal documents matching filter */
|
|
4499
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4500
|
-
/** update only existing documents */
|
|
4501
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
4502
|
-
/** insert/update documents with versioning */
|
|
4503
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4504
|
-
/** delete by document ids with versioning */
|
|
4505
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4506
|
-
/**
|
|
4507
|
-
* type of the documents
|
|
4508
|
-
* @minLength 2
|
|
4509
|
-
*/
|
|
4510
|
-
documentType?: string;
|
|
4511
|
-
/**
|
|
4512
|
-
* language of the documents (mandatory)
|
|
4513
|
-
* @minLength 2
|
|
4514
|
-
*/
|
|
4515
|
-
language?: string | null;
|
|
4516
|
-
/**
|
|
4517
|
-
* one or more search documents
|
|
4518
|
-
* @deprecated
|
|
4519
|
-
*/
|
|
4520
|
-
addDocuments?: InternalDocument[];
|
|
4521
|
-
/**
|
|
4522
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
4523
|
-
* @deprecated
|
|
4524
|
-
*/
|
|
4525
|
-
removeDocumentIds?: string[];
|
|
4526
|
-
/** id to pass to processing notification */
|
|
4527
|
-
correlationId?: string | null;
|
|
4528
|
-
/** when event was created / issued */
|
|
4529
|
-
issuedAt?: Date | null;
|
|
4530
|
-
}
|
|
4531
|
-
/** @oneof */
|
|
4532
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4533
|
-
/** insert/update documents */
|
|
4534
|
-
update?: InternalDocumentUpdateOperation;
|
|
4535
|
-
/** delete by document ids */
|
|
4536
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
4537
|
-
/** delete documents matching filter */
|
|
4538
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
4539
|
-
/** update internal documents matching filter */
|
|
4540
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4541
|
-
/** update only existing documents */
|
|
4542
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
4543
|
-
/** insert/update documents with versioning */
|
|
4544
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4545
|
-
/** delete by document ids with versioning */
|
|
4546
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4547
|
-
}
|
|
4548
|
-
interface InternalDocument {
|
|
4549
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4550
|
-
document?: Record<string, any> | null;
|
|
4551
|
-
}
|
|
4552
|
-
interface InternalDocumentUpdateOperation {
|
|
4553
|
-
/** documents to index or update */
|
|
4554
|
-
documents?: InternalDocument[];
|
|
4555
|
-
}
|
|
4556
|
-
interface DeleteByIdsOperation {
|
|
4557
|
-
/** ids of the documents to delete */
|
|
4558
|
-
documentIds?: string[];
|
|
4559
|
-
/**
|
|
4560
|
-
* tenant id for custom tenancy strategy
|
|
4561
|
-
* @minLength 2
|
|
4562
|
-
* @maxLength 300
|
|
4563
|
-
*/
|
|
4564
|
-
tenantId?: string | null;
|
|
4565
|
-
}
|
|
4566
|
-
interface DeleteByFilterOperation {
|
|
4567
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4568
|
-
filter?: Record<string, any> | null;
|
|
4569
|
-
/**
|
|
4570
|
-
* tenant id for custom tenancy strategy
|
|
4571
|
-
* @minLength 2
|
|
4572
|
-
* @maxLength 300
|
|
4573
|
-
*/
|
|
4574
|
-
tenantId?: string | null;
|
|
4575
|
-
}
|
|
4576
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
4577
|
-
/** documents matching this filter will be updated */
|
|
4578
|
-
filter?: Record<string, any> | null;
|
|
4579
|
-
/** partial document to apply */
|
|
4580
|
-
document?: InternalDocument;
|
|
4581
|
-
/**
|
|
4582
|
-
* tenant id for custom tenancy strategy
|
|
4583
|
-
* @minLength 2
|
|
4584
|
-
* @maxLength 300
|
|
4585
|
-
*/
|
|
4586
|
-
tenantId?: string | null;
|
|
4587
|
-
}
|
|
4588
|
-
interface InternalUpdateExistingOperation {
|
|
4589
|
-
/** documents to update */
|
|
4590
|
-
documents?: InternalDocument[];
|
|
4591
|
-
}
|
|
4592
|
-
interface VersionedDocumentUpdateOperation {
|
|
4593
|
-
/** documents to create or overwrite */
|
|
4594
|
-
documents?: InternalDocument[];
|
|
4595
|
-
/** versioning mode to use instead of default */
|
|
4596
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
4597
|
-
}
|
|
4598
|
-
declare enum VersioningMode {
|
|
4599
|
-
/** use default versioning mode agreed with search team */
|
|
4600
|
-
DEFAULT = "DEFAULT",
|
|
4601
|
-
/** execute only if version is greater than existing */
|
|
4602
|
-
GREATER_THAN = "GREATER_THAN",
|
|
4603
|
-
/** execute only if version is greater or equal to existing */
|
|
4604
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4605
|
-
}
|
|
4606
|
-
/** @enumType */
|
|
4607
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4608
|
-
interface VersionedDeleteByIdsOperation {
|
|
4609
|
-
/** ids with version of the documents to delete */
|
|
4610
|
-
documentIds?: VersionedDocumentId[];
|
|
4611
|
-
/**
|
|
4612
|
-
* tenant id for custom tenancy strategy
|
|
4613
|
-
* @minLength 2
|
|
4614
|
-
* @maxLength 300
|
|
4615
|
-
*/
|
|
4616
|
-
tenantId?: string | null;
|
|
4617
|
-
}
|
|
4618
|
-
interface VersionedDocumentId {
|
|
4619
|
-
/** document id */
|
|
4620
|
-
documentId?: string;
|
|
4621
|
-
/** document version */
|
|
4622
|
-
version?: string;
|
|
4623
|
-
/** versioning mode to use instead of default */
|
|
4624
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
4625
|
-
}
|
|
4626
|
-
interface TriggerReindexRequest {
|
|
4627
|
-
/** @format GUID */
|
|
4628
|
-
metasiteId?: string;
|
|
4629
|
-
/**
|
|
4630
|
-
* @minLength 1
|
|
4631
|
-
* @maxLength 100
|
|
4632
|
-
* @maxSize 100
|
|
4633
|
-
*/
|
|
4634
|
-
orderIds?: string[];
|
|
4635
|
-
}
|
|
4636
|
-
interface TriggerReindexResponse {
|
|
4637
|
-
}
|
|
4638
|
-
interface BatchOfTriggerReindexOrderRequest {
|
|
4639
|
-
/** @maxSize 25 */
|
|
4640
|
-
requests?: TriggerReindexOrderRequest[];
|
|
4641
|
-
}
|
|
4642
|
-
interface DiffmatokyPayload {
|
|
4643
|
-
left?: string;
|
|
4644
|
-
right?: string;
|
|
4645
|
-
compareChannel?: string;
|
|
4646
|
-
entityId?: string;
|
|
4647
|
-
errorInformation?: ErrorInformation;
|
|
4648
|
-
tags?: string[];
|
|
4649
|
-
}
|
|
4650
|
-
interface ErrorInformation {
|
|
4651
|
-
stackTrace?: string;
|
|
4652
|
-
}
|
|
4653
|
-
interface ContinueSideEffectsFlowInLegacyData {
|
|
4654
|
-
storeId?: string;
|
|
4655
|
-
orderId?: string;
|
|
4656
|
-
ordersExperiments?: OrdersExperiments;
|
|
4657
|
-
}
|
|
4658
|
-
interface IndexingMessage {
|
|
4659
|
-
_id?: string;
|
|
4660
|
-
opType?: number;
|
|
4661
|
-
requiredVersions?: string[];
|
|
4662
|
-
}
|
|
4663
|
-
interface GetOrderRequest {
|
|
4664
|
-
/**
|
|
4665
|
-
* ID of the order to retrieve.
|
|
4666
|
-
* @minLength 1
|
|
4667
|
-
* @maxLength 100
|
|
4668
|
-
*/
|
|
4669
|
-
_id: string;
|
|
4670
|
-
}
|
|
4671
|
-
interface GetOrderResponse {
|
|
4672
|
-
/** The requested order. */
|
|
4673
|
-
order?: Order;
|
|
4674
|
-
}
|
|
4675
|
-
interface InternalQueryOrdersResponse {
|
|
4676
|
-
/** List of orders. */
|
|
4677
|
-
orders?: Order[];
|
|
4678
|
-
/** Details on the paged set of results returned. */
|
|
4679
|
-
metadata?: PlatformPagingMetadata;
|
|
2719
|
+
prev?: string | null;
|
|
4680
2720
|
}
|
|
4681
2721
|
interface QueryOrderRequest {
|
|
4682
2722
|
/** Query options. */
|
|
@@ -4820,6 +2860,42 @@ interface BulkUpdateOrdersResponse {
|
|
|
4820
2860
|
/** Bulk action metadata. */
|
|
4821
2861
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4822
2862
|
}
|
|
2863
|
+
interface BulkOrderResult {
|
|
2864
|
+
/** Item metadata. */
|
|
2865
|
+
itemMetadata?: ItemMetadata;
|
|
2866
|
+
/**
|
|
2867
|
+
* Updated order.
|
|
2868
|
+
*
|
|
2869
|
+
* Returned when `returnFullEntity = true`.
|
|
2870
|
+
*/
|
|
2871
|
+
item?: Order;
|
|
2872
|
+
}
|
|
2873
|
+
interface ItemMetadata {
|
|
2874
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2875
|
+
_id?: string | null;
|
|
2876
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2877
|
+
originalIndex?: number;
|
|
2878
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2879
|
+
success?: boolean;
|
|
2880
|
+
/** Details about the error in case of failure. */
|
|
2881
|
+
error?: ApplicationError;
|
|
2882
|
+
}
|
|
2883
|
+
interface ApplicationError {
|
|
2884
|
+
/** Error code. */
|
|
2885
|
+
code?: string;
|
|
2886
|
+
/** Description of the error. */
|
|
2887
|
+
description?: string;
|
|
2888
|
+
/** Data related to the error. */
|
|
2889
|
+
data?: Record<string, any> | null;
|
|
2890
|
+
}
|
|
2891
|
+
interface BulkActionMetadata {
|
|
2892
|
+
/** Number of items that were successfully processed. */
|
|
2893
|
+
totalSuccesses?: number;
|
|
2894
|
+
/** Number of items that couldn't be processed. */
|
|
2895
|
+
totalFailures?: number;
|
|
2896
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2897
|
+
undetailedFailures?: number;
|
|
2898
|
+
}
|
|
4823
2899
|
interface CommitDeltasRequest {
|
|
4824
2900
|
/** Order id to be updated */
|
|
4825
2901
|
_id: string;
|
|
@@ -4844,6 +2920,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
4844
2920
|
changedShippingInfo?: V1ShippingInformation;
|
|
4845
2921
|
/** Remove existing shipping info. */
|
|
4846
2922
|
shippingInfoRemoved?: boolean;
|
|
2923
|
+
/**
|
|
2924
|
+
* Buyer info and selected buyer option details.
|
|
2925
|
+
* @internal
|
|
2926
|
+
*/
|
|
2927
|
+
changedBuyerInfo?: BuyerInfo;
|
|
2928
|
+
/**
|
|
2929
|
+
* Remove existing buyer info.
|
|
2930
|
+
* @internal
|
|
2931
|
+
*/
|
|
2932
|
+
buyerInfoRemoved?: boolean;
|
|
2933
|
+
/**
|
|
2934
|
+
* Updated billing info.
|
|
2935
|
+
* @internal
|
|
2936
|
+
*/
|
|
2937
|
+
changedBillingInfo?: AddressWithContact;
|
|
2938
|
+
/**
|
|
2939
|
+
* Remove existing billing info.
|
|
2940
|
+
* @internal
|
|
2941
|
+
*/
|
|
2942
|
+
billingInfoRemoved?: boolean;
|
|
2943
|
+
/**
|
|
2944
|
+
* Updated recipient info.
|
|
2945
|
+
* @internal
|
|
2946
|
+
*/
|
|
2947
|
+
changedRecipientInfo?: AddressWithContact;
|
|
2948
|
+
/**
|
|
2949
|
+
* Remove existing recipient info.
|
|
2950
|
+
* @internal
|
|
2951
|
+
*/
|
|
2952
|
+
recipientInfoRemoved?: boolean;
|
|
4847
2953
|
/**
|
|
4848
2954
|
* Added/updated/removed order line items.
|
|
4849
2955
|
* @maxSize 300
|
|
@@ -4885,12 +2991,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
4885
2991
|
}
|
|
4886
2992
|
/** @oneof */
|
|
4887
2993
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
2994
|
+
/**
|
|
2995
|
+
* Buyer info and selected buyer option details.
|
|
2996
|
+
* @internal
|
|
2997
|
+
*/
|
|
2998
|
+
changedBuyerInfo?: BuyerInfo;
|
|
2999
|
+
/**
|
|
3000
|
+
* Remove existing buyer info.
|
|
3001
|
+
* @internal
|
|
3002
|
+
*/
|
|
3003
|
+
buyerInfoRemoved?: boolean;
|
|
4888
3004
|
}
|
|
4889
3005
|
/** @oneof */
|
|
4890
3006
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
3007
|
+
/**
|
|
3008
|
+
* Updated billing info.
|
|
3009
|
+
* @internal
|
|
3010
|
+
*/
|
|
3011
|
+
changedBillingInfo?: AddressWithContact;
|
|
3012
|
+
/**
|
|
3013
|
+
* Remove existing billing info.
|
|
3014
|
+
* @internal
|
|
3015
|
+
*/
|
|
3016
|
+
billingInfoRemoved?: boolean;
|
|
4891
3017
|
}
|
|
4892
3018
|
/** @oneof */
|
|
4893
3019
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
3020
|
+
/**
|
|
3021
|
+
* Updated recipient info.
|
|
3022
|
+
* @internal
|
|
3023
|
+
*/
|
|
3024
|
+
changedRecipientInfo?: AddressWithContact;
|
|
3025
|
+
/**
|
|
3026
|
+
* Remove existing recipient info.
|
|
3027
|
+
* @internal
|
|
3028
|
+
*/
|
|
3029
|
+
recipientInfoRemoved?: boolean;
|
|
4894
3030
|
}
|
|
4895
3031
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4896
3032
|
/** The line item was added. */
|
|
@@ -4990,8 +3126,21 @@ interface OrderLineItemChangedDetails {
|
|
|
4990
3126
|
* @maxSize 5
|
|
4991
3127
|
*/
|
|
4992
3128
|
locations?: LocationAndQuantity[];
|
|
3129
|
+
/**
|
|
3130
|
+
* ID of the app managing the inventory.
|
|
3131
|
+
* @internal
|
|
3132
|
+
* @format GUID
|
|
3133
|
+
*/
|
|
3134
|
+
inventoryAppId?: string | null;
|
|
4993
3135
|
/** Subscription info. */
|
|
4994
3136
|
subscriptionInfo?: SubscriptionInfo;
|
|
3137
|
+
/**
|
|
3138
|
+
* Modifier groups that were added to the item.
|
|
3139
|
+
* @internal
|
|
3140
|
+
* @readonly
|
|
3141
|
+
* @maxSize 10
|
|
3142
|
+
*/
|
|
3143
|
+
modifierGroups?: ModifierGroup[];
|
|
4995
3144
|
}
|
|
4996
3145
|
/** Type of selected payment option for catalog item */
|
|
4997
3146
|
declare enum DeltaPaymentOptionType {
|
|
@@ -5378,6 +3527,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5378
3527
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5379
3528
|
/** Payment method is saved for order */
|
|
5380
3529
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3530
|
+
/**
|
|
3531
|
+
* Details of an initiated refund process.
|
|
3532
|
+
*
|
|
3533
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3534
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3535
|
+
* @internal
|
|
3536
|
+
*/
|
|
3537
|
+
refundInitiated?: RefundInitiated;
|
|
3538
|
+
/**
|
|
3539
|
+
* Details of a refunded payment.
|
|
3540
|
+
*
|
|
3541
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3542
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3543
|
+
* @internal
|
|
3544
|
+
*/
|
|
3545
|
+
paymentRefunded?: PaymentRefunded;
|
|
3546
|
+
/**
|
|
3547
|
+
* Details of a failed payment refund.
|
|
3548
|
+
*
|
|
3549
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3550
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3551
|
+
* @internal
|
|
3552
|
+
*/
|
|
3553
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
3554
|
+
/**
|
|
3555
|
+
* Details of refund to store credit.
|
|
3556
|
+
* @internal
|
|
3557
|
+
*/
|
|
3558
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5381
3559
|
/** Details of a pending payment */
|
|
5382
3560
|
paymentPending?: PaymentPending;
|
|
5383
3561
|
/** Details of a canceled payment */
|
|
@@ -5388,6 +3566,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5388
3566
|
orderPending?: OrderPending;
|
|
5389
3567
|
/** Order rejected */
|
|
5390
3568
|
orderRejected?: OrderRejected;
|
|
3569
|
+
/**
|
|
3570
|
+
* Receipt was added for associated payment
|
|
3571
|
+
* @internal
|
|
3572
|
+
*/
|
|
3573
|
+
receiptCreated?: ReceiptCreated;
|
|
3574
|
+
/**
|
|
3575
|
+
* Receipt sent to customer
|
|
3576
|
+
* @internal
|
|
3577
|
+
*/
|
|
3578
|
+
receiptSent?: ReceiptSent;
|
|
3579
|
+
/**
|
|
3580
|
+
* Chargeback created for one of the order's payments.
|
|
3581
|
+
* @internal
|
|
3582
|
+
*/
|
|
3583
|
+
chargebackCreated?: ChargebackCreated;
|
|
3584
|
+
/**
|
|
3585
|
+
* Chargeback reversed for one of the order's payments.
|
|
3586
|
+
* @internal
|
|
3587
|
+
*/
|
|
3588
|
+
chargebackReversed?: ChargebackReversed;
|
|
5391
3589
|
/**
|
|
5392
3590
|
* Internal activity ID.
|
|
5393
3591
|
* @format GUID
|
|
@@ -5452,6 +3650,35 @@ interface InternalActivityContentOneOf {
|
|
|
5452
3650
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5453
3651
|
/** Payment method is saved for order */
|
|
5454
3652
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
3653
|
+
/**
|
|
3654
|
+
* Details of an initiated refund process.
|
|
3655
|
+
*
|
|
3656
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3657
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3658
|
+
* @internal
|
|
3659
|
+
*/
|
|
3660
|
+
refundInitiated?: RefundInitiated;
|
|
3661
|
+
/**
|
|
3662
|
+
* Details of a refunded payment.
|
|
3663
|
+
*
|
|
3664
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3665
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3666
|
+
* @internal
|
|
3667
|
+
*/
|
|
3668
|
+
paymentRefunded?: PaymentRefunded;
|
|
3669
|
+
/**
|
|
3670
|
+
* Details of a failed payment refund.
|
|
3671
|
+
*
|
|
3672
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
3673
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
3674
|
+
* @internal
|
|
3675
|
+
*/
|
|
3676
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
3677
|
+
/**
|
|
3678
|
+
* Details of refund to store credit.
|
|
3679
|
+
* @internal
|
|
3680
|
+
*/
|
|
3681
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5455
3682
|
/** Details of a pending payment */
|
|
5456
3683
|
paymentPending?: PaymentPending;
|
|
5457
3684
|
/** Details of a canceled payment */
|
|
@@ -5462,6 +3689,26 @@ interface InternalActivityContentOneOf {
|
|
|
5462
3689
|
orderPending?: OrderPending;
|
|
5463
3690
|
/** Order rejected */
|
|
5464
3691
|
orderRejected?: OrderRejected;
|
|
3692
|
+
/**
|
|
3693
|
+
* Receipt was added for associated payment
|
|
3694
|
+
* @internal
|
|
3695
|
+
*/
|
|
3696
|
+
receiptCreated?: ReceiptCreated;
|
|
3697
|
+
/**
|
|
3698
|
+
* Receipt sent to customer
|
|
3699
|
+
* @internal
|
|
3700
|
+
*/
|
|
3701
|
+
receiptSent?: ReceiptSent;
|
|
3702
|
+
/**
|
|
3703
|
+
* Chargeback created for one of the order's payments.
|
|
3704
|
+
* @internal
|
|
3705
|
+
*/
|
|
3706
|
+
chargebackCreated?: ChargebackCreated;
|
|
3707
|
+
/**
|
|
3708
|
+
* Chargeback reversed for one of the order's payments.
|
|
3709
|
+
* @internal
|
|
3710
|
+
*/
|
|
3711
|
+
chargebackReversed?: ChargebackReversed;
|
|
5465
3712
|
}
|
|
5466
3713
|
/** Order placed */
|
|
5467
3714
|
interface OrderPlaced {
|
|
@@ -5822,7 +4069,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
5822
4069
|
interface BulkSetBusinessLocationResult {
|
|
5823
4070
|
itemMetadata?: ItemMetadata;
|
|
5824
4071
|
}
|
|
5825
|
-
interface
|
|
4072
|
+
interface MarkOrderAsPaidRequest {
|
|
5826
4073
|
/**
|
|
5827
4074
|
* Order ID.
|
|
5828
4075
|
* @minLength 1
|
|
@@ -5830,11 +4077,18 @@ interface V1MarkOrderAsPaidRequest {
|
|
|
5830
4077
|
*/
|
|
5831
4078
|
_id?: string;
|
|
5832
4079
|
}
|
|
5833
|
-
interface
|
|
4080
|
+
interface MarkOrderAsPaidResponse {
|
|
5834
4081
|
/** Updated order. */
|
|
5835
4082
|
order?: Order;
|
|
5836
4083
|
}
|
|
5837
|
-
|
|
4084
|
+
/** Triggered when the payment status of an order is updated */
|
|
4085
|
+
interface PaymentStatusUpdated {
|
|
4086
|
+
/** The order that was updated */
|
|
4087
|
+
order?: Order;
|
|
4088
|
+
/** The previous status (before the update) */
|
|
4089
|
+
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
4090
|
+
}
|
|
4091
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
5838
4092
|
/**
|
|
5839
4093
|
* IDs of orders to mark as paid.
|
|
5840
4094
|
* @minSize 1
|
|
@@ -5844,7 +4098,7 @@ interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
5844
4098
|
*/
|
|
5845
4099
|
ids?: string[];
|
|
5846
4100
|
}
|
|
5847
|
-
interface
|
|
4101
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
5848
4102
|
/**
|
|
5849
4103
|
* Items updated by the bulk action.
|
|
5850
4104
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -5853,7 +4107,7 @@ interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
5853
4107
|
/** Bulk action metadata. */
|
|
5854
4108
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5855
4109
|
}
|
|
5856
|
-
interface
|
|
4110
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
5857
4111
|
/**
|
|
5858
4112
|
* eCom Order ID
|
|
5859
4113
|
* @minLength 1
|
|
@@ -5861,7 +4115,7 @@ interface V1CreatePaymentGatewayOrderRequest {
|
|
|
5861
4115
|
*/
|
|
5862
4116
|
ecomOrderId?: string;
|
|
5863
4117
|
}
|
|
5864
|
-
interface
|
|
4118
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
5865
4119
|
/** ID of the order created in the payment gateway */
|
|
5866
4120
|
paymentGatewayOrderId?: string;
|
|
5867
4121
|
}
|
|
@@ -5951,6 +4205,70 @@ interface BulkUpdateOrderTagsResponse {
|
|
|
5951
4205
|
interface BulkUpdateOrderTagsResult {
|
|
5952
4206
|
itemMetadata?: ItemMetadata;
|
|
5953
4207
|
}
|
|
4208
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4209
|
+
createdEvent?: EntityCreatedEvent;
|
|
4210
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
4211
|
+
deletedEvent?: EntityDeletedEvent;
|
|
4212
|
+
actionEvent?: ActionEvent;
|
|
4213
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4214
|
+
_id?: string;
|
|
4215
|
+
/**
|
|
4216
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4217
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4218
|
+
*/
|
|
4219
|
+
entityFqdn?: string;
|
|
4220
|
+
/**
|
|
4221
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4222
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4223
|
+
*/
|
|
4224
|
+
slug?: string;
|
|
4225
|
+
/** ID of the entity associated with the event. */
|
|
4226
|
+
entityId?: string;
|
|
4227
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4228
|
+
eventTime?: Date | null;
|
|
4229
|
+
/**
|
|
4230
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4231
|
+
* (for example, GDPR).
|
|
4232
|
+
*/
|
|
4233
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4234
|
+
/** If present, indicates the action that triggered the event. */
|
|
4235
|
+
originatedFrom?: string | null;
|
|
4236
|
+
/**
|
|
4237
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
4238
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
4239
|
+
*/
|
|
4240
|
+
entityEventSequence?: string | null;
|
|
4241
|
+
}
|
|
4242
|
+
/** @oneof */
|
|
4243
|
+
interface DomainEventBodyOneOf {
|
|
4244
|
+
createdEvent?: EntityCreatedEvent;
|
|
4245
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
4246
|
+
deletedEvent?: EntityDeletedEvent;
|
|
4247
|
+
actionEvent?: ActionEvent;
|
|
4248
|
+
}
|
|
4249
|
+
interface EntityCreatedEvent {
|
|
4250
|
+
entity?: string;
|
|
4251
|
+
}
|
|
4252
|
+
interface RestoreInfo {
|
|
4253
|
+
deletedDate?: Date | null;
|
|
4254
|
+
}
|
|
4255
|
+
interface EntityUpdatedEvent {
|
|
4256
|
+
/**
|
|
4257
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4258
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4259
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4260
|
+
*/
|
|
4261
|
+
currentEntity?: string;
|
|
4262
|
+
}
|
|
4263
|
+
interface EntityDeletedEvent {
|
|
4264
|
+
/** Entity that was deleted. */
|
|
4265
|
+
deletedEntity?: string | null;
|
|
4266
|
+
}
|
|
4267
|
+
interface ActionEvent {
|
|
4268
|
+
body?: string;
|
|
4269
|
+
}
|
|
4270
|
+
interface Empty {
|
|
4271
|
+
}
|
|
5954
4272
|
interface Task {
|
|
5955
4273
|
key?: TaskKey;
|
|
5956
4274
|
executeAt?: Date | null;
|
|
@@ -6269,9 +4587,9 @@ interface CalculatedTax {
|
|
|
6269
4587
|
code?: string | null;
|
|
6270
4588
|
}
|
|
6271
4589
|
interface Payments {
|
|
6272
|
-
payments?:
|
|
4590
|
+
payments?: Payment[];
|
|
6273
4591
|
}
|
|
6274
|
-
interface
|
|
4592
|
+
interface Payment {
|
|
6275
4593
|
/** document */
|
|
6276
4594
|
_id?: string;
|
|
6277
4595
|
type?: string;
|
|
@@ -6399,132 +4717,85 @@ declare enum InvoiceStatus {
|
|
|
6399
4717
|
PartiallyPaid = "PartiallyPaid",
|
|
6400
4718
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6401
4719
|
}
|
|
6402
|
-
/** @enumType */
|
|
6403
|
-
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6404
|
-
interface TriggerSideEffectsFromLegacyData {
|
|
6405
|
-
storeId?: string;
|
|
6406
|
-
orderId?: string;
|
|
6407
|
-
ordersExperiments?: OrdersExperiments;
|
|
4720
|
+
/** @enumType */
|
|
4721
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
4722
|
+
interface TriggerSideEffectsFromLegacyData {
|
|
4723
|
+
storeId?: string;
|
|
4724
|
+
orderId?: string;
|
|
4725
|
+
ordersExperiments?: OrdersExperiments;
|
|
4726
|
+
}
|
|
4727
|
+
interface MessageEnvelope {
|
|
4728
|
+
/**
|
|
4729
|
+
* App instance ID.
|
|
4730
|
+
* @format GUID
|
|
4731
|
+
*/
|
|
4732
|
+
instanceId?: string | null;
|
|
4733
|
+
/**
|
|
4734
|
+
* Event type.
|
|
4735
|
+
* @maxLength 150
|
|
4736
|
+
*/
|
|
4737
|
+
eventType?: string;
|
|
4738
|
+
/** The identification type and identity data. */
|
|
4739
|
+
identity?: IdentificationData;
|
|
4740
|
+
/** Stringify payload. */
|
|
4741
|
+
data?: string;
|
|
4742
|
+
}
|
|
4743
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4744
|
+
/**
|
|
4745
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4746
|
+
* @format GUID
|
|
4747
|
+
*/
|
|
4748
|
+
anonymousVisitorId?: string;
|
|
4749
|
+
/**
|
|
4750
|
+
* ID of a site visitor that has logged in to the site.
|
|
4751
|
+
* @format GUID
|
|
4752
|
+
*/
|
|
4753
|
+
memberId?: string;
|
|
4754
|
+
/**
|
|
4755
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4756
|
+
* @format GUID
|
|
4757
|
+
*/
|
|
4758
|
+
wixUserId?: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* ID of an app.
|
|
4761
|
+
* @format GUID
|
|
4762
|
+
*/
|
|
4763
|
+
appId?: string;
|
|
4764
|
+
/** @readonly */
|
|
4765
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4766
|
+
}
|
|
4767
|
+
/** @oneof */
|
|
4768
|
+
interface IdentificationDataIdOneOf {
|
|
4769
|
+
/**
|
|
4770
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4771
|
+
* @format GUID
|
|
4772
|
+
*/
|
|
4773
|
+
anonymousVisitorId?: string;
|
|
4774
|
+
/**
|
|
4775
|
+
* ID of a site visitor that has logged in to the site.
|
|
4776
|
+
* @format GUID
|
|
4777
|
+
*/
|
|
4778
|
+
memberId?: string;
|
|
4779
|
+
/**
|
|
4780
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4781
|
+
* @format GUID
|
|
4782
|
+
*/
|
|
4783
|
+
wixUserId?: string;
|
|
4784
|
+
/**
|
|
4785
|
+
* ID of an app.
|
|
4786
|
+
* @format GUID
|
|
4787
|
+
*/
|
|
4788
|
+
appId?: string;
|
|
4789
|
+
}
|
|
4790
|
+
declare enum WebhookIdentityType {
|
|
4791
|
+
UNKNOWN = "UNKNOWN",
|
|
4792
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4793
|
+
MEMBER = "MEMBER",
|
|
4794
|
+
WIX_USER = "WIX_USER",
|
|
4795
|
+
APP = "APP"
|
|
6408
4796
|
}
|
|
6409
|
-
|
|
6410
|
-
|
|
6411
|
-
description?: string;
|
|
6412
|
-
data?: Record<string, any>;
|
|
6413
|
-
} | {
|
|
6414
|
-
code?: 'ORDER_CANCELED';
|
|
6415
|
-
description?: string;
|
|
6416
|
-
data?: Record<string, any>;
|
|
6417
|
-
} | {
|
|
6418
|
-
code?: 'INVALID_AMOUNT';
|
|
6419
|
-
description?: string;
|
|
6420
|
-
data?: Record<string, any>;
|
|
6421
|
-
} | {
|
|
6422
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
6423
|
-
description?: string;
|
|
6424
|
-
data?: Record<string, any>;
|
|
6425
|
-
} | {
|
|
6426
|
-
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
6427
|
-
description?: string;
|
|
6428
|
-
data?: Record<string, any>;
|
|
6429
|
-
};
|
|
6430
|
-
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
6431
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
6432
|
-
description?: string;
|
|
6433
|
-
data?: Record<string, any>;
|
|
6434
|
-
} | {
|
|
6435
|
-
code?: 'INVALID_AMOUNT';
|
|
6436
|
-
description?: string;
|
|
6437
|
-
data?: Record<string, any>;
|
|
6438
|
-
} | {
|
|
6439
|
-
code?: 'ORDER_CANCELED';
|
|
6440
|
-
description?: string;
|
|
6441
|
-
data?: Record<string, any>;
|
|
6442
|
-
};
|
|
6443
|
-
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
6444
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
6445
|
-
description?: string;
|
|
6446
|
-
data?: Record<string, any>;
|
|
6447
|
-
} | {
|
|
6448
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6449
|
-
description?: string;
|
|
6450
|
-
data?: Record<string, any>;
|
|
6451
|
-
};
|
|
6452
|
-
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
6453
|
-
code?: 'ORDER_ALREADY_PAID';
|
|
6454
|
-
description?: string;
|
|
6455
|
-
data?: Record<string, any>;
|
|
6456
|
-
} | {
|
|
6457
|
-
code?: 'ORDER_CANCELED';
|
|
6458
|
-
description?: string;
|
|
6459
|
-
data?: Record<string, any>;
|
|
6460
|
-
};
|
|
6461
|
-
type TriggerRefundApplicationErrors = {
|
|
6462
|
-
code?: 'PAYMENTS_NOT_FOUND';
|
|
6463
|
-
description?: string;
|
|
6464
|
-
data?: Record<string, any>;
|
|
6465
|
-
} | {
|
|
6466
|
-
code?: 'REFUND_NOT_AVAILABLE';
|
|
6467
|
-
description?: string;
|
|
6468
|
-
data?: Record<string, any>;
|
|
6469
|
-
} | {
|
|
6470
|
-
code?: 'INVALID_AMOUNT';
|
|
6471
|
-
description?: string;
|
|
6472
|
-
data?: Record<string, any>;
|
|
6473
|
-
};
|
|
6474
|
-
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
6475
|
-
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6476
|
-
description?: string;
|
|
6477
|
-
data?: Record<string, any>;
|
|
6478
|
-
} | {
|
|
6479
|
-
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6480
|
-
description?: string;
|
|
6481
|
-
data?: Record<string, any>;
|
|
6482
|
-
} | {
|
|
6483
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6484
|
-
description?: string;
|
|
6485
|
-
data?: Record<string, any>;
|
|
6486
|
-
} | {
|
|
6487
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
6488
|
-
description?: string;
|
|
6489
|
-
data?: Record<string, any>;
|
|
6490
|
-
} | {
|
|
6491
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6492
|
-
description?: string;
|
|
6493
|
-
data?: Record<string, any>;
|
|
6494
|
-
};
|
|
6495
|
-
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
6496
|
-
code?: 'INVALID_AMOUNT';
|
|
6497
|
-
description?: string;
|
|
6498
|
-
data?: Record<string, any>;
|
|
6499
|
-
} | {
|
|
6500
|
-
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
6501
|
-
description?: string;
|
|
6502
|
-
data?: Record<string, any>;
|
|
6503
|
-
} | {
|
|
6504
|
-
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6505
|
-
description?: string;
|
|
6506
|
-
data?: Record<string, any>;
|
|
6507
|
-
} | {
|
|
6508
|
-
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6509
|
-
description?: string;
|
|
6510
|
-
data?: Record<string, any>;
|
|
6511
|
-
} | {
|
|
6512
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6513
|
-
description?: string;
|
|
6514
|
-
data?: Record<string, any>;
|
|
6515
|
-
} | {
|
|
6516
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
6517
|
-
description?: string;
|
|
6518
|
-
data?: Record<string, any>;
|
|
6519
|
-
} | {
|
|
6520
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6521
|
-
description?: string;
|
|
6522
|
-
data?: Record<string, any>;
|
|
6523
|
-
} | {
|
|
6524
|
-
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6525
|
-
description?: string;
|
|
6526
|
-
data?: Record<string, any>;
|
|
6527
|
-
};
|
|
4797
|
+
/** @enumType */
|
|
4798
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
6528
4799
|
type GetOrderApplicationErrors = {
|
|
6529
4800
|
code?: 'ORDER_NOT_FOUND';
|
|
6530
4801
|
description?: string;
|
|
@@ -6645,11 +4916,14 @@ interface OrderApprovedEnvelope {
|
|
|
6645
4916
|
* @slug approved
|
|
6646
4917
|
*/
|
|
6647
4918
|
declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
6648
|
-
interface
|
|
6649
|
-
|
|
4919
|
+
interface OrderCanceledEnvelope {
|
|
4920
|
+
data: OrderCanceledEventOrderCanceled;
|
|
6650
4921
|
metadata: EventMetadata;
|
|
6651
4922
|
}
|
|
6652
|
-
/**
|
|
4923
|
+
/**
|
|
4924
|
+
* Triggered when an order is canceled.
|
|
4925
|
+
* 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).
|
|
4926
|
+
* @permissionScope Manage Stores - all permissions
|
|
6653
4927
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6654
4928
|
* @permissionScope Manage Stores
|
|
6655
4929
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
@@ -6667,17 +4941,18 @@ interface OrderUpdatedEnvelope {
|
|
|
6667
4941
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6668
4942
|
* @permissionId ECOM.READ_ORDERS
|
|
6669
4943
|
* @webhook
|
|
6670
|
-
* @eventType wix.ecom.v1.
|
|
6671
|
-
* @
|
|
4944
|
+
* @eventType wix.ecom.v1.order_canceled
|
|
4945
|
+
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
4946
|
+
* @slug canceled
|
|
6672
4947
|
*/
|
|
6673
|
-
declare function
|
|
6674
|
-
interface
|
|
6675
|
-
|
|
4948
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
4949
|
+
interface OrderCreatedEnvelope {
|
|
4950
|
+
entity: Order;
|
|
6676
4951
|
metadata: EventMetadata;
|
|
6677
4952
|
}
|
|
6678
4953
|
/**
|
|
6679
|
-
* Triggered when an order is
|
|
6680
|
-
* Learn more about [
|
|
4954
|
+
* Triggered when an order is created.
|
|
4955
|
+
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
6681
4956
|
* @permissionScope Manage Stores - all permissions
|
|
6682
4957
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6683
4958
|
* @permissionScope Manage Stores
|
|
@@ -6696,18 +4971,17 @@ interface OrderCanceledEnvelope {
|
|
|
6696
4971
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6697
4972
|
* @permissionId ECOM.READ_ORDERS
|
|
6698
4973
|
* @webhook
|
|
6699
|
-
* @eventType wix.ecom.v1.
|
|
4974
|
+
* @eventType wix.ecom.v1.order_created
|
|
6700
4975
|
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6701
|
-
* @slug
|
|
4976
|
+
* @slug created
|
|
6702
4977
|
*/
|
|
6703
|
-
declare function
|
|
6704
|
-
interface
|
|
6705
|
-
|
|
4978
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4979
|
+
interface OrderPaymentStatusUpdatedEnvelope {
|
|
4980
|
+
data: PaymentStatusUpdated;
|
|
6706
4981
|
metadata: EventMetadata;
|
|
6707
4982
|
}
|
|
6708
4983
|
/**
|
|
6709
|
-
* Triggered when an order is
|
|
6710
|
-
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
4984
|
+
* Triggered when an order's payment status is updated.
|
|
6711
4985
|
* @permissionScope Manage Stores - all permissions
|
|
6712
4986
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6713
4987
|
* @permissionScope Manage Stores
|
|
@@ -6726,114 +5000,38 @@ interface OrderCreatedEnvelope {
|
|
|
6726
5000
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6727
5001
|
* @permissionId ECOM.READ_ORDERS
|
|
6728
5002
|
* @webhook
|
|
6729
|
-
* @eventType wix.ecom.v1.
|
|
5003
|
+
* @eventType wix.ecom.v1.order_payment_status_updated
|
|
6730
5004
|
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6731
|
-
* @slug
|
|
6732
|
-
*/
|
|
6733
|
-
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
6734
|
-
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`;
|
|
6735
|
-
/**
|
|
6736
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6737
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6738
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6739
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6740
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6741
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6742
|
-
* @param amount - Amount to collect
|
|
6743
|
-
* @public
|
|
6744
|
-
* @documentationMaturity preview
|
|
6745
|
-
* @requiredField amount
|
|
6746
|
-
* @requiredField ecomOrderId
|
|
6747
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6748
|
-
* @applicableIdentity APP
|
|
6749
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6750
|
-
*/
|
|
6751
|
-
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
6752
|
-
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
6753
|
-
}>;
|
|
6754
|
-
interface PreparePaymentCollectionOptions {
|
|
6755
|
-
/**
|
|
6756
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6757
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
6758
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6759
|
-
*/
|
|
6760
|
-
paymentGatewayOrderId?: string | null;
|
|
6761
|
-
/**
|
|
6762
|
-
* Whether to delay capture of the payment.
|
|
6763
|
-
* Default: false
|
|
6764
|
-
* @deprecated Whether to delay capture of the payment.
|
|
6765
|
-
* Default: false
|
|
6766
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6767
|
-
* @targetRemovalDate 2024-09-30
|
|
6768
|
-
*/
|
|
6769
|
-
delayedCapture?: boolean;
|
|
6770
|
-
/** Delayed capture payment settings */
|
|
6771
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6772
|
-
}
|
|
6773
|
-
/**
|
|
6774
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
6775
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6776
|
-
* reason why payment collection is not possible.
|
|
6777
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6778
|
-
* @public
|
|
6779
|
-
* @documentationMaturity preview
|
|
6780
|
-
* @requiredField ecomOrderId
|
|
6781
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6782
|
-
* @applicableIdentity APP
|
|
6783
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
5005
|
+
* @slug payment_status_updated
|
|
6784
5006
|
*/
|
|
6785
|
-
declare function
|
|
6786
|
-
interface
|
|
6787
|
-
|
|
6788
|
-
|
|
6789
|
-
}
|
|
6790
|
-
interface ChargeMembershipsOptions {
|
|
6791
|
-
/**
|
|
6792
|
-
* List of items to be paid by memberships
|
|
6793
|
-
* @minSize 1
|
|
6794
|
-
* @maxSize 300
|
|
6795
|
-
*/
|
|
6796
|
-
membershipCharges?: MembershipChargeItem[];
|
|
6797
|
-
}
|
|
6798
|
-
interface TriggerRefundOptions {
|
|
6799
|
-
/** Business model of a refund */
|
|
6800
|
-
details?: RefundDetails;
|
|
6801
|
-
/** Side effect details related to refund */
|
|
6802
|
-
sideEffects?: RefundSideEffects;
|
|
5007
|
+
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
5008
|
+
interface OrderUpdatedEnvelope {
|
|
5009
|
+
entity: Order;
|
|
5010
|
+
metadata: EventMetadata;
|
|
6803
5011
|
}
|
|
6804
|
-
/**
|
|
6805
|
-
*
|
|
6806
|
-
*
|
|
6807
|
-
* @
|
|
6808
|
-
* @
|
|
6809
|
-
* @
|
|
6810
|
-
* @
|
|
6811
|
-
* @
|
|
6812
|
-
* @
|
|
6813
|
-
* @
|
|
6814
|
-
* @
|
|
6815
|
-
* @
|
|
6816
|
-
|
|
6817
|
-
|
|
6818
|
-
|
|
6819
|
-
|
|
6820
|
-
|
|
6821
|
-
*
|
|
6822
|
-
*
|
|
6823
|
-
* @
|
|
6824
|
-
* @param payments - Capture payments information
|
|
6825
|
-
* @public
|
|
6826
|
-
* @documentationMaturity preview
|
|
6827
|
-
* @requiredField ecomOrderId
|
|
6828
|
-
* @requiredField payments
|
|
6829
|
-
* @requiredField payments.paymentId
|
|
6830
|
-
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6831
|
-
* @applicableIdentity APP
|
|
6832
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
5012
|
+
/** @permissionScope Manage Stores - all permissions
|
|
5013
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5014
|
+
* @permissionScope Manage Stores
|
|
5015
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
5016
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
5017
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
5018
|
+
* @permissionScope Read Orders
|
|
5019
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
5020
|
+
* @permissionScope Read Stores - all read permissions
|
|
5021
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
5022
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5023
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5024
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
5025
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
5026
|
+
* @permissionScope Manage Orders
|
|
5027
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
5028
|
+
* @permissionId ECOM.READ_ORDERS
|
|
5029
|
+
* @webhook
|
|
5030
|
+
* @eventType wix.ecom.v1.order_updated
|
|
5031
|
+
* @slug updated
|
|
6833
5032
|
*/
|
|
6834
|
-
declare function
|
|
6835
|
-
|
|
6836
|
-
}>;
|
|
5033
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
5034
|
+
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`;
|
|
6837
5035
|
/**
|
|
6838
5036
|
* Retrieves an order.
|
|
6839
5037
|
*
|
|
@@ -7269,6 +5467,23 @@ interface BulkUpdateOrdersOptions {
|
|
|
7269
5467
|
*/
|
|
7270
5468
|
returnEntity?: boolean;
|
|
7271
5469
|
}
|
|
5470
|
+
/** @param _id - Order id to be updated
|
|
5471
|
+
* @internal
|
|
5472
|
+
* @documentationMaturity preview
|
|
5473
|
+
* @requiredField _id
|
|
5474
|
+
* @requiredField options.changes
|
|
5475
|
+
* @requiredField options.changes.priceSummary.subtotal
|
|
5476
|
+
* @requiredField options.changes.priceSummary.total
|
|
5477
|
+
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
5478
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
5479
|
+
* @applicableIdentity APP
|
|
5480
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
5481
|
+
*/
|
|
5482
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
5483
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5484
|
+
}[OrderNonNullablePaths]> & {
|
|
5485
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
5486
|
+
}>;
|
|
7272
5487
|
interface CommitDeltasOptions {
|
|
7273
5488
|
/**
|
|
7274
5489
|
* Draft order Id representing this change.
|
|
@@ -7286,6 +5501,21 @@ interface CommitDeltasOptions {
|
|
|
7286
5501
|
*/
|
|
7287
5502
|
reason?: string | null;
|
|
7288
5503
|
}
|
|
5504
|
+
/** @internal
|
|
5505
|
+
* @documentationMaturity preview
|
|
5506
|
+
* @requiredField identifiers
|
|
5507
|
+
* @requiredField identifiers._id
|
|
5508
|
+
* @requiredField identifiers.lineItemId
|
|
5509
|
+
* @requiredField lineItem
|
|
5510
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5511
|
+
* @applicableIdentity APP
|
|
5512
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
5513
|
+
* @deprecated
|
|
5514
|
+
* @targetRemovalDate 2024-02-15
|
|
5515
|
+
*/
|
|
5516
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
5517
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5518
|
+
}[OrderNonNullablePaths]>>;
|
|
7289
5519
|
interface UpdateOrderLineItemIdentifiers {
|
|
7290
5520
|
/**
|
|
7291
5521
|
* Order ID
|
|
@@ -7409,13 +5639,61 @@ interface UpdateOrderLineItem {
|
|
|
7409
5639
|
locations?: LocationAndQuantity[];
|
|
7410
5640
|
/** Address used for tax calculation. */
|
|
7411
5641
|
taxableAddress?: TaxableAddress;
|
|
5642
|
+
/**
|
|
5643
|
+
* ID of the app managing the inventory.
|
|
5644
|
+
* @internal
|
|
5645
|
+
* @format GUID
|
|
5646
|
+
*/
|
|
5647
|
+
inventoryAppId?: string | null;
|
|
7412
5648
|
/**
|
|
7413
5649
|
* Custom extended fields for the line item object.
|
|
7414
5650
|
*
|
|
7415
5651
|
* [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.
|
|
7416
5652
|
*/
|
|
7417
5653
|
extendedFields?: ExtendedFields;
|
|
5654
|
+
/**
|
|
5655
|
+
* Modifier groups that were added to the item.
|
|
5656
|
+
* @internal
|
|
5657
|
+
* @readonly
|
|
5658
|
+
* @maxSize 10
|
|
5659
|
+
*/
|
|
5660
|
+
modifierGroups?: ModifierGroup[];
|
|
7418
5661
|
}
|
|
5662
|
+
/**
|
|
5663
|
+
* Adds a merchant comment to an order.
|
|
5664
|
+
* > **Note:** Activities with type CustomActivity not supported
|
|
5665
|
+
* @param _id - Order ID.
|
|
5666
|
+
* @param activity - Activity info.
|
|
5667
|
+
* @internal
|
|
5668
|
+
* @documentationMaturity preview
|
|
5669
|
+
* @requiredField _id
|
|
5670
|
+
* @requiredField activity
|
|
5671
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5672
|
+
* @applicableIdentity APP
|
|
5673
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
5674
|
+
* @deprecated
|
|
5675
|
+
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
5676
|
+
* @targetRemovalDate 2024-11-01
|
|
5677
|
+
*/
|
|
5678
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
5679
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5680
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
5681
|
+
/**
|
|
5682
|
+
* Updates an order's activity.
|
|
5683
|
+
* @param activity - Activity info.
|
|
5684
|
+
* @internal
|
|
5685
|
+
* @documentationMaturity preview
|
|
5686
|
+
* @requiredField activity
|
|
5687
|
+
* @requiredField identifiers
|
|
5688
|
+
* @requiredField identifiers._id
|
|
5689
|
+
* @requiredField identifiers.activityId
|
|
5690
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5691
|
+
* @applicableIdentity APP
|
|
5692
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
5693
|
+
*/
|
|
5694
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
5695
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5696
|
+
}[OrderNonNullablePaths]>>;
|
|
7419
5697
|
interface UpdateActivityIdentifiers {
|
|
7420
5698
|
/**
|
|
7421
5699
|
* Order ID.
|
|
@@ -7429,6 +5707,22 @@ interface UpdateActivityIdentifiers {
|
|
|
7429
5707
|
*/
|
|
7430
5708
|
activityId: string;
|
|
7431
5709
|
}
|
|
5710
|
+
/**
|
|
5711
|
+
* Delete's an order's activity.
|
|
5712
|
+
*
|
|
5713
|
+
* Only custom activities and merchant comments can be deleted.
|
|
5714
|
+
* @internal
|
|
5715
|
+
* @documentationMaturity preview
|
|
5716
|
+
* @requiredField identifiers
|
|
5717
|
+
* @requiredField identifiers._id
|
|
5718
|
+
* @requiredField identifiers.activityId
|
|
5719
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
5720
|
+
* @applicableIdentity APP
|
|
5721
|
+
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
5722
|
+
*/
|
|
5723
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
5724
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5725
|
+
}[OrderNonNullablePaths]>>;
|
|
7432
5726
|
interface DeleteActivityIdentifiers {
|
|
7433
5727
|
/**
|
|
7434
5728
|
* Order ID.
|
|
@@ -7471,6 +5765,43 @@ interface CancelOrderOptions {
|
|
|
7471
5765
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
7472
5766
|
restockAllItems?: boolean;
|
|
7473
5767
|
}
|
|
5768
|
+
/**
|
|
5769
|
+
* Updates order status.
|
|
5770
|
+
*
|
|
5771
|
+
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
5772
|
+
* >Updates into INITIALIZED are not supported.
|
|
5773
|
+
*
|
|
5774
|
+
* Approving order:
|
|
5775
|
+
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
5776
|
+
*
|
|
5777
|
+
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
5778
|
+
* will cause an error.
|
|
5779
|
+
*
|
|
5780
|
+
* Setting PENDING status:
|
|
5781
|
+
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
5782
|
+
* @param orderId - Order ID.
|
|
5783
|
+
* @param status - New order status.
|
|
5784
|
+
* @internal
|
|
5785
|
+
* @documentationMaturity preview
|
|
5786
|
+
* @requiredField orderId
|
|
5787
|
+
* @requiredField status
|
|
5788
|
+
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
5789
|
+
* @applicableIdentity APP
|
|
5790
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
5791
|
+
*/
|
|
5792
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
5793
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
5794
|
+
}[OrderNonNullablePaths]> & {
|
|
5795
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
5796
|
+
}>;
|
|
5797
|
+
/** @internal
|
|
5798
|
+
* @documentationMaturity preview
|
|
5799
|
+
* @requiredField options.aggregation
|
|
5800
|
+
* @permissionId ECOM.READ_ORDERS
|
|
5801
|
+
* @applicableIdentity APP
|
|
5802
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
5803
|
+
*/
|
|
5804
|
+
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
7474
5805
|
interface AggregateOrdersOptions {
|
|
7475
5806
|
/** Filter applied to original data */
|
|
7476
5807
|
filter?: Record<string, any> | null;
|
|
@@ -7507,4 +5838,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
7507
5838
|
unassignTags?: Tags;
|
|
7508
5839
|
}
|
|
7509
5840
|
|
|
7510
|
-
export { NonRefundableReason as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, OrderStatus as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, DiscountType as H, ItemTypeItemType as I, JurisdictionType as J, DiscountReason as K, LineItemQuantityChangeType as L, type MaskedOrder as M, ActivityType as N, type Order as O, type Price as P, AttributionSource as Q, ChannelType as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, ScheduledAction as X, DurationUnit as Y, PaymentCollectabilityStatus as Z, RefundableStatus as _, type PreparePaymentCollectionOptions as a, type PriceSummary as a$, ManuallyRefundableReason as a0, RestockType as a1, TransactionStatus as a2, AuthorizationCaptureStatus as a3, AuthorizationVoidStatus as a4, Reason as a5, ActionType as a6, ChargebackStatus as a7, MembershipPaymentStatus as a8, RefundStatus as a9, type Color as aA, type FocalPoint as aB, type PhysicalProperties as aC, type ItemType as aD, type ItemTypeItemTypeDataOneOf as aE, type ItemTaxFullDetails as aF, type LineItemTaxInfo as aG, type LineItemTaxBreakdown as aH, type DigitalFile as aI, type SubscriptionInfo as aJ, type SubscriptionTitle as aK, type SubscriptionDescription as aL, type SubscriptionSettings as aM, type FreeTrialPeriod as aN, type BillingAdjustment as aO, type BillingAdjustmentPriceSummary as aP, type PriceDescription as aQ, type LocationAndQuantity as aR, type TaxableAddress as aS, type TaxableAddressTaxableAddressDataOneOf as aT, type ExtendedFields as aU, type ModifierGroup as aV, type TranslatableString as aW, type ItemModifier as aX, type BuyerInfo as aY, type BuyerInfoIdOneOf as aZ, type CurrencyConversionDetails as a_, WebhookIdentityType as aa, TextDetection as ab, AnimationDetection as ac, PreviewEmailType as ad, State as ae, Namespace as af, SortOrder as ag, VersioningMode as ah, OrderApprovalStrategy as ai, DeltaPaymentOptionType as aj, InventoryAction as ak, Placement as al, SubdivisionType as am, SourceType as an, CustomFieldGroup as ao, ValueType as ap, DepositType as aq, InvoiceStatus as ar, type OrderLineItem as as, type ProductName as at, type CatalogReference as au, type DescriptionLine as av, type DescriptionLineValueOneOf as aw, type DescriptionLineDescriptionLineValueOneOf as ax, type DescriptionLineName as ay, type PlainTextValue as az, type PreparePaymentCollectionResponse as b, type RegularPaymentPaymentMethodDetailsOneOf as b$, type AddressWithContact as b0, type Address as b1, type StreetAddress as b2, type AddressLocation as b3, type FullAddressContactDetails as b4, type VatId as b5, type V1ShippingInformation as b6, type DeliveryLogistics as b7, type DeliveryLogisticsAddressOneOf as b8, type PickupDetails as b9, type LineItemChanges as bA, type LineItemQuantityChange as bB, type LineItemPriceChange as bC, type ManagedLineItem as bD, type ManagedDiscount as bE, type TranslatedValue as bF, type LineItemAmount as bG, type ManagedAdditionalFee as bH, type TotalPriceChange as bI, type ShippingInformationChange as bJ, type ShippingInformation as bK, type SavedPaymentMethod as bL, type AuthorizedPaymentCreated as bM, type AuthorizedPaymentCaptured as bN, type AuthorizedPaymentVoided as bO, type RefundInitiated as bP, type RefundedPayment as bQ, type RefundedPaymentKindOneOf as bR, type RegularPaymentRefund as bS, type GiftCardPaymentRefund as bT, type MembershipPaymentRefund as bU, type PaymentRefunded as bV, type PaymentRefundFailed as bW, type RefundedAsStoreCredit as bX, type PaymentPending as bY, type PaymentPendingPaymentDetailsOneOf as bZ, type RegularPayment as b_, type PickupAddress as ba, type DeliveryTimeSlot as bb, type ShippingPrice as bc, type ShippingRegion as bd, type TaxSummary as be, type OrderTaxInfo as bf, type OrderTaxBreakdown as bg, type AppliedDiscount as bh, type AppliedDiscountDiscountSourceOneOf as bi, type Coupon as bj, type MerchantDiscount as bk, type MerchantDiscountMerchantDiscountReasonOneOf as bl, type DiscountRule as bm, type DiscountRuleName as bn, type LineItemDiscount as bo, type Activity as bp, type ActivityContentOneOf as bq, type CustomActivity as br, type MerchantComment as bs, type OrderRefunded as bt, type OrderCreatedFromExchange as bu, type NewExchangeOrderCreated as bv, type LineItemExchangeData as bw, type DraftOrderChangesApplied as bx, type OrderChange as by, type OrderChangeValueOneOf as bz, type PreparePaymentCollectionApplicationErrors as c, type RefundSideEffects as c$, type CreditCardDetails as c0, type PaymentCanceled as c1, type PaymentCanceledPaymentDetailsOneOf as c2, type PaymentDeclined as c3, type PaymentDeclinedPaymentDetailsOneOf as c4, type ReceiptCreated as c5, type ReceiptCreatedReceiptInfoOneOf as c6, type WixReceipt as c7, type ExternalReceipt as c8, type ReceiptSent as c9, type MarkOrderAsPaidRequest as cA, type MarkOrderAsPaidResponse as cB, type BulkMarkOrdersAsPaidRequest as cC, type BulkMarkOrdersAsPaidResponse as cD, type BulkOrderResult as cE, type ItemMetadata as cF, type ApplicationError as cG, type BulkActionMetadata as cH, type GetRefundabilityStatusRequest as cI, type GetRefundabilityStatusResponse as cJ, type Refundability as cK, type RefundabilityAdditionalRefundabilityInfoOneOf as cL, type CreatePaymentGatewayOrderRequest as cM, type ChargedBy as cN, type CreatePaymentGatewayOrderResponse as cO, type ChargeMembershipsRequest as cP, type MembershipChargeItem as cQ, type MembershipName as cR, type ServiceProperties as cS, type ChargeMembershipsResponse as cT, type TriggerRefundRequest as cU, type PaymentRefund as cV, type RefundDetails as cW, type RefundItem as cX, type LineItemRefund as cY, type AdditionalFeeRefund as cZ, type ShippingRefund as c_, type ReceiptSentReceiptInfoOneOf as ca, type ChargebackCreated as cb, type ChargebackReversed as cc, type CreatedBy as cd, type CreatedByStringOneOf as ce, type ChannelInfo as cf, type CustomField as cg, type BalanceSummary as ch, type Balance as ci, type AdditionalFee as cj, type FulfillmentStatusesAggregate as ck, type Tags as cl, type TagList as cm, type Location as cn, type OrderApproved as co, type OrdersExperiments as cp, type OrderRejectedEventOrderRejected as cq, type OrderItemsRestocked as cr, type V1RestockItem as cs, type PreparePaymentCollectionRequest as ct, type RedirectUrls as cu, type DelayedCaptureSettings as cv, type Duration as cw, type GetPaymentCollectabilityStatusRequest as cx, type RecordManuallyCollectedPaymentRequest as cy, type RecordManuallyCollectedPaymentResponse as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type SendRefundEmailRequest as d$, type RestockInfo as d0, type RestockItem as d1, type TriggerRefundResponse as d2, type OrderTransactions as d3, type Payment as d4, type PaymentPaymentDetailsOneOf as d5, type PaymentReceiptInfoOneOf as d6, type RegularPaymentDetails as d7, type RegularPaymentDetailsPaymentMethodDetailsOneOf as d8, type CreditCardPaymentMethodDetails as d9, type DomainEventBodyOneOf as dA, type EntityCreatedEvent as dB, type RestoreInfo as dC, type EntityUpdatedEvent as dD, type EntityDeletedEvent as dE, type ActionEvent as dF, type Empty as dG, type MessageEnvelope as dH, type IdentificationData as dI, type IdentificationDataIdOneOf as dJ, type ImageContent as dK, type SendBuyerConfirmationEmailRequest as dL, type SendBuyerConfirmationEmailResponse as dM, type SendBuyerPaymentsReceivedEmailRequest as dN, type SendBuyerPaymentsReceivedEmailResponse as dO, type SendBuyerPickupConfirmationEmailRequest as dP, type SendBuyerPickupConfirmationEmailResponse as dQ, type BulkSendBuyerPickupConfirmationEmailsRequest as dR, type BulkSendBuyerPickupConfirmationEmailsResponse as dS, type SendBuyerShippingConfirmationEmailRequest as dT, type SendBuyerShippingConfirmationEmailResponse as dU, type BulkSendBuyerShippingConfirmationEmailsRequest as dV, type BulkSendBuyerShippingConfirmationEmailsResponse as dW, type SendMerchantOrderReceivedNotificationRequest as dX, type SendMerchantOrderReceivedNotificationResponse as dY, type SendCancelRefundEmailRequest as dZ, type SendCancelRefundEmailResponse as d_, type AuthorizationDetails as da, type AuthorizationCapture as db, type AuthorizationActionFailureDetails as dc, type AuthorizationVoid as dd, type V1ScheduledAction as de, type Chargeback as df, type GiftCardPaymentDetails as dg, type MembershipPaymentDetails as dh, type WixReceiptInfo as di, type ExternalReceiptInfo as dj, type Refund as dk, type RefundTransaction as dl, type RefundStatusInfo as dm, type AggregatedRefundSummary as dn, type RefundItemsBreakdown as dp, type LineItemRefundSummary as dq, type CalculateRefundRequest as dr, type CalculateRefundItemRequest as ds, type CalculateRefundResponse as dt, type CalculateRefundItemResponse as du, type VoidAuthorizedPaymentsRequest as dv, type CaptureAuthorizedPaymentsRequest as dw, type ChargeSavedPaymentMethodRequest as dx, type ChargeSavedPaymentMethodResponse as dy, type DomainEvent as dz, type PaymentCapture as e, type InternalDocumentUpdateByFilterOperation as e$, type SendRefundEmailResponse as e0, type SendMerchantOrderReceivedPushRequest as e1, type SendMerchantOrderReceivedPushResponse as e2, type PreviewEmailByTypeRequest as e3, type PreviewEmailByTypeResponse as e4, type PreviewRefundEmailRequest as e5, type PreviewRefundEmailResponse as e6, type PreviewCancelEmailRequest as e7, type PreviewCancelEmailResponse as e8, type PreviewCancelRefundEmailRequest as e9, type PlatformQueryPagingMethodOneOf as eA, type Sorting as eB, type PlatformPaging as eC, type CursorPaging as eD, type QueryOrdersForMetasiteResponse as eE, type PlatformPagingMetadata as eF, type Cursors as eG, type GetOrderForMetasiteRequest as eH, type GetOrderForMetasiteResponse as eI, type ListOrderTransactionsForMetasiteRequest as eJ, type ListOrderTransactionsForMetasiteResponse as eK, type UpsertRefundRequest as eL, type UpsertRefundResponse as eM, type GetOrderOutOfBoxRequest as eN, type GetOrderOutOfBoxResponse as eO, type GetOrderAgcRequest as eP, type GetOrderAgcResponse as eQ, type GetOrderWithFilterByLocationRequest as eR, type GetOrderWithFilterByLocationResponse as eS, type V1UpdateOrderRequest as eT, type V1UpdateOrderResponse as eU, type UpdateInternalDocumentsEvent as eV, type UpdateInternalDocumentsEventOperationOneOf as eW, type InternalDocument as eX, type InternalDocumentUpdateOperation as eY, type DeleteByIdsOperation as eZ, type DeleteByFilterOperation as e_, type PreviewCancelRefundEmailResponse as ea, type PreviewBuyerPaymentsReceivedEmailRequest as eb, type PreviewBuyerPaymentsReceivedEmailResponse as ec, type PreviewBuyerConfirmationEmailRequest as ed, type PreviewBuyerConfirmationEmailResponse as ee, type PreviewBuyerPickupConfirmationEmailRequest as ef, type PreviewBuyerPickupConfirmationEmailResponse as eg, type PreviewShippingConfirmationEmailRequest as eh, type PreviewShippingConfirmationEmailResponse as ei, type PreviewResendDownloadLinksEmailRequest as ej, type PreviewResendDownloadLinksEmailResponse as ek, type TriggerReindexOrderRequest as el, type SnapshotMessage as em, type PaymentStatusUpdated as en, type GetMetasiteDataRequest as eo, type GetMetasiteDataResponse as ep, type MetaSite as eq, type App as er, type SeoData as es, type MetaTag as et, type HtmlApplication as eu, type ExternalUriMapping as ev, type UserDataResponse as ew, type QueryOrdersForMetasiteRequest as ex, type InternalQueryOrdersRequest as ey, type PlatformQuery as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type UpdateBuyerInfoResponse as f$, type InternalUpdateExistingOperation as f0, type VersionedDocumentUpdateOperation as f1, type VersionedDeleteByIdsOperation as f2, type VersionedDocumentId as f3, type TriggerReindexRequest as f4, type TriggerReindexResponse as f5, type BatchOfTriggerReindexOrderRequest as f6, type DiffmatokyPayload as f7, type ErrorInformation as f8, type ContinueSideEffectsFlowInLegacyData as f9, type ItemChangedDetails as fA, type AppliedDiscountDelta as fB, type AppliedDiscountDeltaDeltaOneOf as fC, type AdditionalFeeDelta as fD, type AdditionalFeeDeltaDeltaOneOf as fE, type DraftOrderCommitSettings as fF, type InventoryUpdateDetails as fG, type CommitDeltasResponse as fH, type OrderDeltasCommitted as fI, type CommittedDiffs as fJ, type CommittedDiffsShippingUpdateInfoOneOf as fK, type LineItemDelta as fL, type LineItemDeltaDeltaOneOf as fM, type ArchiveOrderRequest as fN, type ArchiveOrderResponse as fO, type BulkArchiveOrdersRequest as fP, type BulkArchiveOrdersResponse as fQ, type BulkArchiveOrdersByFilterRequest as fR, type BulkArchiveOrdersByFilterResponse as fS, type UnArchiveOrderRequest as fT, type UnArchiveOrderResponse as fU, type BulkUnArchiveOrdersRequest as fV, type BulkUnArchiveOrdersResponse as fW, type BulkUnArchiveOrdersByFilterRequest as fX, type BulkUnArchiveOrdersByFilterResponse as fY, type UpdateBuyerInfoRequest as fZ, type BuyerInfoUpdate as f_, type IndexingMessage as fa, type GetOrderRequest as fb, type GetOrderResponse as fc, type InternalQueryOrdersResponse as fd, type QueryOrderRequest as fe, type QueryOrderResponse as ff, type SearchOrdersRequest as fg, type CursorSearch as fh, type CursorSearchPagingMethodOneOf as fi, type CursorPagingMetadata as fj, type CreateOrderRequest as fk, type OrderCreationSettings as fl, type OrderCreateNotifications as fm, type CreateOrderResponse as fn, type UpdateOrderRequest as fo, type UpdateOrderResponse as fp, type BulkUpdateOrdersRequest as fq, type CommitDeltasRequest as fr, type DraftOrderDiffs as fs, type DraftOrderDiffsShippingUpdateInfoOneOf as ft, type DraftOrderDiffsBuyerUpdateInfoOneOf as fu, type DraftOrderDiffsBillingUpdateInfoOneOf as fv, type DraftOrderDiffsRecipientUpdateInfoOneOf as fw, type V1LineItemDelta as fx, type V1LineItemDeltaDeltaOneOf as fy, type OrderLineItemChangedDetails as fz, type GetOrderApplicationErrors as g, type BulkMarkAsUnfulfilledResponse as g$, type UpdateBuyerEmailRequest as g0, type UpdateBuyerEmailResponse as g1, type UpdateOrderShippingAddressRequest as g2, type UpdateOrderShippingAddressResponse as g3, type UpdateBillingContactDetailsRequest as g4, type UpdateBillingContactDetailsResponse as g5, type UpdateOrderLineItemRequest as g6, type UpdateOrderLineItemResponse as g7, type UpdateOrderLineItemsRequest as g8, type MaskedOrderLineItem as g9, type PublicActivityContentOneOf as gA, type AddActivityResponse as gB, type AddActivitiesRequest as gC, type AddActivitiesResponse as gD, type UpdateActivityRequest as gE, type UpdateActivityResponse as gF, type DeleteActivityRequest as gG, type DeleteActivityResponse as gH, type UpdateLineItemsDescriptionLinesRequest as gI, type LineItemUpdate as gJ, type UpdateLineItemsDescriptionLinesResponse as gK, type MarkOrderAsSeenByHumanRequest as gL, type MarkOrderAsSeenByHumanResponse as gM, type CancelOrderRequest as gN, type OrderCanceledEventOrderCanceled as gO, type UpdateOrderStatusRequest as gP, type UpdateOrderStatusResponse as gQ, type MarkAsFulfilledRequest as gR, type MarkAsFulfilledResponse as gS, type FulfillmentStatusUpdated as gT, type BulkMarkAsFulfilledRequest as gU, type BulkMarkAsFulfilledResponse as gV, type BulkMarkAsFulfilledByFilterRequest as gW, type BulkMarkAsFulfilledByFilterResponse as gX, type MarkAsUnfulfilledRequest as gY, type MarkAsUnfulfilledResponse as gZ, type BulkMarkAsUnfulfilledRequest as g_, type UpdateOrderLineItemsResponse as ga, type AddInternalActivityRequest as gb, type InternalActivity as gc, type InternalActivityContentOneOf as gd, type OrderPlaced as ge, type OrderPaid as gf, type OrderFulfilled as gg, type OrderNotFulfilled as gh, type OrderCanceled as gi, type DownloadLinkSent as gj, type TrackingNumberAdded as gk, type TrackingNumberEdited as gl, type TrackingLinkAdded as gm, type ShippingConfirmationEmailSent as gn, type InvoiceAdded as go, type InvoiceSent as gp, type FulfillerEmailSent as gq, type ShippingAddressEdited as gr, type EmailEdited as gs, type PickupReadyEmailSent as gt, type OrderPartiallyPaid as gu, type OrderPending as gv, type OrderRejected as gw, type AddInternalActivityResponse as gx, type AddActivityRequest as gy, type PublicActivity as gz, type OrderSearch as h, type EventMetadata as h$, type BulkMarkAsUnfulfilledByFilterRequest as h0, type BulkMarkAsUnfulfilledByFilterResponse as h1, type BulkSetBusinessLocationRequest as h2, type BulkSetBusinessLocationResponse as h3, type BulkSetBusinessLocationResult as h4, type V1MarkOrderAsPaidRequest as h5, type V1MarkOrderAsPaidResponse as h6, type V1BulkMarkOrdersAsPaidRequest as h7, type V1BulkMarkOrdersAsPaidResponse as h8, type V1CreatePaymentGatewayOrderRequest as h9, type CommonAddress as hA, type CommonAddressStreetOneOf as hB, type Subdivision as hC, type StandardDetails as hD, type InvoiceDates as hE, type LineItems as hF, type LineItem as hG, type BigDecimalWrapper as hH, type LineItemTax as hI, type Source as hJ, type LineItemMetaData as hK, type Locale as hL, type TotalPrice as hM, type ItemizedFee as hN, type Discount as hO, type DiscountOneDiscountTypeOneOf as hP, type CalculatedTaxes as hQ, type CalculatedTax as hR, type Payments as hS, type InvoicesPayment as hT, type MetaData as hU, type InvoiceDynamicPriceTotals as hV, type CustomFieldValue as hW, type Value as hX, type Deposit as hY, type TriggerSideEffectsFromLegacyData as hZ, type BaseEventMetadata as h_, type V1CreatePaymentGatewayOrderResponse as ha, type GetShipmentsRequest as hb, type GetShipmentsResponse as hc, type AggregateOrdersRequest as hd, type AggregateOrdersResponse as he, type DecrementItemsQuantityRequest as hf, type DecrementData as hg, type DecrementItemsQuantityResponse as hh, type BulkUpdateOrderTagsRequest as hi, type BulkUpdateOrderTagsResult as hj, type Task as hk, type TaskKey as hl, type TaskAction as hm, type TaskActionActionOneOf as hn, type Complete as ho, type Cancel as hp, type Reschedule as hq, type InvoiceSentEvent as hr, type IdAndVersion as hs, type InvoiceFields as ht, type Customer as hu, type Email as hv, type QuotesAddress as hw, type AddressDescription as hx, type Phone as hy, type Company as hz, type CreateOrderOptions as i, type InvoiceStatusWithLiterals as i$, type PaymentCollectionCreatePaymentGatewayOrderOptions as i0, type ChargeMembershipsOptions as i1, type TriggerRefundOptions as i2, type OrderSearchSpec as i3, type CommitDeltasOptions as i4, type UpdateOrderLineItemIdentifiers as i5, type UpdateOrderLineItem as i6, type UpdateActivityIdentifiers as i7, type DeleteActivityIdentifiers as i8, type AggregateOrdersOptions as i9, type ManuallyRefundableReasonWithLiterals as iA, type RestockTypeWithLiterals as iB, type TransactionStatusWithLiterals as iC, type AuthorizationCaptureStatusWithLiterals as iD, type AuthorizationVoidStatusWithLiterals as iE, type ReasonWithLiterals as iF, type ActionTypeWithLiterals as iG, type ChargebackStatusWithLiterals as iH, type MembershipPaymentStatusWithLiterals as iI, type RefundStatusWithLiterals as iJ, type WebhookIdentityTypeWithLiterals as iK, type TextDetectionWithLiterals as iL, type AnimationDetectionWithLiterals as iM, type PreviewEmailTypeWithLiterals as iN, type StateWithLiterals as iO, type NamespaceWithLiterals as iP, type SortOrderWithLiterals as iQ, type VersioningModeWithLiterals as iR, type OrderApprovalStrategyWithLiterals as iS, type DeltaPaymentOptionTypeWithLiterals as iT, type InventoryActionWithLiterals as iU, type PlacementWithLiterals as iV, type SubdivisionTypeWithLiterals as iW, type SourceTypeWithLiterals as iX, type CustomFieldGroupWithLiterals as iY, type ValueTypeWithLiterals as iZ, type DepositTypeWithLiterals as i_, type DescriptionLineTypeWithLiterals as ia, type ItemTypeItemTypeWithLiterals as ib, type PaymentOptionTypeWithLiterals as ic, type JurisdictionTypeWithLiterals as id, type SubscriptionFrequencyWithLiterals as ie, type AdjustmentTypeWithLiterals as ig, type TaxableAddressTypeWithLiterals as ih, type PaymentStatusWithLiterals as ii, type FulfillmentStatusWithLiterals as ij, type WeightUnitWithLiterals as ik, type VatTypeWithLiterals as il, type PickupMethodWithLiterals as im, type OrderStatusWithLiterals as io, type DiscountTypeWithLiterals as ip, type DiscountReasonWithLiterals as iq, type LineItemQuantityChangeTypeWithLiterals as ir, type ActivityTypeWithLiterals as is, type AttributionSourceWithLiterals as it, type ChannelTypeWithLiterals as iu, type ScheduledActionWithLiterals as iv, type DurationUnitWithLiterals as iw, type PaymentCollectabilityStatusWithLiterals as ix, type RefundableStatusWithLiterals as iy, type NonRefundableReasonWithLiterals as iz, type CreateOrderApplicationErrors as j, type RecordManuallyCollectedPaymentApplicationErrors as j0, type PaymentCollectionMarkOrderAsPaidApplicationErrors as j1, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as j2, type TriggerRefundApplicationErrors as j3, type CommitDeltasApplicationErrors as j4, type UpdateOrderStatusApplicationErrors as j5, onOrderApproved as j6, onOrderUpdated as j7, onOrderCanceled as j8, onOrderCreated as j9, preparePaymentCollection as ja, getPaymentCollectabilityStatus as jb, voidAuthorizedPayments as jc, captureAuthorizedPayments as jd, getOrder as je, type CommonSearchWithEntityContext as jf, createOrder as jg, updateOrder as jh, bulkUpdateOrders as ji, cancelOrder as jj, bulkUpdateOrderTags as jk, type UpdateOrderApplicationErrors as k, type BulkUpdateOrdersResponse as l, type CancelOrderOptions as m, type CancelOrderResponse as n, type CancelOrderApplicationErrors as o, type BulkUpdateOrderTagsOptions as p, type BulkUpdateOrderTagsResponse as q, type OrderApprovedEnvelope as r, type OrderUpdatedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCreatedEnvelope as u, PaymentOptionType as v, SubscriptionFrequency as w, PaymentStatus as x, VatType as y, PickupMethod as z };
|
|
5841
|
+
export { LineItemQuantityChangeType as $, type AddActivityResponse as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, type DeleteActivityIdentifiers as D, type OrderPaymentStatusUpdatedEnvelope as E, type OrderUpdatedEnvelope as F, type GetOrderApplicationErrors as G, DescriptionLineType as H, ItemTypeItemType as I, PaymentOptionType as J, JurisdictionType as K, SubscriptionFrequency as L, type MaskedOrder as M, AdjustmentType as N, type Order as O, type PublicActivity as P, PaymentStatus as Q, FulfillmentStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, PickupMethod as X, OrderStatus as Y, DiscountType as Z, DiscountReason as _, type OrderSearch as a, type DeliveryTimeSlot as a$, ActivityType as a0, AttributionSource as a1, ChannelType as a2, SortOrder as a3, OrderApprovalStrategy as a4, DeltaPaymentOptionType as a5, InventoryAction as a6, Placement as a7, SubdivisionType as a8, SourceType as a9, type SubscriptionSettings as aA, type FreeTrialPeriod as aB, type BillingAdjustment as aC, type BillingAdjustmentPriceSummary as aD, type PriceDescription as aE, type LocationAndQuantity as aF, type TaxableAddress as aG, type TaxableAddressTaxableAddressDataOneOf as aH, type ExtendedFields as aI, type ModifierGroup as aJ, type TranslatableString as aK, type ItemModifier as aL, type BuyerInfo as aM, type BuyerInfoIdOneOf as aN, type CurrencyConversionDetails as aO, type PriceSummary as aP, type AddressWithContact as aQ, type Address as aR, type StreetAddress as aS, type AddressLocation as aT, type FullAddressContactDetails as aU, type VatId as aV, type V1ShippingInformation as aW, type DeliveryLogistics as aX, type DeliveryLogisticsAddressOneOf as aY, type PickupDetails as aZ, type PickupAddress as a_, CustomFieldGroup as aa, ValueType as ab, DepositType as ac, InvoiceStatus as ad, WebhookIdentityType as ae, type OrderLineItem as af, type ProductName as ag, type CatalogReference as ah, type Price as ai, type DescriptionLine as aj, type DescriptionLineValueOneOf as ak, type DescriptionLineDescriptionLineValueOneOf as al, type DescriptionLineName as am, type PlainTextValue as an, type Color as ao, type FocalPoint as ap, type PhysicalProperties as aq, type ItemType as ar, type ItemTypeItemTypeDataOneOf as as, type ItemTaxFullDetails as at, type LineItemTaxInfo as au, type LineItemTaxBreakdown as av, type DigitalFile as aw, type SubscriptionInfo as ax, type SubscriptionTitle as ay, type SubscriptionDescription as az, type CreateOrderApplicationErrors as b, type ChargebackCreated as b$, type ShippingPrice as b0, type ShippingRegion as b1, type TaxSummary as b2, type OrderTaxInfo as b3, type OrderTaxBreakdown as b4, type AppliedDiscount as b5, type AppliedDiscountDiscountSourceOneOf as b6, type Coupon as b7, type MerchantDiscount as b8, type MerchantDiscountMerchantDiscountReasonOneOf as b9, type AuthorizedPaymentCreated as bA, type AuthorizedPaymentCaptured as bB, type AuthorizedPaymentVoided as bC, type RefundInitiated as bD, type RefundedPayment as bE, type RefundedPaymentKindOneOf as bF, type RegularPaymentRefund as bG, type GiftCardPaymentRefund as bH, type MembershipPaymentRefund as bI, type PaymentRefunded as bJ, type PaymentRefundFailed as bK, type RefundedAsStoreCredit as bL, type PaymentPending as bM, type PaymentPendingPaymentDetailsOneOf as bN, type RegularPayment as bO, type RegularPaymentPaymentMethodDetailsOneOf as bP, type CreditCardDetails as bQ, type PaymentCanceled as bR, type PaymentCanceledPaymentDetailsOneOf as bS, type PaymentDeclined as bT, type PaymentDeclinedPaymentDetailsOneOf as bU, type ReceiptCreated as bV, type ReceiptCreatedReceiptInfoOneOf as bW, type WixReceipt as bX, type ExternalReceipt as bY, type ReceiptSent as bZ, type ReceiptSentReceiptInfoOneOf as b_, type DiscountRule as ba, type DiscountRuleName as bb, type LineItemDiscount as bc, type Activity as bd, type ActivityContentOneOf as be, type CustomActivity as bf, type MerchantComment as bg, type OrderRefunded as bh, type OrderCreatedFromExchange as bi, type NewExchangeOrderCreated as bj, type LineItemExchangeData as bk, type DraftOrderChangesApplied as bl, type OrderChange as bm, type OrderChangeValueOneOf as bn, type LineItemChanges as bo, type LineItemQuantityChange as bp, type LineItemPriceChange as bq, type ManagedLineItem as br, type ManagedDiscount as bs, type TranslatedValue as bt, type LineItemAmount as bu, type ManagedAdditionalFee as bv, type TotalPriceChange as bw, type ShippingInformationChange as bx, type ShippingInformation as by, type SavedPaymentMethod as bz, type UpdateOrderApplicationErrors as c, type AdditionalFeeDeltaDeltaOneOf as c$, type ChargebackReversed as c0, type CreatedBy as c1, type CreatedByStringOneOf as c2, type ChannelInfo as c3, type CustomField as c4, type BalanceSummary as c5, type Balance as c6, type AdditionalFee as c7, type FulfillmentStatusesAggregate as c8, type Tags as c9, type CursorSearch as cA, type CursorSearchPagingMethodOneOf as cB, type CursorPagingMetadata as cC, type CreateOrderRequest as cD, type OrderCreationSettings as cE, type OrderCreateNotifications as cF, type CreateOrderResponse as cG, type UpdateOrderRequest as cH, type UpdateOrderResponse as cI, type BulkUpdateOrdersRequest as cJ, type BulkOrderResult as cK, type ItemMetadata as cL, type ApplicationError as cM, type BulkActionMetadata as cN, type CommitDeltasRequest as cO, type DraftOrderDiffs as cP, type DraftOrderDiffsShippingUpdateInfoOneOf as cQ, type DraftOrderDiffsBuyerUpdateInfoOneOf as cR, type DraftOrderDiffsBillingUpdateInfoOneOf as cS, type DraftOrderDiffsRecipientUpdateInfoOneOf as cT, type V1LineItemDelta as cU, type V1LineItemDeltaDeltaOneOf as cV, type OrderLineItemChangedDetails as cW, type ItemChangedDetails as cX, type AppliedDiscountDelta as cY, type AppliedDiscountDeltaDeltaOneOf as cZ, type AdditionalFeeDelta as c_, type TagList as ca, type Location as cb, type DiffmatokyPayload as cc, type ErrorInformation as cd, type ContinueSideEffectsFlowInLegacyData as ce, type OrdersExperiments as cf, type SnapshotMessage as cg, type IndexingMessage as ch, type OrderApproved as ci, type OrderRejectedEventOrderRejected as cj, type OrderItemsRestocked as ck, type RestockItem as cl, type GetOrderRequest as cm, type GetOrderResponse as cn, type InternalQueryOrdersRequest as co, type PlatformQuery as cp, type PlatformQueryPagingMethodOneOf as cq, type Sorting as cr, type PlatformPaging as cs, type CursorPaging as ct, type InternalQueryOrdersResponse as cu, type PlatformPagingMetadata as cv, type Cursors as cw, type QueryOrderRequest as cx, type QueryOrderResponse as cy, type SearchOrdersRequest as cz, type BulkUpdateOrdersResponse as d, type LineItemUpdate as d$, type DraftOrderCommitSettings as d0, type InventoryUpdateDetails as d1, type OrderDeltasCommitted as d2, type CommittedDiffs as d3, type CommittedDiffsShippingUpdateInfoOneOf as d4, type LineItemDelta as d5, type LineItemDeltaDeltaOneOf as d6, type ArchiveOrderRequest as d7, type ArchiveOrderResponse as d8, type BulkArchiveOrdersRequest as d9, type OrderPlaced as dA, type OrderPaid as dB, type OrderFulfilled as dC, type OrderNotFulfilled as dD, type OrderCanceled as dE, type DownloadLinkSent as dF, type TrackingNumberAdded as dG, type TrackingNumberEdited as dH, type TrackingLinkAdded as dI, type ShippingConfirmationEmailSent as dJ, type InvoiceAdded as dK, type InvoiceSent as dL, type FulfillerEmailSent as dM, type ShippingAddressEdited as dN, type EmailEdited as dO, type PickupReadyEmailSent as dP, type OrderPartiallyPaid as dQ, type OrderPending as dR, type OrderRejected as dS, type AddInternalActivityResponse as dT, type AddActivityRequest as dU, type PublicActivityContentOneOf as dV, type AddActivitiesRequest as dW, type AddActivitiesResponse as dX, type UpdateActivityRequest as dY, type DeleteActivityRequest as dZ, type UpdateLineItemsDescriptionLinesRequest as d_, type BulkArchiveOrdersResponse as da, type BulkArchiveOrdersByFilterRequest as db, type BulkArchiveOrdersByFilterResponse as dc, type UnArchiveOrderRequest as dd, type UnArchiveOrderResponse as de, type BulkUnArchiveOrdersRequest as df, type BulkUnArchiveOrdersResponse as dg, type BulkUnArchiveOrdersByFilterRequest as dh, type BulkUnArchiveOrdersByFilterResponse as di, type UpdateBuyerInfoRequest as dj, type BuyerInfoUpdate as dk, type UpdateBuyerInfoResponse as dl, type UpdateBuyerEmailRequest as dm, type UpdateBuyerEmailResponse as dn, type UpdateOrderShippingAddressRequest as dp, type UpdateOrderShippingAddressResponse as dq, type UpdateBillingContactDetailsRequest as dr, type UpdateBillingContactDetailsResponse as ds, type UpdateOrderLineItemRequest as dt, type UpdateOrderLineItemsRequest as du, type MaskedOrderLineItem as dv, type UpdateOrderLineItemsResponse as dw, type AddInternalActivityRequest as dx, type InternalActivity as dy, type InternalActivityContentOneOf as dz, type CommitDeltasOptions as e, type Subdivision as e$, type UpdateLineItemsDescriptionLinesResponse as e0, type MarkOrderAsSeenByHumanRequest as e1, type MarkOrderAsSeenByHumanResponse as e2, type CancelOrderRequest as e3, type OrderCanceledEventOrderCanceled as e4, type UpdateOrderStatusRequest as e5, type MarkAsFulfilledRequest as e6, type MarkAsFulfilledResponse as e7, type FulfillmentStatusUpdated as e8, type BulkMarkAsFulfilledRequest as e9, type BulkUpdateOrderTagsResult as eA, type DomainEvent as eB, type DomainEventBodyOneOf as eC, type EntityCreatedEvent as eD, type RestoreInfo as eE, type EntityUpdatedEvent as eF, type EntityDeletedEvent as eG, type ActionEvent as eH, type Empty as eI, type Task as eJ, type TaskKey as eK, type TaskAction as eL, type TaskActionActionOneOf as eM, type Complete as eN, type Cancel as eO, type Reschedule as eP, type InvoiceSentEvent as eQ, type IdAndVersion as eR, type InvoiceFields as eS, type Customer as eT, type Email as eU, type QuotesAddress as eV, type AddressDescription as eW, type Phone as eX, type Company as eY, type CommonAddress as eZ, type CommonAddressStreetOneOf as e_, type BulkMarkAsFulfilledResponse as ea, type BulkMarkAsFulfilledByFilterRequest as eb, type BulkMarkAsFulfilledByFilterResponse as ec, type MarkAsUnfulfilledRequest as ed, type MarkAsUnfulfilledResponse as ee, type BulkMarkAsUnfulfilledRequest as ef, type BulkMarkAsUnfulfilledResponse as eg, type BulkMarkAsUnfulfilledByFilterRequest as eh, type BulkMarkAsUnfulfilledByFilterResponse as ei, type BulkSetBusinessLocationRequest as ej, type BulkSetBusinessLocationResponse as ek, type BulkSetBusinessLocationResult as el, type MarkOrderAsPaidRequest as em, type MarkOrderAsPaidResponse as en, type PaymentStatusUpdated as eo, type BulkMarkOrdersAsPaidRequest as ep, type BulkMarkOrdersAsPaidResponse as eq, type CreatePaymentGatewayOrderRequest as er, type CreatePaymentGatewayOrderResponse as es, type GetShipmentsRequest as et, type GetShipmentsResponse as eu, type AggregateOrdersRequest as ev, type DecrementItemsQuantityRequest as ew, type DecrementData as ex, type DecrementItemsQuantityResponse as ey, type BulkUpdateOrderTagsRequest as ez, type CommitDeltasResponse as f, onOrderUpdated as f$, type StandardDetails as f0, type InvoiceDates as f1, type LineItems as f2, type LineItem as f3, type BigDecimalWrapper as f4, type LineItemTax as f5, type Source as f6, type LineItemMetaData as f7, type Locale as f8, type TotalPrice as f9, type PaymentStatusWithLiterals as fA, type FulfillmentStatusWithLiterals as fB, type WeightUnitWithLiterals as fC, type VatTypeWithLiterals as fD, type PickupMethodWithLiterals as fE, type DiscountTypeWithLiterals as fF, type DiscountReasonWithLiterals as fG, type LineItemQuantityChangeTypeWithLiterals as fH, type ActivityTypeWithLiterals as fI, type AttributionSourceWithLiterals as fJ, type ChannelTypeWithLiterals as fK, type SortOrderWithLiterals as fL, type OrderApprovalStrategyWithLiterals as fM, type DeltaPaymentOptionTypeWithLiterals as fN, type InventoryActionWithLiterals as fO, type PlacementWithLiterals as fP, type SubdivisionTypeWithLiterals as fQ, type SourceTypeWithLiterals as fR, type CustomFieldGroupWithLiterals as fS, type ValueTypeWithLiterals as fT, type DepositTypeWithLiterals as fU, type InvoiceStatusWithLiterals as fV, type WebhookIdentityTypeWithLiterals as fW, onOrderApproved as fX, onOrderCanceled as fY, onOrderCreated as fZ, onOrderPaymentStatusUpdated as f_, type ItemizedFee as fa, type Discount as fb, type DiscountOneDiscountTypeOneOf as fc, type CalculatedTaxes as fd, type CalculatedTax as fe, type Payments as ff, type Payment as fg, type MetaData as fh, type InvoiceDynamicPriceTotals as fi, type CustomFieldValue as fj, type Value as fk, type Deposit as fl, type TriggerSideEffectsFromLegacyData as fm, type MessageEnvelope as fn, type IdentificationData as fo, type IdentificationDataIdOneOf as fp, type BaseEventMetadata as fq, type EventMetadata as fr, type OrderSearchSpec as fs, type DescriptionLineTypeWithLiterals as ft, type ItemTypeItemTypeWithLiterals as fu, type PaymentOptionTypeWithLiterals as fv, type JurisdictionTypeWithLiterals as fw, type SubscriptionFrequencyWithLiterals as fx, type AdjustmentTypeWithLiterals as fy, type TaxableAddressTypeWithLiterals as fz, type CommitDeltasApplicationErrors as g, getOrder as g0, type CommonSearchWithEntityContext as g1, createOrder as g2, updateOrder as g3, bulkUpdateOrders as g4, commitDeltas as g5, updateOrderLineItem as g6, addActivity as g7, updateActivity as g8, deleteActivity as g9, cancelOrder as ga, updateOrderStatus as gb, aggregateOrders as gc, bulkUpdateOrderTags as gd, type UpdateOrderLineItemIdentifiers as h, type UpdateOrderLineItem as i, type UpdateOrderLineItemResponse as j, type UpdateActivityIdentifiers as k, type UpdateActivityResponse as l, type DeleteActivityResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type OrderStatusWithLiterals as q, type UpdateOrderStatusResponse as r, type UpdateOrderStatusApplicationErrors as s, type AggregateOrdersOptions as t, type AggregateOrdersResponse as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCreatedEnvelope as z };
|