@wix/auto_sdk_ecom_orders 1.0.71 → 1.0.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/ecom-v1-order-orders.universal-BuGgtT93.d.ts → cjs/ecom-v1-order-orders.universal-DepMBjXB.d.ts} +1796 -767
- package/build/cjs/index.d.ts +56 -3
- package/build/cjs/index.js +1044 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +1268 -332
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1006 -38
- package/build/cjs/meta.js +637 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-BuGgtT93.d.mts → es/ecom-v1-order-orders.universal-DepMBjXB.d.mts} +1796 -767
- package/build/es/index.d.mts +56 -3
- package/build/es/index.mjs +1016 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +1240 -331
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1006 -38
- package/build/es/meta.mjs +625 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-B51dgVhk.d.ts → internal/cjs/ecom-v1-order-orders.universal-CHeSUY50.d.ts} +2473 -253
- package/build/internal/cjs/index.d.ts +162 -3
- package/build/internal/cjs/index.js +1044 -8
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +1268 -332
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1006 -38
- package/build/internal/cjs/meta.js +637 -2
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-B51dgVhk.d.mts → internal/es/ecom-v1-order-orders.universal-CHeSUY50.d.mts} +2473 -253
- package/build/internal/es/index.d.mts +162 -3
- package/build/internal/es/index.mjs +1016 -7
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +1240 -331
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1006 -38
- package/build/internal/es/meta.mjs +625 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -283,12 +283,25 @@ interface OrderLineItem {
|
|
|
283
283
|
locations?: LocationAndQuantity[];
|
|
284
284
|
/** Address used for tax calculation. */
|
|
285
285
|
taxableAddress?: TaxableAddress;
|
|
286
|
+
/**
|
|
287
|
+
* ID of the app managing the inventory.
|
|
288
|
+
* @internal
|
|
289
|
+
* @format GUID
|
|
290
|
+
*/
|
|
291
|
+
inventoryAppId?: string | null;
|
|
286
292
|
/**
|
|
287
293
|
* Custom extended fields for the line item object.
|
|
288
294
|
*
|
|
289
295
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
290
296
|
*/
|
|
291
297
|
extendedFields?: ExtendedFields;
|
|
298
|
+
/**
|
|
299
|
+
* Modifier groups that were added to the item.
|
|
300
|
+
* @internal
|
|
301
|
+
* @readonly
|
|
302
|
+
* @maxSize 10
|
|
303
|
+
*/
|
|
304
|
+
modifierGroups?: ModifierGroup[];
|
|
292
305
|
}
|
|
293
306
|
interface ProductName {
|
|
294
307
|
/**
|
|
@@ -359,6 +372,11 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
359
372
|
colorInfo?: Color;
|
|
360
373
|
/** Description line name. */
|
|
361
374
|
name?: DescriptionLineName;
|
|
375
|
+
/**
|
|
376
|
+
* Whether the description line originates from a modifier.
|
|
377
|
+
* @internal
|
|
378
|
+
*/
|
|
379
|
+
modifierDescriptionLine?: boolean;
|
|
362
380
|
}
|
|
363
381
|
/** @oneof */
|
|
364
382
|
interface DescriptionLineValueOneOf {
|
|
@@ -603,6 +621,11 @@ interface SubscriptionInfo {
|
|
|
603
621
|
* @targetRemovalDate 2025-10-01
|
|
604
622
|
*/
|
|
605
623
|
subscriptionOptionTitle?: string;
|
|
624
|
+
/**
|
|
625
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
title?: SubscriptionTitle;
|
|
606
629
|
/**
|
|
607
630
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
608
631
|
* @maxLength 60
|
|
@@ -611,6 +634,11 @@ interface SubscriptionInfo {
|
|
|
611
634
|
* @targetRemovalDate 2025-10-01
|
|
612
635
|
*/
|
|
613
636
|
subscriptionOptionDescription?: string | null;
|
|
637
|
+
/**
|
|
638
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
639
|
+
* @internal
|
|
640
|
+
*/
|
|
641
|
+
description?: SubscriptionDescription;
|
|
614
642
|
/**
|
|
615
643
|
* Subscription detailed information.
|
|
616
644
|
* @immutable
|
|
@@ -621,6 +649,11 @@ interface SubscriptionInfo {
|
|
|
621
649
|
* @maxLength 1000
|
|
622
650
|
*/
|
|
623
651
|
chargesDescription?: string | null;
|
|
652
|
+
/**
|
|
653
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
654
|
+
* @internal
|
|
655
|
+
*/
|
|
656
|
+
billingAdjustment?: BillingAdjustment;
|
|
624
657
|
}
|
|
625
658
|
interface SubscriptionTitle {
|
|
626
659
|
/**
|
|
@@ -670,6 +703,11 @@ interface SubscriptionSettings {
|
|
|
670
703
|
enableCustomerCancellation?: boolean;
|
|
671
704
|
/** Period until first cycle starts. If None => no free trial */
|
|
672
705
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
706
|
+
/**
|
|
707
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
708
|
+
* @internal
|
|
709
|
+
*/
|
|
710
|
+
startDate?: Date | null;
|
|
673
711
|
}
|
|
674
712
|
/** Frequency unit of recurring payment */
|
|
675
713
|
declare enum SubscriptionFrequency {
|
|
@@ -1346,6 +1384,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1346
1384
|
* @immutable
|
|
1347
1385
|
*/
|
|
1348
1386
|
_id?: string | null;
|
|
1387
|
+
/**
|
|
1388
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1389
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1390
|
+
* @internal
|
|
1391
|
+
* @min 1
|
|
1392
|
+
* @max 999
|
|
1393
|
+
*/
|
|
1394
|
+
subscriptionCycles?: number | null;
|
|
1349
1395
|
}
|
|
1350
1396
|
/** @oneof */
|
|
1351
1397
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -1387,6 +1433,13 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1387
1433
|
description?: string | null;
|
|
1388
1434
|
/** Discount amount. */
|
|
1389
1435
|
amount?: Price;
|
|
1436
|
+
/**
|
|
1437
|
+
* Discount percentage.
|
|
1438
|
+
* @internal
|
|
1439
|
+
* @format DECIMAL_VALUE
|
|
1440
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1441
|
+
*/
|
|
1442
|
+
percentage?: string | null;
|
|
1390
1443
|
}
|
|
1391
1444
|
/** @oneof */
|
|
1392
1445
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -1449,6 +1502,70 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1449
1502
|
merchantComment?: MerchantComment;
|
|
1450
1503
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1451
1504
|
orderRefunded?: OrderRefunded;
|
|
1505
|
+
/**
|
|
1506
|
+
* Details of an initiated refund process.
|
|
1507
|
+
*
|
|
1508
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1509
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1510
|
+
* @internal
|
|
1511
|
+
*/
|
|
1512
|
+
refundInitiated?: RefundInitiated;
|
|
1513
|
+
/**
|
|
1514
|
+
* Details of a refunded payment.
|
|
1515
|
+
*
|
|
1516
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1517
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1518
|
+
* @internal
|
|
1519
|
+
*/
|
|
1520
|
+
paymentRefunded?: PaymentRefunded;
|
|
1521
|
+
/**
|
|
1522
|
+
* Details of a failed payment refund.
|
|
1523
|
+
*
|
|
1524
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1525
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1526
|
+
* @internal
|
|
1527
|
+
*/
|
|
1528
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1529
|
+
/**
|
|
1530
|
+
* Details of refund to store credit.
|
|
1531
|
+
* @internal
|
|
1532
|
+
*/
|
|
1533
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1534
|
+
/**
|
|
1535
|
+
* Details of a pending payment
|
|
1536
|
+
* @internal
|
|
1537
|
+
*/
|
|
1538
|
+
paymentPending?: PaymentPending;
|
|
1539
|
+
/**
|
|
1540
|
+
* Details of a canceled payment
|
|
1541
|
+
* @internal
|
|
1542
|
+
*/
|
|
1543
|
+
paymentCanceled?: PaymentCanceled;
|
|
1544
|
+
/**
|
|
1545
|
+
* Details of a declined payment
|
|
1546
|
+
* @internal
|
|
1547
|
+
*/
|
|
1548
|
+
paymentDeclined?: PaymentDeclined;
|
|
1549
|
+
/**
|
|
1550
|
+
* Receipt was added for associated payment
|
|
1551
|
+
* @internal
|
|
1552
|
+
*/
|
|
1553
|
+
receiptCreated?: ReceiptCreated;
|
|
1554
|
+
/**
|
|
1555
|
+
* Receipt sent to customer
|
|
1556
|
+
* @internal
|
|
1557
|
+
*/
|
|
1558
|
+
receiptSent?: ReceiptSent;
|
|
1559
|
+
/**
|
|
1560
|
+
* Order received a chargeback for one of its' payments.
|
|
1561
|
+
* @internal
|
|
1562
|
+
*/
|
|
1563
|
+
chargebackCreated?: ChargebackCreated;
|
|
1564
|
+
/**
|
|
1565
|
+
* Chargeback reversed for one of the order's payments.
|
|
1566
|
+
* @internal
|
|
1567
|
+
*/
|
|
1568
|
+
chargebackReversed?: ChargebackReversed;
|
|
1452
1569
|
/**
|
|
1453
1570
|
* Activity ID.
|
|
1454
1571
|
* @format GUID
|
|
@@ -1477,6 +1594,70 @@ interface ActivityContentOneOf {
|
|
|
1477
1594
|
merchantComment?: MerchantComment;
|
|
1478
1595
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1479
1596
|
orderRefunded?: OrderRefunded;
|
|
1597
|
+
/**
|
|
1598
|
+
* Details of an initiated refund process.
|
|
1599
|
+
*
|
|
1600
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1601
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1602
|
+
* @internal
|
|
1603
|
+
*/
|
|
1604
|
+
refundInitiated?: RefundInitiated;
|
|
1605
|
+
/**
|
|
1606
|
+
* Details of a refunded payment.
|
|
1607
|
+
*
|
|
1608
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1609
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1610
|
+
* @internal
|
|
1611
|
+
*/
|
|
1612
|
+
paymentRefunded?: PaymentRefunded;
|
|
1613
|
+
/**
|
|
1614
|
+
* Details of a failed payment refund.
|
|
1615
|
+
*
|
|
1616
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1617
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1618
|
+
* @internal
|
|
1619
|
+
*/
|
|
1620
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1621
|
+
/**
|
|
1622
|
+
* Details of refund to store credit.
|
|
1623
|
+
* @internal
|
|
1624
|
+
*/
|
|
1625
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1626
|
+
/**
|
|
1627
|
+
* Details of a pending payment
|
|
1628
|
+
* @internal
|
|
1629
|
+
*/
|
|
1630
|
+
paymentPending?: PaymentPending;
|
|
1631
|
+
/**
|
|
1632
|
+
* Details of a canceled payment
|
|
1633
|
+
* @internal
|
|
1634
|
+
*/
|
|
1635
|
+
paymentCanceled?: PaymentCanceled;
|
|
1636
|
+
/**
|
|
1637
|
+
* Details of a declined payment
|
|
1638
|
+
* @internal
|
|
1639
|
+
*/
|
|
1640
|
+
paymentDeclined?: PaymentDeclined;
|
|
1641
|
+
/**
|
|
1642
|
+
* Receipt was added for associated payment
|
|
1643
|
+
* @internal
|
|
1644
|
+
*/
|
|
1645
|
+
receiptCreated?: ReceiptCreated;
|
|
1646
|
+
/**
|
|
1647
|
+
* Receipt sent to customer
|
|
1648
|
+
* @internal
|
|
1649
|
+
*/
|
|
1650
|
+
receiptSent?: ReceiptSent;
|
|
1651
|
+
/**
|
|
1652
|
+
* Order received a chargeback for one of its' payments.
|
|
1653
|
+
* @internal
|
|
1654
|
+
*/
|
|
1655
|
+
chargebackCreated?: ChargebackCreated;
|
|
1656
|
+
/**
|
|
1657
|
+
* Chargeback reversed for one of the order's payments.
|
|
1658
|
+
* @internal
|
|
1659
|
+
*/
|
|
1660
|
+
chargebackReversed?: ChargebackReversed;
|
|
1480
1661
|
}
|
|
1481
1662
|
interface CustomActivity {
|
|
1482
1663
|
/**
|
|
@@ -2228,11 +2409,29 @@ interface BalanceSummary {
|
|
|
2228
2409
|
* @readonly
|
|
2229
2410
|
*/
|
|
2230
2411
|
authorized?: Price;
|
|
2412
|
+
/**
|
|
2413
|
+
* Sum of all pending refund transactions.
|
|
2414
|
+
* @internal
|
|
2415
|
+
* @readonly
|
|
2416
|
+
*/
|
|
2417
|
+
pendingRefund?: Price;
|
|
2231
2418
|
/**
|
|
2232
2419
|
* Sum of all pending transactions.
|
|
2233
2420
|
* @readonly
|
|
2234
2421
|
*/
|
|
2235
2422
|
pending?: Price;
|
|
2423
|
+
/**
|
|
2424
|
+
* Sum of all transaction chargebacks.
|
|
2425
|
+
* @internal
|
|
2426
|
+
* @readonly
|
|
2427
|
+
*/
|
|
2428
|
+
chargeback?: Price;
|
|
2429
|
+
/**
|
|
2430
|
+
* Sum of all chargeback reversals.
|
|
2431
|
+
* @internal
|
|
2432
|
+
* @readonly
|
|
2433
|
+
*/
|
|
2434
|
+
chargebackReversal?: Price;
|
|
2236
2435
|
}
|
|
2237
2436
|
/**
|
|
2238
2437
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2294,6 +2493,14 @@ interface AdditionalFee {
|
|
|
2294
2493
|
* @format GUID
|
|
2295
2494
|
*/
|
|
2296
2495
|
lineItemIds?: string[];
|
|
2496
|
+
/**
|
|
2497
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
2498
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
2499
|
+
* @internal
|
|
2500
|
+
* @min 1
|
|
2501
|
+
* @max 999
|
|
2502
|
+
*/
|
|
2503
|
+
subscriptionCycles?: number | null;
|
|
2297
2504
|
}
|
|
2298
2505
|
interface FulfillmentStatusesAggregate {
|
|
2299
2506
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -2350,141 +2557,6 @@ interface Location {
|
|
|
2350
2557
|
*/
|
|
2351
2558
|
name?: string;
|
|
2352
2559
|
}
|
|
2353
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
2354
|
-
/** insert/update documents */
|
|
2355
|
-
update?: InternalDocumentUpdateOperation;
|
|
2356
|
-
/** delete by document ids */
|
|
2357
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2358
|
-
/** delete documents matching filter */
|
|
2359
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2360
|
-
/** update internal documents matching filter */
|
|
2361
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2362
|
-
/** update only existing documents */
|
|
2363
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2364
|
-
/** insert/update documents with versioning */
|
|
2365
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2366
|
-
/** delete by document ids with versioning */
|
|
2367
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2368
|
-
/**
|
|
2369
|
-
* type of the documents
|
|
2370
|
-
* @minLength 2
|
|
2371
|
-
*/
|
|
2372
|
-
documentType?: string;
|
|
2373
|
-
/**
|
|
2374
|
-
* language of the documents (mandatory)
|
|
2375
|
-
* @minLength 2
|
|
2376
|
-
*/
|
|
2377
|
-
language?: string | null;
|
|
2378
|
-
/**
|
|
2379
|
-
* one or more search documents
|
|
2380
|
-
* @deprecated
|
|
2381
|
-
*/
|
|
2382
|
-
addDocuments?: InternalDocument[];
|
|
2383
|
-
/**
|
|
2384
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
2385
|
-
* @deprecated
|
|
2386
|
-
*/
|
|
2387
|
-
removeDocumentIds?: string[];
|
|
2388
|
-
/** id to pass to processing notification */
|
|
2389
|
-
correlationId?: string | null;
|
|
2390
|
-
/** when event was created / issued */
|
|
2391
|
-
issuedAt?: Date | null;
|
|
2392
|
-
}
|
|
2393
|
-
/** @oneof */
|
|
2394
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
2395
|
-
/** insert/update documents */
|
|
2396
|
-
update?: InternalDocumentUpdateOperation;
|
|
2397
|
-
/** delete by document ids */
|
|
2398
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2399
|
-
/** delete documents matching filter */
|
|
2400
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2401
|
-
/** update internal documents matching filter */
|
|
2402
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2403
|
-
/** update only existing documents */
|
|
2404
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2405
|
-
/** insert/update documents with versioning */
|
|
2406
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2407
|
-
/** delete by document ids with versioning */
|
|
2408
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2409
|
-
}
|
|
2410
|
-
interface InternalDocument {
|
|
2411
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
2412
|
-
document?: Record<string, any> | null;
|
|
2413
|
-
}
|
|
2414
|
-
interface InternalDocumentUpdateOperation {
|
|
2415
|
-
/** documents to index or update */
|
|
2416
|
-
documents?: InternalDocument[];
|
|
2417
|
-
}
|
|
2418
|
-
interface DeleteByIdsOperation {
|
|
2419
|
-
/** ids of the documents to delete */
|
|
2420
|
-
documentIds?: string[];
|
|
2421
|
-
/**
|
|
2422
|
-
* tenant id for custom tenancy strategy
|
|
2423
|
-
* @minLength 2
|
|
2424
|
-
* @maxLength 300
|
|
2425
|
-
*/
|
|
2426
|
-
tenantId?: string | null;
|
|
2427
|
-
}
|
|
2428
|
-
interface DeleteByFilterOperation {
|
|
2429
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2430
|
-
filter?: Record<string, any> | null;
|
|
2431
|
-
/**
|
|
2432
|
-
* tenant id for custom tenancy strategy
|
|
2433
|
-
* @minLength 2
|
|
2434
|
-
* @maxLength 300
|
|
2435
|
-
*/
|
|
2436
|
-
tenantId?: string | null;
|
|
2437
|
-
}
|
|
2438
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
2439
|
-
/** documents matching this filter will be updated */
|
|
2440
|
-
filter?: Record<string, any> | null;
|
|
2441
|
-
/** partial document to apply */
|
|
2442
|
-
document?: InternalDocument;
|
|
2443
|
-
/**
|
|
2444
|
-
* tenant id for custom tenancy strategy
|
|
2445
|
-
* @minLength 2
|
|
2446
|
-
* @maxLength 300
|
|
2447
|
-
*/
|
|
2448
|
-
tenantId?: string | null;
|
|
2449
|
-
}
|
|
2450
|
-
interface InternalUpdateExistingOperation {
|
|
2451
|
-
/** documents to update */
|
|
2452
|
-
documents?: InternalDocument[];
|
|
2453
|
-
}
|
|
2454
|
-
interface VersionedDocumentUpdateOperation {
|
|
2455
|
-
/** documents to create or overwrite */
|
|
2456
|
-
documents?: InternalDocument[];
|
|
2457
|
-
/** versioning mode to use instead of default */
|
|
2458
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2459
|
-
}
|
|
2460
|
-
declare enum VersioningMode {
|
|
2461
|
-
/** use default versioning mode agreed with search team */
|
|
2462
|
-
DEFAULT = "DEFAULT",
|
|
2463
|
-
/** execute only if version is greater than existing */
|
|
2464
|
-
GREATER_THAN = "GREATER_THAN",
|
|
2465
|
-
/** execute only if version is greater or equal to existing */
|
|
2466
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2467
|
-
}
|
|
2468
|
-
/** @enumType */
|
|
2469
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
2470
|
-
interface VersionedDeleteByIdsOperation {
|
|
2471
|
-
/** ids with version of the documents to delete */
|
|
2472
|
-
documentIds?: VersionedDocumentId[];
|
|
2473
|
-
/**
|
|
2474
|
-
* tenant id for custom tenancy strategy
|
|
2475
|
-
* @minLength 2
|
|
2476
|
-
* @maxLength 300
|
|
2477
|
-
*/
|
|
2478
|
-
tenantId?: string | null;
|
|
2479
|
-
}
|
|
2480
|
-
interface VersionedDocumentId {
|
|
2481
|
-
/** document id */
|
|
2482
|
-
documentId?: string;
|
|
2483
|
-
/** document version */
|
|
2484
|
-
version?: string;
|
|
2485
|
-
/** versioning mode to use instead of default */
|
|
2486
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2487
|
-
}
|
|
2488
2560
|
/** Triggered when the order status changes to approved */
|
|
2489
2561
|
interface OrderApproved {
|
|
2490
2562
|
/** The order that was updated */
|
|
@@ -2506,9 +2578,9 @@ interface OrderItemsRestocked {
|
|
|
2506
2578
|
/** The order which items were restocked */
|
|
2507
2579
|
order?: Order;
|
|
2508
2580
|
/** Restocked items and quantities */
|
|
2509
|
-
restockItems?:
|
|
2581
|
+
restockItems?: V1RestockItem[];
|
|
2510
2582
|
}
|
|
2511
|
-
interface
|
|
2583
|
+
interface V1RestockItem {
|
|
2512
2584
|
/**
|
|
2513
2585
|
* ID of the line item being restocked.
|
|
2514
2586
|
* @format GUID
|
|
@@ -2521,35 +2593,315 @@ interface RestockItem {
|
|
|
2521
2593
|
*/
|
|
2522
2594
|
quantity?: number;
|
|
2523
2595
|
}
|
|
2524
|
-
interface
|
|
2596
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
2525
2597
|
/** @format GUID */
|
|
2526
|
-
|
|
2598
|
+
orderId?: string;
|
|
2599
|
+
}
|
|
2600
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
2601
|
+
}
|
|
2602
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
2527
2603
|
/**
|
|
2528
2604
|
* @minLength 1
|
|
2529
2605
|
* @maxLength 100
|
|
2530
|
-
* @maxSize 100
|
|
2531
2606
|
*/
|
|
2532
|
-
|
|
2607
|
+
orderId?: string;
|
|
2533
2608
|
}
|
|
2534
|
-
interface
|
|
2609
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
2535
2610
|
}
|
|
2536
|
-
interface
|
|
2537
|
-
createdEvent?: EntityCreatedEvent;
|
|
2538
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2539
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2540
|
-
actionEvent?: ActionEvent;
|
|
2541
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2542
|
-
_id?: string;
|
|
2611
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
2543
2612
|
/**
|
|
2544
|
-
*
|
|
2545
|
-
*
|
|
2613
|
+
* @minLength 1
|
|
2614
|
+
* @maxLength 100
|
|
2546
2615
|
*/
|
|
2547
|
-
|
|
2616
|
+
orderId?: string;
|
|
2617
|
+
}
|
|
2618
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
2619
|
+
}
|
|
2620
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
2548
2621
|
/**
|
|
2549
|
-
*
|
|
2550
|
-
*
|
|
2622
|
+
* IDs of orders to send pickup emails for.
|
|
2623
|
+
* @minSize 1
|
|
2624
|
+
* @maxSize 300
|
|
2551
2625
|
*/
|
|
2552
|
-
|
|
2626
|
+
orderIds?: string[];
|
|
2627
|
+
}
|
|
2628
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
2629
|
+
}
|
|
2630
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
2631
|
+
/**
|
|
2632
|
+
* @minLength 1
|
|
2633
|
+
* @maxLength 100
|
|
2634
|
+
*/
|
|
2635
|
+
orderId?: string;
|
|
2636
|
+
}
|
|
2637
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
2638
|
+
}
|
|
2639
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
2640
|
+
/**
|
|
2641
|
+
* IDs of orders to send pickup emails for.
|
|
2642
|
+
* @minSize 1
|
|
2643
|
+
* @maxSize 300
|
|
2644
|
+
*/
|
|
2645
|
+
orderIds?: string[];
|
|
2646
|
+
}
|
|
2647
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
2648
|
+
}
|
|
2649
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
2650
|
+
/**
|
|
2651
|
+
* @minLength 1
|
|
2652
|
+
* @maxLength 100
|
|
2653
|
+
*/
|
|
2654
|
+
orderId?: string;
|
|
2655
|
+
}
|
|
2656
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
2657
|
+
}
|
|
2658
|
+
interface SendCancelRefundEmailRequest {
|
|
2659
|
+
/**
|
|
2660
|
+
* The ID of order that is canceled/refunded
|
|
2661
|
+
* @minLength 1
|
|
2662
|
+
* @maxLength 100
|
|
2663
|
+
*/
|
|
2664
|
+
orderId?: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* Personal note added to the email (optional)
|
|
2667
|
+
* @minLength 1
|
|
2668
|
+
* @maxLength 1000
|
|
2669
|
+
*/
|
|
2670
|
+
customMessage?: string | null;
|
|
2671
|
+
/** Refund amount */
|
|
2672
|
+
refundAmount?: Price;
|
|
2673
|
+
/**
|
|
2674
|
+
* Refund ID. (Optional)
|
|
2675
|
+
* @format GUID
|
|
2676
|
+
*/
|
|
2677
|
+
refundId?: string | null;
|
|
2678
|
+
}
|
|
2679
|
+
interface SendCancelRefundEmailResponse {
|
|
2680
|
+
}
|
|
2681
|
+
interface SendRefundEmailRequest {
|
|
2682
|
+
/**
|
|
2683
|
+
* The ID of order that is refunded
|
|
2684
|
+
* @format GUID
|
|
2685
|
+
*/
|
|
2686
|
+
orderId?: string;
|
|
2687
|
+
/**
|
|
2688
|
+
* Refund ID
|
|
2689
|
+
* @format GUID
|
|
2690
|
+
*/
|
|
2691
|
+
refundId?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Personal note added to the email (optional)
|
|
2694
|
+
* @minLength 1
|
|
2695
|
+
* @maxLength 1000
|
|
2696
|
+
*/
|
|
2697
|
+
customMessage?: string | null;
|
|
2698
|
+
}
|
|
2699
|
+
interface SendRefundEmailResponse {
|
|
2700
|
+
}
|
|
2701
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
2702
|
+
/**
|
|
2703
|
+
* @minLength 1
|
|
2704
|
+
* @maxLength 100
|
|
2705
|
+
*/
|
|
2706
|
+
orderId?: string;
|
|
2707
|
+
}
|
|
2708
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
2709
|
+
}
|
|
2710
|
+
interface PreviewEmailByTypeRequest {
|
|
2711
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
2712
|
+
}
|
|
2713
|
+
declare enum PreviewEmailType {
|
|
2714
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
2715
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
2716
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
2717
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
2718
|
+
}
|
|
2719
|
+
/** @enumType */
|
|
2720
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
2721
|
+
interface PreviewEmailByTypeResponse {
|
|
2722
|
+
emailPreview?: string;
|
|
2723
|
+
}
|
|
2724
|
+
interface PreviewRefundEmailRequest {
|
|
2725
|
+
/**
|
|
2726
|
+
* @minLength 1
|
|
2727
|
+
* @maxLength 100
|
|
2728
|
+
*/
|
|
2729
|
+
orderId?: string;
|
|
2730
|
+
/** Refund amount */
|
|
2731
|
+
refundAmount?: Price;
|
|
2732
|
+
/** Refund business details */
|
|
2733
|
+
details?: RefundDetails;
|
|
2734
|
+
/**
|
|
2735
|
+
* Personal note added to the email (optional)
|
|
2736
|
+
* @minLength 1
|
|
2737
|
+
* @maxLength 1000
|
|
2738
|
+
*/
|
|
2739
|
+
customMessage?: string | null;
|
|
2740
|
+
/**
|
|
2741
|
+
* Refund ID. (Optional)
|
|
2742
|
+
* @format GUID
|
|
2743
|
+
*/
|
|
2744
|
+
refundId?: string | null;
|
|
2745
|
+
}
|
|
2746
|
+
/** Business model of a refund request */
|
|
2747
|
+
interface RefundDetails {
|
|
2748
|
+
/**
|
|
2749
|
+
* Order line item IDs and quantities that were refunded.
|
|
2750
|
+
* @maxSize 300
|
|
2751
|
+
*/
|
|
2752
|
+
items?: RefundItem[];
|
|
2753
|
+
/** Whether the shipping fee was also refunded. */
|
|
2754
|
+
shippingIncluded?: boolean;
|
|
2755
|
+
/**
|
|
2756
|
+
* Reason for the refund, provided by customer (optional).
|
|
2757
|
+
* @maxLength 200
|
|
2758
|
+
*/
|
|
2759
|
+
reason?: string | null;
|
|
2760
|
+
/**
|
|
2761
|
+
* Line items that were refunded.
|
|
2762
|
+
* @maxSize 300
|
|
2763
|
+
*/
|
|
2764
|
+
lineItems?: LineItemRefund[];
|
|
2765
|
+
/**
|
|
2766
|
+
* Additional fees that were refunded.
|
|
2767
|
+
* @maxSize 100
|
|
2768
|
+
*/
|
|
2769
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
2770
|
+
/** Shipping amount that was refunded. */
|
|
2771
|
+
shipping?: ShippingRefund;
|
|
2772
|
+
}
|
|
2773
|
+
interface RefundItem {
|
|
2774
|
+
/**
|
|
2775
|
+
* Line item ID the refunded line item.
|
|
2776
|
+
* @format GUID
|
|
2777
|
+
*/
|
|
2778
|
+
lineItemId?: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* Line item quantity refunded.
|
|
2781
|
+
* @min 1
|
|
2782
|
+
* @max 100000
|
|
2783
|
+
*/
|
|
2784
|
+
quantity?: number;
|
|
2785
|
+
}
|
|
2786
|
+
interface LineItemRefund {
|
|
2787
|
+
/**
|
|
2788
|
+
* Line item ID.
|
|
2789
|
+
* @format GUID
|
|
2790
|
+
* @immutable
|
|
2791
|
+
*/
|
|
2792
|
+
lineItemId?: string;
|
|
2793
|
+
/**
|
|
2794
|
+
* Refund quantity.
|
|
2795
|
+
* @min 1
|
|
2796
|
+
* @max 100000
|
|
2797
|
+
* @immutable
|
|
2798
|
+
*/
|
|
2799
|
+
quantity?: number;
|
|
2800
|
+
}
|
|
2801
|
+
interface AdditionalFeeRefund {
|
|
2802
|
+
/**
|
|
2803
|
+
* Additional fee ID.
|
|
2804
|
+
* @format GUID
|
|
2805
|
+
* @immutable
|
|
2806
|
+
*/
|
|
2807
|
+
additionalFeeId?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* Refund amount.
|
|
2810
|
+
* @immutable
|
|
2811
|
+
*/
|
|
2812
|
+
amount?: Price;
|
|
2813
|
+
}
|
|
2814
|
+
interface ShippingRefund {
|
|
2815
|
+
/**
|
|
2816
|
+
* Refund amount.
|
|
2817
|
+
* @immutable
|
|
2818
|
+
*/
|
|
2819
|
+
amount?: Price;
|
|
2820
|
+
}
|
|
2821
|
+
interface PreviewRefundEmailResponse {
|
|
2822
|
+
emailPreview?: string;
|
|
2823
|
+
}
|
|
2824
|
+
interface PreviewCancelEmailRequest {
|
|
2825
|
+
/**
|
|
2826
|
+
* @minLength 1
|
|
2827
|
+
* @maxLength 100
|
|
2828
|
+
*/
|
|
2829
|
+
orderId?: string;
|
|
2830
|
+
/**
|
|
2831
|
+
* Personal note added to the email (optional)
|
|
2832
|
+
* @minLength 1
|
|
2833
|
+
* @maxLength 1000
|
|
2834
|
+
*/
|
|
2835
|
+
customMessage?: string | null;
|
|
2836
|
+
}
|
|
2837
|
+
interface PreviewCancelEmailResponse {
|
|
2838
|
+
emailPreview?: string;
|
|
2839
|
+
}
|
|
2840
|
+
interface PreviewCancelRefundEmailRequest {
|
|
2841
|
+
/**
|
|
2842
|
+
* @minLength 1
|
|
2843
|
+
* @maxLength 100
|
|
2844
|
+
*/
|
|
2845
|
+
orderId?: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* Personal note added to the email (optional)
|
|
2848
|
+
* @minLength 1
|
|
2849
|
+
* @maxLength 1000
|
|
2850
|
+
*/
|
|
2851
|
+
customMessage?: string | null;
|
|
2852
|
+
/** Refund amount */
|
|
2853
|
+
refundAmount?: Price;
|
|
2854
|
+
/**
|
|
2855
|
+
* Refund ID. (Optional)
|
|
2856
|
+
* @format GUID
|
|
2857
|
+
*/
|
|
2858
|
+
refundId?: string | null;
|
|
2859
|
+
}
|
|
2860
|
+
interface PreviewCancelRefundEmailResponse {
|
|
2861
|
+
emailPreview?: string;
|
|
2862
|
+
}
|
|
2863
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
2864
|
+
}
|
|
2865
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
2866
|
+
emailPreview?: string;
|
|
2867
|
+
}
|
|
2868
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
2869
|
+
}
|
|
2870
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
2871
|
+
emailPreview?: string;
|
|
2872
|
+
}
|
|
2873
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
2874
|
+
}
|
|
2875
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
2876
|
+
emailPreview?: string;
|
|
2877
|
+
}
|
|
2878
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
2879
|
+
}
|
|
2880
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
2881
|
+
emailPreview?: string;
|
|
2882
|
+
}
|
|
2883
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
2884
|
+
}
|
|
2885
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
2886
|
+
emailPreview?: string;
|
|
2887
|
+
}
|
|
2888
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2889
|
+
createdEvent?: EntityCreatedEvent;
|
|
2890
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2891
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2892
|
+
actionEvent?: ActionEvent;
|
|
2893
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2894
|
+
_id?: string;
|
|
2895
|
+
/**
|
|
2896
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2897
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2898
|
+
*/
|
|
2899
|
+
entityFqdn?: string;
|
|
2900
|
+
/**
|
|
2901
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2902
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2903
|
+
*/
|
|
2904
|
+
slug?: string;
|
|
2553
2905
|
/** ID of the entity associated with the event. */
|
|
2554
2906
|
entityId?: string;
|
|
2555
2907
|
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
@@ -2597,91 +2949,1353 @@ interface ActionEvent {
|
|
|
2597
2949
|
}
|
|
2598
2950
|
interface Empty {
|
|
2599
2951
|
}
|
|
2600
|
-
interface
|
|
2601
|
-
/**
|
|
2602
|
-
|
|
2952
|
+
interface MessageEnvelope {
|
|
2953
|
+
/**
|
|
2954
|
+
* App instance ID.
|
|
2955
|
+
* @format GUID
|
|
2956
|
+
*/
|
|
2957
|
+
instanceId?: string | null;
|
|
2958
|
+
/**
|
|
2959
|
+
* Event type.
|
|
2960
|
+
* @maxLength 150
|
|
2961
|
+
*/
|
|
2962
|
+
eventType?: string;
|
|
2963
|
+
/** The identification type and identity data. */
|
|
2964
|
+
identity?: IdentificationData;
|
|
2965
|
+
/** Stringify payload. */
|
|
2966
|
+
data?: string;
|
|
2967
|
+
}
|
|
2968
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2969
|
+
/**
|
|
2970
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2971
|
+
* @format GUID
|
|
2972
|
+
*/
|
|
2973
|
+
anonymousVisitorId?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* ID of a site visitor that has logged in to the site.
|
|
2976
|
+
* @format GUID
|
|
2977
|
+
*/
|
|
2978
|
+
memberId?: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2981
|
+
* @format GUID
|
|
2982
|
+
*/
|
|
2983
|
+
wixUserId?: string;
|
|
2984
|
+
/**
|
|
2985
|
+
* ID of an app.
|
|
2986
|
+
* @format GUID
|
|
2987
|
+
*/
|
|
2988
|
+
appId?: string;
|
|
2989
|
+
/** @readonly */
|
|
2990
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2991
|
+
}
|
|
2992
|
+
/** @oneof */
|
|
2993
|
+
interface IdentificationDataIdOneOf {
|
|
2994
|
+
/**
|
|
2995
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2996
|
+
* @format GUID
|
|
2997
|
+
*/
|
|
2998
|
+
anonymousVisitorId?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* ID of a site visitor that has logged in to the site.
|
|
3001
|
+
* @format GUID
|
|
3002
|
+
*/
|
|
3003
|
+
memberId?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3006
|
+
* @format GUID
|
|
3007
|
+
*/
|
|
3008
|
+
wixUserId?: string;
|
|
3009
|
+
/**
|
|
3010
|
+
* ID of an app.
|
|
3011
|
+
* @format GUID
|
|
3012
|
+
*/
|
|
3013
|
+
appId?: string;
|
|
3014
|
+
}
|
|
3015
|
+
declare enum WebhookIdentityType {
|
|
3016
|
+
UNKNOWN = "UNKNOWN",
|
|
3017
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3018
|
+
MEMBER = "MEMBER",
|
|
3019
|
+
WIX_USER = "WIX_USER",
|
|
3020
|
+
APP = "APP"
|
|
3021
|
+
}
|
|
3022
|
+
/** @enumType */
|
|
3023
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3024
|
+
interface PreparePaymentCollectionRequest {
|
|
3025
|
+
/**
|
|
3026
|
+
* Ecom order ID.
|
|
3027
|
+
* @minLength 1
|
|
3028
|
+
* @maxLength 100
|
|
3029
|
+
*/
|
|
3030
|
+
ecomOrderId: string;
|
|
3031
|
+
/** Amount to collect */
|
|
3032
|
+
amount: Price;
|
|
3033
|
+
/**
|
|
3034
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
3035
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
3036
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
3037
|
+
*/
|
|
3038
|
+
paymentGatewayOrderId?: string | null;
|
|
3039
|
+
/**
|
|
3040
|
+
* Whether to delay capture of the payment.
|
|
3041
|
+
* Default: false
|
|
3042
|
+
* @deprecated Whether to delay capture of the payment.
|
|
3043
|
+
* Default: false
|
|
3044
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3045
|
+
* @targetRemovalDate 2024-09-30
|
|
3046
|
+
*/
|
|
3047
|
+
delayedCapture?: boolean;
|
|
3048
|
+
/**
|
|
3049
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
3050
|
+
* Default: `true`
|
|
3051
|
+
* @internal
|
|
3052
|
+
*/
|
|
3053
|
+
merchantInitiated?: boolean | null;
|
|
3054
|
+
/**
|
|
3055
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
3056
|
+
* @internal
|
|
3057
|
+
*/
|
|
3058
|
+
redirectUrls?: RedirectUrls;
|
|
3059
|
+
/** Delayed capture payment settings */
|
|
3060
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
3061
|
+
}
|
|
3062
|
+
interface RedirectUrls {
|
|
3063
|
+
/**
|
|
3064
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
3065
|
+
* @format WEB_URL
|
|
3066
|
+
*/
|
|
3067
|
+
successUrl?: string | null;
|
|
3068
|
+
/**
|
|
3069
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
3070
|
+
* @format WEB_URL
|
|
3071
|
+
*/
|
|
3072
|
+
cancelUrl?: string | null;
|
|
3073
|
+
/**
|
|
3074
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
3075
|
+
* @format WEB_URL
|
|
3076
|
+
*/
|
|
3077
|
+
errorUrl?: string | null;
|
|
3078
|
+
/**
|
|
3079
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
3080
|
+
* @format WEB_URL
|
|
3081
|
+
*/
|
|
3082
|
+
pendingUrl?: string | null;
|
|
3083
|
+
}
|
|
3084
|
+
interface DelayedCaptureSettings {
|
|
3085
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3086
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
3087
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3088
|
+
delayDuration?: Duration;
|
|
3089
|
+
}
|
|
3090
|
+
declare enum ScheduledAction {
|
|
3091
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3092
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
3093
|
+
VOID = "VOID",
|
|
3094
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
3095
|
+
CAPTURE = "CAPTURE"
|
|
3096
|
+
}
|
|
3097
|
+
/** @enumType */
|
|
3098
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
3099
|
+
interface Duration {
|
|
3100
|
+
/**
|
|
3101
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
3102
|
+
* @min 1
|
|
3103
|
+
*/
|
|
3104
|
+
count?: number;
|
|
3105
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
3106
|
+
unit?: DurationUnitWithLiterals;
|
|
3107
|
+
}
|
|
3108
|
+
declare enum DurationUnit {
|
|
3109
|
+
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
3110
|
+
MINUTES = "MINUTES",
|
|
3111
|
+
HOURS = "HOURS",
|
|
3112
|
+
DAYS = "DAYS"
|
|
3113
|
+
}
|
|
3114
|
+
/** @enumType */
|
|
3115
|
+
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
3116
|
+
interface PreparePaymentCollectionResponse {
|
|
3117
|
+
/** Payment gateway order id which is associated with given payment */
|
|
3118
|
+
paymentGatewayOrderId?: string;
|
|
3119
|
+
}
|
|
3120
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
3121
|
+
/**
|
|
3122
|
+
* Ecom order ID.
|
|
3123
|
+
* @minLength 1
|
|
3124
|
+
* @maxLength 100
|
|
3125
|
+
*/
|
|
3126
|
+
ecomOrderId: string;
|
|
3127
|
+
}
|
|
3128
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
3129
|
+
/** Payment collectability status */
|
|
3130
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
3131
|
+
/** Collectable order amount */
|
|
3132
|
+
amount?: Price;
|
|
3133
|
+
}
|
|
3134
|
+
declare enum PaymentCollectabilityStatus {
|
|
3135
|
+
UNKNOWN = "UNKNOWN",
|
|
3136
|
+
COLLECTABLE = "COLLECTABLE",
|
|
3137
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
3138
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
3139
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
3140
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
3141
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
3142
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
3143
|
+
}
|
|
3144
|
+
/** @enumType */
|
|
3145
|
+
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';
|
|
3146
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
3147
|
+
/**
|
|
3148
|
+
* Order ID.
|
|
3149
|
+
* @minLength 1
|
|
3150
|
+
* @maxLength 100
|
|
3151
|
+
*/
|
|
3152
|
+
orderId: string;
|
|
3153
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
3154
|
+
amount: Price;
|
|
3155
|
+
}
|
|
3156
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
3157
|
+
}
|
|
3158
|
+
interface MarkOrderAsPaidRequest {
|
|
3159
|
+
/**
|
|
3160
|
+
* Ecom order ID.
|
|
3161
|
+
* @minLength 1
|
|
3162
|
+
* @maxLength 100
|
|
3163
|
+
*/
|
|
3164
|
+
ecomOrderId: string;
|
|
3165
|
+
}
|
|
3166
|
+
interface MarkOrderAsPaidResponse {
|
|
3167
|
+
/** Updated order. */
|
|
3168
|
+
order?: Order;
|
|
3169
|
+
}
|
|
3170
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
3171
|
+
/**
|
|
3172
|
+
* IDs of orders to mark as paid.
|
|
3173
|
+
* @minSize 1
|
|
3174
|
+
* @maxSize 100
|
|
3175
|
+
* @minLength 1
|
|
3176
|
+
* @maxLength 100
|
|
3177
|
+
*/
|
|
3178
|
+
ecomOrderIds: string[];
|
|
3179
|
+
}
|
|
3180
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
3181
|
+
/**
|
|
3182
|
+
* Items updated by the bulk action.
|
|
3183
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
3184
|
+
*/
|
|
3185
|
+
results?: BulkOrderResult[];
|
|
3186
|
+
/** Bulk action metadata. */
|
|
3187
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3188
|
+
}
|
|
3189
|
+
interface BulkOrderResult {
|
|
3190
|
+
/** Item metadata. */
|
|
3191
|
+
itemMetadata?: ItemMetadata;
|
|
3192
|
+
/**
|
|
3193
|
+
* Updated order.
|
|
3194
|
+
*
|
|
3195
|
+
* Returned when `returnFullEntity = true`.
|
|
3196
|
+
*/
|
|
3197
|
+
item?: Order;
|
|
3198
|
+
}
|
|
3199
|
+
interface ItemMetadata {
|
|
3200
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3201
|
+
_id?: string | null;
|
|
3202
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3203
|
+
originalIndex?: number;
|
|
3204
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3205
|
+
success?: boolean;
|
|
3206
|
+
/** Details about the error in case of failure. */
|
|
3207
|
+
error?: ApplicationError;
|
|
3208
|
+
}
|
|
3209
|
+
interface ApplicationError {
|
|
3210
|
+
/** Error code. */
|
|
3211
|
+
code?: string;
|
|
3212
|
+
/** Description of the error. */
|
|
3213
|
+
description?: string;
|
|
3214
|
+
/** Data related to the error. */
|
|
3215
|
+
data?: Record<string, any> | null;
|
|
3216
|
+
}
|
|
3217
|
+
interface BulkActionMetadata {
|
|
3218
|
+
/** Number of items that were successfully processed. */
|
|
3219
|
+
totalSuccesses?: number;
|
|
3220
|
+
/** Number of items that couldn't be processed. */
|
|
3221
|
+
totalFailures?: number;
|
|
3222
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3223
|
+
undetailedFailures?: number;
|
|
3224
|
+
}
|
|
3225
|
+
interface GetRefundabilityStatusRequest {
|
|
3226
|
+
/**
|
|
3227
|
+
* Order ID.
|
|
3228
|
+
* @minLength 1
|
|
3229
|
+
* @maxLength 100
|
|
3230
|
+
*/
|
|
3231
|
+
ecomOrderId: string;
|
|
3232
|
+
}
|
|
3233
|
+
interface GetRefundabilityStatusResponse {
|
|
3234
|
+
/**
|
|
3235
|
+
* Refundability details.
|
|
3236
|
+
* @maxSize 300
|
|
3237
|
+
*/
|
|
3238
|
+
refundabilities?: Refundability[];
|
|
3239
|
+
/**
|
|
3240
|
+
* Whether the order supports refunding per item.
|
|
3241
|
+
* @deprecated
|
|
3242
|
+
*/
|
|
3243
|
+
refundablePerItem?: boolean;
|
|
3244
|
+
}
|
|
3245
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
3246
|
+
/** Reason why payment is not refundable. */
|
|
3247
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
3248
|
+
/** Reason why payment is only refundable manually. */
|
|
3249
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3250
|
+
/** Payment ID. */
|
|
3251
|
+
paymentId?: string;
|
|
3252
|
+
/** Payment refundability status. */
|
|
3253
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
3254
|
+
/** Link to payment provider dashboard. */
|
|
3255
|
+
providerLink?: string | null;
|
|
3256
|
+
}
|
|
3257
|
+
/** @oneof */
|
|
3258
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
3259
|
+
/** Reason why payment is not refundable. */
|
|
3260
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
3261
|
+
/** Reason why payment is only refundable manually. */
|
|
3262
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3263
|
+
}
|
|
3264
|
+
declare enum RefundableStatus {
|
|
3265
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
3266
|
+
MANUAL = "MANUAL",
|
|
3267
|
+
REFUNDABLE = "REFUNDABLE"
|
|
3268
|
+
}
|
|
3269
|
+
/** @enumType */
|
|
3270
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
3271
|
+
declare enum NonRefundableReason {
|
|
3272
|
+
NONE = "NONE",
|
|
3273
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
3274
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
3275
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
3276
|
+
NOT_PAID = "NOT_PAID",
|
|
3277
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
3278
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
3279
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
3280
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
3281
|
+
FORBIDDEN = "FORBIDDEN",
|
|
3282
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
3283
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
3284
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
3285
|
+
}
|
|
3286
|
+
/** @enumType */
|
|
3287
|
+
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';
|
|
3288
|
+
declare enum ManuallyRefundableReason {
|
|
3289
|
+
EXPIRED = "EXPIRED",
|
|
3290
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
3291
|
+
OFFLINE = "OFFLINE",
|
|
3292
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
3293
|
+
}
|
|
3294
|
+
/** @enumType */
|
|
3295
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
3296
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
3297
|
+
/**
|
|
3298
|
+
* Ecom order ID.
|
|
3299
|
+
* @minLength 1
|
|
3300
|
+
* @maxLength 100
|
|
3301
|
+
*/
|
|
3302
|
+
ecomOrderId: string;
|
|
3303
|
+
/** Information about the user who initiated the payment. */
|
|
3304
|
+
chargedBy?: ChargedBy;
|
|
3305
|
+
}
|
|
3306
|
+
interface ChargedBy {
|
|
3307
|
+
/**
|
|
3308
|
+
* ID - id of the user who initiated the payment
|
|
3309
|
+
* @format GUID
|
|
3310
|
+
*/
|
|
3311
|
+
_id?: string;
|
|
3312
|
+
/**
|
|
3313
|
+
* Full name - name of the user who initiated the payment
|
|
3314
|
+
* @minLength 1
|
|
3315
|
+
* @maxLength 200
|
|
3316
|
+
*/
|
|
3317
|
+
fullName?: string | null;
|
|
3318
|
+
}
|
|
3319
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
3320
|
+
/** ID of the order created in the payment gateway */
|
|
3321
|
+
paymentGatewayOrderId?: string;
|
|
3322
|
+
}
|
|
3323
|
+
interface ChargeMembershipsRequest {
|
|
3324
|
+
/**
|
|
3325
|
+
* Order ID.
|
|
3326
|
+
* @minLength 1
|
|
3327
|
+
* @maxLength 100
|
|
3328
|
+
*/
|
|
3329
|
+
ecomOrderId: string;
|
|
3330
|
+
/**
|
|
3331
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
3332
|
+
* but a user which is using the membership on behalf of the a member
|
|
3333
|
+
* @format GUID
|
|
3334
|
+
*/
|
|
3335
|
+
memberId: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* List of items to be paid by memberships
|
|
3338
|
+
* @minSize 1
|
|
3339
|
+
* @maxSize 300
|
|
3340
|
+
*/
|
|
3341
|
+
membershipCharges?: MembershipChargeItem[];
|
|
3342
|
+
}
|
|
3343
|
+
interface MembershipChargeItem {
|
|
3344
|
+
/**
|
|
3345
|
+
* The id of used membership
|
|
3346
|
+
* @minLength 1
|
|
3347
|
+
* @maxLength 100
|
|
3348
|
+
*/
|
|
3349
|
+
membershipId?: string;
|
|
3350
|
+
/**
|
|
3351
|
+
* ID of the application providing this payment option
|
|
3352
|
+
* @format GUID
|
|
3353
|
+
*/
|
|
3354
|
+
appId?: string;
|
|
3355
|
+
/** The name of used membership */
|
|
3356
|
+
membershipName?: MembershipName;
|
|
3357
|
+
/** Additional data about this membership */
|
|
3358
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
3359
|
+
/** Catalog and item reference info. */
|
|
3360
|
+
catalogReference?: CatalogReference;
|
|
3361
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
3362
|
+
serviceProperties?: ServiceProperties;
|
|
3363
|
+
/**
|
|
3364
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
3365
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
3366
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
3367
|
+
* @minLength 1
|
|
3368
|
+
* @maxLength 36
|
|
3369
|
+
*/
|
|
3370
|
+
rootCatalogItemId?: string | null;
|
|
3371
|
+
/**
|
|
3372
|
+
* line item id of Checkout/Order line item
|
|
3373
|
+
* @minLength 1
|
|
3374
|
+
* @maxLength 100
|
|
3375
|
+
*/
|
|
3376
|
+
lineItemId?: string;
|
|
3377
|
+
}
|
|
3378
|
+
interface MembershipName {
|
|
3379
|
+
/**
|
|
3380
|
+
* Membership name.
|
|
3381
|
+
* @maxLength 100
|
|
3382
|
+
*/
|
|
3383
|
+
original?: string;
|
|
3384
|
+
/**
|
|
3385
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
3386
|
+
* @maxLength 100
|
|
3387
|
+
*/
|
|
3388
|
+
translated?: string | null;
|
|
3389
|
+
}
|
|
3390
|
+
interface ServiceProperties {
|
|
3391
|
+
/**
|
|
3392
|
+
* 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.
|
|
3393
|
+
* For example, the start time of a class.
|
|
3394
|
+
*/
|
|
3395
|
+
scheduledDate?: Date | null;
|
|
3396
|
+
/**
|
|
3397
|
+
* 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.
|
|
3398
|
+
* @min 1
|
|
3399
|
+
* @max 10000
|
|
3400
|
+
*/
|
|
3401
|
+
numberOfParticipants?: number | null;
|
|
3402
|
+
}
|
|
3403
|
+
interface ChargeMembershipsResponse {
|
|
3404
|
+
}
|
|
3405
|
+
interface TriggerRefundRequest {
|
|
3406
|
+
/**
|
|
3407
|
+
* The order this refund related to
|
|
3408
|
+
* @minLength 1
|
|
3409
|
+
* @maxLength 100
|
|
3410
|
+
*/
|
|
3411
|
+
ecomOrderId: string;
|
|
3412
|
+
/**
|
|
3413
|
+
* Refund operations information
|
|
3414
|
+
* @minSize 1
|
|
3415
|
+
* @maxSize 1
|
|
3416
|
+
*/
|
|
3417
|
+
payments: PaymentRefund[];
|
|
3418
|
+
/** Business model of a refund */
|
|
3419
|
+
details?: RefundDetails;
|
|
3420
|
+
/** Side effect details related to refund */
|
|
3421
|
+
sideEffects?: RefundSideEffects;
|
|
3422
|
+
}
|
|
3423
|
+
interface PaymentRefund {
|
|
3424
|
+
/**
|
|
3425
|
+
* Specific payment within the order to refund
|
|
3426
|
+
* @format GUID
|
|
3427
|
+
*/
|
|
3428
|
+
paymentId?: string;
|
|
3429
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
3430
|
+
amount?: Price;
|
|
3431
|
+
/**
|
|
3432
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
3433
|
+
* 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.
|
|
3434
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
3435
|
+
*/
|
|
3436
|
+
externalRefund?: boolean;
|
|
3437
|
+
}
|
|
3438
|
+
interface RefundSideEffects {
|
|
3439
|
+
/** Inventory restock details as part of this refund. */
|
|
3440
|
+
restockInfo?: RestockInfo;
|
|
3441
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
3442
|
+
sendOrderRefundedEmail?: boolean;
|
|
3443
|
+
/**
|
|
3444
|
+
* Custom message added to the refund confirmation email.
|
|
3445
|
+
* @minLength 1
|
|
3446
|
+
* @maxLength 1000
|
|
3447
|
+
*/
|
|
3448
|
+
customMessage?: string | null;
|
|
3449
|
+
}
|
|
3450
|
+
interface RestockInfo {
|
|
3451
|
+
/** Restock type. */
|
|
3452
|
+
type?: RestockTypeWithLiterals;
|
|
3453
|
+
/**
|
|
3454
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
3455
|
+
* @maxSize 300
|
|
3456
|
+
*/
|
|
3457
|
+
items?: RestockItem[];
|
|
3458
|
+
}
|
|
3459
|
+
declare enum RestockType {
|
|
3460
|
+
NO_ITEMS = "NO_ITEMS",
|
|
3461
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
3462
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
3463
|
+
}
|
|
3464
|
+
/** @enumType */
|
|
3465
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
3466
|
+
interface RestockItem {
|
|
3467
|
+
/**
|
|
3468
|
+
* ID of the line item being restocked.
|
|
3469
|
+
* @format GUID
|
|
3470
|
+
*/
|
|
3471
|
+
lineItemId?: string;
|
|
3472
|
+
/**
|
|
3473
|
+
* Line item quantity being restocked.
|
|
3474
|
+
* @min 1
|
|
3475
|
+
* @max 100000
|
|
3476
|
+
*/
|
|
3477
|
+
quantity?: number;
|
|
3478
|
+
}
|
|
3479
|
+
interface TriggerRefundResponse {
|
|
3480
|
+
/** All order's transactions after the refunds were added */
|
|
3481
|
+
orderTransactions?: OrderTransactions;
|
|
3482
|
+
/** Created refund ID */
|
|
3483
|
+
refundId?: string | null;
|
|
3484
|
+
/** Payment ID's that the refund execution had failed for */
|
|
3485
|
+
failedPaymentIds?: ItemMetadata[];
|
|
3486
|
+
}
|
|
3487
|
+
interface OrderTransactions {
|
|
3488
|
+
/**
|
|
3489
|
+
* Order ID.
|
|
3490
|
+
* @format GUID
|
|
3491
|
+
*/
|
|
3492
|
+
orderId?: string;
|
|
3493
|
+
/**
|
|
3494
|
+
* Record of payments made to the merchant.
|
|
3495
|
+
* @maxSize 100
|
|
3496
|
+
*/
|
|
3497
|
+
payments?: Payment[];
|
|
3498
|
+
/**
|
|
3499
|
+
* Record of refunds made to the buyer.
|
|
3500
|
+
* @maxSize 300
|
|
3501
|
+
*/
|
|
3502
|
+
refunds?: Refund[];
|
|
3503
|
+
}
|
|
3504
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
3505
|
+
/** Regular payment details. */
|
|
3506
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3507
|
+
/** Gift card payment details. */
|
|
3508
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3509
|
+
/**
|
|
3510
|
+
* Receipt created by Wix
|
|
3511
|
+
* @internal
|
|
3512
|
+
*/
|
|
3513
|
+
wixReceipt?: WixReceiptInfo;
|
|
3514
|
+
/**
|
|
3515
|
+
* Receipt created by an external system.
|
|
3516
|
+
* @internal
|
|
3517
|
+
*/
|
|
3518
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
3519
|
+
/**
|
|
3520
|
+
* Payment ID.
|
|
3521
|
+
* @format GUID
|
|
3522
|
+
* @readonly
|
|
3523
|
+
*/
|
|
3524
|
+
_id?: string | null;
|
|
3525
|
+
/** 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. */
|
|
3526
|
+
_createdDate?: Date | null;
|
|
3527
|
+
/**
|
|
3528
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
3529
|
+
* @readonly
|
|
3530
|
+
*/
|
|
3531
|
+
_updatedDate?: Date | null;
|
|
3532
|
+
/** Payment amount. */
|
|
3533
|
+
amount?: Price;
|
|
3534
|
+
/**
|
|
3535
|
+
* Whether refunds for this payment are disabled.
|
|
3536
|
+
* + `true`: This payment is not refundable.
|
|
3537
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
3538
|
+
*/
|
|
3539
|
+
refundDisabled?: boolean;
|
|
3540
|
+
/**
|
|
3541
|
+
* Whether receipt generation for this payment are allowed.
|
|
3542
|
+
* + `true`: This payment supports receipt generation.
|
|
3543
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
3544
|
+
* @internal
|
|
3545
|
+
* @readonly
|
|
3546
|
+
*/
|
|
3547
|
+
supportReceiptGeneration?: boolean;
|
|
3548
|
+
}
|
|
3549
|
+
/** @oneof */
|
|
3550
|
+
interface PaymentPaymentDetailsOneOf {
|
|
3551
|
+
/** Regular payment details. */
|
|
3552
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
3553
|
+
/** Gift card payment details. */
|
|
3554
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3555
|
+
}
|
|
3556
|
+
/** @oneof */
|
|
3557
|
+
interface PaymentReceiptInfoOneOf {
|
|
3558
|
+
/**
|
|
3559
|
+
* Receipt created by Wix
|
|
3560
|
+
* @internal
|
|
3561
|
+
*/
|
|
3562
|
+
wixReceipt?: WixReceiptInfo;
|
|
3563
|
+
/**
|
|
3564
|
+
* Receipt created by an external system.
|
|
3565
|
+
* @internal
|
|
3566
|
+
*/
|
|
3567
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
3568
|
+
}
|
|
3569
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3570
|
+
/** Whether regular card used */
|
|
3571
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3572
|
+
/**
|
|
3573
|
+
* Wix Payments order ID.
|
|
3574
|
+
* @maxLength 100
|
|
3575
|
+
*/
|
|
3576
|
+
paymentOrderId?: string | null;
|
|
3577
|
+
/**
|
|
3578
|
+
* Payment gateway's transaction ID.
|
|
3579
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
3580
|
+
* @maxLength 100
|
|
3581
|
+
*/
|
|
3582
|
+
gatewayTransactionId?: string | null;
|
|
3583
|
+
/**
|
|
3584
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
3585
|
+
* + `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`
|
|
3586
|
+
* @maxLength 100
|
|
3587
|
+
*/
|
|
3588
|
+
paymentMethod?: string | null;
|
|
3589
|
+
/**
|
|
3590
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
3591
|
+
* @maxLength 100
|
|
3592
|
+
*/
|
|
3593
|
+
providerTransactionId?: string | null;
|
|
3594
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3595
|
+
offlinePayment?: boolean;
|
|
3596
|
+
/** Payment status. */
|
|
3597
|
+
status?: TransactionStatusWithLiterals;
|
|
3598
|
+
/**
|
|
3599
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
3600
|
+
* @immutable
|
|
3601
|
+
*/
|
|
3602
|
+
savedPaymentMethod?: boolean;
|
|
3603
|
+
/** Authorization details. */
|
|
3604
|
+
authorizationDetails?: AuthorizationDetails;
|
|
3605
|
+
/**
|
|
3606
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
3607
|
+
* @internal
|
|
3608
|
+
* @maxLength 300
|
|
3609
|
+
*/
|
|
3610
|
+
paymentProvider?: string | null;
|
|
3611
|
+
/**
|
|
3612
|
+
* Record of chargebacks made by the buyer.
|
|
3613
|
+
* @maxSize 6
|
|
3614
|
+
*/
|
|
3615
|
+
chargebacks?: Chargeback[];
|
|
3616
|
+
}
|
|
3617
|
+
/** @oneof */
|
|
3618
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3619
|
+
/** Whether regular card used */
|
|
3620
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3621
|
+
}
|
|
3622
|
+
declare enum TransactionStatus {
|
|
3623
|
+
UNDEFINED = "UNDEFINED",
|
|
3624
|
+
APPROVED = "APPROVED",
|
|
3625
|
+
PENDING = "PENDING",
|
|
3626
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3627
|
+
CANCELED = "CANCELED",
|
|
3628
|
+
DECLINED = "DECLINED",
|
|
3629
|
+
REFUNDED = "REFUNDED",
|
|
3630
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3631
|
+
AUTHORIZED = "AUTHORIZED",
|
|
3632
|
+
VOIDED = "VOIDED"
|
|
3633
|
+
}
|
|
3634
|
+
/** @enumType */
|
|
3635
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3636
|
+
interface CreditCardPaymentMethodDetails {
|
|
3637
|
+
/**
|
|
3638
|
+
* The last 4 digits of the card number.
|
|
3639
|
+
* @maxLength 4
|
|
3640
|
+
*/
|
|
3641
|
+
lastFourDigits?: string | null;
|
|
3642
|
+
/**
|
|
3643
|
+
* Card issuer's brand.
|
|
3644
|
+
* @maxLength 100
|
|
3645
|
+
*/
|
|
3646
|
+
brand?: string | null;
|
|
3647
|
+
}
|
|
3648
|
+
interface AuthorizationDetails {
|
|
3649
|
+
/**
|
|
3650
|
+
* Whether the authorized payment is of a delayed capture.
|
|
3651
|
+
* @readonly
|
|
3652
|
+
*/
|
|
3653
|
+
delayedCapture?: boolean;
|
|
3654
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3655
|
+
authorizedDate?: Date | null;
|
|
3656
|
+
/**
|
|
3657
|
+
* List of captures associated with payment
|
|
3658
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3659
|
+
* @maxSize 1
|
|
3660
|
+
*/
|
|
3661
|
+
captures?: AuthorizationCapture[];
|
|
3662
|
+
/** Void associated with payment */
|
|
3663
|
+
void?: AuthorizationVoid;
|
|
3664
|
+
/** Scheduled action for this transaction */
|
|
3665
|
+
scheduledAction?: V1ScheduledAction;
|
|
3666
|
+
}
|
|
3667
|
+
interface AuthorizationCapture {
|
|
3668
|
+
/**
|
|
3669
|
+
* Capture ID.
|
|
3670
|
+
* @format GUID
|
|
3671
|
+
* @readonly
|
|
3672
|
+
*/
|
|
3673
|
+
_id?: string | null;
|
|
3674
|
+
/** Status of this capture action */
|
|
3675
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3676
|
+
/**
|
|
3677
|
+
* Amount of this capture
|
|
3678
|
+
* @immutable
|
|
3679
|
+
*/
|
|
3680
|
+
amount?: Price;
|
|
3681
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3682
|
+
_createdDate?: Date | null;
|
|
3683
|
+
/** In case of status is FAILED may contain failure details */
|
|
3684
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3685
|
+
}
|
|
3686
|
+
declare enum AuthorizationCaptureStatus {
|
|
3687
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3688
|
+
/** Capture operation still in progress. */
|
|
3689
|
+
PENDING = "PENDING",
|
|
3690
|
+
/** Capture operation succeeded. */
|
|
3691
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3692
|
+
/** Capture operation failed. */
|
|
3693
|
+
FAILED = "FAILED"
|
|
3694
|
+
}
|
|
3695
|
+
/** @enumType */
|
|
3696
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3697
|
+
interface AuthorizationActionFailureDetails {
|
|
3698
|
+
/** @maxLength 100 */
|
|
3699
|
+
failureCode?: string;
|
|
3700
|
+
}
|
|
3701
|
+
interface AuthorizationVoid {
|
|
3702
|
+
/** Status of this void action */
|
|
3703
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
3704
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3705
|
+
voidedDate?: Date | null;
|
|
3706
|
+
/** In case of status is FAILED may contain failure details */
|
|
3707
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
3708
|
+
/** Reason of void action */
|
|
3709
|
+
reason?: ReasonWithLiterals;
|
|
3710
|
+
}
|
|
3711
|
+
declare enum AuthorizationVoidStatus {
|
|
3712
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3713
|
+
/** Void operation still in progress. */
|
|
3714
|
+
PENDING = "PENDING",
|
|
3715
|
+
/** Void operation succeeded. */
|
|
3716
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3717
|
+
/** Void operation failed. */
|
|
3718
|
+
FAILED = "FAILED"
|
|
3719
|
+
}
|
|
3720
|
+
/** @enumType */
|
|
3721
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3722
|
+
/** Reason the authorization was voided. */
|
|
3723
|
+
declare enum Reason {
|
|
3724
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3725
|
+
/** Authorization was voided by user. */
|
|
3726
|
+
MANUAL = "MANUAL",
|
|
3727
|
+
/** Authorization passed execution date. */
|
|
3728
|
+
SCHEDULED = "SCHEDULED"
|
|
3729
|
+
}
|
|
3730
|
+
/** @enumType */
|
|
3731
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3732
|
+
interface V1ScheduledAction {
|
|
3733
|
+
/** Type of the action. */
|
|
3734
|
+
actionType?: ActionTypeWithLiterals;
|
|
3735
|
+
/** The date and time of the action. */
|
|
3736
|
+
executionDate?: Date | null;
|
|
3737
|
+
}
|
|
3738
|
+
declare enum ActionType {
|
|
3739
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3740
|
+
VOID = "VOID",
|
|
3741
|
+
CAPTURE = "CAPTURE"
|
|
3742
|
+
}
|
|
3743
|
+
/** @enumType */
|
|
3744
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3745
|
+
interface Chargeback {
|
|
3746
|
+
/**
|
|
3747
|
+
* Chargeback ID.
|
|
3748
|
+
* @format GUID
|
|
3749
|
+
* @readonly
|
|
3750
|
+
* @immutable
|
|
3751
|
+
*/
|
|
3752
|
+
_id?: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* 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.
|
|
3755
|
+
* @readonly
|
|
3756
|
+
* @immutable
|
|
3757
|
+
*/
|
|
3758
|
+
_createdDate?: Date | null;
|
|
3759
|
+
/**
|
|
3760
|
+
* 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.
|
|
3761
|
+
* @readonly
|
|
3762
|
+
*/
|
|
3763
|
+
_updatedDate?: Date | null;
|
|
3764
|
+
/**
|
|
3765
|
+
* Amount.
|
|
3766
|
+
* @readonly
|
|
3767
|
+
* @immutable
|
|
3768
|
+
*/
|
|
3769
|
+
amount?: Price;
|
|
3770
|
+
/**
|
|
3771
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
3772
|
+
* @readonly
|
|
3773
|
+
*/
|
|
3774
|
+
reversalAmount?: Price;
|
|
3775
|
+
/**
|
|
3776
|
+
* Status.
|
|
3777
|
+
*
|
|
3778
|
+
* Default: `"APPROVED"`.
|
|
3779
|
+
*/
|
|
3780
|
+
status?: ChargebackStatusWithLiterals;
|
|
3781
|
+
/**
|
|
3782
|
+
* External chargeback ID.
|
|
3783
|
+
* @format GUID
|
|
3784
|
+
* @readonly
|
|
3785
|
+
* @immutable
|
|
3786
|
+
*/
|
|
3787
|
+
externalId?: string | null;
|
|
3788
|
+
}
|
|
3789
|
+
declare enum ChargebackStatus {
|
|
3790
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3791
|
+
/** Chargeback was approved. */
|
|
3792
|
+
APPROVED = "APPROVED",
|
|
3793
|
+
/** Chargeback was reversed. */
|
|
3794
|
+
REVERSED = "REVERSED"
|
|
3795
|
+
}
|
|
3796
|
+
/** @enumType */
|
|
3797
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3798
|
+
interface GiftCardPaymentDetails {
|
|
3799
|
+
/**
|
|
3800
|
+
* Gift card payment ID.
|
|
3801
|
+
* @minLength 1
|
|
3802
|
+
* @maxLength 100
|
|
3803
|
+
*/
|
|
3804
|
+
giftCardPaymentId?: string;
|
|
3805
|
+
/**
|
|
3806
|
+
* ID of the app that created the gift card.
|
|
3807
|
+
* @format GUID
|
|
3808
|
+
*/
|
|
3809
|
+
appId?: string;
|
|
3810
|
+
/**
|
|
3811
|
+
* Whether the gift card is voided.
|
|
3812
|
+
* @readonly
|
|
3813
|
+
*/
|
|
3814
|
+
voided?: boolean;
|
|
3815
|
+
/**
|
|
3816
|
+
* Gift card obfuscated code.
|
|
3817
|
+
* @internal
|
|
3818
|
+
* @maxLength 30
|
|
3819
|
+
* @immutable
|
|
3820
|
+
*/
|
|
3821
|
+
obfuscatedCode?: string | null;
|
|
3822
|
+
}
|
|
3823
|
+
interface MembershipPaymentDetails {
|
|
3824
|
+
/**
|
|
3825
|
+
* Membership ID.
|
|
3826
|
+
* @minLength 1
|
|
3827
|
+
* @maxLength 100
|
|
3828
|
+
*/
|
|
3829
|
+
membershipId?: string;
|
|
3830
|
+
/**
|
|
3831
|
+
* ID of the line item this membership applies to.
|
|
3832
|
+
* @minLength 1
|
|
3833
|
+
* @maxLength 100
|
|
3834
|
+
*/
|
|
3835
|
+
lineItemId?: string;
|
|
3836
|
+
/** Payment status. */
|
|
3837
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
3838
|
+
/** Membership name. */
|
|
3839
|
+
name?: MembershipName;
|
|
3840
|
+
/**
|
|
3841
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3842
|
+
* @minLength 1
|
|
3843
|
+
* @maxLength 100
|
|
3844
|
+
*/
|
|
3845
|
+
externalTransactionId?: string | null;
|
|
3846
|
+
/**
|
|
3847
|
+
* Whether the membership is voided.
|
|
3848
|
+
* @readonly
|
|
3849
|
+
*/
|
|
3850
|
+
voided?: boolean;
|
|
3851
|
+
/**
|
|
3852
|
+
* ID of the application providing this payment option.
|
|
3853
|
+
* @format GUID
|
|
3854
|
+
*/
|
|
3855
|
+
providerAppId?: string;
|
|
3856
|
+
}
|
|
3857
|
+
declare enum MembershipPaymentStatus {
|
|
3858
|
+
/** Payment was charged. */
|
|
3859
|
+
CHARGED = "CHARGED",
|
|
3860
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3861
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3862
|
+
}
|
|
3863
|
+
/** @enumType */
|
|
3864
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3865
|
+
interface WixReceiptInfo {
|
|
3866
|
+
/**
|
|
3867
|
+
* Receipt ID
|
|
3868
|
+
* @format GUID
|
|
3869
|
+
*/
|
|
3870
|
+
receiptId?: string;
|
|
3871
|
+
/**
|
|
3872
|
+
* Display number of receipt
|
|
3873
|
+
* @minLength 1
|
|
3874
|
+
* @maxLength 40
|
|
3875
|
+
*/
|
|
3876
|
+
displayNumber?: string | null;
|
|
3877
|
+
}
|
|
3878
|
+
interface ExternalReceiptInfo {
|
|
3879
|
+
/**
|
|
3880
|
+
* External receipt ID
|
|
3881
|
+
* @maxLength 100
|
|
3882
|
+
*/
|
|
3883
|
+
receiptId?: string | null;
|
|
3884
|
+
/**
|
|
3885
|
+
* ID of the app providing the receipt
|
|
3886
|
+
* @format GUID
|
|
3887
|
+
*/
|
|
3888
|
+
appId?: string | null;
|
|
3889
|
+
/**
|
|
3890
|
+
* Display number of receipt
|
|
3891
|
+
* @minLength 1
|
|
3892
|
+
* @maxLength 40
|
|
3893
|
+
*/
|
|
3894
|
+
displayNumber?: string | null;
|
|
3895
|
+
}
|
|
3896
|
+
interface Refund {
|
|
3897
|
+
/**
|
|
3898
|
+
* Refund ID.
|
|
3899
|
+
* @format GUID
|
|
3900
|
+
* @readonly
|
|
3901
|
+
*/
|
|
3902
|
+
_id?: string;
|
|
3903
|
+
/**
|
|
3904
|
+
* List of transactions.
|
|
3905
|
+
* @maxSize 50
|
|
3906
|
+
*/
|
|
3907
|
+
transactions?: RefundTransaction[];
|
|
3908
|
+
/** Refund business details. */
|
|
3909
|
+
details?: RefundDetails;
|
|
3910
|
+
/**
|
|
3911
|
+
* 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.
|
|
3912
|
+
* @readonly
|
|
3913
|
+
* @immutable
|
|
3914
|
+
*/
|
|
3915
|
+
_createdDate?: Date | null;
|
|
3916
|
+
/**
|
|
3917
|
+
* Aggregated refund summary.
|
|
3918
|
+
* @readonly
|
|
3919
|
+
*/
|
|
3920
|
+
summary?: AggregatedRefundSummary;
|
|
3921
|
+
/**
|
|
3922
|
+
* ID of the app that initiated this refund.
|
|
3923
|
+
* @format GUID
|
|
3924
|
+
* @readonly
|
|
3925
|
+
* @immutable
|
|
3926
|
+
*/
|
|
3927
|
+
requestingServiceAppId?: string | null;
|
|
3928
|
+
}
|
|
3929
|
+
interface RefundTransaction {
|
|
3930
|
+
/**
|
|
3931
|
+
* ID of the payment associated with this refund.
|
|
3932
|
+
* @format GUID
|
|
3933
|
+
* @immutable
|
|
3934
|
+
*/
|
|
3935
|
+
paymentId?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* Refund amount.
|
|
3938
|
+
* @immutable
|
|
3939
|
+
*/
|
|
3940
|
+
amount?: Price;
|
|
3941
|
+
/** Refund status. */
|
|
3942
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
3943
|
+
/** Optional details of current refund status. */
|
|
3944
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
3945
|
+
/**
|
|
3946
|
+
* Payment gateway's refund ID.
|
|
3947
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
3948
|
+
* @format GUID
|
|
3949
|
+
*/
|
|
3950
|
+
gatewayRefundId?: string | null;
|
|
3951
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3952
|
+
providerRefundId?: string | null;
|
|
3953
|
+
/**
|
|
3954
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
3955
|
+
* @immutable
|
|
3956
|
+
*/
|
|
3957
|
+
externalRefund?: boolean;
|
|
3958
|
+
}
|
|
3959
|
+
/** Refund transaction status. */
|
|
3960
|
+
declare enum RefundStatus {
|
|
3961
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3962
|
+
PENDING = "PENDING",
|
|
3963
|
+
/** Refund transaction succeeded. */
|
|
3964
|
+
SUCCEEDED = "SUCCEEDED",
|
|
3965
|
+
/** Refund transaction failed. */
|
|
3966
|
+
FAILED = "FAILED",
|
|
3967
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
3968
|
+
SCHEDULED = "SCHEDULED",
|
|
3969
|
+
/** Refund was initiated on payment provider side. */
|
|
3970
|
+
STARTED = "STARTED"
|
|
3971
|
+
}
|
|
3972
|
+
/** @enumType */
|
|
3973
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3974
|
+
interface RefundStatusInfo {
|
|
3975
|
+
/**
|
|
3976
|
+
* Reason code for the refund's current status.
|
|
3977
|
+
*
|
|
3978
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3979
|
+
* @minLength 1
|
|
3980
|
+
* @maxLength 10
|
|
3981
|
+
*/
|
|
3982
|
+
paymentGatewayReasonCode?: string | null;
|
|
3983
|
+
/**
|
|
3984
|
+
* Free text explanation of current refund status.
|
|
3985
|
+
* @minLength 1
|
|
3986
|
+
* @maxLength 1000
|
|
3987
|
+
*/
|
|
3988
|
+
description?: string | null;
|
|
3989
|
+
}
|
|
3990
|
+
interface AggregatedRefundSummary {
|
|
3991
|
+
/** Total amount requested for refund. */
|
|
3992
|
+
requestedRefund?: Price;
|
|
3993
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3994
|
+
pendingRefund?: Price;
|
|
3995
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3996
|
+
refunded?: Price;
|
|
3997
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3998
|
+
failedRefundAmount?: Price;
|
|
3999
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
4000
|
+
pending?: boolean;
|
|
4001
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
4002
|
+
breakdown?: RefundItemsBreakdown;
|
|
4003
|
+
}
|
|
4004
|
+
interface RefundItemsBreakdown {
|
|
4005
|
+
/**
|
|
4006
|
+
* Refunded line items and the amount refunded for each.
|
|
4007
|
+
* @maxSize 300
|
|
4008
|
+
*/
|
|
4009
|
+
lineItems?: LineItemRefundSummary[];
|
|
4010
|
+
}
|
|
4011
|
+
interface LineItemRefundSummary {
|
|
4012
|
+
/**
|
|
4013
|
+
* ID of the refunded line item.
|
|
4014
|
+
* @format GUID
|
|
4015
|
+
*/
|
|
4016
|
+
lineItemId?: string;
|
|
4017
|
+
/** Total refunded amount for the line item. */
|
|
4018
|
+
totalRefundedAmount?: Price;
|
|
4019
|
+
}
|
|
4020
|
+
interface CalculateRefundRequest {
|
|
4021
|
+
/**
|
|
4022
|
+
* Order ID
|
|
4023
|
+
* @minLength 1
|
|
4024
|
+
* @maxLength 100
|
|
4025
|
+
*/
|
|
4026
|
+
ecomOrderId?: string;
|
|
4027
|
+
/**
|
|
4028
|
+
* Refunded line items and quantity
|
|
4029
|
+
* @maxSize 300
|
|
4030
|
+
*/
|
|
4031
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
4032
|
+
/** Should include shipping in refund calculation */
|
|
4033
|
+
refundShipping?: boolean;
|
|
4034
|
+
}
|
|
4035
|
+
interface CalculateRefundItemRequest {
|
|
4036
|
+
/**
|
|
4037
|
+
* ID of the line item being refunded
|
|
4038
|
+
* @format GUID
|
|
4039
|
+
*/
|
|
4040
|
+
_id?: string;
|
|
4041
|
+
/**
|
|
4042
|
+
* How much of that line item is being refunded
|
|
4043
|
+
* @min 1
|
|
4044
|
+
* @max 100000
|
|
4045
|
+
*/
|
|
4046
|
+
quantity?: number;
|
|
4047
|
+
}
|
|
4048
|
+
interface CalculateRefundResponse {
|
|
4049
|
+
/** Total refundable amount */
|
|
4050
|
+
total?: Price;
|
|
4051
|
+
/** Tax cost of the order */
|
|
4052
|
+
tax?: Price;
|
|
4053
|
+
/** Discount given for this order */
|
|
4054
|
+
discount?: Price;
|
|
4055
|
+
/** Total cost of the order (without tax) */
|
|
4056
|
+
subtotal?: Price;
|
|
4057
|
+
/** Total shipping cost for order */
|
|
4058
|
+
shipping?: Price;
|
|
4059
|
+
/** Previous refund given on that order */
|
|
4060
|
+
previouslyRefundedAmount?: Price;
|
|
4061
|
+
/**
|
|
4062
|
+
* The refundable items of that order
|
|
4063
|
+
* @maxSize 300
|
|
4064
|
+
*/
|
|
4065
|
+
items?: CalculateRefundItemResponse[];
|
|
4066
|
+
}
|
|
4067
|
+
interface CalculateRefundItemResponse {
|
|
4068
|
+
/**
|
|
4069
|
+
* Line item ID
|
|
4070
|
+
* @format GUID
|
|
4071
|
+
*/
|
|
4072
|
+
_id?: string;
|
|
4073
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
4074
|
+
price?: Price;
|
|
4075
|
+
}
|
|
4076
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
4077
|
+
/**
|
|
4078
|
+
* Wix eCommerce order ID
|
|
4079
|
+
* @minLength 1
|
|
4080
|
+
* @maxLength 100
|
|
4081
|
+
*/
|
|
4082
|
+
ecomOrderId: string;
|
|
4083
|
+
/**
|
|
4084
|
+
* Payment IDs
|
|
4085
|
+
* @minSize 1
|
|
4086
|
+
* @maxSize 100
|
|
4087
|
+
* @format GUID
|
|
4088
|
+
*/
|
|
4089
|
+
paymentIds: string[];
|
|
4090
|
+
}
|
|
4091
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
4092
|
+
/** All order's transactions after the void was triggered */
|
|
4093
|
+
orderTransactions?: OrderTransactions;
|
|
2603
4094
|
}
|
|
2604
|
-
interface
|
|
2605
|
-
/** @format GUID */
|
|
2606
|
-
metasiteId?: string;
|
|
4095
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
2607
4096
|
/**
|
|
4097
|
+
* Wix eCommerce order ID
|
|
2608
4098
|
* @minLength 1
|
|
2609
4099
|
* @maxLength 100
|
|
2610
4100
|
*/
|
|
2611
|
-
|
|
4101
|
+
ecomOrderId: string;
|
|
4102
|
+
/**
|
|
4103
|
+
* Capture payments information
|
|
4104
|
+
* @minSize 1
|
|
4105
|
+
* @maxSize 100
|
|
4106
|
+
*/
|
|
4107
|
+
payments: PaymentCapture[];
|
|
2612
4108
|
}
|
|
2613
|
-
interface
|
|
4109
|
+
interface PaymentCapture {
|
|
2614
4110
|
/**
|
|
2615
|
-
*
|
|
4111
|
+
* Payment ID
|
|
2616
4112
|
* @format GUID
|
|
2617
4113
|
*/
|
|
2618
|
-
|
|
4114
|
+
paymentId?: string | null;
|
|
2619
4115
|
/**
|
|
2620
|
-
*
|
|
2621
|
-
*
|
|
4116
|
+
* Capture amount.
|
|
4117
|
+
* If not provided - full authorized amount will be captured.
|
|
2622
4118
|
*/
|
|
2623
|
-
|
|
2624
|
-
/** The identification type and identity data. */
|
|
2625
|
-
identity?: IdentificationData;
|
|
2626
|
-
/** Stringify payload. */
|
|
2627
|
-
data?: string;
|
|
4119
|
+
amount?: Price;
|
|
2628
4120
|
}
|
|
2629
|
-
interface
|
|
4121
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
4122
|
+
/** All order's transactions after the capture was triggered */
|
|
4123
|
+
orderTransactions?: OrderTransactions;
|
|
4124
|
+
}
|
|
4125
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
2630
4126
|
/**
|
|
2631
|
-
*
|
|
2632
|
-
* @
|
|
4127
|
+
* Ecom Order ID.
|
|
4128
|
+
* @minLength 1
|
|
4129
|
+
* @maxLength 100
|
|
2633
4130
|
*/
|
|
2634
|
-
|
|
4131
|
+
ecomOrderId?: string;
|
|
4132
|
+
/** Amount to be charged */
|
|
4133
|
+
amount?: Price;
|
|
4134
|
+
}
|
|
4135
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
4136
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
4137
|
+
paymentGatewayOrderId?: string;
|
|
4138
|
+
}
|
|
4139
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4140
|
+
/** insert/update documents */
|
|
4141
|
+
update?: InternalDocumentUpdateOperation;
|
|
4142
|
+
/** delete by document ids */
|
|
4143
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
4144
|
+
/** delete documents matching filter */
|
|
4145
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
4146
|
+
/** update internal documents matching filter */
|
|
4147
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4148
|
+
/** update only existing documents */
|
|
4149
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
4150
|
+
/** insert/update documents with versioning */
|
|
4151
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4152
|
+
/** delete by document ids with versioning */
|
|
4153
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2635
4154
|
/**
|
|
2636
|
-
*
|
|
2637
|
-
* @
|
|
4155
|
+
* type of the documents
|
|
4156
|
+
* @minLength 2
|
|
2638
4157
|
*/
|
|
2639
|
-
|
|
4158
|
+
documentType?: string;
|
|
2640
4159
|
/**
|
|
2641
|
-
*
|
|
2642
|
-
* @
|
|
4160
|
+
* language of the documents (mandatory)
|
|
4161
|
+
* @minLength 2
|
|
2643
4162
|
*/
|
|
2644
|
-
|
|
4163
|
+
language?: string | null;
|
|
2645
4164
|
/**
|
|
2646
|
-
*
|
|
2647
|
-
* @
|
|
4165
|
+
* one or more search documents
|
|
4166
|
+
* @deprecated
|
|
2648
4167
|
*/
|
|
2649
|
-
|
|
2650
|
-
/**
|
|
2651
|
-
|
|
4168
|
+
addDocuments?: InternalDocument[];
|
|
4169
|
+
/**
|
|
4170
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
4171
|
+
* @deprecated
|
|
4172
|
+
*/
|
|
4173
|
+
removeDocumentIds?: string[];
|
|
4174
|
+
/** id to pass to processing notification */
|
|
4175
|
+
correlationId?: string | null;
|
|
4176
|
+
/** when event was created / issued */
|
|
4177
|
+
issuedAt?: Date | null;
|
|
2652
4178
|
}
|
|
2653
4179
|
/** @oneof */
|
|
2654
|
-
interface
|
|
4180
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4181
|
+
/** insert/update documents */
|
|
4182
|
+
update?: InternalDocumentUpdateOperation;
|
|
4183
|
+
/** delete by document ids */
|
|
4184
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
4185
|
+
/** delete documents matching filter */
|
|
4186
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
4187
|
+
/** update internal documents matching filter */
|
|
4188
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4189
|
+
/** update only existing documents */
|
|
4190
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
4191
|
+
/** insert/update documents with versioning */
|
|
4192
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4193
|
+
/** delete by document ids with versioning */
|
|
4194
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4195
|
+
}
|
|
4196
|
+
interface InternalDocument {
|
|
4197
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4198
|
+
document?: Record<string, any> | null;
|
|
4199
|
+
}
|
|
4200
|
+
interface InternalDocumentUpdateOperation {
|
|
4201
|
+
/** documents to index or update */
|
|
4202
|
+
documents?: InternalDocument[];
|
|
4203
|
+
}
|
|
4204
|
+
interface DeleteByIdsOperation {
|
|
4205
|
+
/** ids of the documents to delete */
|
|
4206
|
+
documentIds?: string[];
|
|
2655
4207
|
/**
|
|
2656
|
-
*
|
|
2657
|
-
* @
|
|
4208
|
+
* tenant id for custom tenancy strategy
|
|
4209
|
+
* @minLength 2
|
|
4210
|
+
* @maxLength 300
|
|
2658
4211
|
*/
|
|
2659
|
-
|
|
4212
|
+
tenantId?: string | null;
|
|
4213
|
+
}
|
|
4214
|
+
interface DeleteByFilterOperation {
|
|
4215
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4216
|
+
filter?: Record<string, any> | null;
|
|
2660
4217
|
/**
|
|
2661
|
-
*
|
|
2662
|
-
* @
|
|
4218
|
+
* tenant id for custom tenancy strategy
|
|
4219
|
+
* @minLength 2
|
|
4220
|
+
* @maxLength 300
|
|
2663
4221
|
*/
|
|
2664
|
-
|
|
4222
|
+
tenantId?: string | null;
|
|
4223
|
+
}
|
|
4224
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
4225
|
+
/** documents matching this filter will be updated */
|
|
4226
|
+
filter?: Record<string, any> | null;
|
|
4227
|
+
/** partial document to apply */
|
|
4228
|
+
document?: InternalDocument;
|
|
2665
4229
|
/**
|
|
2666
|
-
*
|
|
2667
|
-
* @
|
|
4230
|
+
* tenant id for custom tenancy strategy
|
|
4231
|
+
* @minLength 2
|
|
4232
|
+
* @maxLength 300
|
|
2668
4233
|
*/
|
|
2669
|
-
|
|
4234
|
+
tenantId?: string | null;
|
|
4235
|
+
}
|
|
4236
|
+
interface InternalUpdateExistingOperation {
|
|
4237
|
+
/** documents to update */
|
|
4238
|
+
documents?: InternalDocument[];
|
|
4239
|
+
}
|
|
4240
|
+
interface VersionedDocumentUpdateOperation {
|
|
4241
|
+
/** documents to create or overwrite */
|
|
4242
|
+
documents?: InternalDocument[];
|
|
4243
|
+
/** versioning mode to use instead of default */
|
|
4244
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4245
|
+
}
|
|
4246
|
+
declare enum VersioningMode {
|
|
4247
|
+
/** use default versioning mode agreed with search team */
|
|
4248
|
+
DEFAULT = "DEFAULT",
|
|
4249
|
+
/** execute only if version is greater than existing */
|
|
4250
|
+
GREATER_THAN = "GREATER_THAN",
|
|
4251
|
+
/** execute only if version is greater or equal to existing */
|
|
4252
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4253
|
+
}
|
|
4254
|
+
/** @enumType */
|
|
4255
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4256
|
+
interface VersionedDeleteByIdsOperation {
|
|
4257
|
+
/** ids with version of the documents to delete */
|
|
4258
|
+
documentIds?: VersionedDocumentId[];
|
|
2670
4259
|
/**
|
|
2671
|
-
*
|
|
2672
|
-
* @
|
|
4260
|
+
* tenant id for custom tenancy strategy
|
|
4261
|
+
* @minLength 2
|
|
4262
|
+
* @maxLength 300
|
|
2673
4263
|
*/
|
|
2674
|
-
|
|
4264
|
+
tenantId?: string | null;
|
|
2675
4265
|
}
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
|
|
4266
|
+
interface VersionedDocumentId {
|
|
4267
|
+
/** document id */
|
|
4268
|
+
documentId?: string;
|
|
4269
|
+
/** document version */
|
|
4270
|
+
version?: string;
|
|
4271
|
+
/** versioning mode to use instead of default */
|
|
4272
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4273
|
+
}
|
|
4274
|
+
interface TriggerReindexRequest {
|
|
4275
|
+
/** @format GUID */
|
|
4276
|
+
metasiteId?: string;
|
|
4277
|
+
/**
|
|
4278
|
+
* @minLength 1
|
|
4279
|
+
* @maxLength 100
|
|
4280
|
+
* @maxSize 100
|
|
4281
|
+
*/
|
|
4282
|
+
orderIds?: string[];
|
|
4283
|
+
}
|
|
4284
|
+
interface TriggerReindexResponse {
|
|
4285
|
+
}
|
|
4286
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
4287
|
+
/** @maxSize 25 */
|
|
4288
|
+
requests?: TriggerReindexOrderRequest[];
|
|
4289
|
+
}
|
|
4290
|
+
interface TriggerReindexOrderRequest {
|
|
4291
|
+
/** @format GUID */
|
|
4292
|
+
metasiteId?: string;
|
|
4293
|
+
/**
|
|
4294
|
+
* @minLength 1
|
|
4295
|
+
* @maxLength 100
|
|
4296
|
+
*/
|
|
4297
|
+
orderId?: string;
|
|
2682
4298
|
}
|
|
2683
|
-
/** @enumType */
|
|
2684
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2685
4299
|
interface DiffmatokyPayload {
|
|
2686
4300
|
left?: string;
|
|
2687
4301
|
right?: string;
|
|
@@ -2949,42 +4563,6 @@ interface BulkUpdateOrdersResponse {
|
|
|
2949
4563
|
/** Bulk action metadata. */
|
|
2950
4564
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2951
4565
|
}
|
|
2952
|
-
interface BulkOrderResult {
|
|
2953
|
-
/** Item metadata. */
|
|
2954
|
-
itemMetadata?: ItemMetadata;
|
|
2955
|
-
/**
|
|
2956
|
-
* Updated order.
|
|
2957
|
-
*
|
|
2958
|
-
* Returned when `returnFullEntity = true`.
|
|
2959
|
-
*/
|
|
2960
|
-
item?: Order;
|
|
2961
|
-
}
|
|
2962
|
-
interface ItemMetadata {
|
|
2963
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2964
|
-
_id?: string | null;
|
|
2965
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2966
|
-
originalIndex?: number;
|
|
2967
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2968
|
-
success?: boolean;
|
|
2969
|
-
/** Details about the error in case of failure. */
|
|
2970
|
-
error?: ApplicationError;
|
|
2971
|
-
}
|
|
2972
|
-
interface ApplicationError {
|
|
2973
|
-
/** Error code. */
|
|
2974
|
-
code?: string;
|
|
2975
|
-
/** Description of the error. */
|
|
2976
|
-
description?: string;
|
|
2977
|
-
/** Data related to the error. */
|
|
2978
|
-
data?: Record<string, any> | null;
|
|
2979
|
-
}
|
|
2980
|
-
interface BulkActionMetadata {
|
|
2981
|
-
/** Number of items that were successfully processed. */
|
|
2982
|
-
totalSuccesses?: number;
|
|
2983
|
-
/** Number of items that couldn't be processed. */
|
|
2984
|
-
totalFailures?: number;
|
|
2985
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2986
|
-
undetailedFailures?: number;
|
|
2987
|
-
}
|
|
2988
4566
|
interface CommitDeltasRequest {
|
|
2989
4567
|
/** Order id to be updated */
|
|
2990
4568
|
_id: string;
|
|
@@ -3009,6 +4587,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
3009
4587
|
changedShippingInfo?: V1ShippingInformation;
|
|
3010
4588
|
/** Remove existing shipping info. */
|
|
3011
4589
|
shippingInfoRemoved?: boolean;
|
|
4590
|
+
/**
|
|
4591
|
+
* Buyer info and selected buyer option details.
|
|
4592
|
+
* @internal
|
|
4593
|
+
*/
|
|
4594
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4595
|
+
/**
|
|
4596
|
+
* Remove existing buyer info.
|
|
4597
|
+
* @internal
|
|
4598
|
+
*/
|
|
4599
|
+
buyerInfoRemoved?: boolean;
|
|
4600
|
+
/**
|
|
4601
|
+
* Updated billing info.
|
|
4602
|
+
* @internal
|
|
4603
|
+
*/
|
|
4604
|
+
changedBillingInfo?: AddressWithContact;
|
|
4605
|
+
/**
|
|
4606
|
+
* Remove existing billing info.
|
|
4607
|
+
* @internal
|
|
4608
|
+
*/
|
|
4609
|
+
billingInfoRemoved?: boolean;
|
|
4610
|
+
/**
|
|
4611
|
+
* Updated recipient info.
|
|
4612
|
+
* @internal
|
|
4613
|
+
*/
|
|
4614
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4615
|
+
/**
|
|
4616
|
+
* Remove existing recipient info.
|
|
4617
|
+
* @internal
|
|
4618
|
+
*/
|
|
4619
|
+
recipientInfoRemoved?: boolean;
|
|
3012
4620
|
/**
|
|
3013
4621
|
* Added/updated/removed order line items.
|
|
3014
4622
|
* @maxSize 300
|
|
@@ -3050,12 +4658,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
3050
4658
|
}
|
|
3051
4659
|
/** @oneof */
|
|
3052
4660
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4661
|
+
/**
|
|
4662
|
+
* Buyer info and selected buyer option details.
|
|
4663
|
+
* @internal
|
|
4664
|
+
*/
|
|
4665
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4666
|
+
/**
|
|
4667
|
+
* Remove existing buyer info.
|
|
4668
|
+
* @internal
|
|
4669
|
+
*/
|
|
4670
|
+
buyerInfoRemoved?: boolean;
|
|
3053
4671
|
}
|
|
3054
4672
|
/** @oneof */
|
|
3055
4673
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4674
|
+
/**
|
|
4675
|
+
* Updated billing info.
|
|
4676
|
+
* @internal
|
|
4677
|
+
*/
|
|
4678
|
+
changedBillingInfo?: AddressWithContact;
|
|
4679
|
+
/**
|
|
4680
|
+
* Remove existing billing info.
|
|
4681
|
+
* @internal
|
|
4682
|
+
*/
|
|
4683
|
+
billingInfoRemoved?: boolean;
|
|
3056
4684
|
}
|
|
3057
4685
|
/** @oneof */
|
|
3058
4686
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4687
|
+
/**
|
|
4688
|
+
* Updated recipient info.
|
|
4689
|
+
* @internal
|
|
4690
|
+
*/
|
|
4691
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4692
|
+
/**
|
|
4693
|
+
* Remove existing recipient info.
|
|
4694
|
+
* @internal
|
|
4695
|
+
*/
|
|
4696
|
+
recipientInfoRemoved?: boolean;
|
|
3059
4697
|
}
|
|
3060
4698
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
3061
4699
|
/** The line item was added. */
|
|
@@ -3155,8 +4793,21 @@ interface OrderLineItemChangedDetails {
|
|
|
3155
4793
|
* @maxSize 5
|
|
3156
4794
|
*/
|
|
3157
4795
|
locations?: LocationAndQuantity[];
|
|
4796
|
+
/**
|
|
4797
|
+
* ID of the app managing the inventory.
|
|
4798
|
+
* @internal
|
|
4799
|
+
* @format GUID
|
|
4800
|
+
*/
|
|
4801
|
+
inventoryAppId?: string | null;
|
|
3158
4802
|
/** Subscription info. */
|
|
3159
4803
|
subscriptionInfo?: SubscriptionInfo;
|
|
4804
|
+
/**
|
|
4805
|
+
* Modifier groups that were added to the item.
|
|
4806
|
+
* @internal
|
|
4807
|
+
* @readonly
|
|
4808
|
+
* @maxSize 10
|
|
4809
|
+
*/
|
|
4810
|
+
modifierGroups?: ModifierGroup[];
|
|
3160
4811
|
}
|
|
3161
4812
|
/** Type of selected payment option for catalog item */
|
|
3162
4813
|
declare enum DeltaPaymentOptionType {
|
|
@@ -3543,6 +5194,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3543
5194
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3544
5195
|
/** Payment method is saved for order */
|
|
3545
5196
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5197
|
+
/**
|
|
5198
|
+
* Details of an initiated refund process.
|
|
5199
|
+
*
|
|
5200
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5201
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5202
|
+
* @internal
|
|
5203
|
+
*/
|
|
5204
|
+
refundInitiated?: RefundInitiated;
|
|
5205
|
+
/**
|
|
5206
|
+
* Details of a refunded payment.
|
|
5207
|
+
*
|
|
5208
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5209
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5210
|
+
* @internal
|
|
5211
|
+
*/
|
|
5212
|
+
paymentRefunded?: PaymentRefunded;
|
|
5213
|
+
/**
|
|
5214
|
+
* Details of a failed payment refund.
|
|
5215
|
+
*
|
|
5216
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5217
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5218
|
+
* @internal
|
|
5219
|
+
*/
|
|
5220
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5221
|
+
/**
|
|
5222
|
+
* Details of refund to store credit.
|
|
5223
|
+
* @internal
|
|
5224
|
+
*/
|
|
5225
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3546
5226
|
/** Details of a pending payment */
|
|
3547
5227
|
paymentPending?: PaymentPending;
|
|
3548
5228
|
/** Details of a canceled payment */
|
|
@@ -3553,6 +5233,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
3553
5233
|
orderPending?: OrderPending;
|
|
3554
5234
|
/** Order rejected */
|
|
3555
5235
|
orderRejected?: OrderRejected;
|
|
5236
|
+
/**
|
|
5237
|
+
* Receipt was added for associated payment
|
|
5238
|
+
* @internal
|
|
5239
|
+
*/
|
|
5240
|
+
receiptCreated?: ReceiptCreated;
|
|
5241
|
+
/**
|
|
5242
|
+
* Receipt sent to customer
|
|
5243
|
+
* @internal
|
|
5244
|
+
*/
|
|
5245
|
+
receiptSent?: ReceiptSent;
|
|
5246
|
+
/**
|
|
5247
|
+
* Chargeback created for one of the order's payments.
|
|
5248
|
+
* @internal
|
|
5249
|
+
*/
|
|
5250
|
+
chargebackCreated?: ChargebackCreated;
|
|
5251
|
+
/**
|
|
5252
|
+
* Chargeback reversed for one of the order's payments.
|
|
5253
|
+
* @internal
|
|
5254
|
+
*/
|
|
5255
|
+
chargebackReversed?: ChargebackReversed;
|
|
3556
5256
|
/**
|
|
3557
5257
|
* Internal activity ID.
|
|
3558
5258
|
* @format GUID
|
|
@@ -3617,6 +5317,35 @@ interface InternalActivityContentOneOf {
|
|
|
3617
5317
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
3618
5318
|
/** Payment method is saved for order */
|
|
3619
5319
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5320
|
+
/**
|
|
5321
|
+
* Details of an initiated refund process.
|
|
5322
|
+
*
|
|
5323
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5324
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5325
|
+
* @internal
|
|
5326
|
+
*/
|
|
5327
|
+
refundInitiated?: RefundInitiated;
|
|
5328
|
+
/**
|
|
5329
|
+
* Details of a refunded payment.
|
|
5330
|
+
*
|
|
5331
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5332
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5333
|
+
* @internal
|
|
5334
|
+
*/
|
|
5335
|
+
paymentRefunded?: PaymentRefunded;
|
|
5336
|
+
/**
|
|
5337
|
+
* Details of a failed payment refund.
|
|
5338
|
+
*
|
|
5339
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5340
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5341
|
+
* @internal
|
|
5342
|
+
*/
|
|
5343
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5344
|
+
/**
|
|
5345
|
+
* Details of refund to store credit.
|
|
5346
|
+
* @internal
|
|
5347
|
+
*/
|
|
5348
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
3620
5349
|
/** Details of a pending payment */
|
|
3621
5350
|
paymentPending?: PaymentPending;
|
|
3622
5351
|
/** Details of a canceled payment */
|
|
@@ -3627,6 +5356,26 @@ interface InternalActivityContentOneOf {
|
|
|
3627
5356
|
orderPending?: OrderPending;
|
|
3628
5357
|
/** Order rejected */
|
|
3629
5358
|
orderRejected?: OrderRejected;
|
|
5359
|
+
/**
|
|
5360
|
+
* Receipt was added for associated payment
|
|
5361
|
+
* @internal
|
|
5362
|
+
*/
|
|
5363
|
+
receiptCreated?: ReceiptCreated;
|
|
5364
|
+
/**
|
|
5365
|
+
* Receipt sent to customer
|
|
5366
|
+
* @internal
|
|
5367
|
+
*/
|
|
5368
|
+
receiptSent?: ReceiptSent;
|
|
5369
|
+
/**
|
|
5370
|
+
* Chargeback created for one of the order's payments.
|
|
5371
|
+
* @internal
|
|
5372
|
+
*/
|
|
5373
|
+
chargebackCreated?: ChargebackCreated;
|
|
5374
|
+
/**
|
|
5375
|
+
* Chargeback reversed for one of the order's payments.
|
|
5376
|
+
* @internal
|
|
5377
|
+
*/
|
|
5378
|
+
chargebackReversed?: ChargebackReversed;
|
|
3630
5379
|
}
|
|
3631
5380
|
/** Order placed */
|
|
3632
5381
|
interface OrderPlaced {
|
|
@@ -3987,7 +5736,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
3987
5736
|
interface BulkSetBusinessLocationResult {
|
|
3988
5737
|
itemMetadata?: ItemMetadata;
|
|
3989
5738
|
}
|
|
3990
|
-
interface
|
|
5739
|
+
interface V1MarkOrderAsPaidRequest {
|
|
3991
5740
|
/**
|
|
3992
5741
|
* Order ID.
|
|
3993
5742
|
* @minLength 1
|
|
@@ -3995,7 +5744,7 @@ interface MarkOrderAsPaidRequest {
|
|
|
3995
5744
|
*/
|
|
3996
5745
|
_id?: string;
|
|
3997
5746
|
}
|
|
3998
|
-
interface
|
|
5747
|
+
interface V1MarkOrderAsPaidResponse {
|
|
3999
5748
|
/** Updated order. */
|
|
4000
5749
|
order?: Order;
|
|
4001
5750
|
}
|
|
@@ -4006,7 +5755,7 @@ interface PaymentStatusUpdated {
|
|
|
4006
5755
|
/** The previous status (before the update) */
|
|
4007
5756
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
4008
5757
|
}
|
|
4009
|
-
interface
|
|
5758
|
+
interface V1BulkMarkOrdersAsPaidRequest {
|
|
4010
5759
|
/**
|
|
4011
5760
|
* IDs of orders to mark as paid.
|
|
4012
5761
|
* @minSize 1
|
|
@@ -4016,7 +5765,7 @@ interface BulkMarkOrdersAsPaidRequest {
|
|
|
4016
5765
|
*/
|
|
4017
5766
|
ids?: string[];
|
|
4018
5767
|
}
|
|
4019
|
-
interface
|
|
5768
|
+
interface V1BulkMarkOrdersAsPaidResponse {
|
|
4020
5769
|
/**
|
|
4021
5770
|
* Items updated by the bulk action.
|
|
4022
5771
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -4025,7 +5774,7 @@ interface BulkMarkOrdersAsPaidResponse {
|
|
|
4025
5774
|
/** Bulk action metadata. */
|
|
4026
5775
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4027
5776
|
}
|
|
4028
|
-
interface
|
|
5777
|
+
interface V1CreatePaymentGatewayOrderRequest {
|
|
4029
5778
|
/**
|
|
4030
5779
|
* eCom Order ID
|
|
4031
5780
|
* @minLength 1
|
|
@@ -4033,7 +5782,7 @@ interface CreatePaymentGatewayOrderRequest {
|
|
|
4033
5782
|
*/
|
|
4034
5783
|
ecomOrderId?: string;
|
|
4035
5784
|
}
|
|
4036
|
-
interface
|
|
5785
|
+
interface V1CreatePaymentGatewayOrderResponse {
|
|
4037
5786
|
/** ID of the order created in the payment gateway */
|
|
4038
5787
|
paymentGatewayOrderId?: string;
|
|
4039
5788
|
}
|
|
@@ -4441,9 +6190,9 @@ interface CalculatedTax {
|
|
|
4441
6190
|
code?: string | null;
|
|
4442
6191
|
}
|
|
4443
6192
|
interface Payments {
|
|
4444
|
-
payments?:
|
|
6193
|
+
payments?: InvoicesPayment[];
|
|
4445
6194
|
}
|
|
4446
|
-
interface
|
|
6195
|
+
interface InvoicesPayment {
|
|
4447
6196
|
/** document */
|
|
4448
6197
|
_id?: string;
|
|
4449
6198
|
type?: string;
|
|
@@ -4578,6 +6327,125 @@ interface TriggerSideEffectsFromLegacyData {
|
|
|
4578
6327
|
orderId?: string;
|
|
4579
6328
|
ordersExperiments?: OrdersExperiments;
|
|
4580
6329
|
}
|
|
6330
|
+
type PreparePaymentCollectionApplicationErrors = {
|
|
6331
|
+
code?: 'PAYMENT_METHODS_NOT_FOUND';
|
|
6332
|
+
description?: string;
|
|
6333
|
+
data?: Record<string, any>;
|
|
6334
|
+
} | {
|
|
6335
|
+
code?: 'ORDER_CANCELED';
|
|
6336
|
+
description?: string;
|
|
6337
|
+
data?: Record<string, any>;
|
|
6338
|
+
} | {
|
|
6339
|
+
code?: 'INVALID_AMOUNT';
|
|
6340
|
+
description?: string;
|
|
6341
|
+
data?: Record<string, any>;
|
|
6342
|
+
} | {
|
|
6343
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6344
|
+
description?: string;
|
|
6345
|
+
data?: Record<string, any>;
|
|
6346
|
+
} | {
|
|
6347
|
+
code?: 'NO_ASSOCIATED_ECOM_ORDER';
|
|
6348
|
+
description?: string;
|
|
6349
|
+
data?: Record<string, any>;
|
|
6350
|
+
};
|
|
6351
|
+
type RecordManuallyCollectedPaymentApplicationErrors = {
|
|
6352
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6353
|
+
description?: string;
|
|
6354
|
+
data?: Record<string, any>;
|
|
6355
|
+
} | {
|
|
6356
|
+
code?: 'INVALID_AMOUNT';
|
|
6357
|
+
description?: string;
|
|
6358
|
+
data?: Record<string, any>;
|
|
6359
|
+
} | {
|
|
6360
|
+
code?: 'ORDER_CANCELED';
|
|
6361
|
+
description?: string;
|
|
6362
|
+
data?: Record<string, any>;
|
|
6363
|
+
};
|
|
6364
|
+
type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
|
|
6365
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6366
|
+
description?: string;
|
|
6367
|
+
data?: Record<string, any>;
|
|
6368
|
+
} | {
|
|
6369
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6370
|
+
description?: string;
|
|
6371
|
+
data?: Record<string, any>;
|
|
6372
|
+
};
|
|
6373
|
+
type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
|
|
6374
|
+
code?: 'ORDER_ALREADY_PAID';
|
|
6375
|
+
description?: string;
|
|
6376
|
+
data?: Record<string, any>;
|
|
6377
|
+
} | {
|
|
6378
|
+
code?: 'ORDER_CANCELED';
|
|
6379
|
+
description?: string;
|
|
6380
|
+
data?: Record<string, any>;
|
|
6381
|
+
};
|
|
6382
|
+
type TriggerRefundApplicationErrors = {
|
|
6383
|
+
code?: 'PAYMENTS_NOT_FOUND';
|
|
6384
|
+
description?: string;
|
|
6385
|
+
data?: Record<string, any>;
|
|
6386
|
+
} | {
|
|
6387
|
+
code?: 'REFUND_NOT_AVAILABLE';
|
|
6388
|
+
description?: string;
|
|
6389
|
+
data?: Record<string, any>;
|
|
6390
|
+
} | {
|
|
6391
|
+
code?: 'INVALID_AMOUNT';
|
|
6392
|
+
description?: string;
|
|
6393
|
+
data?: Record<string, any>;
|
|
6394
|
+
};
|
|
6395
|
+
type VoidAuthorizedPaymentsApplicationErrors = {
|
|
6396
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6397
|
+
description?: string;
|
|
6398
|
+
data?: Record<string, any>;
|
|
6399
|
+
} | {
|
|
6400
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6401
|
+
description?: string;
|
|
6402
|
+
data?: Record<string, any>;
|
|
6403
|
+
} | {
|
|
6404
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6405
|
+
description?: string;
|
|
6406
|
+
data?: Record<string, any>;
|
|
6407
|
+
} | {
|
|
6408
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6409
|
+
description?: string;
|
|
6410
|
+
data?: Record<string, any>;
|
|
6411
|
+
} | {
|
|
6412
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6413
|
+
description?: string;
|
|
6414
|
+
data?: Record<string, any>;
|
|
6415
|
+
};
|
|
6416
|
+
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
6417
|
+
code?: 'INVALID_AMOUNT';
|
|
6418
|
+
description?: string;
|
|
6419
|
+
data?: Record<string, any>;
|
|
6420
|
+
} | {
|
|
6421
|
+
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
6422
|
+
description?: string;
|
|
6423
|
+
data?: Record<string, any>;
|
|
6424
|
+
} | {
|
|
6425
|
+
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6426
|
+
description?: string;
|
|
6427
|
+
data?: Record<string, any>;
|
|
6428
|
+
} | {
|
|
6429
|
+
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6430
|
+
description?: string;
|
|
6431
|
+
data?: Record<string, any>;
|
|
6432
|
+
} | {
|
|
6433
|
+
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6434
|
+
description?: string;
|
|
6435
|
+
data?: Record<string, any>;
|
|
6436
|
+
} | {
|
|
6437
|
+
code?: 'PAYMENT_NOT_FOUND';
|
|
6438
|
+
description?: string;
|
|
6439
|
+
data?: Record<string, any>;
|
|
6440
|
+
} | {
|
|
6441
|
+
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6442
|
+
description?: string;
|
|
6443
|
+
data?: Record<string, any>;
|
|
6444
|
+
} | {
|
|
6445
|
+
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6446
|
+
description?: string;
|
|
6447
|
+
data?: Record<string, any>;
|
|
6448
|
+
};
|
|
4581
6449
|
type GetOrderApplicationErrors = {
|
|
4582
6450
|
code?: 'ORDER_NOT_FOUND';
|
|
4583
6451
|
description?: string;
|
|
@@ -4814,6 +6682,225 @@ interface OrderPaymentStatusUpdatedEnvelope {
|
|
|
4814
6682
|
*/
|
|
4815
6683
|
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
4816
6684
|
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`;
|
|
6685
|
+
/**
|
|
6686
|
+
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6687
|
+
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6688
|
+
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6689
|
+
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6690
|
+
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6691
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6692
|
+
* @param amount - Amount to collect
|
|
6693
|
+
* @public
|
|
6694
|
+
* @documentationMaturity preview
|
|
6695
|
+
* @requiredField amount
|
|
6696
|
+
* @requiredField ecomOrderId
|
|
6697
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6698
|
+
* @applicableIdentity APP
|
|
6699
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6700
|
+
*/
|
|
6701
|
+
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
6702
|
+
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
6703
|
+
}>;
|
|
6704
|
+
interface PreparePaymentCollectionOptions {
|
|
6705
|
+
/**
|
|
6706
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6707
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
6708
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6709
|
+
*/
|
|
6710
|
+
paymentGatewayOrderId?: string | null;
|
|
6711
|
+
/**
|
|
6712
|
+
* Whether to delay capture of the payment.
|
|
6713
|
+
* Default: false
|
|
6714
|
+
* @deprecated Whether to delay capture of the payment.
|
|
6715
|
+
* Default: false
|
|
6716
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6717
|
+
* @targetRemovalDate 2024-09-30
|
|
6718
|
+
*/
|
|
6719
|
+
delayedCapture?: boolean;
|
|
6720
|
+
/** Delayed capture payment settings */
|
|
6721
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6722
|
+
}
|
|
6723
|
+
/**
|
|
6724
|
+
* Provides payment collectability status for given order. If payment collection is possible
|
|
6725
|
+
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6726
|
+
* reason why payment collection is not possible.
|
|
6727
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6728
|
+
* @public
|
|
6729
|
+
* @documentationMaturity preview
|
|
6730
|
+
* @requiredField ecomOrderId
|
|
6731
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6732
|
+
* @applicableIdentity APP
|
|
6733
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6734
|
+
*/
|
|
6735
|
+
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6736
|
+
/**
|
|
6737
|
+
* Records and approves new manual payment with provided custom amount on given order.
|
|
6738
|
+
* Existing pending payments are ignored.
|
|
6739
|
+
* Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
|
|
6740
|
+
* @param orderId - Order ID.
|
|
6741
|
+
* @param amount - Amount to be recorded as approved manual payment for given order
|
|
6742
|
+
* @internal
|
|
6743
|
+
* @documentationMaturity preview
|
|
6744
|
+
* @requiredField amount
|
|
6745
|
+
* @requiredField orderId
|
|
6746
|
+
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6747
|
+
* @applicableIdentity APP
|
|
6748
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
|
|
6749
|
+
*/
|
|
6750
|
+
declare function recordManuallyCollectedPayment(orderId: string, amount: Price): Promise<void & {
|
|
6751
|
+
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
|
|
6752
|
+
}>;
|
|
6753
|
+
/**
|
|
6754
|
+
* Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
6755
|
+
* In case the order already has an offline payment transaction associated with it
|
|
6756
|
+
* (usually when manual payment method is chosen at checkout) - This transaction will become approved.
|
|
6757
|
+
* In case the order has no payment transactions associated with it
|
|
6758
|
+
* (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
|
|
6759
|
+
* will be created and approved.
|
|
6760
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6761
|
+
* @internal
|
|
6762
|
+
* @documentationMaturity preview
|
|
6763
|
+
* @requiredField ecomOrderId
|
|
6764
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6765
|
+
* @applicableIdentity APP
|
|
6766
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
6767
|
+
*/
|
|
6768
|
+
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
6769
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
6770
|
+
}[OrderNonNullablePaths]> & {
|
|
6771
|
+
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
6772
|
+
}>;
|
|
6773
|
+
/**
|
|
6774
|
+
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
6775
|
+
* @param ecomOrderIds - IDs of orders to mark as paid.
|
|
6776
|
+
* @internal
|
|
6777
|
+
* @documentationMaturity preview
|
|
6778
|
+
* @requiredField ecomOrderIds
|
|
6779
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6780
|
+
* @applicableIdentity APP
|
|
6781
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
|
|
6782
|
+
*/
|
|
6783
|
+
declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
6784
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
6785
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
6786
|
+
/**
|
|
6787
|
+
* Checks whether this order can be refunded.
|
|
6788
|
+
* @param ecomOrderId - Order ID.
|
|
6789
|
+
* @internal
|
|
6790
|
+
* @documentationMaturity preview
|
|
6791
|
+
* @requiredField ecomOrderId
|
|
6792
|
+
* @permissionId ECOM.READ_TRANSACTIONS
|
|
6793
|
+
* @applicableIdentity APP
|
|
6794
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
|
|
6795
|
+
*/
|
|
6796
|
+
declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
6797
|
+
/**
|
|
6798
|
+
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
6799
|
+
* 1. An explicit amount provided in the request, or;
|
|
6800
|
+
* 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
|
|
6801
|
+
* As a result, an ID of the created payment gateway order would be returned.
|
|
6802
|
+
* You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
|
|
6803
|
+
* @param ecomOrderId - Ecom order ID.
|
|
6804
|
+
* @internal
|
|
6805
|
+
* @documentationMaturity preview
|
|
6806
|
+
* @requiredField ecomOrderId
|
|
6807
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
6808
|
+
* @applicableIdentity APP
|
|
6809
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
|
|
6810
|
+
*/
|
|
6811
|
+
declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
|
|
6812
|
+
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
|
|
6813
|
+
}>;
|
|
6814
|
+
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6815
|
+
/** Information about the user who initiated the payment. */
|
|
6816
|
+
chargedBy?: ChargedBy;
|
|
6817
|
+
}
|
|
6818
|
+
/** @param ecomOrderId - Order ID.
|
|
6819
|
+
* @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
6820
|
+
* but a user which is using the membership on behalf of the a member
|
|
6821
|
+
* @internal
|
|
6822
|
+
* @documentationMaturity preview
|
|
6823
|
+
* @requiredField ecomOrderId
|
|
6824
|
+
* @requiredField memberId
|
|
6825
|
+
* @requiredField options.membershipCharges.appId
|
|
6826
|
+
* @requiredField options.membershipCharges.catalogReference
|
|
6827
|
+
* @requiredField options.membershipCharges.catalogReference.appId
|
|
6828
|
+
* @requiredField options.membershipCharges.catalogReference.catalogItemId
|
|
6829
|
+
* @requiredField options.membershipCharges.membershipId
|
|
6830
|
+
* @requiredField options.membershipCharges.membershipName
|
|
6831
|
+
* @requiredField options.membershipCharges.membershipName.original
|
|
6832
|
+
* @requiredField options.membershipCharges.rootCatalogItemId
|
|
6833
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
6834
|
+
* @applicableIdentity APP
|
|
6835
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
|
|
6836
|
+
*/
|
|
6837
|
+
declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
|
|
6838
|
+
interface ChargeMembershipsOptions {
|
|
6839
|
+
/**
|
|
6840
|
+
* List of items to be paid by memberships
|
|
6841
|
+
* @minSize 1
|
|
6842
|
+
* @maxSize 300
|
|
6843
|
+
*/
|
|
6844
|
+
membershipCharges?: MembershipChargeItem[];
|
|
6845
|
+
}
|
|
6846
|
+
/**
|
|
6847
|
+
* Calls corresponding payment providers and creates refund transactions for requested payments.
|
|
6848
|
+
* Updates order transactions based on refund results.
|
|
6849
|
+
* For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
|
|
6850
|
+
* will only update order transactions.
|
|
6851
|
+
* @param ecomOrderId - The order this refund related to
|
|
6852
|
+
* @param payments - Refund operations information
|
|
6853
|
+
* @internal
|
|
6854
|
+
* @documentationMaturity preview
|
|
6855
|
+
* @requiredField ecomOrderId
|
|
6856
|
+
* @requiredField payments
|
|
6857
|
+
* @requiredField payments.paymentId
|
|
6858
|
+
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
6859
|
+
* @applicableIdentity APP
|
|
6860
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
|
|
6861
|
+
*/
|
|
6862
|
+
declare function triggerRefund(ecomOrderId: string, payments: NonNullablePaths<PaymentRefund, `paymentId`>[], options?: TriggerRefundOptions): Promise<NonNullablePaths<TriggerRefundResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`> & {
|
|
6863
|
+
__applicationErrorsType?: TriggerRefundApplicationErrors;
|
|
6864
|
+
}>;
|
|
6865
|
+
interface TriggerRefundOptions {
|
|
6866
|
+
/** Business model of a refund */
|
|
6867
|
+
details?: RefundDetails;
|
|
6868
|
+
/** Side effect details related to refund */
|
|
6869
|
+
sideEffects?: RefundSideEffects;
|
|
6870
|
+
}
|
|
6871
|
+
/**
|
|
6872
|
+
* Void authorized payments
|
|
6873
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6874
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6875
|
+
* @param paymentIds - Payment IDs
|
|
6876
|
+
* @public
|
|
6877
|
+
* @documentationMaturity preview
|
|
6878
|
+
* @requiredField ecomOrderId
|
|
6879
|
+
* @requiredField paymentIds
|
|
6880
|
+
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6881
|
+
* @applicableIdentity APP
|
|
6882
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6883
|
+
*/
|
|
6884
|
+
declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
6885
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
6886
|
+
}>;
|
|
6887
|
+
/**
|
|
6888
|
+
* Capture authorized payments
|
|
6889
|
+
* Transaction statuses for related payments will be updated in async way
|
|
6890
|
+
* @param ecomOrderId - Wix eCommerce order ID
|
|
6891
|
+
* @param payments - Capture payments information
|
|
6892
|
+
* @public
|
|
6893
|
+
* @documentationMaturity preview
|
|
6894
|
+
* @requiredField ecomOrderId
|
|
6895
|
+
* @requiredField payments
|
|
6896
|
+
* @requiredField payments.paymentId
|
|
6897
|
+
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6898
|
+
* @applicableIdentity APP
|
|
6899
|
+
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6900
|
+
*/
|
|
6901
|
+
declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
6902
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
6903
|
+
}>;
|
|
4817
6904
|
/**
|
|
4818
6905
|
* Retrieves an order.
|
|
4819
6906
|
*
|
|
@@ -5249,6 +7336,23 @@ interface BulkUpdateOrdersOptions {
|
|
|
5249
7336
|
*/
|
|
5250
7337
|
returnEntity?: boolean;
|
|
5251
7338
|
}
|
|
7339
|
+
/** @param _id - Order id to be updated
|
|
7340
|
+
* @internal
|
|
7341
|
+
* @documentationMaturity preview
|
|
7342
|
+
* @requiredField _id
|
|
7343
|
+
* @requiredField options.changes
|
|
7344
|
+
* @requiredField options.changes.priceSummary.subtotal
|
|
7345
|
+
* @requiredField options.changes.priceSummary.total
|
|
7346
|
+
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
7347
|
+
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7348
|
+
* @applicableIdentity APP
|
|
7349
|
+
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
7350
|
+
*/
|
|
7351
|
+
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
7352
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7353
|
+
}[OrderNonNullablePaths]> & {
|
|
7354
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
7355
|
+
}>;
|
|
5252
7356
|
interface CommitDeltasOptions {
|
|
5253
7357
|
/**
|
|
5254
7358
|
* Draft order Id representing this change.
|
|
@@ -5266,6 +7370,21 @@ interface CommitDeltasOptions {
|
|
|
5266
7370
|
*/
|
|
5267
7371
|
reason?: string | null;
|
|
5268
7372
|
}
|
|
7373
|
+
/** @internal
|
|
7374
|
+
* @documentationMaturity preview
|
|
7375
|
+
* @requiredField identifiers
|
|
7376
|
+
* @requiredField identifiers._id
|
|
7377
|
+
* @requiredField identifiers.lineItemId
|
|
7378
|
+
* @requiredField lineItem
|
|
7379
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7380
|
+
* @applicableIdentity APP
|
|
7381
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
7382
|
+
* @deprecated
|
|
7383
|
+
* @targetRemovalDate 2024-02-15
|
|
7384
|
+
*/
|
|
7385
|
+
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
7386
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7387
|
+
}[OrderNonNullablePaths]>>;
|
|
5269
7388
|
interface UpdateOrderLineItemIdentifiers {
|
|
5270
7389
|
/**
|
|
5271
7390
|
* Order ID
|
|
@@ -5389,13 +7508,61 @@ interface UpdateOrderLineItem {
|
|
|
5389
7508
|
locations?: LocationAndQuantity[];
|
|
5390
7509
|
/** Address used for tax calculation. */
|
|
5391
7510
|
taxableAddress?: TaxableAddress;
|
|
7511
|
+
/**
|
|
7512
|
+
* ID of the app managing the inventory.
|
|
7513
|
+
* @internal
|
|
7514
|
+
* @format GUID
|
|
7515
|
+
*/
|
|
7516
|
+
inventoryAppId?: string | null;
|
|
5392
7517
|
/**
|
|
5393
7518
|
* Custom extended fields for the line item object.
|
|
5394
7519
|
*
|
|
5395
7520
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
5396
7521
|
*/
|
|
5397
7522
|
extendedFields?: ExtendedFields;
|
|
7523
|
+
/**
|
|
7524
|
+
* Modifier groups that were added to the item.
|
|
7525
|
+
* @internal
|
|
7526
|
+
* @readonly
|
|
7527
|
+
* @maxSize 10
|
|
7528
|
+
*/
|
|
7529
|
+
modifierGroups?: ModifierGroup[];
|
|
5398
7530
|
}
|
|
7531
|
+
/**
|
|
7532
|
+
* Adds a merchant comment to an order.
|
|
7533
|
+
* > **Note:** Activities with type CustomActivity not supported
|
|
7534
|
+
* @param _id - Order ID.
|
|
7535
|
+
* @param activity - Activity info.
|
|
7536
|
+
* @internal
|
|
7537
|
+
* @documentationMaturity preview
|
|
7538
|
+
* @requiredField _id
|
|
7539
|
+
* @requiredField activity
|
|
7540
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7541
|
+
* @applicableIdentity APP
|
|
7542
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
7543
|
+
* @deprecated
|
|
7544
|
+
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
7545
|
+
* @targetRemovalDate 2024-11-01
|
|
7546
|
+
*/
|
|
7547
|
+
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
7548
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7549
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
7550
|
+
/**
|
|
7551
|
+
* Updates an order's activity.
|
|
7552
|
+
* @param activity - Activity info.
|
|
7553
|
+
* @internal
|
|
7554
|
+
* @documentationMaturity preview
|
|
7555
|
+
* @requiredField activity
|
|
7556
|
+
* @requiredField identifiers
|
|
7557
|
+
* @requiredField identifiers._id
|
|
7558
|
+
* @requiredField identifiers.activityId
|
|
7559
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7560
|
+
* @applicableIdentity APP
|
|
7561
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
7562
|
+
*/
|
|
7563
|
+
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
7564
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7565
|
+
}[OrderNonNullablePaths]>>;
|
|
5399
7566
|
interface UpdateActivityIdentifiers {
|
|
5400
7567
|
/**
|
|
5401
7568
|
* Order ID.
|
|
@@ -5409,6 +7576,22 @@ interface UpdateActivityIdentifiers {
|
|
|
5409
7576
|
*/
|
|
5410
7577
|
activityId: string;
|
|
5411
7578
|
}
|
|
7579
|
+
/**
|
|
7580
|
+
* Delete's an order's activity.
|
|
7581
|
+
*
|
|
7582
|
+
* Only custom activities and merchant comments can be deleted.
|
|
7583
|
+
* @internal
|
|
7584
|
+
* @documentationMaturity preview
|
|
7585
|
+
* @requiredField identifiers
|
|
7586
|
+
* @requiredField identifiers._id
|
|
7587
|
+
* @requiredField identifiers.activityId
|
|
7588
|
+
* @permissionId ECOM.MODIFY_ORDERS
|
|
7589
|
+
* @applicableIdentity APP
|
|
7590
|
+
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
7591
|
+
*/
|
|
7592
|
+
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
7593
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7594
|
+
}[OrderNonNullablePaths]>>;
|
|
5412
7595
|
interface DeleteActivityIdentifiers {
|
|
5413
7596
|
/**
|
|
5414
7597
|
* Order ID.
|
|
@@ -5451,6 +7634,43 @@ interface CancelOrderOptions {
|
|
|
5451
7634
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5452
7635
|
restockAllItems?: boolean;
|
|
5453
7636
|
}
|
|
7637
|
+
/**
|
|
7638
|
+
* Updates order status.
|
|
7639
|
+
*
|
|
7640
|
+
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
7641
|
+
* >Updates into INITIALIZED are not supported.
|
|
7642
|
+
*
|
|
7643
|
+
* Approving order:
|
|
7644
|
+
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
7645
|
+
*
|
|
7646
|
+
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
7647
|
+
* will cause an error.
|
|
7648
|
+
*
|
|
7649
|
+
* Setting PENDING status:
|
|
7650
|
+
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
7651
|
+
* @param orderId - Order ID.
|
|
7652
|
+
* @param status - New order status.
|
|
7653
|
+
* @internal
|
|
7654
|
+
* @documentationMaturity preview
|
|
7655
|
+
* @requiredField orderId
|
|
7656
|
+
* @requiredField status
|
|
7657
|
+
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
7658
|
+
* @applicableIdentity APP
|
|
7659
|
+
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
7660
|
+
*/
|
|
7661
|
+
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
7662
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7663
|
+
}[OrderNonNullablePaths]> & {
|
|
7664
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
7665
|
+
}>;
|
|
7666
|
+
/** @internal
|
|
7667
|
+
* @documentationMaturity preview
|
|
7668
|
+
* @requiredField options.aggregation
|
|
7669
|
+
* @permissionId ECOM.READ_ORDERS
|
|
7670
|
+
* @applicableIdentity APP
|
|
7671
|
+
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
7672
|
+
*/
|
|
7673
|
+
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
5454
7674
|
interface AggregateOrdersOptions {
|
|
5455
7675
|
/** Filter applied to original data */
|
|
5456
7676
|
filter?: Record<string, any> | null;
|
|
@@ -5487,4 +7707,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
5487
7707
|
unassignTags?: Tags;
|
|
5488
7708
|
}
|
|
5489
7709
|
|
|
5490
|
-
export { type OrderLineItem as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, DescriptionLineType as D, OrderApprovalStrategy as E, FulfillmentStatus as F, type GetOrderApplicationErrors as G, DeltaPaymentOptionType as H, ItemTypeItemType as I, JurisdictionType as J, InventoryAction as K, LineItemQuantityChangeType as L, type MaskedOrder as M, Placement as N, type Order as O, PaymentOptionType as P, SubdivisionType as Q, SourceType as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, CustomFieldGroup as X, ValueType as Y, DepositType as Z, InvoiceStatus as _, type OrderSearch as a, type CustomActivity as a$, type ProductName as a0, type CatalogReference as a1, type Price as a2, type DescriptionLine as a3, type DescriptionLineValueOneOf as a4, type DescriptionLineDescriptionLineValueOneOf as a5, type DescriptionLineName as a6, type PlainTextValue as a7, type Color as a8, type FocalPoint as a9, type AddressWithContact as aA, type Address as aB, type StreetAddress as aC, type AddressLocation as aD, type FullAddressContactDetails as aE, type VatId as aF, type V1ShippingInformation as aG, type DeliveryLogistics as aH, type DeliveryLogisticsAddressOneOf as aI, type PickupDetails as aJ, type PickupAddress as aK, type DeliveryTimeSlot as aL, type ShippingPrice as aM, type ShippingRegion as aN, type TaxSummary as aO, type OrderTaxInfo as aP, type OrderTaxBreakdown as aQ, type AppliedDiscount as aR, type AppliedDiscountDiscountSourceOneOf as aS, type Coupon as aT, type MerchantDiscount as aU, type MerchantDiscountMerchantDiscountReasonOneOf as aV, type DiscountRule as aW, type DiscountRuleName as aX, type LineItemDiscount as aY, type Activity as aZ, type ActivityContentOneOf as a_, type PhysicalProperties as aa, type ItemType as ab, type ItemTypeItemTypeDataOneOf as ac, type ItemTaxFullDetails as ad, type LineItemTaxInfo as ae, type LineItemTaxBreakdown as af, type DigitalFile as ag, type SubscriptionInfo as ah, type SubscriptionTitle as ai, type SubscriptionDescription as aj, type SubscriptionSettings as ak, type FreeTrialPeriod as al, type BillingAdjustment as am, type BillingAdjustmentPriceSummary as an, type PriceDescription as ao, type LocationAndQuantity as ap, type TaxableAddress as aq, type TaxableAddressTaxableAddressDataOneOf as ar, type ExtendedFields as as, type ModifierGroup as at, type TranslatableString as au, type ItemModifier as av, type BuyerInfo as aw, type BuyerInfoIdOneOf as ax, type CurrencyConversionDetails as ay, type PriceSummary as az, type CreateOrderApplicationErrors as b, type InternalDocumentUpdateOperation as b$, type MerchantComment as b0, type OrderRefunded as b1, type OrderCreatedFromExchange as b2, type NewExchangeOrderCreated as b3, type LineItemExchangeData as b4, type DraftOrderChangesApplied as b5, type OrderChange as b6, type OrderChangeValueOneOf as b7, type LineItemChanges as b8, type LineItemQuantityChange as b9, type CreditCardDetails as bA, type PaymentCanceled as bB, type PaymentCanceledPaymentDetailsOneOf as bC, type PaymentDeclined as bD, type PaymentDeclinedPaymentDetailsOneOf as bE, type ReceiptCreated as bF, type ReceiptCreatedReceiptInfoOneOf as bG, type WixReceipt as bH, type ExternalReceipt as bI, type ReceiptSent as bJ, type ReceiptSentReceiptInfoOneOf as bK, type ChargebackCreated as bL, type ChargebackReversed as bM, type CreatedBy as bN, type CreatedByStringOneOf as bO, type ChannelInfo as bP, type CustomField as bQ, type BalanceSummary as bR, type Balance as bS, type AdditionalFee as bT, type FulfillmentStatusesAggregate as bU, type Tags as bV, type TagList as bW, type Location as bX, type UpdateInternalDocumentsEvent as bY, type UpdateInternalDocumentsEventOperationOneOf as bZ, type InternalDocument as b_, type LineItemPriceChange as ba, type ManagedLineItem as bb, type ManagedDiscount as bc, type TranslatedValue as bd, type LineItemAmount as be, type ManagedAdditionalFee as bf, type TotalPriceChange as bg, type ShippingInformationChange as bh, type ShippingInformation as bi, type SavedPaymentMethod as bj, type AuthorizedPaymentCreated as bk, type AuthorizedPaymentCaptured as bl, type AuthorizedPaymentVoided as bm, type RefundInitiated as bn, type RefundedPayment as bo, type RefundedPaymentKindOneOf as bp, type RegularPaymentRefund as bq, type GiftCardPaymentRefund as br, type MembershipPaymentRefund as bs, type PaymentRefunded as bt, type PaymentRefundFailed as bu, type RefundedAsStoreCredit as bv, type PaymentPending as bw, type PaymentPendingPaymentDetailsOneOf as bx, type RegularPayment as by, type RegularPaymentPaymentMethodDetailsOneOf as bz, type UpdateOrderApplicationErrors as c, type DraftOrderDiffsBuyerUpdateInfoOneOf as c$, type DeleteByIdsOperation as c0, type DeleteByFilterOperation as c1, type InternalDocumentUpdateByFilterOperation as c2, type InternalUpdateExistingOperation as c3, type VersionedDocumentUpdateOperation as c4, type VersionedDeleteByIdsOperation as c5, type VersionedDocumentId as c6, type OrderApproved as c7, type OrdersExperiments as c8, type OrderRejectedEventOrderRejected as c9, type PlatformQueryPagingMethodOneOf as cA, type Sorting as cB, type PlatformPaging as cC, type CursorPaging as cD, type InternalQueryOrdersResponse as cE, type PlatformPagingMetadata as cF, type Cursors as cG, type QueryOrderRequest as cH, type QueryOrderResponse as cI, type SearchOrdersRequest as cJ, type CursorSearch as cK, type CursorSearchPagingMethodOneOf as cL, type CursorPagingMetadata as cM, type CreateOrderRequest as cN, type OrderCreationSettings as cO, type OrderCreateNotifications as cP, type CreateOrderResponse as cQ, type UpdateOrderRequest as cR, type UpdateOrderResponse as cS, type BulkUpdateOrdersRequest as cT, type BulkOrderResult as cU, type ItemMetadata as cV, type ApplicationError as cW, type BulkActionMetadata as cX, type CommitDeltasRequest as cY, type DraftOrderDiffs as cZ, type DraftOrderDiffsShippingUpdateInfoOneOf as c_, type OrderItemsRestocked as ca, type RestockItem as cb, type TriggerReindexRequest as cc, type TriggerReindexResponse as cd, type DomainEvent as ce, type DomainEventBodyOneOf as cf, type EntityCreatedEvent as cg, type RestoreInfo as ch, type EntityUpdatedEvent as ci, type EntityDeletedEvent as cj, type ActionEvent as ck, type Empty as cl, type BatchOfTriggerReindexOrderRequest as cm, type TriggerReindexOrderRequest as cn, type MessageEnvelope as co, type IdentificationData as cp, type IdentificationDataIdOneOf as cq, type DiffmatokyPayload as cr, type ErrorInformation as cs, type ContinueSideEffectsFlowInLegacyData as ct, type SnapshotMessage as cu, type IndexingMessage as cv, type GetOrderRequest as cw, type GetOrderResponse as cx, type InternalQueryOrdersRequest as cy, type PlatformQuery as cz, type BulkUpdateOrdersResponse as d, type PickupReadyEmailSent as d$, type DraftOrderDiffsBillingUpdateInfoOneOf as d0, type DraftOrderDiffsRecipientUpdateInfoOneOf as d1, type V1LineItemDelta as d2, type V1LineItemDeltaDeltaOneOf as d3, type OrderLineItemChangedDetails as d4, type ItemChangedDetails as d5, type AppliedDiscountDelta as d6, type AppliedDiscountDeltaDeltaOneOf as d7, type AdditionalFeeDelta as d8, type AdditionalFeeDeltaDeltaOneOf as d9, type UpdateOrderShippingAddressRequest as dA, type UpdateOrderShippingAddressResponse as dB, type UpdateBillingContactDetailsRequest as dC, type UpdateBillingContactDetailsResponse as dD, type UpdateOrderLineItemRequest as dE, type UpdateOrderLineItemResponse as dF, type UpdateOrderLineItemsRequest as dG, type MaskedOrderLineItem as dH, type UpdateOrderLineItemsResponse as dI, type AddInternalActivityRequest as dJ, type InternalActivity as dK, type InternalActivityContentOneOf as dL, type OrderPlaced as dM, type OrderPaid as dN, type OrderFulfilled as dO, type OrderNotFulfilled as dP, type OrderCanceled as dQ, type DownloadLinkSent as dR, type TrackingNumberAdded as dS, type TrackingNumberEdited as dT, type TrackingLinkAdded as dU, type ShippingConfirmationEmailSent as dV, type InvoiceAdded as dW, type InvoiceSent as dX, type FulfillerEmailSent as dY, type ShippingAddressEdited as dZ, type EmailEdited as d_, type DraftOrderCommitSettings as da, type InventoryUpdateDetails as db, type CommitDeltasResponse as dc, type OrderDeltasCommitted as dd, type CommittedDiffs as de, type CommittedDiffsShippingUpdateInfoOneOf as df, type LineItemDelta as dg, type LineItemDeltaDeltaOneOf as dh, type ArchiveOrderRequest as di, type ArchiveOrderResponse as dj, type BulkArchiveOrdersRequest as dk, type BulkArchiveOrdersResponse as dl, type BulkArchiveOrdersByFilterRequest as dm, type BulkArchiveOrdersByFilterResponse as dn, type UnArchiveOrderRequest as dp, type UnArchiveOrderResponse as dq, type BulkUnArchiveOrdersRequest as dr, type BulkUnArchiveOrdersResponse as ds, type BulkUnArchiveOrdersByFilterRequest as dt, type BulkUnArchiveOrdersByFilterResponse as du, type UpdateBuyerInfoRequest as dv, type BuyerInfoUpdate as dw, type UpdateBuyerInfoResponse as dx, type UpdateBuyerEmailRequest as dy, type UpdateBuyerEmailResponse as dz, type CancelOrderOptions as e, type IdAndVersion as e$, type OrderPartiallyPaid as e0, type OrderPending as e1, type OrderRejected as e2, type AddInternalActivityResponse as e3, type AddActivityRequest as e4, type PublicActivity as e5, type PublicActivityContentOneOf as e6, type AddActivityResponse as e7, type AddActivitiesRequest as e8, type AddActivitiesResponse as e9, type BulkSetBusinessLocationRequest as eA, type BulkSetBusinessLocationResponse as eB, type BulkSetBusinessLocationResult as eC, type MarkOrderAsPaidRequest as eD, type MarkOrderAsPaidResponse as eE, type PaymentStatusUpdated as eF, type BulkMarkOrdersAsPaidRequest as eG, type BulkMarkOrdersAsPaidResponse as eH, type CreatePaymentGatewayOrderRequest as eI, type CreatePaymentGatewayOrderResponse as eJ, type GetShipmentsRequest as eK, type GetShipmentsResponse as eL, type AggregateOrdersRequest as eM, type AggregateOrdersResponse as eN, type DecrementItemsQuantityRequest as eO, type DecrementData as eP, type DecrementItemsQuantityResponse as eQ, type BulkUpdateOrderTagsRequest as eR, type BulkUpdateOrderTagsResult as eS, type Task as eT, type TaskKey as eU, type TaskAction as eV, type TaskActionActionOneOf as eW, type Complete as eX, type Cancel as eY, type Reschedule as eZ, type InvoiceSentEvent as e_, type UpdateActivityRequest as ea, type UpdateActivityResponse as eb, type DeleteActivityRequest as ec, type DeleteActivityResponse as ed, type UpdateLineItemsDescriptionLinesRequest as ee, type LineItemUpdate as ef, type UpdateLineItemsDescriptionLinesResponse as eg, type MarkOrderAsSeenByHumanRequest as eh, type MarkOrderAsSeenByHumanResponse as ei, type CancelOrderRequest as ej, type OrderCanceledEventOrderCanceled as ek, type UpdateOrderStatusRequest as el, type UpdateOrderStatusResponse as em, type MarkAsFulfilledRequest as en, type MarkAsFulfilledResponse as eo, type FulfillmentStatusUpdated as ep, type BulkMarkAsFulfilledRequest as eq, type BulkMarkAsFulfilledResponse as er, type BulkMarkAsFulfilledByFilterRequest as es, type BulkMarkAsFulfilledByFilterResponse as et, type MarkAsUnfulfilledRequest as eu, type MarkAsUnfulfilledResponse as ev, type BulkMarkAsUnfulfilledRequest as ew, type BulkMarkAsUnfulfilledResponse as ex, type BulkMarkAsUnfulfilledByFilterRequest as ey, type BulkMarkAsUnfulfilledByFilterResponse as ez, type CancelOrderResponse as f, type SortOrderWithLiterals as f$, type InvoiceFields as f0, type Customer as f1, type Email as f2, type QuotesAddress as f3, type AddressDescription as f4, type Phone as f5, type Company as f6, type CommonAddress as f7, type CommonAddressStreetOneOf as f8, type Subdivision as f9, type CommitDeltasOptions as fA, type UpdateOrderLineItemIdentifiers as fB, type UpdateOrderLineItem as fC, type UpdateActivityIdentifiers as fD, type DeleteActivityIdentifiers as fE, type AggregateOrdersOptions as fF, type DescriptionLineTypeWithLiterals as fG, type ItemTypeItemTypeWithLiterals as fH, type PaymentOptionTypeWithLiterals as fI, type JurisdictionTypeWithLiterals as fJ, type SubscriptionFrequencyWithLiterals as fK, type AdjustmentTypeWithLiterals as fL, type TaxableAddressTypeWithLiterals as fM, type PaymentStatusWithLiterals as fN, type FulfillmentStatusWithLiterals as fO, type WeightUnitWithLiterals as fP, type VatTypeWithLiterals as fQ, type PickupMethodWithLiterals as fR, type OrderStatusWithLiterals as fS, type DiscountTypeWithLiterals as fT, type DiscountReasonWithLiterals as fU, type LineItemQuantityChangeTypeWithLiterals as fV, type ActivityTypeWithLiterals as fW, type AttributionSourceWithLiterals as fX, type ChannelTypeWithLiterals as fY, type VersioningModeWithLiterals as fZ, type WebhookIdentityTypeWithLiterals as f_, type StandardDetails as fa, type InvoiceDates as fb, type LineItems as fc, type LineItem as fd, type BigDecimalWrapper as fe, type LineItemTax as ff, type Source as fg, type LineItemMetaData as fh, type Locale as fi, type TotalPrice as fj, type ItemizedFee as fk, type Discount as fl, type DiscountOneDiscountTypeOneOf as fm, type CalculatedTaxes as fn, type CalculatedTax as fo, type Payments as fp, type Payment as fq, type MetaData as fr, type InvoiceDynamicPriceTotals as fs, type CustomFieldValue as ft, type Value as fu, type Deposit as fv, type TriggerSideEffectsFromLegacyData as fw, type BaseEventMetadata as fx, type EventMetadata as fy, type OrderSearchSpec as fz, type CancelOrderApplicationErrors as g, type OrderApprovalStrategyWithLiterals as g0, type DeltaPaymentOptionTypeWithLiterals as g1, type InventoryActionWithLiterals as g2, type PlacementWithLiterals as g3, type SubdivisionTypeWithLiterals as g4, type SourceTypeWithLiterals as g5, type CustomFieldGroupWithLiterals as g6, type ValueTypeWithLiterals as g7, type DepositTypeWithLiterals as g8, type InvoiceStatusWithLiterals as g9, type CommitDeltasApplicationErrors as ga, type UpdateOrderStatusApplicationErrors as gb, onOrderApproved as gc, onOrderUpdated as gd, onOrderCanceled as ge, onOrderCreated as gf, onOrderPaymentStatusUpdated as gg, getOrder as gh, type CommonSearchWithEntityContext as gi, createOrder as gj, updateOrder as gk, bulkUpdateOrders as gl, cancelOrder as gm, bulkUpdateOrderTags as gn, type BulkUpdateOrderTagsOptions as h, type BulkUpdateOrderTagsResponse as i, type OrderApprovedEnvelope as j, type OrderUpdatedEnvelope as k, type OrderCanceledEnvelope as l, type OrderCreatedEnvelope as m, type OrderPaymentStatusUpdatedEnvelope as n, SubscriptionFrequency as o, PaymentStatus as p, PickupMethod as q, OrderStatus as r, DiscountType as s, DiscountReason as t, ActivityType as u, AttributionSource as v, ChannelType as w, VersioningMode as x, WebhookIdentityType as y, SortOrder as z };
|
|
7710
|
+
export { type AggregateOrdersResponse as $, type UpdateOrderLineItemIdentifiers as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type UpdateOrderLineItem as D, type UpdateOrderLineItemResponse as E, type PublicActivity as F, type GetPaymentCollectabilityStatusResponse as G, type AddActivityResponse as H, type UpdateActivityIdentifiers as I, type UpdateActivityResponse as J, type DeleteActivityIdentifiers as K, type DeleteActivityResponse as L, type MarkOrderAsPaidResponse as M, type CancelOrderOptions as N, type Order as O, type Price as P, type CancelOrderResponse as Q, type RecordManuallyCollectedPaymentApplicationErrors as R, type SearchOrdersResponse as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type CancelOrderApplicationErrors as W, type OrderStatusWithLiterals as X, type UpdateOrderStatusResponse as Y, type UpdateOrderStatusApplicationErrors as Z, type AggregateOrdersOptions as _, type PreparePaymentCollectionOptions as a, type Color as a$, type BulkUpdateOrderTagsOptions as a0, type BulkUpdateOrderTagsResponse as a1, type OrderApprovedEnvelope as a2, type OrderUpdatedEnvelope as a3, type OrderCanceledEnvelope as a4, type OrderCreatedEnvelope as a5, type OrderPaymentStatusUpdatedEnvelope as a6, DescriptionLineType as a7, ItemTypeItemType as a8, PaymentOptionType as a9, AuthorizationCaptureStatus as aA, AuthorizationVoidStatus as aB, Reason as aC, ActionType as aD, ChargebackStatus as aE, MembershipPaymentStatus as aF, RefundStatus as aG, VersioningMode as aH, SortOrder as aI, OrderApprovalStrategy as aJ, DeltaPaymentOptionType as aK, InventoryAction as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, JurisdictionType as aa, SubscriptionFrequency as ab, AdjustmentType as ac, TaxableAddressType as ad, PaymentStatus as ae, FulfillmentStatus as af, WeightUnit as ag, VatType as ah, PickupMethod as ai, OrderStatus as aj, DiscountType as ak, DiscountReason as al, LineItemQuantityChangeType as am, ActivityType as an, AttributionSource as ao, ChannelType as ap, PreviewEmailType as aq, WebhookIdentityType as ar, ScheduledAction as as, DurationUnit as at, PaymentCollectabilityStatus as au, RefundableStatus as av, NonRefundableReason as aw, ManuallyRefundableReason as ax, RestockType as ay, TransactionStatus as az, type PreparePaymentCollectionResponse as b, type LineItemChanges as b$, type FocalPoint as b0, type PhysicalProperties as b1, type ItemType as b2, type ItemTypeItemTypeDataOneOf as b3, type ItemTaxFullDetails as b4, type LineItemTaxInfo as b5, type LineItemTaxBreakdown as b6, type DigitalFile as b7, type SubscriptionInfo as b8, type SubscriptionTitle as b9, type PickupDetails as bA, type PickupAddress as bB, type DeliveryTimeSlot as bC, type ShippingPrice as bD, type ShippingRegion as bE, type TaxSummary as bF, type OrderTaxInfo as bG, type OrderTaxBreakdown as bH, type AppliedDiscount as bI, type AppliedDiscountDiscountSourceOneOf as bJ, type Coupon as bK, type MerchantDiscount as bL, type MerchantDiscountMerchantDiscountReasonOneOf as bM, type DiscountRule as bN, type DiscountRuleName as bO, type LineItemDiscount as bP, type Activity as bQ, type ActivityContentOneOf as bR, type CustomActivity as bS, type MerchantComment as bT, type OrderRefunded as bU, type OrderCreatedFromExchange as bV, type NewExchangeOrderCreated as bW, type LineItemExchangeData as bX, type DraftOrderChangesApplied as bY, type OrderChange as bZ, type OrderChangeValueOneOf as b_, type SubscriptionDescription as ba, type SubscriptionSettings as bb, type FreeTrialPeriod as bc, type BillingAdjustment as bd, type BillingAdjustmentPriceSummary as be, type PriceDescription as bf, type LocationAndQuantity as bg, type TaxableAddress as bh, type TaxableAddressTaxableAddressDataOneOf as bi, type ExtendedFields as bj, type ModifierGroup as bk, type TranslatableString as bl, type ItemModifier as bm, type BuyerInfo as bn, type BuyerInfoIdOneOf as bo, type CurrencyConversionDetails as bp, type PriceSummary as bq, type AddressWithContact as br, type Address as bs, type StreetAddress as bt, type AddressLocation as bu, type FullAddressContactDetails as bv, type VatId as bw, type V1ShippingInformation as bx, type DeliveryLogistics as by, type DeliveryLogisticsAddressOneOf as bz, type PreparePaymentCollectionApplicationErrors as c, type BulkSendBuyerPickupConfirmationEmailsResponse as c$, type LineItemQuantityChange as c0, type LineItemPriceChange as c1, type ManagedLineItem as c2, type ManagedDiscount as c3, type TranslatedValue as c4, type LineItemAmount as c5, type ManagedAdditionalFee as c6, type TotalPriceChange as c7, type ShippingInformationChange as c8, type ShippingInformation as c9, type ReceiptSent as cA, type ReceiptSentReceiptInfoOneOf as cB, type ChargebackCreated as cC, type ChargebackReversed as cD, type CreatedBy as cE, type CreatedByStringOneOf as cF, type ChannelInfo as cG, type CustomField as cH, type BalanceSummary as cI, type Balance as cJ, type AdditionalFee as cK, type FulfillmentStatusesAggregate as cL, type Tags as cM, type TagList as cN, type Location as cO, type OrderApproved as cP, type OrdersExperiments as cQ, type OrderRejectedEventOrderRejected as cR, type OrderItemsRestocked as cS, type V1RestockItem as cT, type SendBuyerConfirmationEmailRequest as cU, type SendBuyerConfirmationEmailResponse as cV, type SendBuyerPaymentsReceivedEmailRequest as cW, type SendBuyerPaymentsReceivedEmailResponse as cX, type SendBuyerPickupConfirmationEmailRequest as cY, type SendBuyerPickupConfirmationEmailResponse as cZ, type BulkSendBuyerPickupConfirmationEmailsRequest as c_, type SavedPaymentMethod as ca, type AuthorizedPaymentCreated as cb, type AuthorizedPaymentCaptured as cc, type AuthorizedPaymentVoided as cd, type RefundInitiated as ce, type RefundedPayment as cf, type RefundedPaymentKindOneOf as cg, type RegularPaymentRefund as ch, type GiftCardPaymentRefund as ci, type MembershipPaymentRefund as cj, type PaymentRefunded as ck, type PaymentRefundFailed as cl, type RefundedAsStoreCredit as cm, type PaymentPending as cn, type PaymentPendingPaymentDetailsOneOf as co, type RegularPayment as cp, type RegularPaymentPaymentMethodDetailsOneOf as cq, type CreditCardDetails as cr, type PaymentCanceled as cs, type PaymentCanceledPaymentDetailsOneOf as ct, type PaymentDeclined as cu, type PaymentDeclinedPaymentDetailsOneOf as cv, type ReceiptCreated as cw, type ReceiptCreatedReceiptInfoOneOf as cx, type WixReceipt as cy, type ExternalReceipt as cz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as d, type CreatePaymentGatewayOrderRequest as d$, type SendBuyerShippingConfirmationEmailRequest as d0, type SendBuyerShippingConfirmationEmailResponse as d1, type BulkSendBuyerShippingConfirmationEmailsRequest as d2, type BulkSendBuyerShippingConfirmationEmailsResponse as d3, type SendMerchantOrderReceivedNotificationRequest as d4, type SendMerchantOrderReceivedNotificationResponse as d5, type SendCancelRefundEmailRequest as d6, type SendCancelRefundEmailResponse as d7, type SendRefundEmailRequest as d8, type SendRefundEmailResponse as d9, type DomainEvent as dA, type DomainEventBodyOneOf as dB, type EntityCreatedEvent as dC, type RestoreInfo as dD, type EntityUpdatedEvent as dE, type EntityDeletedEvent as dF, type ActionEvent as dG, type Empty as dH, type MessageEnvelope as dI, type IdentificationData as dJ, type IdentificationDataIdOneOf as dK, type PreparePaymentCollectionRequest as dL, type RedirectUrls as dM, type DelayedCaptureSettings as dN, type Duration as dO, type GetPaymentCollectabilityStatusRequest as dP, type RecordManuallyCollectedPaymentRequest as dQ, type RecordManuallyCollectedPaymentResponse as dR, type MarkOrderAsPaidRequest as dS, type BulkMarkOrdersAsPaidRequest as dT, type BulkOrderResult as dU, type ItemMetadata as dV, type ApplicationError as dW, type BulkActionMetadata as dX, type GetRefundabilityStatusRequest as dY, type Refundability as dZ, type RefundabilityAdditionalRefundabilityInfoOneOf as d_, type SendMerchantOrderReceivedPushRequest as da, type SendMerchantOrderReceivedPushResponse as db, type PreviewEmailByTypeRequest as dc, type PreviewEmailByTypeResponse as dd, type PreviewRefundEmailRequest as de, type RefundDetails as df, type RefundItem as dg, type LineItemRefund as dh, type AdditionalFeeRefund as di, type ShippingRefund as dj, type PreviewRefundEmailResponse as dk, type PreviewCancelEmailRequest as dl, type PreviewCancelEmailResponse as dm, type PreviewCancelRefundEmailRequest as dn, type PreviewCancelRefundEmailResponse as dp, type PreviewBuyerPaymentsReceivedEmailRequest as dq, type PreviewBuyerPaymentsReceivedEmailResponse as dr, type PreviewBuyerConfirmationEmailRequest as ds, type PreviewBuyerConfirmationEmailResponse as dt, type PreviewBuyerPickupConfirmationEmailRequest as du, type PreviewBuyerPickupConfirmationEmailResponse as dv, type PreviewShippingConfirmationEmailRequest as dw, type PreviewShippingConfirmationEmailResponse as dx, type PreviewResendDownloadLinksEmailRequest as dy, type PreviewResendDownloadLinksEmailResponse as dz, type GetRefundabilityStatusResponse as e, type InternalQueryOrdersRequest as e$, type ChargedBy as e0, type ChargeMembershipsRequest as e1, type MembershipChargeItem as e2, type MembershipName as e3, type ServiceProperties as e4, type ChargeMembershipsResponse as e5, type TriggerRefundRequest as e6, type RefundSideEffects as e7, type RestockInfo as e8, type RestockItem as e9, type CalculateRefundItemResponse as eA, type VoidAuthorizedPaymentsRequest as eB, type CaptureAuthorizedPaymentsRequest as eC, type ChargeSavedPaymentMethodRequest as eD, type ChargeSavedPaymentMethodResponse as eE, type UpdateInternalDocumentsEvent as eF, type UpdateInternalDocumentsEventOperationOneOf as eG, type InternalDocument as eH, type InternalDocumentUpdateOperation as eI, type DeleteByIdsOperation as eJ, type DeleteByFilterOperation as eK, type InternalDocumentUpdateByFilterOperation as eL, type InternalUpdateExistingOperation as eM, type VersionedDocumentUpdateOperation as eN, type VersionedDeleteByIdsOperation as eO, type VersionedDocumentId as eP, type TriggerReindexRequest as eQ, type TriggerReindexResponse as eR, type BatchOfTriggerReindexOrderRequest as eS, type TriggerReindexOrderRequest as eT, type DiffmatokyPayload as eU, type ErrorInformation as eV, type ContinueSideEffectsFlowInLegacyData as eW, type SnapshotMessage as eX, type IndexingMessage as eY, type GetOrderRequest as eZ, type GetOrderResponse as e_, type OrderTransactions as ea, type Payment as eb, type PaymentPaymentDetailsOneOf as ec, type PaymentReceiptInfoOneOf as ed, type RegularPaymentDetails as ee, type RegularPaymentDetailsPaymentMethodDetailsOneOf as ef, type CreditCardPaymentMethodDetails as eg, type AuthorizationDetails as eh, type AuthorizationCapture as ei, type AuthorizationActionFailureDetails as ej, type AuthorizationVoid as ek, type V1ScheduledAction as el, type Chargeback as em, type GiftCardPaymentDetails as en, type MembershipPaymentDetails as eo, type WixReceiptInfo as ep, type ExternalReceiptInfo as eq, type Refund as er, type RefundTransaction as es, type RefundStatusInfo as et, type AggregatedRefundSummary as eu, type RefundItemsBreakdown as ev, type LineItemRefundSummary as ew, type CalculateRefundRequest as ex, type CalculateRefundItemRequest as ey, type CalculateRefundResponse as ez, type PaymentCollectionCreatePaymentGatewayOrderOptions as f, type UpdateOrderLineItemRequest as f$, type PlatformQuery as f0, type PlatformQueryPagingMethodOneOf as f1, type Sorting as f2, type PlatformPaging as f3, type CursorPaging as f4, type InternalQueryOrdersResponse as f5, type PlatformPagingMetadata as f6, type Cursors as f7, type QueryOrderRequest as f8, type QueryOrderResponse as f9, type InventoryUpdateDetails as fA, type OrderDeltasCommitted as fB, type CommittedDiffs as fC, type CommittedDiffsShippingUpdateInfoOneOf as fD, type LineItemDelta as fE, type LineItemDeltaDeltaOneOf as fF, type ArchiveOrderRequest as fG, type ArchiveOrderResponse as fH, type BulkArchiveOrdersRequest as fI, type BulkArchiveOrdersResponse as fJ, type BulkArchiveOrdersByFilterRequest as fK, type BulkArchiveOrdersByFilterResponse as fL, type UnArchiveOrderRequest as fM, type UnArchiveOrderResponse as fN, type BulkUnArchiveOrdersRequest as fO, type BulkUnArchiveOrdersResponse as fP, type BulkUnArchiveOrdersByFilterRequest as fQ, type BulkUnArchiveOrdersByFilterResponse as fR, type UpdateBuyerInfoRequest as fS, type BuyerInfoUpdate as fT, type UpdateBuyerInfoResponse as fU, type UpdateBuyerEmailRequest as fV, type UpdateBuyerEmailResponse as fW, type UpdateOrderShippingAddressRequest as fX, type UpdateOrderShippingAddressResponse as fY, type UpdateBillingContactDetailsRequest as fZ, type UpdateBillingContactDetailsResponse as f_, type SearchOrdersRequest as fa, type CursorSearch as fb, type CursorSearchPagingMethodOneOf as fc, type CursorPagingMetadata as fd, type CreateOrderRequest as fe, type OrderCreationSettings as ff, type OrderCreateNotifications as fg, type CreateOrderResponse as fh, type UpdateOrderRequest as fi, type UpdateOrderResponse as fj, type BulkUpdateOrdersRequest as fk, type CommitDeltasRequest as fl, type DraftOrderDiffs as fm, type DraftOrderDiffsShippingUpdateInfoOneOf as fn, type DraftOrderDiffsBuyerUpdateInfoOneOf as fo, type DraftOrderDiffsBillingUpdateInfoOneOf as fp, type DraftOrderDiffsRecipientUpdateInfoOneOf as fq, type V1LineItemDelta as fr, type V1LineItemDeltaDeltaOneOf as fs, type OrderLineItemChangedDetails as ft, type ItemChangedDetails as fu, type AppliedDiscountDelta as fv, type AppliedDiscountDeltaDeltaOneOf as fw, type AdditionalFeeDelta as fx, type AdditionalFeeDeltaDeltaOneOf as fy, type DraftOrderCommitSettings as fz, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as g, type GetShipmentsRequest as g$, type UpdateOrderLineItemsRequest as g0, type MaskedOrderLineItem as g1, type UpdateOrderLineItemsResponse as g2, type AddInternalActivityRequest as g3, type InternalActivity as g4, type InternalActivityContentOneOf as g5, type OrderPlaced as g6, type OrderPaid as g7, type OrderFulfilled as g8, type OrderNotFulfilled as g9, type MarkOrderAsSeenByHumanResponse as gA, type CancelOrderRequest as gB, type OrderCanceledEventOrderCanceled as gC, type UpdateOrderStatusRequest as gD, type MarkAsFulfilledRequest as gE, type MarkAsFulfilledResponse as gF, type FulfillmentStatusUpdated as gG, type BulkMarkAsFulfilledRequest as gH, type BulkMarkAsFulfilledResponse as gI, type BulkMarkAsFulfilledByFilterRequest as gJ, type BulkMarkAsFulfilledByFilterResponse as gK, type MarkAsUnfulfilledRequest as gL, type MarkAsUnfulfilledResponse as gM, type BulkMarkAsUnfulfilledRequest as gN, type BulkMarkAsUnfulfilledResponse as gO, type BulkMarkAsUnfulfilledByFilterRequest as gP, type BulkMarkAsUnfulfilledByFilterResponse as gQ, type BulkSetBusinessLocationRequest as gR, type BulkSetBusinessLocationResponse as gS, type BulkSetBusinessLocationResult as gT, type V1MarkOrderAsPaidRequest as gU, type V1MarkOrderAsPaidResponse as gV, type PaymentStatusUpdated as gW, type V1BulkMarkOrdersAsPaidRequest as gX, type V1BulkMarkOrdersAsPaidResponse as gY, type V1CreatePaymentGatewayOrderRequest as gZ, type V1CreatePaymentGatewayOrderResponse as g_, type OrderCanceled as ga, type DownloadLinkSent as gb, type TrackingNumberAdded as gc, type TrackingNumberEdited as gd, type TrackingLinkAdded as ge, type ShippingConfirmationEmailSent as gf, type InvoiceAdded as gg, type InvoiceSent as gh, type FulfillerEmailSent as gi, type ShippingAddressEdited as gj, type EmailEdited as gk, type PickupReadyEmailSent as gl, type OrderPartiallyPaid as gm, type OrderPending as gn, type OrderRejected as go, type AddInternalActivityResponse as gp, type AddActivityRequest as gq, type PublicActivityContentOneOf as gr, type AddActivitiesRequest as gs, type AddActivitiesResponse as gt, type UpdateActivityRequest as gu, type DeleteActivityRequest as gv, type UpdateLineItemsDescriptionLinesRequest as gw, type LineItemUpdate as gx, type UpdateLineItemsDescriptionLinesResponse as gy, type MarkOrderAsSeenByHumanRequest as gz, type ChargeMembershipsOptions as h, type PickupMethodWithLiterals as h$, type GetShipmentsResponse as h0, type AggregateOrdersRequest as h1, type DecrementItemsQuantityRequest as h2, type DecrementData as h3, type DecrementItemsQuantityResponse as h4, type BulkUpdateOrderTagsRequest as h5, type BulkUpdateOrderTagsResult as h6, type Task as h7, type TaskKey as h8, type TaskAction as h9, type ItemizedFee as hA, type Discount as hB, type DiscountOneDiscountTypeOneOf as hC, type CalculatedTaxes as hD, type CalculatedTax as hE, type Payments as hF, type InvoicesPayment as hG, type MetaData as hH, type InvoiceDynamicPriceTotals as hI, type CustomFieldValue as hJ, type Value as hK, type Deposit as hL, type TriggerSideEffectsFromLegacyData as hM, type BaseEventMetadata as hN, type EventMetadata as hO, type OrderSearchSpec as hP, type DescriptionLineTypeWithLiterals as hQ, type ItemTypeItemTypeWithLiterals as hR, type PaymentOptionTypeWithLiterals as hS, type JurisdictionTypeWithLiterals as hT, type SubscriptionFrequencyWithLiterals as hU, type AdjustmentTypeWithLiterals as hV, type TaxableAddressTypeWithLiterals as hW, type PaymentStatusWithLiterals as hX, type FulfillmentStatusWithLiterals as hY, type WeightUnitWithLiterals as hZ, type VatTypeWithLiterals as h_, type TaskActionActionOneOf as ha, type Complete as hb, type Cancel as hc, type Reschedule as hd, type InvoiceSentEvent as he, type IdAndVersion as hf, type InvoiceFields as hg, type Customer as hh, type Email as hi, type QuotesAddress as hj, type AddressDescription as hk, type Phone as hl, type Company as hm, type CommonAddress as hn, type CommonAddressStreetOneOf as ho, type Subdivision as hp, type StandardDetails as hq, type InvoiceDates as hr, type LineItems as hs, type LineItem as ht, type BigDecimalWrapper as hu, type LineItemTax as hv, type Source as hw, type LineItemMetaData as hx, type Locale as hy, type TotalPrice as hz, type PaymentRefund as i, cancelOrder as i$, type DiscountTypeWithLiterals as i0, type DiscountReasonWithLiterals as i1, type LineItemQuantityChangeTypeWithLiterals as i2, type ActivityTypeWithLiterals as i3, type AttributionSourceWithLiterals as i4, type ChannelTypeWithLiterals as i5, type PreviewEmailTypeWithLiterals as i6, type WebhookIdentityTypeWithLiterals as i7, type ScheduledActionWithLiterals as i8, type DurationUnitWithLiterals as i9, type InvoiceStatusWithLiterals as iA, onOrderApproved as iB, onOrderUpdated as iC, onOrderCanceled as iD, onOrderCreated as iE, onOrderPaymentStatusUpdated as iF, preparePaymentCollection as iG, getPaymentCollectabilityStatus as iH, recordManuallyCollectedPayment as iI, paymentCollectionMarkOrderAsPaid as iJ, paymentCollectionBulkMarkOrdersAsPaid as iK, getRefundabilityStatus as iL, paymentCollectionCreatePaymentGatewayOrder as iM, chargeMemberships as iN, triggerRefund as iO, voidAuthorizedPayments as iP, captureAuthorizedPayments as iQ, getOrder as iR, type CommonSearchWithEntityContext as iS, createOrder as iT, updateOrder as iU, bulkUpdateOrders as iV, commitDeltas as iW, updateOrderLineItem as iX, addActivity as iY, updateActivity as iZ, deleteActivity as i_, type PaymentCollectabilityStatusWithLiterals as ia, type RefundableStatusWithLiterals as ib, type NonRefundableReasonWithLiterals as ic, type ManuallyRefundableReasonWithLiterals as id, type RestockTypeWithLiterals as ie, type TransactionStatusWithLiterals as ig, type AuthorizationCaptureStatusWithLiterals as ih, type AuthorizationVoidStatusWithLiterals as ii, type ReasonWithLiterals as ij, type ActionTypeWithLiterals as ik, type ChargebackStatusWithLiterals as il, type MembershipPaymentStatusWithLiterals as im, type RefundStatusWithLiterals as io, type VersioningModeWithLiterals as ip, type SortOrderWithLiterals as iq, type OrderApprovalStrategyWithLiterals as ir, type DeltaPaymentOptionTypeWithLiterals as is, type InventoryActionWithLiterals as it, type PlacementWithLiterals as iu, type SubdivisionTypeWithLiterals as iv, type SourceTypeWithLiterals as iw, type CustomFieldGroupWithLiterals as ix, type ValueTypeWithLiterals as iy, type DepositTypeWithLiterals as iz, type TriggerRefundResponse as j, updateOrderStatus as j0, aggregateOrders as j1, bulkUpdateOrderTags as j2, type TriggerRefundApplicationErrors as k, type VoidAuthorizedPaymentsApplicationErrors as l, type PaymentCapture as m, type CaptureAuthorizedPaymentsResponse as n, type CaptureAuthorizedPaymentsApplicationErrors as o, type GetOrderApplicationErrors as p, type OrderSearch as q, type CreateOrderOptions as r, type CreateOrderApplicationErrors as s, type UpdateOrderApplicationErrors as t, type MaskedOrder as u, type BulkUpdateOrdersOptions as v, type BulkUpdateOrdersResponse as w, type CommitDeltasOptions as x, type CommitDeltasResponse as y, type CommitDeltasApplicationErrors as z };
|