@wix/auto_sdk_ecom_orders 1.0.30 → 1.0.32
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/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/cjs/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +13 -13
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.types.d.ts +2 -515
- package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +33 -514
- package/build/cjs/src/ecom-v1-order-orders.universal.js +22 -0
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/es/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/es/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.public.d.ts +13 -13
- package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.types.d.ts +2 -515
- package/build/es/src/ecom-v1-order-orders.universal.d.ts +33 -514
- package/build/es/src/ecom-v1-order-orders.universal.js +22 -0
- package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +24 -24
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +2 -737
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +76 -749
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +22 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +24 -24
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +2 -737
- package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +76 -749
- package/build/internal/es/src/ecom-v1-order-orders.universal.js +22 -0
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
export interface Order {
|
|
2
3
|
/**
|
|
3
4
|
* Order ID.
|
|
@@ -3049,7 +3050,7 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
3049
3050
|
*/
|
|
3050
3051
|
paymentOrderId?: string | null;
|
|
3051
3052
|
/**
|
|
3052
|
-
* Payment gateway's transaction ID.
|
|
3053
|
+
* Payment gateway's transaction ID.
|
|
3053
3054
|
* This field is only returned when the value of `offline_payment` is `false`.
|
|
3054
3055
|
* @maxLength 100
|
|
3055
3056
|
*/
|
|
@@ -3347,7 +3348,7 @@ export interface RefundTransaction {
|
|
|
3347
3348
|
/** Optional details of current refund status. */
|
|
3348
3349
|
refundStatusInfo?: RefundStatusInfo;
|
|
3349
3350
|
/**
|
|
3350
|
-
* Payment gateway's refund ID.
|
|
3351
|
+
* Payment gateway's refund ID.
|
|
3351
3352
|
* This field is only returned when the value of `external_refund` is `false`.
|
|
3352
3353
|
* @format GUID
|
|
3353
3354
|
*/
|
|
@@ -6456,729 +6457,6 @@ export interface TriggerSideEffectsFromLegacyData {
|
|
|
6456
6457
|
orderId?: string;
|
|
6457
6458
|
ordersExperiments?: OrdersExperiments;
|
|
6458
6459
|
}
|
|
6459
|
-
export interface PreparePaymentCollectionResponseNonNullableFields {
|
|
6460
|
-
paymentGatewayOrderId: string;
|
|
6461
|
-
}
|
|
6462
|
-
interface PriceNonNullableFields {
|
|
6463
|
-
amount: string;
|
|
6464
|
-
formattedAmount: string;
|
|
6465
|
-
}
|
|
6466
|
-
export interface GetPaymentCollectabilityStatusResponseNonNullableFields {
|
|
6467
|
-
status: PaymentCollectabilityStatus;
|
|
6468
|
-
amount?: PriceNonNullableFields;
|
|
6469
|
-
/** @internal */
|
|
6470
|
-
authorizationSupported: boolean;
|
|
6471
|
-
}
|
|
6472
|
-
interface ProductNameNonNullableFields {
|
|
6473
|
-
original: string;
|
|
6474
|
-
}
|
|
6475
|
-
interface CatalogReferenceNonNullableFields {
|
|
6476
|
-
catalogItemId: string;
|
|
6477
|
-
appId: string;
|
|
6478
|
-
}
|
|
6479
|
-
interface PlainTextValueNonNullableFields {
|
|
6480
|
-
original: string;
|
|
6481
|
-
}
|
|
6482
|
-
interface ColorNonNullableFields {
|
|
6483
|
-
original: string;
|
|
6484
|
-
}
|
|
6485
|
-
interface DescriptionLineNameNonNullableFields {
|
|
6486
|
-
original: string;
|
|
6487
|
-
}
|
|
6488
|
-
interface DescriptionLineNonNullableFields {
|
|
6489
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
6490
|
-
colorInfo?: ColorNonNullableFields;
|
|
6491
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
6492
|
-
color: string;
|
|
6493
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
6494
|
-
lineType: DescriptionLineType;
|
|
6495
|
-
}
|
|
6496
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
6497
|
-
shippable: boolean;
|
|
6498
|
-
}
|
|
6499
|
-
interface ItemTypeNonNullableFields {
|
|
6500
|
-
preset: ItemTypeItemType;
|
|
6501
|
-
custom: string;
|
|
6502
|
-
}
|
|
6503
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
6504
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6505
|
-
taxRate: string;
|
|
6506
|
-
totalTax?: PriceNonNullableFields;
|
|
6507
|
-
}
|
|
6508
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
6509
|
-
taxAmount?: PriceNonNullableFields;
|
|
6510
|
-
jurisdictionType: JurisdictionType;
|
|
6511
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
6512
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6513
|
-
}
|
|
6514
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
6515
|
-
taxAmount?: PriceNonNullableFields;
|
|
6516
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6517
|
-
taxIncludedInPrice: boolean;
|
|
6518
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
6519
|
-
}
|
|
6520
|
-
interface DigitalFileNonNullableFields {
|
|
6521
|
-
fileId: string;
|
|
6522
|
-
}
|
|
6523
|
-
interface SubscriptionTitleNonNullableFields {
|
|
6524
|
-
original: string;
|
|
6525
|
-
}
|
|
6526
|
-
interface SubscriptionDescriptionNonNullableFields {
|
|
6527
|
-
original: string;
|
|
6528
|
-
}
|
|
6529
|
-
interface FreeTrialPeriodNonNullableFields {
|
|
6530
|
-
frequency: SubscriptionFrequency;
|
|
6531
|
-
interval: number;
|
|
6532
|
-
}
|
|
6533
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
6534
|
-
frequency: SubscriptionFrequency;
|
|
6535
|
-
autoRenewal: boolean;
|
|
6536
|
-
/** @internal */
|
|
6537
|
-
enableCustomerCancellation: boolean;
|
|
6538
|
-
/** @internal */
|
|
6539
|
-
freeTrialPeriod?: FreeTrialPeriodNonNullableFields;
|
|
6540
|
-
}
|
|
6541
|
-
interface BillingAdjustmentPriceSummaryNonNullableFields {
|
|
6542
|
-
subtotal?: PriceNonNullableFields;
|
|
6543
|
-
tax?: PriceNonNullableFields;
|
|
6544
|
-
total?: PriceNonNullableFields;
|
|
6545
|
-
}
|
|
6546
|
-
interface BillingAdjustmentNonNullableFields {
|
|
6547
|
-
type: AdjustmentType;
|
|
6548
|
-
priceSummary?: BillingAdjustmentPriceSummaryNonNullableFields;
|
|
6549
|
-
}
|
|
6550
|
-
interface SubscriptionInfoNonNullableFields {
|
|
6551
|
-
cycleNumber: number;
|
|
6552
|
-
subscriptionOptionTitle: string;
|
|
6553
|
-
/** @internal */
|
|
6554
|
-
title?: SubscriptionTitleNonNullableFields;
|
|
6555
|
-
/** @internal */
|
|
6556
|
-
description?: SubscriptionDescriptionNonNullableFields;
|
|
6557
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
6558
|
-
/** @internal */
|
|
6559
|
-
billingAdjustment?: BillingAdjustmentNonNullableFields;
|
|
6560
|
-
}
|
|
6561
|
-
interface PriceDescriptionNonNullableFields {
|
|
6562
|
-
original: string;
|
|
6563
|
-
}
|
|
6564
|
-
interface LocationAndQuantityNonNullableFields {
|
|
6565
|
-
_id: string;
|
|
6566
|
-
quantity: number;
|
|
6567
|
-
}
|
|
6568
|
-
interface TaxableAddressNonNullableFields {
|
|
6569
|
-
addressType: TaxableAddressType;
|
|
6570
|
-
}
|
|
6571
|
-
interface OrderLineItemNonNullableFields {
|
|
6572
|
-
_id: string;
|
|
6573
|
-
productName?: ProductNameNonNullableFields;
|
|
6574
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
6575
|
-
quantity: number;
|
|
6576
|
-
totalDiscount?: PriceNonNullableFields;
|
|
6577
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
6578
|
-
image: string;
|
|
6579
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
6580
|
-
itemType?: ItemTypeNonNullableFields;
|
|
6581
|
-
price?: PriceNonNullableFields;
|
|
6582
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
6583
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
6584
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
6585
|
-
paymentOption: PaymentOptionType;
|
|
6586
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6587
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
6588
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
6589
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
6590
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
6591
|
-
depositAmount?: PriceNonNullableFields;
|
|
6592
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
6593
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
6594
|
-
/** @internal */
|
|
6595
|
-
taxableAddress?: TaxableAddressNonNullableFields;
|
|
6596
|
-
/** @internal */
|
|
6597
|
-
priceUndetermined: boolean;
|
|
6598
|
-
/** @internal */
|
|
6599
|
-
fixedQuantity: boolean;
|
|
6600
|
-
}
|
|
6601
|
-
interface BuyerInfoNonNullableFields {
|
|
6602
|
-
visitorId: string;
|
|
6603
|
-
memberId: string;
|
|
6604
|
-
}
|
|
6605
|
-
interface PriceSummaryNonNullableFields {
|
|
6606
|
-
subtotal?: PriceNonNullableFields;
|
|
6607
|
-
shipping?: PriceNonNullableFields;
|
|
6608
|
-
tax?: PriceNonNullableFields;
|
|
6609
|
-
discount?: PriceNonNullableFields;
|
|
6610
|
-
totalPrice?: PriceNonNullableFields;
|
|
6611
|
-
total?: PriceNonNullableFields;
|
|
6612
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
6613
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
6614
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
6615
|
-
}
|
|
6616
|
-
interface StreetAddressNonNullableFields {
|
|
6617
|
-
number: string;
|
|
6618
|
-
name: string;
|
|
6619
|
-
apt: string;
|
|
6620
|
-
}
|
|
6621
|
-
interface AddressNonNullableFields {
|
|
6622
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
6623
|
-
}
|
|
6624
|
-
interface VatIdNonNullableFields {
|
|
6625
|
-
_id: string;
|
|
6626
|
-
type: VatType;
|
|
6627
|
-
}
|
|
6628
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
6629
|
-
vatId?: VatIdNonNullableFields;
|
|
6630
|
-
}
|
|
6631
|
-
interface AddressWithContactNonNullableFields {
|
|
6632
|
-
address?: AddressNonNullableFields;
|
|
6633
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
6634
|
-
}
|
|
6635
|
-
interface PickupAddressNonNullableFields {
|
|
6636
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
6637
|
-
}
|
|
6638
|
-
interface PickupDetailsNonNullableFields {
|
|
6639
|
-
address?: PickupAddressNonNullableFields;
|
|
6640
|
-
pickupMethod: PickupMethod;
|
|
6641
|
-
}
|
|
6642
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
6643
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
6644
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
6645
|
-
}
|
|
6646
|
-
interface ShippingPriceNonNullableFields {
|
|
6647
|
-
price?: PriceNonNullableFields;
|
|
6648
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
6649
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
6650
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6651
|
-
discount?: PriceNonNullableFields;
|
|
6652
|
-
}
|
|
6653
|
-
interface V1ShippingInformationNonNullableFields {
|
|
6654
|
-
title: string;
|
|
6655
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
6656
|
-
cost?: ShippingPriceNonNullableFields;
|
|
6657
|
-
}
|
|
6658
|
-
interface TaxSummaryNonNullableFields {
|
|
6659
|
-
totalTax?: PriceNonNullableFields;
|
|
6660
|
-
}
|
|
6661
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
6662
|
-
taxName: string;
|
|
6663
|
-
taxType: string;
|
|
6664
|
-
jurisdiction: string;
|
|
6665
|
-
jurisdictionType: JurisdictionType;
|
|
6666
|
-
rate: string;
|
|
6667
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
6668
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
6669
|
-
}
|
|
6670
|
-
interface OrderTaxInfoNonNullableFields {
|
|
6671
|
-
totalTax?: PriceNonNullableFields;
|
|
6672
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
6673
|
-
}
|
|
6674
|
-
interface CouponNonNullableFields {
|
|
6675
|
-
_id: string;
|
|
6676
|
-
code: string;
|
|
6677
|
-
name: string;
|
|
6678
|
-
amount?: PriceNonNullableFields;
|
|
6679
|
-
}
|
|
6680
|
-
interface MerchantDiscountNonNullableFields {
|
|
6681
|
-
discountReason: DiscountReason;
|
|
6682
|
-
amount?: PriceNonNullableFields;
|
|
6683
|
-
}
|
|
6684
|
-
interface DiscountRuleNameNonNullableFields {
|
|
6685
|
-
original: string;
|
|
6686
|
-
}
|
|
6687
|
-
interface DiscountRuleNonNullableFields {
|
|
6688
|
-
_id: string;
|
|
6689
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
6690
|
-
amount?: PriceNonNullableFields;
|
|
6691
|
-
}
|
|
6692
|
-
interface LineItemDiscountNonNullableFields {
|
|
6693
|
-
_id: string;
|
|
6694
|
-
totalDiscount?: PriceNonNullableFields;
|
|
6695
|
-
}
|
|
6696
|
-
interface AppliedDiscountNonNullableFields {
|
|
6697
|
-
coupon?: CouponNonNullableFields;
|
|
6698
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
6699
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
6700
|
-
discountType: DiscountType;
|
|
6701
|
-
lineItemIds: string[];
|
|
6702
|
-
/** @internal */
|
|
6703
|
-
lineItemDiscounts: LineItemDiscountNonNullableFields[];
|
|
6704
|
-
}
|
|
6705
|
-
interface CustomActivityNonNullableFields {
|
|
6706
|
-
appId: string;
|
|
6707
|
-
type: string;
|
|
6708
|
-
}
|
|
6709
|
-
interface MerchantCommentNonNullableFields {
|
|
6710
|
-
message: string;
|
|
6711
|
-
}
|
|
6712
|
-
interface OrderRefundedNonNullableFields {
|
|
6713
|
-
manual: boolean;
|
|
6714
|
-
amount?: PriceNonNullableFields;
|
|
6715
|
-
reason: string;
|
|
6716
|
-
}
|
|
6717
|
-
interface OrderCreatedFromExchangeNonNullableFields {
|
|
6718
|
-
originalOrderId: string;
|
|
6719
|
-
}
|
|
6720
|
-
interface LineItemExchangeDataNonNullableFields {
|
|
6721
|
-
lineItemId: string;
|
|
6722
|
-
quantity: number;
|
|
6723
|
-
}
|
|
6724
|
-
interface NewExchangeOrderCreatedNonNullableFields {
|
|
6725
|
-
exchangeOrderId: string;
|
|
6726
|
-
lineItems: LineItemExchangeDataNonNullableFields[];
|
|
6727
|
-
}
|
|
6728
|
-
interface LineItemQuantityChangeNonNullableFields {
|
|
6729
|
-
originalQuantity: number;
|
|
6730
|
-
newQuantity: number;
|
|
6731
|
-
diff: number;
|
|
6732
|
-
deltaType: LineItemQuantityChangeType;
|
|
6733
|
-
}
|
|
6734
|
-
interface LineItemPriceChangeNonNullableFields {
|
|
6735
|
-
originalPrice?: PriceNonNullableFields;
|
|
6736
|
-
newPrice?: PriceNonNullableFields;
|
|
6737
|
-
}
|
|
6738
|
-
interface LineItemChangesNonNullableFields {
|
|
6739
|
-
_id: string;
|
|
6740
|
-
name?: ProductNameNonNullableFields;
|
|
6741
|
-
quantity?: LineItemQuantityChangeNonNullableFields;
|
|
6742
|
-
price?: LineItemPriceChangeNonNullableFields;
|
|
6743
|
-
}
|
|
6744
|
-
interface ManagedLineItemNonNullableFields {
|
|
6745
|
-
_id: string;
|
|
6746
|
-
name?: ProductNameNonNullableFields;
|
|
6747
|
-
quantity: number;
|
|
6748
|
-
}
|
|
6749
|
-
interface TranslatedValueNonNullableFields {
|
|
6750
|
-
original: string;
|
|
6751
|
-
}
|
|
6752
|
-
interface LineItemAmountNonNullableFields {
|
|
6753
|
-
_id: string;
|
|
6754
|
-
name?: ProductNameNonNullableFields;
|
|
6755
|
-
amount?: PriceNonNullableFields;
|
|
6756
|
-
}
|
|
6757
|
-
interface ManagedDiscountNonNullableFields {
|
|
6758
|
-
_id: string;
|
|
6759
|
-
name?: TranslatedValueNonNullableFields;
|
|
6760
|
-
affectedLineItems: LineItemAmountNonNullableFields[];
|
|
6761
|
-
totalAmount?: PriceNonNullableFields;
|
|
6762
|
-
}
|
|
6763
|
-
interface ManagedAdditionalFeeNonNullableFields {
|
|
6764
|
-
_id: string;
|
|
6765
|
-
name?: TranslatedValueNonNullableFields;
|
|
6766
|
-
affectedLineItems: LineItemAmountNonNullableFields[];
|
|
6767
|
-
totalAmount?: PriceNonNullableFields;
|
|
6768
|
-
}
|
|
6769
|
-
interface TotalPriceChangeNonNullableFields {
|
|
6770
|
-
originalTotal?: PriceNonNullableFields;
|
|
6771
|
-
newTotal?: PriceNonNullableFields;
|
|
6772
|
-
}
|
|
6773
|
-
interface ShippingInformationNonNullableFields {
|
|
6774
|
-
total?: PriceNonNullableFields;
|
|
6775
|
-
shippingTitle: string;
|
|
6776
|
-
}
|
|
6777
|
-
interface ShippingInformationChangeNonNullableFields {
|
|
6778
|
-
originalShippingInfo?: ShippingInformationNonNullableFields;
|
|
6779
|
-
newShippingInfo?: ShippingInformationNonNullableFields;
|
|
6780
|
-
}
|
|
6781
|
-
interface OrderChangeNonNullableFields {
|
|
6782
|
-
lineItemChanged?: LineItemChangesNonNullableFields;
|
|
6783
|
-
lineItemAdded?: ManagedLineItemNonNullableFields;
|
|
6784
|
-
lineItemRemoved?: ManagedLineItemNonNullableFields;
|
|
6785
|
-
discountAdded?: ManagedDiscountNonNullableFields;
|
|
6786
|
-
discountRemoved?: ManagedDiscountNonNullableFields;
|
|
6787
|
-
additionalFeeAdded?: ManagedAdditionalFeeNonNullableFields;
|
|
6788
|
-
additionalFeeRemoved?: ManagedAdditionalFeeNonNullableFields;
|
|
6789
|
-
totalPriceChanged?: TotalPriceChangeNonNullableFields;
|
|
6790
|
-
shippingInformationChanged?: ShippingInformationChangeNonNullableFields;
|
|
6791
|
-
}
|
|
6792
|
-
interface DraftOrderChangesAppliedNonNullableFields {
|
|
6793
|
-
draftOrderId: string;
|
|
6794
|
-
changes: OrderChangeNonNullableFields[];
|
|
6795
|
-
}
|
|
6796
|
-
interface SavedPaymentMethodNonNullableFields {
|
|
6797
|
-
name: string;
|
|
6798
|
-
}
|
|
6799
|
-
interface AuthorizedPaymentCreatedNonNullableFields {
|
|
6800
|
-
paymentId: string;
|
|
6801
|
-
amount?: PriceNonNullableFields;
|
|
6802
|
-
}
|
|
6803
|
-
interface AuthorizedPaymentCapturedNonNullableFields {
|
|
6804
|
-
paymentId: string;
|
|
6805
|
-
amount?: PriceNonNullableFields;
|
|
6806
|
-
}
|
|
6807
|
-
interface AuthorizedPaymentVoidedNonNullableFields {
|
|
6808
|
-
paymentId: string;
|
|
6809
|
-
amount?: PriceNonNullableFields;
|
|
6810
|
-
}
|
|
6811
|
-
interface RegularPaymentRefundNonNullableFields {
|
|
6812
|
-
amount?: PriceNonNullableFields;
|
|
6813
|
-
}
|
|
6814
|
-
interface GiftCardPaymentRefundNonNullableFields {
|
|
6815
|
-
amount?: PriceNonNullableFields;
|
|
6816
|
-
}
|
|
6817
|
-
interface RefundedPaymentNonNullableFields {
|
|
6818
|
-
regular?: RegularPaymentRefundNonNullableFields;
|
|
6819
|
-
giftCard?: GiftCardPaymentRefundNonNullableFields;
|
|
6820
|
-
paymentId: string;
|
|
6821
|
-
externalRefund: boolean;
|
|
6822
|
-
}
|
|
6823
|
-
interface RefundInitiatedNonNullableFields {
|
|
6824
|
-
refundId: string;
|
|
6825
|
-
amount?: PriceNonNullableFields;
|
|
6826
|
-
payments: RefundedPaymentNonNullableFields[];
|
|
6827
|
-
}
|
|
6828
|
-
interface PaymentRefundedNonNullableFields {
|
|
6829
|
-
refundId: string;
|
|
6830
|
-
payment?: RefundedPaymentNonNullableFields;
|
|
6831
|
-
}
|
|
6832
|
-
interface PaymentRefundFailedNonNullableFields {
|
|
6833
|
-
refundId: string;
|
|
6834
|
-
payment?: RefundedPaymentNonNullableFields;
|
|
6835
|
-
}
|
|
6836
|
-
interface RefundedAsStoreCreditNonNullableFields {
|
|
6837
|
-
amount?: PriceNonNullableFields;
|
|
6838
|
-
}
|
|
6839
|
-
interface RegularPaymentNonNullableFields {
|
|
6840
|
-
amount?: PriceNonNullableFields;
|
|
6841
|
-
}
|
|
6842
|
-
interface PaymentPendingNonNullableFields {
|
|
6843
|
-
regular?: RegularPaymentNonNullableFields;
|
|
6844
|
-
paymentId: string;
|
|
6845
|
-
}
|
|
6846
|
-
interface PaymentCanceledNonNullableFields {
|
|
6847
|
-
regular?: RegularPaymentNonNullableFields;
|
|
6848
|
-
paymentId: string;
|
|
6849
|
-
}
|
|
6850
|
-
interface PaymentDeclinedNonNullableFields {
|
|
6851
|
-
regular?: RegularPaymentNonNullableFields;
|
|
6852
|
-
paymentId: string;
|
|
6853
|
-
}
|
|
6854
|
-
interface WixReceiptNonNullableFields {
|
|
6855
|
-
receiptId: string;
|
|
6856
|
-
}
|
|
6857
|
-
interface ReceiptCreatedNonNullableFields {
|
|
6858
|
-
wixReceipt?: WixReceiptNonNullableFields;
|
|
6859
|
-
paymentId: string;
|
|
6860
|
-
}
|
|
6861
|
-
interface ReceiptSentNonNullableFields {
|
|
6862
|
-
wixReceipt?: WixReceiptNonNullableFields;
|
|
6863
|
-
paymentId: string;
|
|
6864
|
-
}
|
|
6865
|
-
interface ActivityNonNullableFields {
|
|
6866
|
-
customActivity?: CustomActivityNonNullableFields;
|
|
6867
|
-
merchantComment?: MerchantCommentNonNullableFields;
|
|
6868
|
-
orderRefunded?: OrderRefundedNonNullableFields;
|
|
6869
|
-
orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
|
|
6870
|
-
newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
|
|
6871
|
-
/** @internal */
|
|
6872
|
-
draftOrderChangesApplied?: DraftOrderChangesAppliedNonNullableFields;
|
|
6873
|
-
/** @internal */
|
|
6874
|
-
savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
|
|
6875
|
-
/** @internal */
|
|
6876
|
-
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields;
|
|
6877
|
-
/** @internal */
|
|
6878
|
-
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields;
|
|
6879
|
-
/** @internal */
|
|
6880
|
-
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields;
|
|
6881
|
-
/** @internal */
|
|
6882
|
-
refundInitiated?: RefundInitiatedNonNullableFields;
|
|
6883
|
-
/** @internal */
|
|
6884
|
-
paymentRefunded?: PaymentRefundedNonNullableFields;
|
|
6885
|
-
/** @internal */
|
|
6886
|
-
paymentRefundFailed?: PaymentRefundFailedNonNullableFields;
|
|
6887
|
-
/** @internal */
|
|
6888
|
-
refundedAsStoreCredit?: RefundedAsStoreCreditNonNullableFields;
|
|
6889
|
-
/** @internal */
|
|
6890
|
-
paymentPending?: PaymentPendingNonNullableFields;
|
|
6891
|
-
/** @internal */
|
|
6892
|
-
paymentCanceled?: PaymentCanceledNonNullableFields;
|
|
6893
|
-
/** @internal */
|
|
6894
|
-
paymentDeclined?: PaymentDeclinedNonNullableFields;
|
|
6895
|
-
/** @internal */
|
|
6896
|
-
receiptCreated?: ReceiptCreatedNonNullableFields;
|
|
6897
|
-
/** @internal */
|
|
6898
|
-
receiptSent?: ReceiptSentNonNullableFields;
|
|
6899
|
-
type: ActivityType;
|
|
6900
|
-
}
|
|
6901
|
-
interface CreatedByNonNullableFields {
|
|
6902
|
-
userId: string;
|
|
6903
|
-
memberId: string;
|
|
6904
|
-
visitorId: string;
|
|
6905
|
-
appId: string;
|
|
6906
|
-
}
|
|
6907
|
-
interface ChannelInfoNonNullableFields {
|
|
6908
|
-
type: ChannelType;
|
|
6909
|
-
}
|
|
6910
|
-
interface CustomFieldNonNullableFields {
|
|
6911
|
-
title: string;
|
|
6912
|
-
}
|
|
6913
|
-
interface BalanceNonNullableFields {
|
|
6914
|
-
amount: string;
|
|
6915
|
-
formattedAmount: string;
|
|
6916
|
-
}
|
|
6917
|
-
interface BalanceSummaryNonNullableFields {
|
|
6918
|
-
balance?: BalanceNonNullableFields;
|
|
6919
|
-
paid?: PriceNonNullableFields;
|
|
6920
|
-
refunded?: PriceNonNullableFields;
|
|
6921
|
-
authorized?: PriceNonNullableFields;
|
|
6922
|
-
/** @internal */
|
|
6923
|
-
pendingRefund?: PriceNonNullableFields;
|
|
6924
|
-
pending?: PriceNonNullableFields;
|
|
6925
|
-
}
|
|
6926
|
-
interface AdditionalFeeNonNullableFields {
|
|
6927
|
-
name: string;
|
|
6928
|
-
price?: PriceNonNullableFields;
|
|
6929
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6930
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
6931
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
6932
|
-
_id: string;
|
|
6933
|
-
lineItemIds: string[];
|
|
6934
|
-
}
|
|
6935
|
-
interface TagListNonNullableFields {
|
|
6936
|
-
tagIds: string[];
|
|
6937
|
-
}
|
|
6938
|
-
interface TagsNonNullableFields {
|
|
6939
|
-
privateTags?: TagListNonNullableFields;
|
|
6940
|
-
tags?: TagListNonNullableFields;
|
|
6941
|
-
}
|
|
6942
|
-
interface LocationNonNullableFields {
|
|
6943
|
-
_id: string;
|
|
6944
|
-
name: string;
|
|
6945
|
-
}
|
|
6946
|
-
export interface OrderNonNullableFields {
|
|
6947
|
-
number: string;
|
|
6948
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
6949
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
6950
|
-
paymentStatus: PaymentStatus;
|
|
6951
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
6952
|
-
weightUnit: WeightUnit;
|
|
6953
|
-
taxIncludedInPrices: boolean;
|
|
6954
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
6955
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
6956
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
6957
|
-
status: OrderStatus;
|
|
6958
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
6959
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
6960
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
6961
|
-
activities: ActivityNonNullableFields[];
|
|
6962
|
-
attributionSource: AttributionSource;
|
|
6963
|
-
createdBy?: CreatedByNonNullableFields;
|
|
6964
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
6965
|
-
customFields: CustomFieldNonNullableFields[];
|
|
6966
|
-
isInternalOrderCreate: boolean;
|
|
6967
|
-
payNow?: PriceSummaryNonNullableFields;
|
|
6968
|
-
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
6969
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
6970
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
6971
|
-
tags?: TagsNonNullableFields;
|
|
6972
|
-
businessLocation?: LocationNonNullableFields;
|
|
6973
|
-
/** @internal */
|
|
6974
|
-
payAfterFreeTrial?: PriceSummaryNonNullableFields;
|
|
6975
|
-
}
|
|
6976
|
-
export interface MarkOrderAsPaidResponseNonNullableFields {
|
|
6977
|
-
order?: OrderNonNullableFields;
|
|
6978
|
-
}
|
|
6979
|
-
interface ApplicationErrorNonNullableFields {
|
|
6980
|
-
code: string;
|
|
6981
|
-
description: string;
|
|
6982
|
-
}
|
|
6983
|
-
interface ItemMetadataNonNullableFields {
|
|
6984
|
-
originalIndex: number;
|
|
6985
|
-
success: boolean;
|
|
6986
|
-
error?: ApplicationErrorNonNullableFields;
|
|
6987
|
-
}
|
|
6988
|
-
interface BulkOrderResultNonNullableFields {
|
|
6989
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
6990
|
-
item?: OrderNonNullableFields;
|
|
6991
|
-
}
|
|
6992
|
-
interface BulkActionMetadataNonNullableFields {
|
|
6993
|
-
totalSuccesses: number;
|
|
6994
|
-
totalFailures: number;
|
|
6995
|
-
undetailedFailures: number;
|
|
6996
|
-
}
|
|
6997
|
-
export interface BulkMarkOrdersAsPaidResponseNonNullableFields {
|
|
6998
|
-
results: BulkOrderResultNonNullableFields[];
|
|
6999
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
7000
|
-
}
|
|
7001
|
-
interface RefundabilityNonNullableFields {
|
|
7002
|
-
nonRefundableReason: NonRefundableReason;
|
|
7003
|
-
manuallyRefundableReason: ManuallyRefundableReason;
|
|
7004
|
-
paymentId: string;
|
|
7005
|
-
refundabilityStatus: RefundableStatus;
|
|
7006
|
-
}
|
|
7007
|
-
export interface GetRefundabilityStatusResponseNonNullableFields {
|
|
7008
|
-
refundabilities: RefundabilityNonNullableFields[];
|
|
7009
|
-
refundablePerItem: boolean;
|
|
7010
|
-
}
|
|
7011
|
-
export interface CreatePaymentGatewayOrderResponseNonNullableFields {
|
|
7012
|
-
paymentGatewayOrderId: string;
|
|
7013
|
-
}
|
|
7014
|
-
interface AuthorizationActionFailureDetailsNonNullableFields {
|
|
7015
|
-
failureCode: string;
|
|
7016
|
-
}
|
|
7017
|
-
interface AuthorizationCaptureNonNullableFields {
|
|
7018
|
-
status: AuthorizationCaptureStatus;
|
|
7019
|
-
amount?: PriceNonNullableFields;
|
|
7020
|
-
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields;
|
|
7021
|
-
}
|
|
7022
|
-
interface AuthorizationVoidNonNullableFields {
|
|
7023
|
-
status: AuthorizationVoidStatus;
|
|
7024
|
-
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields;
|
|
7025
|
-
reason: Reason;
|
|
7026
|
-
}
|
|
7027
|
-
interface V1ScheduledActionNonNullableFields {
|
|
7028
|
-
actionType: ActionType;
|
|
7029
|
-
}
|
|
7030
|
-
interface AuthorizationDetailsNonNullableFields {
|
|
7031
|
-
delayedCapture: boolean;
|
|
7032
|
-
captures: AuthorizationCaptureNonNullableFields[];
|
|
7033
|
-
void?: AuthorizationVoidNonNullableFields;
|
|
7034
|
-
scheduledAction?: V1ScheduledActionNonNullableFields;
|
|
7035
|
-
}
|
|
7036
|
-
interface RegularPaymentDetailsNonNullableFields {
|
|
7037
|
-
offlinePayment: boolean;
|
|
7038
|
-
status: TransactionStatus;
|
|
7039
|
-
savedPaymentMethod: boolean;
|
|
7040
|
-
authorizationDetails?: AuthorizationDetailsNonNullableFields;
|
|
7041
|
-
}
|
|
7042
|
-
interface GiftCardPaymentDetailsNonNullableFields {
|
|
7043
|
-
giftCardPaymentId: string;
|
|
7044
|
-
giftCardId: string;
|
|
7045
|
-
appId: string;
|
|
7046
|
-
voided: boolean;
|
|
7047
|
-
}
|
|
7048
|
-
interface MembershipNameNonNullableFields {
|
|
7049
|
-
original: string;
|
|
7050
|
-
}
|
|
7051
|
-
interface MembershipPaymentDetailsNonNullableFields {
|
|
7052
|
-
membershipId: string;
|
|
7053
|
-
lineItemId: string;
|
|
7054
|
-
status: MembershipPaymentStatus;
|
|
7055
|
-
name?: MembershipNameNonNullableFields;
|
|
7056
|
-
voided: boolean;
|
|
7057
|
-
providerAppId: string;
|
|
7058
|
-
}
|
|
7059
|
-
interface WixReceiptInfoNonNullableFields {
|
|
7060
|
-
receiptId: string;
|
|
7061
|
-
}
|
|
7062
|
-
interface PaymentNonNullableFields {
|
|
7063
|
-
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields;
|
|
7064
|
-
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields;
|
|
7065
|
-
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields;
|
|
7066
|
-
/** @internal */
|
|
7067
|
-
wixReceipt?: WixReceiptInfoNonNullableFields;
|
|
7068
|
-
amount?: PriceNonNullableFields;
|
|
7069
|
-
refundDisabled: boolean;
|
|
7070
|
-
/** @internal */
|
|
7071
|
-
supportReceiptGeneration: boolean;
|
|
7072
|
-
}
|
|
7073
|
-
interface RefundTransactionNonNullableFields {
|
|
7074
|
-
paymentId: string;
|
|
7075
|
-
amount?: PriceNonNullableFields;
|
|
7076
|
-
refundStatus: RefundStatus;
|
|
7077
|
-
externalRefund: boolean;
|
|
7078
|
-
}
|
|
7079
|
-
interface RefundItemNonNullableFields {
|
|
7080
|
-
lineItemId: string;
|
|
7081
|
-
quantity: number;
|
|
7082
|
-
}
|
|
7083
|
-
interface LineItemRefundNonNullableFields {
|
|
7084
|
-
lineItemId: string;
|
|
7085
|
-
quantity: number;
|
|
7086
|
-
}
|
|
7087
|
-
interface AdditionalFeeRefundNonNullableFields {
|
|
7088
|
-
additionalFeeId: string;
|
|
7089
|
-
amount?: PriceNonNullableFields;
|
|
7090
|
-
}
|
|
7091
|
-
interface ShippingRefundNonNullableFields {
|
|
7092
|
-
amount?: PriceNonNullableFields;
|
|
7093
|
-
}
|
|
7094
|
-
interface RefundDetailsNonNullableFields {
|
|
7095
|
-
items: RefundItemNonNullableFields[];
|
|
7096
|
-
shippingIncluded: boolean;
|
|
7097
|
-
lineItems: LineItemRefundNonNullableFields[];
|
|
7098
|
-
additionalFees: AdditionalFeeRefundNonNullableFields[];
|
|
7099
|
-
shipping?: ShippingRefundNonNullableFields;
|
|
7100
|
-
}
|
|
7101
|
-
interface LineItemRefundSummaryNonNullableFields {
|
|
7102
|
-
lineItemId: string;
|
|
7103
|
-
totalRefundedAmount?: PriceNonNullableFields;
|
|
7104
|
-
}
|
|
7105
|
-
interface RefundItemsBreakdownNonNullableFields {
|
|
7106
|
-
lineItems: LineItemRefundSummaryNonNullableFields[];
|
|
7107
|
-
}
|
|
7108
|
-
interface AggregatedRefundSummaryNonNullableFields {
|
|
7109
|
-
requestedRefund?: PriceNonNullableFields;
|
|
7110
|
-
pendingRefund?: PriceNonNullableFields;
|
|
7111
|
-
refunded?: PriceNonNullableFields;
|
|
7112
|
-
failedRefundAmount?: PriceNonNullableFields;
|
|
7113
|
-
pending: boolean;
|
|
7114
|
-
breakdown?: RefundItemsBreakdownNonNullableFields;
|
|
7115
|
-
}
|
|
7116
|
-
interface RefundNonNullableFields {
|
|
7117
|
-
_id: string;
|
|
7118
|
-
transactions: RefundTransactionNonNullableFields[];
|
|
7119
|
-
details?: RefundDetailsNonNullableFields;
|
|
7120
|
-
summary?: AggregatedRefundSummaryNonNullableFields;
|
|
7121
|
-
}
|
|
7122
|
-
interface OrderTransactionsNonNullableFields {
|
|
7123
|
-
orderId: string;
|
|
7124
|
-
payments: PaymentNonNullableFields[];
|
|
7125
|
-
refunds: RefundNonNullableFields[];
|
|
7126
|
-
}
|
|
7127
|
-
export interface TriggerRefundResponseNonNullableFields {
|
|
7128
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
7129
|
-
failedPaymentIds: ItemMetadataNonNullableFields[];
|
|
7130
|
-
}
|
|
7131
|
-
export interface VoidAuthorizedPaymentsResponseNonNullableFields {
|
|
7132
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
7133
|
-
}
|
|
7134
|
-
export interface CaptureAuthorizedPaymentsResponseNonNullableFields {
|
|
7135
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
7136
|
-
}
|
|
7137
|
-
export interface GetOrderResponseNonNullableFields {
|
|
7138
|
-
order?: OrderNonNullableFields;
|
|
7139
|
-
}
|
|
7140
|
-
export interface SearchOrdersResponseNonNullableFields {
|
|
7141
|
-
orders: OrderNonNullableFields[];
|
|
7142
|
-
}
|
|
7143
|
-
export interface CreateOrderResponseNonNullableFields {
|
|
7144
|
-
order?: OrderNonNullableFields;
|
|
7145
|
-
}
|
|
7146
|
-
export interface UpdateOrderResponseNonNullableFields {
|
|
7147
|
-
order?: OrderNonNullableFields;
|
|
7148
|
-
}
|
|
7149
|
-
export interface BulkUpdateOrdersResponseNonNullableFields {
|
|
7150
|
-
results: BulkOrderResultNonNullableFields[];
|
|
7151
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
7152
|
-
}
|
|
7153
|
-
export interface CommitDeltasResponseNonNullableFields {
|
|
7154
|
-
order?: OrderNonNullableFields;
|
|
7155
|
-
}
|
|
7156
|
-
export interface UpdateOrderLineItemResponseNonNullableFields {
|
|
7157
|
-
order?: OrderNonNullableFields;
|
|
7158
|
-
}
|
|
7159
|
-
export interface AddActivityResponseNonNullableFields {
|
|
7160
|
-
order?: OrderNonNullableFields;
|
|
7161
|
-
activityId: string;
|
|
7162
|
-
}
|
|
7163
|
-
export interface UpdateActivityResponseNonNullableFields {
|
|
7164
|
-
order?: OrderNonNullableFields;
|
|
7165
|
-
}
|
|
7166
|
-
export interface DeleteActivityResponseNonNullableFields {
|
|
7167
|
-
order?: OrderNonNullableFields;
|
|
7168
|
-
}
|
|
7169
|
-
export interface CancelOrderResponseNonNullableFields {
|
|
7170
|
-
order?: OrderNonNullableFields;
|
|
7171
|
-
}
|
|
7172
|
-
export interface UpdateOrderStatusResponseNonNullableFields {
|
|
7173
|
-
order?: OrderNonNullableFields;
|
|
7174
|
-
}
|
|
7175
|
-
interface BulkUpdateOrderTagsResultNonNullableFields {
|
|
7176
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
7177
|
-
}
|
|
7178
|
-
export interface BulkUpdateOrderTagsResponseNonNullableFields {
|
|
7179
|
-
results: BulkUpdateOrderTagsResultNonNullableFields[];
|
|
7180
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
7181
|
-
}
|
|
7182
6460
|
export interface BaseEventMetadata {
|
|
7183
6461
|
/**
|
|
7184
6462
|
* App instance ID.
|
|
@@ -7247,6 +6525,8 @@ export interface OrderApprovedEnvelope {
|
|
|
7247
6525
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7248
6526
|
* @permissionScope Manage eCommerce - all permissions
|
|
7249
6527
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6528
|
+
* @permissionScope Picasso private app mega scope
|
|
6529
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7250
6530
|
* @permissionScope Manage Orders
|
|
7251
6531
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7252
6532
|
* @permissionId ECOM.READ_ORDERS
|
|
@@ -7271,6 +6551,8 @@ export interface OrderUpdatedEnvelope {
|
|
|
7271
6551
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7272
6552
|
* @permissionScope Manage eCommerce - all permissions
|
|
7273
6553
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6554
|
+
* @permissionScope Picasso private app mega scope
|
|
6555
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7274
6556
|
* @permissionScope Manage Orders
|
|
7275
6557
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7276
6558
|
* @permissionId ECOM.READ_ORDERS
|
|
@@ -7339,6 +6621,7 @@ export interface OrderCreatedEnvelope {
|
|
|
7339
6621
|
* @slug created
|
|
7340
6622
|
*/
|
|
7341
6623
|
export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
6624
|
+
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}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `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}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `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` | `appliedDiscounts.${number}.lineItemIds` | `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` | `additionalFees.${number}.lineItemIds` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`;
|
|
7342
6625
|
/**
|
|
7343
6626
|
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
7344
6627
|
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
@@ -7354,10 +6637,12 @@ export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) =>
|
|
|
7354
6637
|
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7355
6638
|
* @permissionScope Manage Restaurants - all permissions
|
|
7356
6639
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6640
|
+
* @permissionScope Picasso private app mega scope
|
|
6641
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7357
6642
|
* @applicableIdentity APP
|
|
7358
6643
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
7359
6644
|
*/
|
|
7360
|
-
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<PreparePaymentCollectionResponse
|
|
6645
|
+
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`>>;
|
|
7361
6646
|
export interface PreparePaymentCollectionOptions {
|
|
7362
6647
|
/**
|
|
7363
6648
|
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
@@ -7388,10 +6673,12 @@ export interface PreparePaymentCollectionOptions {
|
|
|
7388
6673
|
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7389
6674
|
* @permissionScope Manage Restaurants - all permissions
|
|
7390
6675
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6676
|
+
* @permissionScope Picasso private app mega scope
|
|
6677
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7391
6678
|
* @applicableIdentity APP
|
|
7392
6679
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
7393
6680
|
*/
|
|
7394
|
-
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse
|
|
6681
|
+
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
7395
6682
|
/**
|
|
7396
6683
|
* Records and approves new manual payment with provided custom amount on given order.
|
|
7397
6684
|
* Existing pending payments are ignored.
|
|
@@ -7405,6 +6692,8 @@ export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Pro
|
|
|
7405
6692
|
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7406
6693
|
* @permissionScope Manage Restaurants - all permissions
|
|
7407
6694
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6695
|
+
* @permissionScope Picasso private app mega scope
|
|
6696
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7408
6697
|
* @applicableIdentity APP
|
|
7409
6698
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
|
|
7410
6699
|
*/
|
|
@@ -7427,12 +6716,16 @@ export declare function recordManuallyCollectedPayment(orderId: string, amount:
|
|
|
7427
6716
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7428
6717
|
* @permissionScope Manage eCommerce - all permissions
|
|
7429
6718
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6719
|
+
* @permissionScope Picasso private app mega scope
|
|
6720
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7430
6721
|
* @permissionScope Manage Orders
|
|
7431
6722
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7432
6723
|
* @applicableIdentity APP
|
|
7433
6724
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
7434
6725
|
*/
|
|
7435
|
-
export declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<MarkOrderAsPaidResponse
|
|
6726
|
+
export declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
6727
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
6728
|
+
}[OrderNonNullablePaths]>>;
|
|
7436
6729
|
/**
|
|
7437
6730
|
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
7438
6731
|
* @param ecomOrderIds - IDs of orders to mark as paid.
|
|
@@ -7446,12 +6739,16 @@ export declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): P
|
|
|
7446
6739
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7447
6740
|
* @permissionScope Manage eCommerce - all permissions
|
|
7448
6741
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6742
|
+
* @permissionScope Picasso private app mega scope
|
|
6743
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7449
6744
|
* @permissionScope Manage Orders
|
|
7450
6745
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7451
6746
|
* @applicableIdentity APP
|
|
7452
6747
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
|
|
7453
6748
|
*/
|
|
7454
|
-
export declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<BulkMarkOrdersAsPaidResponse
|
|
6749
|
+
export 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` | {
|
|
6750
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
6751
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7455
6752
|
/**
|
|
7456
6753
|
* Checks whether this order can be refunded.
|
|
7457
6754
|
* @param ecomOrderId - Order ID.
|
|
@@ -7471,12 +6768,14 @@ export declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: stri
|
|
|
7471
6768
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7472
6769
|
* @permissionScope Manage eCommerce - all permissions
|
|
7473
6770
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6771
|
+
* @permissionScope Picasso private app mega scope
|
|
6772
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7474
6773
|
* @permissionScope Manage Orders
|
|
7475
6774
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7476
6775
|
* @applicableIdentity APP
|
|
7477
6776
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
|
|
7478
6777
|
*/
|
|
7479
|
-
export declare function getRefundabilityStatus(ecomOrderId: string): Promise<GetRefundabilityStatusResponse
|
|
6778
|
+
export declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
7480
6779
|
/**
|
|
7481
6780
|
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
7482
6781
|
* 1. An explicit amount provided in the request, or;
|
|
@@ -7494,12 +6793,14 @@ export declare function getRefundabilityStatus(ecomOrderId: string): Promise<Get
|
|
|
7494
6793
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7495
6794
|
* @permissionScope Manage eCommerce - all permissions
|
|
7496
6795
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6796
|
+
* @permissionScope Picasso private app mega scope
|
|
6797
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7497
6798
|
* @permissionScope Manage Orders
|
|
7498
6799
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7499
6800
|
* @applicableIdentity APP
|
|
7500
6801
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
|
|
7501
6802
|
*/
|
|
7502
|
-
export declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<CreatePaymentGatewayOrderResponse
|
|
6803
|
+
export declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`>>;
|
|
7503
6804
|
export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
7504
6805
|
/** Information about the user who initiated the payment. */
|
|
7505
6806
|
chargedBy?: ChargedBy;
|
|
@@ -7526,12 +6827,14 @@ export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
|
7526
6827
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7527
6828
|
* @permissionScope Manage eCommerce - all permissions
|
|
7528
6829
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6830
|
+
* @permissionScope Picasso private app mega scope
|
|
6831
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7529
6832
|
* @permissionScope Manage Orders
|
|
7530
6833
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7531
6834
|
* @applicableIdentity APP
|
|
7532
6835
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
|
|
7533
6836
|
*/
|
|
7534
|
-
export declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: ChargeMembershipsOptions): Promise<void>;
|
|
6837
|
+
export 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>;
|
|
7535
6838
|
export interface ChargeMembershipsOptions {
|
|
7536
6839
|
/**
|
|
7537
6840
|
* List of items to be paid by memberships
|
|
@@ -7559,12 +6862,14 @@ export interface ChargeMembershipsOptions {
|
|
|
7559
6862
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7560
6863
|
* @permissionScope Manage eCommerce - all permissions
|
|
7561
6864
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6865
|
+
* @permissionScope Picasso private app mega scope
|
|
6866
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7562
6867
|
* @permissionScope Manage Orders
|
|
7563
6868
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7564
6869
|
* @applicableIdentity APP
|
|
7565
6870
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
|
|
7566
6871
|
*/
|
|
7567
|
-
export declare function triggerRefund(ecomOrderId: string, payments: PaymentRefund[], options?: TriggerRefundOptions): Promise<TriggerRefundResponse
|
|
6872
|
+
export 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.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `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}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`>>;
|
|
7568
6873
|
export interface TriggerRefundOptions {
|
|
7569
6874
|
/** Business model of a refund */
|
|
7570
6875
|
details?: RefundDetails;
|
|
@@ -7587,12 +6892,14 @@ export interface TriggerRefundOptions {
|
|
|
7587
6892
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7588
6893
|
* @permissionScope Manage eCommerce - all permissions
|
|
7589
6894
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6895
|
+
* @permissionScope Picasso private app mega scope
|
|
6896
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7590
6897
|
* @permissionScope Manage Orders
|
|
7591
6898
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7592
6899
|
* @applicableIdentity APP
|
|
7593
6900
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
7594
6901
|
*/
|
|
7595
|
-
export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse
|
|
6902
|
+
export 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.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `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}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
7596
6903
|
/**
|
|
7597
6904
|
* Capture authorized payments
|
|
7598
6905
|
* Transaction statuses for related payments will be updated in async way
|
|
@@ -7610,12 +6917,14 @@ export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds:
|
|
|
7610
6917
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7611
6918
|
* @permissionScope Manage eCommerce - all permissions
|
|
7612
6919
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6920
|
+
* @permissionScope Picasso private app mega scope
|
|
6921
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7613
6922
|
* @permissionScope Manage Orders
|
|
7614
6923
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7615
6924
|
* @applicableIdentity APP
|
|
7616
6925
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
7617
6926
|
*/
|
|
7618
|
-
export declare function captureAuthorizedPayments(ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse
|
|
6927
|
+
export 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.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `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}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
7619
6928
|
/**
|
|
7620
6929
|
* Retrieves an order.
|
|
7621
6930
|
*
|
|
@@ -7648,7 +6957,7 @@ export declare function captureAuthorizedPayments(ecomOrderId: string, payments:
|
|
|
7648
6957
|
* @returns Fulfilled - The requested order.
|
|
7649
6958
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
7650
6959
|
*/
|
|
7651
|
-
export declare function getOrder(_id: string): Promise<Order
|
|
6960
|
+
export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
7652
6961
|
/**
|
|
7653
6962
|
* Retrieves a list of orders, given the provided paging, filtering, and sorting.
|
|
7654
6963
|
*
|
|
@@ -7685,7 +6994,9 @@ export declare function getOrder(_id: string): Promise<Order & OrderNonNullableF
|
|
|
7685
6994
|
* @applicableIdentity APP
|
|
7686
6995
|
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
7687
6996
|
*/
|
|
7688
|
-
export declare function searchOrders(options?: SearchOrdersOptions): Promise<SearchOrdersResponse
|
|
6997
|
+
export declare function searchOrders(options?: SearchOrdersOptions): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
6998
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
6999
|
+
}[OrderNonNullablePaths]>>;
|
|
7689
7000
|
export interface SearchOrdersOptions {
|
|
7690
7001
|
/** Search options. */
|
|
7691
7002
|
search?: CursorSearch;
|
|
@@ -7731,7 +7042,7 @@ export interface SearchOrdersOptions {
|
|
|
7731
7042
|
* @returns Newly created order.
|
|
7732
7043
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
7733
7044
|
*/
|
|
7734
|
-
export declare function createOrder(order: Order, options?: CreateOrderOptions): Promise<Order
|
|
7045
|
+
export declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
7735
7046
|
export interface CreateOrderOptions {
|
|
7736
7047
|
/** Determine order lifecycle */
|
|
7737
7048
|
settings?: OrderCreationSettings;
|
|
@@ -7782,7 +7093,7 @@ export interface CreateOrderOptions {
|
|
|
7782
7093
|
* @returns Newly created order.
|
|
7783
7094
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
7784
7095
|
*/
|
|
7785
|
-
export declare function updateOrder(_id: string
|
|
7096
|
+
export declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
7786
7097
|
export interface UpdateOrder {
|
|
7787
7098
|
/**
|
|
7788
7099
|
* Order ID.
|
|
@@ -8002,7 +7313,9 @@ export interface UpdateOrder {
|
|
|
8002
7313
|
* @applicableIdentity APP
|
|
8003
7314
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
8004
7315
|
*/
|
|
8005
|
-
export declare function bulkUpdateOrders(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions): Promise<BulkUpdateOrdersResponse
|
|
7316
|
+
export declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
7317
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
7318
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
8006
7319
|
export interface BulkUpdateOrdersOptions {
|
|
8007
7320
|
/**
|
|
8008
7321
|
* Whether to return the full order entities.
|
|
@@ -8022,7 +7335,9 @@ export interface BulkUpdateOrdersOptions {
|
|
|
8022
7335
|
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
8023
7336
|
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
8024
7337
|
*/
|
|
8025
|
-
export declare function commitDeltas(_id: string, options?: CommitDeltasOptions): Promise<CommitDeltasResponse
|
|
7338
|
+
export declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
7339
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7340
|
+
}[OrderNonNullablePaths]>>;
|
|
8026
7341
|
export interface CommitDeltasOptions {
|
|
8027
7342
|
/**
|
|
8028
7343
|
* Draft order Id representing this change.
|
|
@@ -8062,7 +7377,9 @@ export interface CommitDeltasOptions {
|
|
|
8062
7377
|
* @deprecated
|
|
8063
7378
|
* @targetRemovalDate 2024-02-15
|
|
8064
7379
|
*/
|
|
8065
|
-
export declare function updateOrderLineItem(identifiers: UpdateOrderLineItemIdentifiers, lineItem: UpdateOrderLineItem): Promise<UpdateOrderLineItemResponse
|
|
7380
|
+
export declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
7381
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7382
|
+
}[OrderNonNullablePaths]>>;
|
|
8066
7383
|
export interface UpdateOrderLineItemIdentifiers {
|
|
8067
7384
|
/**
|
|
8068
7385
|
* Order ID
|
|
@@ -8228,7 +7545,9 @@ export interface UpdateOrderLineItem {
|
|
|
8228
7545
|
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
8229
7546
|
* @targetRemovalDate 2024-11-01
|
|
8230
7547
|
*/
|
|
8231
|
-
export declare function addActivity(_id: string, activity: PublicActivity): Promise<AddActivityResponse
|
|
7548
|
+
export declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
7549
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7550
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
8232
7551
|
/**
|
|
8233
7552
|
* Updates an order's activity.
|
|
8234
7553
|
* @param activity - Activity info.
|
|
@@ -8252,7 +7571,9 @@ export declare function addActivity(_id: string, activity: PublicActivity): Prom
|
|
|
8252
7571
|
* @applicableIdentity APP
|
|
8253
7572
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
8254
7573
|
*/
|
|
8255
|
-
export declare function updateActivity(identifiers: UpdateActivityIdentifiers, activity: PublicActivity): Promise<UpdateActivityResponse
|
|
7574
|
+
export declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
7575
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7576
|
+
}[OrderNonNullablePaths]>>;
|
|
8256
7577
|
export interface UpdateActivityIdentifiers {
|
|
8257
7578
|
/**
|
|
8258
7579
|
* Order ID.
|
|
@@ -8289,7 +7610,9 @@ export interface UpdateActivityIdentifiers {
|
|
|
8289
7610
|
* @applicableIdentity APP
|
|
8290
7611
|
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
8291
7612
|
*/
|
|
8292
|
-
export declare function deleteActivity(identifiers: DeleteActivityIdentifiers): Promise<DeleteActivityResponse
|
|
7613
|
+
export declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
7614
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7615
|
+
}[OrderNonNullablePaths]>>;
|
|
8293
7616
|
export interface DeleteActivityIdentifiers {
|
|
8294
7617
|
/**
|
|
8295
7618
|
* Order ID.
|
|
@@ -8325,7 +7648,9 @@ export interface DeleteActivityIdentifiers {
|
|
|
8325
7648
|
* @applicableIdentity APP
|
|
8326
7649
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
8327
7650
|
*/
|
|
8328
|
-
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<CancelOrderResponse
|
|
7651
|
+
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
7652
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7653
|
+
}[OrderNonNullablePaths]>>;
|
|
8329
7654
|
export interface CancelOrderOptions {
|
|
8330
7655
|
/** Whether to send an order canceled email to the buyer. */
|
|
8331
7656
|
sendOrderCanceledEmail?: boolean;
|
|
@@ -8372,7 +7697,9 @@ export interface CancelOrderOptions {
|
|
|
8372
7697
|
* @applicableIdentity APP
|
|
8373
7698
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
8374
7699
|
*/
|
|
8375
|
-
export declare function updateOrderStatus(orderId: string, status: OrderStatus): Promise<UpdateOrderStatusResponse
|
|
7700
|
+
export declare function updateOrderStatus(orderId: string, status: OrderStatus): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
7701
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7702
|
+
}[OrderNonNullablePaths]>>;
|
|
8376
7703
|
/** @internal
|
|
8377
7704
|
* @documentationMaturity preview
|
|
8378
7705
|
* @requiredField options.aggregation
|
|
@@ -8396,7 +7723,7 @@ export declare function updateOrderStatus(orderId: string, status: OrderStatus):
|
|
|
8396
7723
|
* @applicableIdentity APP
|
|
8397
7724
|
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
8398
7725
|
*/
|
|
8399
|
-
export declare function aggregateOrders(options?: AggregateOrdersOptions): Promise<AggregateOrdersResponse>;
|
|
7726
|
+
export declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
8400
7727
|
export interface AggregateOrdersOptions {
|
|
8401
7728
|
/** Filter applied to original data */
|
|
8402
7729
|
filter?: Record<string, any> | null;
|
|
@@ -8445,7 +7772,7 @@ export interface AggregateOrdersOptions {
|
|
|
8445
7772
|
* @applicableIdentity APP
|
|
8446
7773
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
8447
7774
|
*/
|
|
8448
|
-
export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<BulkUpdateOrderTagsResponse
|
|
7775
|
+
export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
8449
7776
|
export interface BulkUpdateOrderTagsOptions {
|
|
8450
7777
|
/** Tags to be added to orders */
|
|
8451
7778
|
assignTags?: Tags;
|