@wix/auto_sdk_ecom_draft-orders 1.0.16 → 1.0.18
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-draft-order-draft-orders.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +21 -21
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +15 -15
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +0 -501
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +83 -502
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +21 -21
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +15 -15
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +0 -501
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +83 -502
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +21 -21
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +15 -15
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +0 -764
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +83 -765
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +21 -21
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +15 -15
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +0 -764
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +83 -765
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
|
|
2
3
|
export interface DraftOrder {
|
|
3
4
|
/**
|
|
@@ -3493,495 +3494,7 @@ export declare enum WebhookIdentityType {
|
|
|
3493
3494
|
WIX_USER = "WIX_USER",
|
|
3494
3495
|
APP = "APP"
|
|
3495
3496
|
}
|
|
3496
|
-
|
|
3497
|
-
amount: string;
|
|
3498
|
-
formattedAmount: string;
|
|
3499
|
-
}
|
|
3500
|
-
interface PriceDescriptionNonNullableFields {
|
|
3501
|
-
original: string;
|
|
3502
|
-
}
|
|
3503
|
-
interface ItemChangedDetailsNonNullableFields {
|
|
3504
|
-
priceBeforeChange?: PriceNonNullableFields;
|
|
3505
|
-
priceDescriptionBeforeChange?: PriceDescriptionNonNullableFields;
|
|
3506
|
-
}
|
|
3507
|
-
interface ProductNameNonNullableFields {
|
|
3508
|
-
original: string;
|
|
3509
|
-
}
|
|
3510
|
-
interface CatalogReferenceNonNullableFields {
|
|
3511
|
-
catalogItemId: string;
|
|
3512
|
-
appId: string;
|
|
3513
|
-
}
|
|
3514
|
-
interface PlainTextValueNonNullableFields {
|
|
3515
|
-
original: string;
|
|
3516
|
-
}
|
|
3517
|
-
interface ColorNonNullableFields {
|
|
3518
|
-
original: string;
|
|
3519
|
-
}
|
|
3520
|
-
interface DescriptionLineNameNonNullableFields {
|
|
3521
|
-
original: string;
|
|
3522
|
-
}
|
|
3523
|
-
interface DescriptionLineNonNullableFields {
|
|
3524
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
3525
|
-
colorInfo?: ColorNonNullableFields;
|
|
3526
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
3527
|
-
color: string;
|
|
3528
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
3529
|
-
lineType: DescriptionLineType;
|
|
3530
|
-
}
|
|
3531
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
3532
|
-
shippable: boolean;
|
|
3533
|
-
}
|
|
3534
|
-
interface ItemTypeNonNullableFields {
|
|
3535
|
-
preset: ItemTypeItemType;
|
|
3536
|
-
custom: string;
|
|
3537
|
-
}
|
|
3538
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
3539
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3540
|
-
taxRate: string;
|
|
3541
|
-
totalTax?: PriceNonNullableFields;
|
|
3542
|
-
}
|
|
3543
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
3544
|
-
taxAmount?: PriceNonNullableFields;
|
|
3545
|
-
jurisdictionType: JurisdictionType;
|
|
3546
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
3547
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3548
|
-
}
|
|
3549
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
3550
|
-
taxAmount?: PriceNonNullableFields;
|
|
3551
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3552
|
-
taxIncludedInPrice: boolean;
|
|
3553
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
3554
|
-
}
|
|
3555
|
-
interface DigitalFileNonNullableFields {
|
|
3556
|
-
fileId: string;
|
|
3557
|
-
}
|
|
3558
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
3559
|
-
frequency: SubscriptionFrequency;
|
|
3560
|
-
autoRenewal: boolean;
|
|
3561
|
-
}
|
|
3562
|
-
interface SubscriptionInfoNonNullableFields {
|
|
3563
|
-
cycleNumber: number;
|
|
3564
|
-
subscriptionOptionTitle: string;
|
|
3565
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
3566
|
-
}
|
|
3567
|
-
interface LocationAndQuantityNonNullableFields {
|
|
3568
|
-
_id: string;
|
|
3569
|
-
quantity: number;
|
|
3570
|
-
}
|
|
3571
|
-
interface OrderLineItemNonNullableFields {
|
|
3572
|
-
_id: string;
|
|
3573
|
-
productName?: ProductNameNonNullableFields;
|
|
3574
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3575
|
-
quantity: number;
|
|
3576
|
-
totalDiscount?: PriceNonNullableFields;
|
|
3577
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
3578
|
-
image: string;
|
|
3579
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
3580
|
-
itemType?: ItemTypeNonNullableFields;
|
|
3581
|
-
price?: PriceNonNullableFields;
|
|
3582
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
3583
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3584
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3585
|
-
paymentOption: PaymentOptionType;
|
|
3586
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3587
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
3588
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
3589
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
3590
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
3591
|
-
depositAmount?: PriceNonNullableFields;
|
|
3592
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
3593
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
3594
|
-
}
|
|
3595
|
-
interface ItemDetailsNonNullableFields {
|
|
3596
|
-
added: boolean;
|
|
3597
|
-
changedDetails?: ItemChangedDetailsNonNullableFields;
|
|
3598
|
-
removed: boolean;
|
|
3599
|
-
lineItem?: OrderLineItemNonNullableFields;
|
|
3600
|
-
}
|
|
3601
|
-
interface StreetAddressNonNullableFields {
|
|
3602
|
-
number: string;
|
|
3603
|
-
name: string;
|
|
3604
|
-
apt: string;
|
|
3605
|
-
}
|
|
3606
|
-
interface AddressNonNullableFields {
|
|
3607
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3608
|
-
}
|
|
3609
|
-
interface VatIdNonNullableFields {
|
|
3610
|
-
_id: string;
|
|
3611
|
-
type: VatType;
|
|
3612
|
-
}
|
|
3613
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
3614
|
-
vatId?: VatIdNonNullableFields;
|
|
3615
|
-
}
|
|
3616
|
-
interface AddressWithContactNonNullableFields {
|
|
3617
|
-
address?: AddressNonNullableFields;
|
|
3618
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
3619
|
-
}
|
|
3620
|
-
interface PickupAddressNonNullableFields {
|
|
3621
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3622
|
-
}
|
|
3623
|
-
interface V1PickupDetailsNonNullableFields {
|
|
3624
|
-
address?: PickupAddressNonNullableFields;
|
|
3625
|
-
pickupMethod: PickupDetailsPickupMethod;
|
|
3626
|
-
}
|
|
3627
|
-
interface V1DeliveryLogisticsNonNullableFields {
|
|
3628
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
3629
|
-
pickupDetails?: V1PickupDetailsNonNullableFields;
|
|
3630
|
-
}
|
|
3631
|
-
interface V1ShippingPriceNonNullableFields {
|
|
3632
|
-
price?: PriceNonNullableFields;
|
|
3633
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3634
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3635
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3636
|
-
discount?: PriceNonNullableFields;
|
|
3637
|
-
}
|
|
3638
|
-
interface V1ShippingInformationNonNullableFields {
|
|
3639
|
-
title: string;
|
|
3640
|
-
logistics?: V1DeliveryLogisticsNonNullableFields;
|
|
3641
|
-
cost?: V1ShippingPriceNonNullableFields;
|
|
3642
|
-
}
|
|
3643
|
-
interface ShippingChangedDetailsNonNullableFields {
|
|
3644
|
-
shippingInfoBeforeChange?: V1ShippingInformationNonNullableFields;
|
|
3645
|
-
}
|
|
3646
|
-
interface ShippingDetailsNonNullableFields {
|
|
3647
|
-
added: boolean;
|
|
3648
|
-
changedDetails?: ShippingChangedDetailsNonNullableFields;
|
|
3649
|
-
removed: boolean;
|
|
3650
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
3651
|
-
}
|
|
3652
|
-
interface BuyerInfoNonNullableFields {
|
|
3653
|
-
visitorId: string;
|
|
3654
|
-
memberId: string;
|
|
3655
|
-
}
|
|
3656
|
-
interface AdditionalFeeNonNullableFields {
|
|
3657
|
-
name: string;
|
|
3658
|
-
price?: PriceNonNullableFields;
|
|
3659
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3660
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
3661
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
3662
|
-
_id: string;
|
|
3663
|
-
lineItemIds: string[];
|
|
3664
|
-
}
|
|
3665
|
-
interface TaxDetailsNonNullableFields {
|
|
3666
|
-
taxable: boolean;
|
|
3667
|
-
}
|
|
3668
|
-
interface AdditionalFeeDetailsNonNullableFields {
|
|
3669
|
-
additionalFee?: AdditionalFeeNonNullableFields;
|
|
3670
|
-
taxDetails?: TaxDetailsNonNullableFields;
|
|
3671
|
-
source: SourceType;
|
|
3672
|
-
applied: boolean;
|
|
3673
|
-
}
|
|
3674
|
-
interface CouponNonNullableFields {
|
|
3675
|
-
_id: string;
|
|
3676
|
-
code: string;
|
|
3677
|
-
name: string;
|
|
3678
|
-
amount?: PriceNonNullableFields;
|
|
3679
|
-
}
|
|
3680
|
-
interface MerchantDiscountNonNullableFields {
|
|
3681
|
-
discountReason: DiscountReason;
|
|
3682
|
-
amount?: PriceNonNullableFields;
|
|
3683
|
-
}
|
|
3684
|
-
interface DiscountRuleNameNonNullableFields {
|
|
3685
|
-
original: string;
|
|
3686
|
-
}
|
|
3687
|
-
interface DiscountRuleNonNullableFields {
|
|
3688
|
-
_id: string;
|
|
3689
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
3690
|
-
amount?: PriceNonNullableFields;
|
|
3691
|
-
}
|
|
3692
|
-
interface AppliedDiscountNonNullableFields {
|
|
3693
|
-
coupon?: CouponNonNullableFields;
|
|
3694
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
3695
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
3696
|
-
discountType: AppliedDiscountDiscountType;
|
|
3697
|
-
lineItemIds: string[];
|
|
3698
|
-
}
|
|
3699
|
-
interface DiscountDetailsNonNullableFields {
|
|
3700
|
-
discount?: AppliedDiscountNonNullableFields;
|
|
3701
|
-
source: SourceType;
|
|
3702
|
-
applied: boolean;
|
|
3703
|
-
}
|
|
3704
|
-
interface CreatedByNonNullableFields {
|
|
3705
|
-
userId: string;
|
|
3706
|
-
appId: string;
|
|
3707
|
-
}
|
|
3708
|
-
interface PriceSummaryNonNullableFields {
|
|
3709
|
-
subtotal?: PriceNonNullableFields;
|
|
3710
|
-
shipping?: PriceNonNullableFields;
|
|
3711
|
-
tax?: PriceNonNullableFields;
|
|
3712
|
-
discount?: PriceNonNullableFields;
|
|
3713
|
-
totalPrice?: PriceNonNullableFields;
|
|
3714
|
-
total?: PriceNonNullableFields;
|
|
3715
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
3716
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
3717
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
3718
|
-
}
|
|
3719
|
-
interface TaxSummaryNonNullableFields {
|
|
3720
|
-
totalTax?: PriceNonNullableFields;
|
|
3721
|
-
}
|
|
3722
|
-
interface BalanceNonNullableFields {
|
|
3723
|
-
amount: string;
|
|
3724
|
-
formattedAmount: string;
|
|
3725
|
-
}
|
|
3726
|
-
interface BalanceSummaryNonNullableFields {
|
|
3727
|
-
balance?: BalanceNonNullableFields;
|
|
3728
|
-
paid?: PriceNonNullableFields;
|
|
3729
|
-
refunded?: PriceNonNullableFields;
|
|
3730
|
-
authorized?: PriceNonNullableFields;
|
|
3731
|
-
}
|
|
3732
|
-
interface InventoryUpdateNonNullableFields {
|
|
3733
|
-
lineItemId: string;
|
|
3734
|
-
}
|
|
3735
|
-
interface DraftOrderCommitSettingsNonNullableFields {
|
|
3736
|
-
updateInventory: InventoryUpdateNonNullableFields[];
|
|
3737
|
-
}
|
|
3738
|
-
interface RecipientInfoChangedDetailsNonNullableFields {
|
|
3739
|
-
recipientInfoBeforeChange?: AddressWithContactNonNullableFields;
|
|
3740
|
-
}
|
|
3741
|
-
interface RecipientInfoDetailsNonNullableFields {
|
|
3742
|
-
added: boolean;
|
|
3743
|
-
changedDetails?: RecipientInfoChangedDetailsNonNullableFields;
|
|
3744
|
-
removed: boolean;
|
|
3745
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3746
|
-
}
|
|
3747
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
3748
|
-
taxName: string;
|
|
3749
|
-
taxType: string;
|
|
3750
|
-
jurisdiction: string;
|
|
3751
|
-
jurisdictionType: JurisdictionType;
|
|
3752
|
-
rate: string;
|
|
3753
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
3754
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
3755
|
-
}
|
|
3756
|
-
interface OrderTaxInfoNonNullableFields {
|
|
3757
|
-
totalTax?: PriceNonNullableFields;
|
|
3758
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
3759
|
-
}
|
|
3760
|
-
interface LocationNonNullableFields {
|
|
3761
|
-
_id: string;
|
|
3762
|
-
name: string;
|
|
3763
|
-
}
|
|
3764
|
-
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3765
|
-
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3766
|
-
}
|
|
3767
|
-
interface BusinessLocationDetailsNonNullableFields {
|
|
3768
|
-
added: boolean;
|
|
3769
|
-
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3770
|
-
removed: boolean;
|
|
3771
|
-
businessLocation?: LocationNonNullableFields;
|
|
3772
|
-
}
|
|
3773
|
-
interface DraftOrderNonNullableFields {
|
|
3774
|
-
lineItems: ItemDetailsNonNullableFields[];
|
|
3775
|
-
shippingInfo?: ShippingDetailsNonNullableFields;
|
|
3776
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3777
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3778
|
-
additionalFees: AdditionalFeeDetailsNonNullableFields[];
|
|
3779
|
-
discounts: DiscountDetailsNonNullableFields[];
|
|
3780
|
-
createdBy?: CreatedByNonNullableFields;
|
|
3781
|
-
status: EditingStatus;
|
|
3782
|
-
weightUnit: WeightUnit;
|
|
3783
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
3784
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
3785
|
-
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
3786
|
-
commitSettings?: DraftOrderCommitSettingsNonNullableFields;
|
|
3787
|
-
recipientInfo?: RecipientInfoDetailsNonNullableFields;
|
|
3788
|
-
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
3789
|
-
}
|
|
3790
|
-
interface PickupDetailsNonNullableFields {
|
|
3791
|
-
address?: AddressNonNullableFields;
|
|
3792
|
-
pickupMethod: PickupMethod;
|
|
3793
|
-
}
|
|
3794
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
3795
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
3796
|
-
}
|
|
3797
|
-
interface ShippingPriceNonNullableFields {
|
|
3798
|
-
price?: PriceNonNullableFields;
|
|
3799
|
-
currency: string;
|
|
3800
|
-
}
|
|
3801
|
-
interface ShippingOptionNonNullableFields {
|
|
3802
|
-
code: string;
|
|
3803
|
-
title: string;
|
|
3804
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
3805
|
-
cost?: ShippingPriceNonNullableFields;
|
|
3806
|
-
}
|
|
3807
|
-
interface ApplicationErrorNonNullableFields {
|
|
3808
|
-
code: string;
|
|
3809
|
-
description: string;
|
|
3810
|
-
}
|
|
3811
|
-
interface FieldViolationNonNullableFields {
|
|
3812
|
-
field: string;
|
|
3813
|
-
description: string;
|
|
3814
|
-
violatedRule: RuleType;
|
|
3815
|
-
}
|
|
3816
|
-
interface ValidationErrorNonNullableFields {
|
|
3817
|
-
fieldViolations: FieldViolationNonNullableFields[];
|
|
3818
|
-
}
|
|
3819
|
-
interface DetailsNonNullableFields {
|
|
3820
|
-
applicationError?: ApplicationErrorNonNullableFields;
|
|
3821
|
-
validationError?: ValidationErrorNonNullableFields;
|
|
3822
|
-
}
|
|
3823
|
-
interface CarrierErrorNonNullableFields {
|
|
3824
|
-
carrierId: string;
|
|
3825
|
-
error?: DetailsNonNullableFields;
|
|
3826
|
-
}
|
|
3827
|
-
interface CarrierErrorsNonNullableFields {
|
|
3828
|
-
errors: CarrierErrorNonNullableFields[];
|
|
3829
|
-
}
|
|
3830
|
-
interface CalculationErrorsNonNullableFields {
|
|
3831
|
-
generalShippingCalculationError?: DetailsNonNullableFields;
|
|
3832
|
-
carrierErrors?: CarrierErrorsNonNullableFields;
|
|
3833
|
-
taxCalculationError?: DetailsNonNullableFields;
|
|
3834
|
-
orderValidationErrors: ApplicationErrorNonNullableFields[];
|
|
3835
|
-
}
|
|
3836
|
-
interface CalculatedDraftOrderNonNullableFields {
|
|
3837
|
-
draftOrder?: DraftOrderNonNullableFields;
|
|
3838
|
-
shippingOptions: ShippingOptionNonNullableFields[];
|
|
3839
|
-
calculationErrors?: CalculationErrorsNonNullableFields;
|
|
3840
|
-
}
|
|
3841
|
-
export interface CreateDraftOrderResponseNonNullableFields {
|
|
3842
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3843
|
-
}
|
|
3844
|
-
export interface CreateEmptyDraftOrderResponseNonNullableFields {
|
|
3845
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3846
|
-
}
|
|
3847
|
-
export interface AddLineItemsToDraftOrderResponseNonNullableFields {
|
|
3848
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3849
|
-
}
|
|
3850
|
-
export interface UpdateLineItemsResponseNonNullableFields {
|
|
3851
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3852
|
-
}
|
|
3853
|
-
export interface SetDiscountsResponseNonNullableFields {
|
|
3854
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3855
|
-
}
|
|
3856
|
-
export interface CreateCustomDiscountsResponseNonNullableFields {
|
|
3857
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3858
|
-
}
|
|
3859
|
-
export interface DeleteCustomDiscountsResponseNonNullableFields {
|
|
3860
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3861
|
-
}
|
|
3862
|
-
export interface SetAdditionalFeesResponseNonNullableFields {
|
|
3863
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3864
|
-
}
|
|
3865
|
-
export interface CreateCustomAdditionalFeesResponseNonNullableFields {
|
|
3866
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3867
|
-
}
|
|
3868
|
-
export interface DeleteCustomAdditionalFeesResponseNonNullableFields {
|
|
3869
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3870
|
-
}
|
|
3871
|
-
export interface SetShippingInfoResponseNonNullableFields {
|
|
3872
|
-
}
|
|
3873
|
-
export interface SetBuyerInfoResponseNonNullableFields {
|
|
3874
|
-
}
|
|
3875
|
-
export interface SetRecipientInfoResponseNonNullableFields {
|
|
3876
|
-
}
|
|
3877
|
-
export interface SetBillingInfoResponseNonNullableFields {
|
|
3878
|
-
}
|
|
3879
|
-
export interface GetDraftOrderResponseNonNullableFields {
|
|
3880
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3881
|
-
}
|
|
3882
|
-
export interface GetOrderDraftabilityStatusResponseNonNullableFields {
|
|
3883
|
-
orderId: string;
|
|
3884
|
-
orderDraftable: boolean;
|
|
3885
|
-
nonDraftableReasons: NonDraftableReason[];
|
|
3886
|
-
}
|
|
3887
|
-
interface CustomActivityNonNullableFields {
|
|
3888
|
-
appId: string;
|
|
3889
|
-
type: string;
|
|
3890
|
-
}
|
|
3891
|
-
interface MerchantCommentNonNullableFields {
|
|
3892
|
-
message: string;
|
|
3893
|
-
}
|
|
3894
|
-
interface OrderRefundedNonNullableFields {
|
|
3895
|
-
manual: boolean;
|
|
3896
|
-
amount?: PriceNonNullableFields;
|
|
3897
|
-
reason: string;
|
|
3898
|
-
}
|
|
3899
|
-
interface OrderCreatedFromExchangeNonNullableFields {
|
|
3900
|
-
originalOrderId: string;
|
|
3901
|
-
}
|
|
3902
|
-
interface LineItemExchangeDataNonNullableFields {
|
|
3903
|
-
lineItemId: string;
|
|
3904
|
-
quantity: number;
|
|
3905
|
-
}
|
|
3906
|
-
interface NewExchangeOrderCreatedNonNullableFields {
|
|
3907
|
-
exchangeOrderId: string;
|
|
3908
|
-
lineItems: LineItemExchangeDataNonNullableFields[];
|
|
3909
|
-
}
|
|
3910
|
-
interface ActivityNonNullableFields {
|
|
3911
|
-
customActivity?: CustomActivityNonNullableFields;
|
|
3912
|
-
merchantComment?: MerchantCommentNonNullableFields;
|
|
3913
|
-
orderRefunded?: OrderRefundedNonNullableFields;
|
|
3914
|
-
orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
|
|
3915
|
-
newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
|
|
3916
|
-
type: ActivityType;
|
|
3917
|
-
}
|
|
3918
|
-
interface V1CreatedByNonNullableFields {
|
|
3919
|
-
userId: string;
|
|
3920
|
-
memberId: string;
|
|
3921
|
-
visitorId: string;
|
|
3922
|
-
appId: string;
|
|
3923
|
-
}
|
|
3924
|
-
interface ChannelInfoNonNullableFields {
|
|
3925
|
-
type: ChannelType;
|
|
3926
|
-
}
|
|
3927
|
-
interface CustomFieldNonNullableFields {
|
|
3928
|
-
title: string;
|
|
3929
|
-
}
|
|
3930
|
-
interface V1BalanceSummaryNonNullableFields {
|
|
3931
|
-
balance?: BalanceNonNullableFields;
|
|
3932
|
-
paid?: PriceNonNullableFields;
|
|
3933
|
-
refunded?: PriceNonNullableFields;
|
|
3934
|
-
authorized?: PriceNonNullableFields;
|
|
3935
|
-
pending?: PriceNonNullableFields;
|
|
3936
|
-
}
|
|
3937
|
-
interface TagListNonNullableFields {
|
|
3938
|
-
tagIds: string[];
|
|
3939
|
-
}
|
|
3940
|
-
interface TagsNonNullableFields {
|
|
3941
|
-
privateTags?: TagListNonNullableFields;
|
|
3942
|
-
tags?: TagListNonNullableFields;
|
|
3943
|
-
}
|
|
3944
|
-
interface OrderNonNullableFields {
|
|
3945
|
-
number: string;
|
|
3946
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
3947
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3948
|
-
paymentStatus: PaymentStatus;
|
|
3949
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
3950
|
-
weightUnit: WeightUnit;
|
|
3951
|
-
taxIncludedInPrices: boolean;
|
|
3952
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
3953
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3954
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
3955
|
-
status: OrderStatus;
|
|
3956
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
3957
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
3958
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
3959
|
-
activities: ActivityNonNullableFields[];
|
|
3960
|
-
attributionSource: AttributionSource;
|
|
3961
|
-
createdBy?: V1CreatedByNonNullableFields;
|
|
3962
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
3963
|
-
customFields: CustomFieldNonNullableFields[];
|
|
3964
|
-
isInternalOrderCreate: boolean;
|
|
3965
|
-
payNow?: PriceSummaryNonNullableFields;
|
|
3966
|
-
balanceSummary?: V1BalanceSummaryNonNullableFields;
|
|
3967
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
3968
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3969
|
-
tags?: TagsNonNullableFields;
|
|
3970
|
-
businessLocation?: LocationNonNullableFields;
|
|
3971
|
-
}
|
|
3972
|
-
export interface CommitDraftOrderResponseNonNullableFields {
|
|
3973
|
-
committedDraftOrder?: DraftOrderNonNullableFields;
|
|
3974
|
-
orderAfterCommit?: OrderNonNullableFields;
|
|
3975
|
-
}
|
|
3976
|
-
export interface CreateOrderFromDraftResponseNonNullableFields {
|
|
3977
|
-
}
|
|
3978
|
-
export interface QueryDraftOrdersResponseNonNullableFields {
|
|
3979
|
-
draftOrders: DraftOrderNonNullableFields[];
|
|
3980
|
-
}
|
|
3981
|
-
export interface SetTaxExemptionResponseNonNullableFields {
|
|
3982
|
-
}
|
|
3983
|
-
export interface SetBusinessLocationResponseNonNullableFields {
|
|
3984
|
-
}
|
|
3497
|
+
type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `lineItems.${number}.changedDetails.priceBeforeChange.amount` | `lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `lineItems.${number}.removed` | `lineItems.${number}.lineItem._id` | `lineItems.${number}.lineItem.productName.original` | `lineItems.${number}.lineItem.catalogReference.catalogItemId` | `lineItems.${number}.lineItem.catalogReference.appId` | `lineItems.${number}.lineItem.quantity` | `lineItems.${number}.lineItem.descriptionLines` | `lineItems.${number}.lineItem.descriptionLines.${number}.plainText.original` | `lineItems.${number}.lineItem.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.lineItem.descriptionLines.${number}.name.original` | `lineItems.${number}.lineItem.physicalProperties.shippable` | `lineItems.${number}.lineItem.itemType.preset` | `lineItems.${number}.lineItem.itemType.custom` | `lineItems.${number}.lineItem.paymentOption` | `lineItems.${number}.lineItem.taxDetails.taxRate` | `lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `lineItems.${number}.lineItem.taxInfo.taxBreakdown` | `lineItems.${number}.lineItem.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.lineItem.digitalFile.fileId` | `lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.lineItem.locations` | `lineItems.${number}.lineItem.locations.${number}._id` | `lineItems.${number}.lineItem.locations.${number}.quantity` | `shippingInfo.added` | `shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.amount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.formattedAmount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.taxDetails.taxRate` | `shippingInfo.removed` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.additionalFee.name` | `additionalFees.${number}.additionalFee.price.amount` | `additionalFees.${number}.additionalFee.price.formattedAmount` | `additionalFees.${number}.additionalFee.taxDetails.taxRate` | `additionalFees.${number}.additionalFee._id` | `additionalFees.${number}.additionalFee.lineItemIds` | `additionalFees.${number}.taxDetails.taxable` | `additionalFees.${number}.source` | `additionalFees.${number}.applied` | `discounts` | `discounts.${number}.discount.coupon._id` | `discounts.${number}.discount.coupon.code` | `discounts.${number}.discount.coupon.name` | `discounts.${number}.discount.coupon.amount.amount` | `discounts.${number}.discount.coupon.amount.formattedAmount` | `discounts.${number}.discount.merchantDiscount.discountReason` | `discounts.${number}.discount.discountRule._id` | `discounts.${number}.discount.discountRule.name.original` | `discounts.${number}.discount.discountType` | `discounts.${number}.discount.lineItemIds` | `discounts.${number}.source` | `discounts.${number}.applied` | `createdBy.userId` | `createdBy.appId` | `status` | `weightUnit` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.authorized.amount` | `balanceSummary.authorized.formattedAmount` | `commitSettings.updateInventory` | `commitSettings.updateInventory.${number}.lineItemId` | `recipientInfo.added` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.number` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.name` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId._id` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId.type` | `recipientInfo.removed` | `businessLocationDetails.added` | `businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `businessLocationDetails.removed`;
|
|
3985
3498
|
/**
|
|
3986
3499
|
* Creates or gets a draft order.
|
|
3987
3500
|
*
|
|
@@ -4000,10 +3513,14 @@ export interface SetBusinessLocationResponseNonNullableFields {
|
|
|
4000
3513
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4001
3514
|
* @permissionScope Manage eCommerce - all permissions
|
|
4002
3515
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3516
|
+
* @permissionScope Picasso private app mega scope
|
|
3517
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4003
3518
|
* @applicableIdentity APP
|
|
4004
3519
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
|
|
4005
3520
|
*/
|
|
4006
|
-
export declare function createDraftOrder(orderId: string
|
|
3521
|
+
export declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<CreateDraftOrderResponse, {
|
|
3522
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3523
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4007
3524
|
/**
|
|
4008
3525
|
* Creates an empty draft order.
|
|
4009
3526
|
* @public
|
|
@@ -4017,10 +3534,14 @@ export declare function createDraftOrder(orderId: string | null): Promise<Create
|
|
|
4017
3534
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4018
3535
|
* @permissionScope Manage eCommerce - all permissions
|
|
4019
3536
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3537
|
+
* @permissionScope Picasso private app mega scope
|
|
3538
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4020
3539
|
* @applicableIdentity APP
|
|
4021
3540
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
|
|
4022
3541
|
*/
|
|
4023
|
-
export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderResponse
|
|
3542
|
+
export declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDraftOrderResponse, {
|
|
3543
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3544
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4024
3545
|
/**
|
|
4025
3546
|
* Adds line items to a draft order.
|
|
4026
3547
|
* @param draftOrderId - The draft order id
|
|
@@ -4035,10 +3556,14 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
|
|
|
4035
3556
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4036
3557
|
* @permissionScope Manage eCommerce - all permissions
|
|
4037
3558
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3559
|
+
* @permissionScope Picasso private app mega scope
|
|
3560
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4038
3561
|
* @applicableIdentity APP
|
|
4039
3562
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
|
|
4040
3563
|
*/
|
|
4041
|
-
export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse
|
|
3564
|
+
export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: NonNullablePaths<AddLineItemsToDraftOrderOptions, `catalogLineItems.${number}.catalogReference`>): Promise<NonNullablePaths<AddLineItemsToDraftOrderResponse, {
|
|
3565
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3566
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4042
3567
|
export interface AddLineItemsToDraftOrderOptions {
|
|
4043
3568
|
/**
|
|
4044
3569
|
* Catalog line items to add to draft order.
|
|
@@ -4070,10 +3595,14 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
4070
3595
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4071
3596
|
* @permissionScope Manage eCommerce - all permissions
|
|
4072
3597
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3598
|
+
* @permissionScope Picasso private app mega scope
|
|
3599
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4073
3600
|
* @applicableIdentity APP
|
|
4074
3601
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
4075
3602
|
*/
|
|
4076
|
-
export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse
|
|
3603
|
+
export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<NonNullablePaths<UpdateLineItemsResponse, {
|
|
3604
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3605
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4077
3606
|
export interface UpdateLineItemsOptions {
|
|
4078
3607
|
/**
|
|
4079
3608
|
* Details of changes to apply per line item
|
|
@@ -4099,10 +3628,14 @@ export interface UpdateLineItemsOptions {
|
|
|
4099
3628
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4100
3629
|
* @permissionScope Manage eCommerce - all permissions
|
|
4101
3630
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3631
|
+
* @permissionScope Picasso private app mega scope
|
|
3632
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4102
3633
|
* @applicableIdentity APP
|
|
4103
3634
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
|
|
4104
3635
|
*/
|
|
4105
|
-
export declare function setDiscounts(draftOrderId: string, discounts: IdAndApplied[]): Promise<SetDiscountsResponse
|
|
3636
|
+
export declare function setDiscounts(draftOrderId: string, discounts: IdAndApplied[]): Promise<NonNullablePaths<SetDiscountsResponse, {
|
|
3637
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3638
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4106
3639
|
/**
|
|
4107
3640
|
* Adds merchant discounts to the order.
|
|
4108
3641
|
* @param draftOrderId - The draft order id
|
|
@@ -4119,10 +3652,14 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
4119
3652
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4120
3653
|
* @permissionScope Manage eCommerce - all permissions
|
|
4121
3654
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3655
|
+
* @permissionScope Picasso private app mega scope
|
|
3656
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4122
3657
|
* @applicableIdentity APP
|
|
4123
3658
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
|
|
4124
3659
|
*/
|
|
4125
|
-
export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse
|
|
3660
|
+
export declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount` | `discounts.${number}.amount.amount` | `discounts.${number}.discountType`>): Promise<NonNullablePaths<CreateCustomDiscountsResponse, {
|
|
3661
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3662
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4126
3663
|
export interface CreateCustomDiscountsOptions {
|
|
4127
3664
|
/**
|
|
4128
3665
|
* The discounts to add.
|
|
@@ -4146,10 +3683,14 @@ export interface CreateCustomDiscountsOptions {
|
|
|
4146
3683
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4147
3684
|
* @permissionScope Manage eCommerce - all permissions
|
|
4148
3685
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3686
|
+
* @permissionScope Picasso private app mega scope
|
|
3687
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4149
3688
|
* @applicableIdentity APP
|
|
4150
3689
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
|
|
4151
3690
|
*/
|
|
4152
|
-
export declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<DeleteCustomDiscountsResponse
|
|
3691
|
+
export declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<NonNullablePaths<DeleteCustomDiscountsResponse, {
|
|
3692
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3693
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4153
3694
|
/**
|
|
4154
3695
|
* Set which additional fees existing on the draft order are to be opt-in.
|
|
4155
3696
|
* All existing additional fees not provided on the call are opted-out.
|
|
@@ -4166,10 +3707,14 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
4166
3707
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4167
3708
|
* @permissionScope Manage eCommerce - all permissions
|
|
4168
3709
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3710
|
+
* @permissionScope Picasso private app mega scope
|
|
3711
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4169
3712
|
* @applicableIdentity APP
|
|
4170
3713
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
|
|
4171
3714
|
*/
|
|
4172
|
-
export declare function setAdditionalFees(draftOrderId: string, additionalFees: IdAndApplied[]): Promise<SetAdditionalFeesResponse
|
|
3715
|
+
export declare function setAdditionalFees(draftOrderId: string, additionalFees: IdAndApplied[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
|
|
3716
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3717
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4173
3718
|
/**
|
|
4174
3719
|
* Create custom additional fees to the order.
|
|
4175
3720
|
* added additional fees are by default opted-out.
|
|
@@ -4188,10 +3733,14 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4188
3733
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4189
3734
|
* @permissionScope Manage eCommerce - all permissions
|
|
4190
3735
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3736
|
+
* @permissionScope Picasso private app mega scope
|
|
3737
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4191
3738
|
* @applicableIdentity APP
|
|
4192
3739
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
|
|
4193
3740
|
*/
|
|
4194
|
-
export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse
|
|
3741
|
+
export declare function createCustomAdditionalFees(draftOrderId: string, options?: NonNullablePaths<CreateCustomAdditionalFeesOptions, `customAdditionalFees.${number}.name` | `customAdditionalFees.${number}.price` | `customAdditionalFees.${number}.price.amount`>): Promise<NonNullablePaths<CreateCustomAdditionalFeesResponse, {
|
|
3742
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3743
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4195
3744
|
export interface CreateCustomAdditionalFeesOptions {
|
|
4196
3745
|
/**
|
|
4197
3746
|
* The additional fees to add. added with opted-out setting
|
|
@@ -4215,10 +3764,14 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
4215
3764
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4216
3765
|
* @permissionScope Manage eCommerce - all permissions
|
|
4217
3766
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3767
|
+
* @permissionScope Picasso private app mega scope
|
|
3768
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4218
3769
|
* @applicableIdentity APP
|
|
4219
3770
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
|
|
4220
3771
|
*/
|
|
4221
|
-
export declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<DeleteCustomAdditionalFeesResponse
|
|
3772
|
+
export declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<NonNullablePaths<DeleteCustomAdditionalFeesResponse, {
|
|
3773
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3774
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4222
3775
|
/**
|
|
4223
3776
|
* Sets shipping info to a draft order.
|
|
4224
3777
|
* @public
|
|
@@ -4230,6 +3783,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
4230
3783
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4231
3784
|
* @permissionScope Manage eCommerce - all permissions
|
|
4232
3785
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3786
|
+
* @permissionScope Picasso private app mega scope
|
|
3787
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4233
3788
|
* @applicableIdentity APP
|
|
4234
3789
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
|
|
4235
3790
|
*/
|
|
@@ -4245,6 +3800,8 @@ export declare function setShippingInfo(): Promise<void>;
|
|
|
4245
3800
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4246
3801
|
* @permissionScope Manage eCommerce - all permissions
|
|
4247
3802
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3803
|
+
* @permissionScope Picasso private app mega scope
|
|
3804
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4248
3805
|
* @applicableIdentity APP
|
|
4249
3806
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
|
|
4250
3807
|
*/
|
|
@@ -4260,6 +3817,8 @@ export declare function setBuyerInfo(): Promise<void>;
|
|
|
4260
3817
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4261
3818
|
* @permissionScope Manage eCommerce - all permissions
|
|
4262
3819
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3820
|
+
* @permissionScope Picasso private app mega scope
|
|
3821
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4263
3822
|
* @applicableIdentity APP
|
|
4264
3823
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
|
|
4265
3824
|
*/
|
|
@@ -4275,6 +3834,8 @@ export declare function setRecipientInfo(): Promise<void>;
|
|
|
4275
3834
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4276
3835
|
* @permissionScope Manage eCommerce - all permissions
|
|
4277
3836
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3837
|
+
* @permissionScope Picasso private app mega scope
|
|
3838
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4278
3839
|
* @applicableIdentity APP
|
|
4279
3840
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
|
|
4280
3841
|
*/
|
|
@@ -4297,10 +3858,14 @@ export declare function setBillingInfo(): Promise<void>;
|
|
|
4297
3858
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4298
3859
|
* @permissionScope Manage eCommerce - all permissions
|
|
4299
3860
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3861
|
+
* @permissionScope Picasso private app mega scope
|
|
3862
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4300
3863
|
* @applicableIdentity APP
|
|
4301
3864
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
|
|
4302
3865
|
*/
|
|
4303
|
-
export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrderResponse
|
|
3866
|
+
export declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<GetDraftOrderResponse, {
|
|
3867
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3868
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4304
3869
|
/**
|
|
4305
3870
|
* Checks whether a draft can be created for this order
|
|
4306
3871
|
* @param orderId - Order ID.
|
|
@@ -4314,10 +3879,12 @@ export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrd
|
|
|
4314
3879
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4315
3880
|
* @permissionScope Manage eCommerce - all permissions
|
|
4316
3881
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3882
|
+
* @permissionScope Picasso private app mega scope
|
|
3883
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4317
3884
|
* @applicableIdentity APP
|
|
4318
3885
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
|
|
4319
3886
|
*/
|
|
4320
|
-
export declare function getOrderDraftabilityStatus(orderId: string): Promise<GetOrderDraftabilityStatusResponse
|
|
3887
|
+
export declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullablePaths<GetOrderDraftabilityStatusResponse, `orderId` | `orderDraftable` | `nonDraftableReasons`>>;
|
|
4321
3888
|
/**
|
|
4322
3889
|
* Commit latest changes to the baseline order and control what side-effects will be applied.
|
|
4323
3890
|
* Commit cannot be undone or reverted.
|
|
@@ -4334,10 +3901,14 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Get
|
|
|
4334
3901
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4335
3902
|
* @permissionScope Manage eCommerce - all permissions
|
|
4336
3903
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3904
|
+
* @permissionScope Picasso private app mega scope
|
|
3905
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4337
3906
|
* @applicableIdentity APP
|
|
4338
3907
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
|
|
4339
3908
|
*/
|
|
4340
|
-
export declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<CommitDraftOrderResponse
|
|
3909
|
+
export declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<NonNullablePaths<CommitDraftOrderResponse, {
|
|
3910
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
3911
|
+
}[DraftOrderNonNullablePaths] | `orderAfterCommit.number` | `orderAfterCommit.lineItems` | `orderAfterCommit.lineItems.${number}._id` | `orderAfterCommit.lineItems.${number}.productName.original` | `orderAfterCommit.lineItems.${number}.catalogReference.catalogItemId` | `orderAfterCommit.lineItems.${number}.catalogReference.appId` | `orderAfterCommit.lineItems.${number}.quantity` | `orderAfterCommit.lineItems.${number}.totalDiscount.amount` | `orderAfterCommit.lineItems.${number}.totalDiscount.formattedAmount` | `orderAfterCommit.lineItems.${number}.descriptionLines` | `orderAfterCommit.lineItems.${number}.descriptionLines.${number}.plainText.original` | `orderAfterCommit.lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `orderAfterCommit.lineItems.${number}.descriptionLines.${number}.name.original` | `orderAfterCommit.lineItems.${number}.physicalProperties.shippable` | `orderAfterCommit.lineItems.${number}.itemType.preset` | `orderAfterCommit.lineItems.${number}.itemType.custom` | `orderAfterCommit.lineItems.${number}.paymentOption` | `orderAfterCommit.lineItems.${number}.taxDetails.taxRate` | `orderAfterCommit.lineItems.${number}.taxInfo.taxIncludedInPrice` | `orderAfterCommit.lineItems.${number}.taxInfo.taxBreakdown` | `orderAfterCommit.lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `orderAfterCommit.lineItems.${number}.digitalFile.fileId` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.cycleNumber` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `orderAfterCommit.lineItems.${number}.priceDescription.original` | `orderAfterCommit.lineItems.${number}.locations` | `orderAfterCommit.lineItems.${number}.locations.${number}._id` | `orderAfterCommit.lineItems.${number}.locations.${number}.quantity` | `orderAfterCommit.buyerInfo.visitorId` | `orderAfterCommit.buyerInfo.memberId` | `orderAfterCommit.paymentStatus` | `orderAfterCommit.fulfillmentStatus` | `orderAfterCommit.weightUnit` | `orderAfterCommit.taxIncludedInPrices` | `orderAfterCommit.billingInfo.address.streetAddress.number` | `orderAfterCommit.billingInfo.address.streetAddress.name` | `orderAfterCommit.billingInfo.contactDetails.vatId._id` | `orderAfterCommit.billingInfo.contactDetails.vatId.type` | `orderAfterCommit.shippingInfo.title` | `orderAfterCommit.shippingInfo.logistics.pickupDetails.pickupMethod` | `orderAfterCommit.status` | `orderAfterCommit.taxInfo.taxBreakdown` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxName` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdiction` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdictionType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.rate` | `orderAfterCommit.appliedDiscounts` | `orderAfterCommit.appliedDiscounts.${number}.coupon._id` | `orderAfterCommit.appliedDiscounts.${number}.coupon.code` | `orderAfterCommit.appliedDiscounts.${number}.coupon.name` | `orderAfterCommit.appliedDiscounts.${number}.merchantDiscount.discountReason` | `orderAfterCommit.appliedDiscounts.${number}.discountRule._id` | `orderAfterCommit.appliedDiscounts.${number}.discountRule.name.original` | `orderAfterCommit.appliedDiscounts.${number}.discountType` | `orderAfterCommit.appliedDiscounts.${number}.lineItemIds` | `orderAfterCommit.activities` | `orderAfterCommit.activities.${number}.customActivity.appId` | `orderAfterCommit.activities.${number}.customActivity.type` | `orderAfterCommit.activities.${number}.merchantComment.message` | `orderAfterCommit.activities.${number}.orderRefunded.manual` | `orderAfterCommit.activities.${number}.orderRefunded.reason` | `orderAfterCommit.activities.${number}.type` | `orderAfterCommit.attributionSource` | `orderAfterCommit.createdBy.userId` | `orderAfterCommit.createdBy.memberId` | `orderAfterCommit.createdBy.visitorId` | `orderAfterCommit.createdBy.appId` | `orderAfterCommit.channelInfo.type` | `orderAfterCommit.customFields` | `orderAfterCommit.customFields.${number}.title` | `orderAfterCommit.balanceSummary.balance.amount` | `orderAfterCommit.balanceSummary.balance.formattedAmount` | `orderAfterCommit.additionalFees` | `orderAfterCommit.additionalFees.${number}.name` | `orderAfterCommit.additionalFees.${number}._id` | `orderAfterCommit.additionalFees.${number}.lineItemIds` | `orderAfterCommit.tags.privateTags.tagIds` | `orderAfterCommit.businessLocation._id` | `orderAfterCommit.businessLocation.name`>>;
|
|
4341
3912
|
export interface CommitDraftOrderOptions {
|
|
4342
3913
|
/** Optional side effects to trigger */
|
|
4343
3914
|
commitSettings?: DraftOrderCommitSettings;
|
|
@@ -4361,6 +3932,8 @@ export interface CommitDraftOrderOptions {
|
|
|
4361
3932
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4362
3933
|
* @permissionScope Manage eCommerce - all permissions
|
|
4363
3934
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3935
|
+
* @permissionScope Picasso private app mega scope
|
|
3936
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4364
3937
|
* @applicableIdentity APP
|
|
4365
3938
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
|
|
4366
3939
|
*/
|
|
@@ -4380,6 +3953,8 @@ export declare function createOrderFromDraft(): Promise<void>;
|
|
|
4380
3953
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4381
3954
|
* @permissionScope Manage eCommerce - all permissions
|
|
4382
3955
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3956
|
+
* @permissionScope Picasso private app mega scope
|
|
3957
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4383
3958
|
* @applicableIdentity APP
|
|
4384
3959
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
|
|
4385
3960
|
*/
|
|
@@ -4403,6 +3978,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
|
|
|
4403
3978
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4404
3979
|
* @permissionScope Manage eCommerce - all permissions
|
|
4405
3980
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3981
|
+
* @permissionScope Picasso private app mega scope
|
|
3982
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4406
3983
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4407
3984
|
* @applicableIdentity APP
|
|
4408
3985
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
@@ -4496,6 +4073,8 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4496
4073
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4497
4074
|
* @permissionScope Manage eCommerce - all permissions
|
|
4498
4075
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4076
|
+
* @permissionScope Picasso private app mega scope
|
|
4077
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4499
4078
|
* @applicableIdentity APP
|
|
4500
4079
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
|
|
4501
4080
|
*/
|
|
@@ -4511,6 +4090,8 @@ export declare function setTaxExemption(): Promise<void>;
|
|
|
4511
4090
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4512
4091
|
* @permissionScope Manage eCommerce - all permissions
|
|
4513
4092
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4093
|
+
* @permissionScope Picasso private app mega scope
|
|
4094
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
4514
4095
|
* @applicableIdentity APP
|
|
4515
4096
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
|
|
4516
4097
|
*/
|