@wix/auto_sdk_ecom_draft-orders 1.0.40 → 1.0.41

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.
Files changed (29) hide show
  1. package/build/cjs/index.d.ts +65 -23
  2. package/build/cjs/index.js +1 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/{ecom-v1-draft-order-draft-orders.universal-BVXrKSFI.d.ts → index.typings.d.ts} +713 -1
  5. package/build/cjs/index.typings.js +4958 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +2 -1
  8. package/build/es/index.d.mts +65 -23
  9. package/build/es/index.mjs +1 -0
  10. package/build/es/index.mjs.map +1 -1
  11. package/build/es/{ecom-v1-draft-order-draft-orders.universal-BVXrKSFI.d.mts → index.typings.d.mts} +713 -1
  12. package/build/es/index.typings.mjs +4884 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/es/meta.d.mts +2 -1
  15. package/build/internal/cjs/index.d.ts +65 -23
  16. package/build/internal/cjs/index.js +1 -0
  17. package/build/internal/cjs/index.js.map +1 -1
  18. package/build/internal/cjs/{ecom-v1-draft-order-draft-orders.universal-DfcxUgXs.d.ts → index.typings.d.ts} +713 -1
  19. package/build/internal/cjs/index.typings.js +4958 -0
  20. package/build/internal/cjs/index.typings.js.map +1 -0
  21. package/build/internal/cjs/meta.d.ts +2 -1
  22. package/build/internal/es/index.d.mts +65 -23
  23. package/build/internal/es/index.mjs +1 -0
  24. package/build/internal/es/index.mjs.map +1 -1
  25. package/build/internal/es/{ecom-v1-draft-order-draft-orders.universal-DfcxUgXs.d.mts → index.typings.d.mts} +713 -1
  26. package/build/internal/es/index.typings.mjs +4884 -0
  27. package/build/internal/es/index.typings.mjs.map +1 -0
  28. package/build/internal/es/meta.d.mts +2 -1
  29. package/package.json +2 -2
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  /**
2
4
  * Draft Order main entity.
3
5
  * A temporary version of an order, allowing modifications before finalization.
@@ -433,6 +435,8 @@ declare enum DescriptionLineType {
433
435
  /** Color type. */
434
436
  COLOR = "COLOR"
435
437
  }
438
+ /** @enumType */
439
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
436
440
  interface FocalPoint {
437
441
  /** X-coordinate of the focal point. */
438
442
  x?: number;
@@ -3855,6 +3859,235 @@ declare enum WebhookIdentityType {
3855
3859
  }
3856
3860
  /** @enumType */
3857
3861
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3862
+ type CreateDraftOrderApplicationErrors = {
3863
+ code?: 'ORDER_CANNOT_BE_EDITED';
3864
+ description?: string;
3865
+ data?: Record<string, any>;
3866
+ } | {
3867
+ code?: 'ORDER_IS_ALREADY_EDITED';
3868
+ description?: string;
3869
+ data?: Record<string, any>;
3870
+ } | {
3871
+ code?: 'FAILED_TO_FETCH_SETTINGS';
3872
+ description?: string;
3873
+ data?: Record<string, any>;
3874
+ } | {
3875
+ code?: 'NOT_AUTHORIZED_TO_READ_DRAFT_ORDERS';
3876
+ description?: string;
3877
+ data?: Record<string, any>;
3878
+ };
3879
+ type CreateEmptyDraftOrderApplicationErrors = {
3880
+ code?: 'FAILED_TO_FETCH_SETTINGS';
3881
+ description?: string;
3882
+ data?: Record<string, any>;
3883
+ };
3884
+ type AddLineItemsToDraftOrderApplicationErrors = {
3885
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
3886
+ description?: string;
3887
+ data?: Record<string, any>;
3888
+ } | {
3889
+ code?: 'MAX_ITEMS_REACHED';
3890
+ description?: string;
3891
+ data?: Record<string, any>;
3892
+ } | {
3893
+ code?: 'MULTIPLE_ADDS_FOR_SAME_LINE_ITEM';
3894
+ description?: string;
3895
+ data?: Record<string, any>;
3896
+ } | {
3897
+ code?: 'CATALOG_ITEM_NOT_AVAILABLE';
3898
+ description?: string;
3899
+ data?: Record<string, any>;
3900
+ } | {
3901
+ code?: 'CATALOG_ITEM_NOT_FOUND';
3902
+ description?: string;
3903
+ data?: Record<string, any>;
3904
+ } | {
3905
+ code?: 'CATALOG_ITEM_PAYMENT_OPTION_UNSUPPORTED';
3906
+ description?: string;
3907
+ data?: Record<string, any>;
3908
+ } | {
3909
+ code?: 'CATALOG_ITEM_ALREADY_EXIST';
3910
+ description?: string;
3911
+ data?: Record<string, any>;
3912
+ } | {
3913
+ code?: 'GIFT_CARD_ITEM_UNSUPPORTED';
3914
+ description?: string;
3915
+ data?: Record<string, any>;
3916
+ } | {
3917
+ code?: 'SUBSCRIPTION_ITEM_UNSUPPORTED';
3918
+ description?: string;
3919
+ data?: Record<string, any>;
3920
+ };
3921
+ type UpdateLineItemsApplicationErrors = {
3922
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
3923
+ description?: string;
3924
+ data?: Record<string, any>;
3925
+ } | {
3926
+ code?: 'LINE_ITEM_DOES_NOT_EXIST';
3927
+ description?: string;
3928
+ data?: Record<string, any>;
3929
+ } | {
3930
+ code?: 'MULTIPLE_CHANGES_FOR_SAME_LINE_ITEM';
3931
+ description?: string;
3932
+ data?: Record<string, any>;
3933
+ } | {
3934
+ code?: 'EMPTY_CHANGE_REQUEST';
3935
+ description?: string;
3936
+ data?: Record<string, any>;
3937
+ } | {
3938
+ code?: 'UPDATING_PRICE_OF_REMOVED_ITEM_IS_FORBIDDEN';
3939
+ description?: string;
3940
+ data?: Record<string, any>;
3941
+ } | {
3942
+ code?: 'UPDATING_LINE_ITEM_WITH_LOCATIONS';
3943
+ description?: string;
3944
+ data?: Record<string, any>;
3945
+ };
3946
+ type SetDiscountsApplicationErrors = {
3947
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
3948
+ description?: string;
3949
+ data?: Record<string, any>;
3950
+ } | {
3951
+ code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
3952
+ description?: string;
3953
+ data?: Record<string, any>;
3954
+ } | {
3955
+ code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
3956
+ description?: string;
3957
+ data?: Record<string, any>;
3958
+ };
3959
+ type CreateCustomDiscountsApplicationErrors = {
3960
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
3961
+ description?: string;
3962
+ data?: Record<string, any>;
3963
+ } | {
3964
+ code?: 'DISCOUNT_NOT_FOUND';
3965
+ description?: string;
3966
+ data?: Record<string, any>;
3967
+ } | {
3968
+ code?: 'DISCOUNTS_AMOUNT_EXCEED_ORDER_TOTALS';
3969
+ description?: string;
3970
+ data?: Record<string, any>;
3971
+ } | {
3972
+ code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
3973
+ description?: string;
3974
+ data?: Record<string, any>;
3975
+ } | {
3976
+ code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
3977
+ description?: string;
3978
+ data?: Record<string, any>;
3979
+ };
3980
+ type DeleteCustomDiscountsApplicationErrors = {
3981
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
3982
+ description?: string;
3983
+ data?: Record<string, any>;
3984
+ } | {
3985
+ code?: 'DISCOUNT_NOT_FOUND';
3986
+ description?: string;
3987
+ data?: Record<string, any>;
3988
+ } | {
3989
+ code?: 'DISCOUNT_REMOVE_NOT_SUPPORTED';
3990
+ description?: string;
3991
+ data?: Record<string, any>;
3992
+ };
3993
+ type SetAdditionalFeesApplicationErrors = {
3994
+ code?: 'ADDITIONAL_FEE_NOT_FOUND';
3995
+ description?: string;
3996
+ data?: Record<string, any>;
3997
+ };
3998
+ type CreateCustomAdditionalFeesApplicationErrors = {
3999
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4000
+ description?: string;
4001
+ data?: Record<string, any>;
4002
+ } | {
4003
+ code?: 'LINE_ITEM_NOT_FOUND';
4004
+ description?: string;
4005
+ data?: Record<string, any>;
4006
+ };
4007
+ type DeleteCustomAdditionalFeesApplicationErrors = {
4008
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4009
+ description?: string;
4010
+ data?: Record<string, any>;
4011
+ } | {
4012
+ code?: 'ADDITIONAL_FEE_NOT_FOUND';
4013
+ description?: string;
4014
+ data?: Record<string, any>;
4015
+ } | {
4016
+ code?: 'ADDITIONAL_FEE_REMOVE_NOT_SUPPORTED';
4017
+ description?: string;
4018
+ data?: Record<string, any>;
4019
+ };
4020
+ type SetShippingInfoApplicationErrors = {
4021
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4022
+ description?: string;
4023
+ data?: Record<string, any>;
4024
+ };
4025
+ type SetBuyerInfoApplicationErrors = {
4026
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4027
+ description?: string;
4028
+ data?: Record<string, any>;
4029
+ };
4030
+ type SetRecipientInfoApplicationErrors = {
4031
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4032
+ description?: string;
4033
+ data?: Record<string, any>;
4034
+ };
4035
+ type SetBillingInfoApplicationErrors = {
4036
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4037
+ description?: string;
4038
+ data?: Record<string, any>;
4039
+ };
4040
+ type GetDraftOrderApplicationErrors = {
4041
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4042
+ description?: string;
4043
+ data?: Record<string, any>;
4044
+ };
4045
+ type CommitDraftOrderApplicationErrors = {
4046
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4047
+ description?: string;
4048
+ data?: Record<string, any>;
4049
+ } | {
4050
+ code?: 'DRAFT_ORDER_COMMIT_FAILED_VALIDATIONS';
4051
+ description?: string;
4052
+ data?: Record<string, any>;
4053
+ };
4054
+ type CreateOrderFromDraftApplicationErrors = {
4055
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4056
+ description?: string;
4057
+ data?: Record<string, any>;
4058
+ } | {
4059
+ code?: 'CREATE_ORDER_FAILED_VALIDATIONS';
4060
+ description?: string;
4061
+ data?: Record<string, any>;
4062
+ };
4063
+ type DeleteDraftOrderApplicationErrors = {
4064
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4065
+ description?: string;
4066
+ data?: Record<string, any>;
4067
+ } | {
4068
+ code?: 'DRAFT_ORDER_CANNOT_BE_DELETED';
4069
+ description?: string;
4070
+ data?: Record<string, any>;
4071
+ };
4072
+ type UpdateExtendedFieldsApplicationErrors = {
4073
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4074
+ description?: string;
4075
+ data?: Record<string, any>;
4076
+ };
4077
+ type SetTaxExemptionApplicationErrors = {
4078
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4079
+ description?: string;
4080
+ data?: Record<string, any>;
4081
+ };
4082
+ type SetBusinessLocationApplicationErrors = {
4083
+ code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
4084
+ description?: string;
4085
+ data?: Record<string, any>;
4086
+ } | {
4087
+ code?: 'BUSINESS_LOCATION_CANNOT_BE_EDITED';
4088
+ description?: string;
4089
+ data?: Record<string, any>;
4090
+ };
3858
4091
  interface BaseEventMetadata {
3859
4092
  /**
3860
4093
  * App instance ID.
@@ -3903,13 +4136,118 @@ interface DraftOrderCreatedEnvelope {
3903
4136
  entity: DraftOrder;
3904
4137
  metadata: EventMetadata;
3905
4138
  }
4139
+ /**
4140
+ * Triggered when a draft order is created.
4141
+ * @permissionScope Manage Stores - all permissions
4142
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4143
+ * @permissionScope Manage Stores
4144
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4145
+ * @permissionScope Manage Restaurants - all permissions
4146
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4147
+ * @permissionScope Manage eCommerce - all permissions
4148
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4149
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4150
+ * @webhook
4151
+ * @eventType wix.ecom.v1.draft_order_created
4152
+ * @slug created
4153
+ * @documentationMaturity preview
4154
+ */
4155
+ declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
3906
4156
  interface DraftOrderDeletedEnvelope {
3907
4157
  metadata: EventMetadata;
3908
4158
  }
4159
+ /**
4160
+ * Triggered when a draft order is deleted.
4161
+ * @permissionScope Manage Stores - all permissions
4162
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4163
+ * @permissionScope Manage Stores
4164
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4165
+ * @permissionScope Manage Restaurants - all permissions
4166
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4167
+ * @permissionScope Manage eCommerce - all permissions
4168
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4169
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4170
+ * @webhook
4171
+ * @eventType wix.ecom.v1.draft_order_deleted
4172
+ * @slug deleted
4173
+ * @documentationMaturity preview
4174
+ */
4175
+ declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
3909
4176
  interface DraftOrderUpdatedEnvelope {
3910
4177
  entity: DraftOrder;
3911
4178
  metadata: EventMetadata;
3912
4179
  }
4180
+ /**
4181
+ * Triggered when a draft order is updated.
4182
+ * @permissionScope Manage Stores - all permissions
4183
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4184
+ * @permissionScope Manage Stores
4185
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4186
+ * @permissionScope Manage Restaurants - all permissions
4187
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4188
+ * @permissionScope Manage eCommerce - all permissions
4189
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4190
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4191
+ * @webhook
4192
+ * @eventType wix.ecom.v1.draft_order_updated
4193
+ * @slug updated
4194
+ * @documentationMaturity preview
4195
+ */
4196
+ declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
4197
+ 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.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.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.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.lineItem.taxableAddress.addressType` | `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}.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}.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.paid.amount` | `balanceSummary.paid.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` | `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` | `buyerDetails.added` | `buyerDetails.changedDetails.buyerInfoBeforeChange.visitorId` | `buyerDetails.changedDetails.buyerInfoBeforeChange.memberId` | `buyerDetails.removed` | `billingDetails.added` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.number` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.name` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId._id` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId.type` | `billingDetails.removed` | `businessLocationDetails.added` | `businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `businessLocationDetails.removed`;
4198
+ /**
4199
+ * Creates or retrieves a draft order based on the specified order ID.
4200
+ *
4201
+ * When passing the ID of an order that is already in draft, the existing draft order is returned.
4202
+ * To complete a draft and update the original order, call Commit Draft Order.
4203
+ * @param orderId - ID of the order to create a draft for.
4204
+ * @public
4205
+ * @documentationMaturity preview
4206
+ * @requiredField orderId
4207
+ * @permissionId ECOM.DRAFT_ORDERS_CREATE
4208
+ * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4209
+ * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
4210
+ * @applicableIdentity APP
4211
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
4212
+ */
4213
+ declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<CreateDraftOrderResponse, {
4214
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4215
+ }[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`> & {
4216
+ __applicationErrorsType?: CreateDraftOrderApplicationErrors;
4217
+ }>;
4218
+ /**
4219
+ * Creates an empty draft order.
4220
+ *
4221
+ * After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
4222
+ * @public
4223
+ * @documentationMaturity preview
4224
+ * @permissionId ECOM.DRAFT_ORDERS_CREATE
4225
+ * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4226
+ * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
4227
+ * @applicableIdentity APP
4228
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
4229
+ */
4230
+ declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDraftOrderResponse, {
4231
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4232
+ }[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`> & {
4233
+ __applicationErrorsType?: CreateEmptyDraftOrderApplicationErrors;
4234
+ }>;
4235
+ /**
4236
+ * Adds catalog or custom line items to a draft order.
4237
+ * @param draftOrderId - Draft order ID.
4238
+ * @public
4239
+ * @documentationMaturity preview
4240
+ * @requiredField draftOrderId
4241
+ * @requiredField options.catalogLineItems.catalogReference
4242
+ * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
4243
+ * @applicableIdentity APP
4244
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
4245
+ */
4246
+ declare function addLineItemsToDraftOrder(draftOrderId: string, options?: NonNullablePaths<AddLineItemsToDraftOrderOptions, `catalogLineItems.${number}.catalogReference`>): Promise<NonNullablePaths<AddLineItemsToDraftOrderResponse, {
4247
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4248
+ }[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`> & {
4249
+ __applicationErrorsType?: AddLineItemsToDraftOrderApplicationErrors;
4250
+ }>;
3913
4251
  interface AddLineItemsToDraftOrderOptions {
3914
4252
  /**
3915
4253
  * Catalog line items to add to draft order.
@@ -3924,6 +4262,75 @@ interface AddLineItemsToDraftOrderOptions {
3924
4262
  */
3925
4263
  customLineItems?: CustomLineItem[];
3926
4264
  }
4265
+ /**
4266
+ * Updates a draft order's line items.
4267
+ *
4268
+ * You can update a line item's quantity, price, and description.
4269
+ * > **Notes:**
4270
+ * > + Specifying a quantity of `0` will remove the line item.
4271
+ * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
4272
+ * > + Quantity cannot be decreased for fulfilled line items. To retrieve fulfillment information, specify the order ID when calling List Fulfillments For Single Order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-fulfillments/list-fulfillments-for-single-order) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order)).
4273
+ * @param draftOrderId - Draft order ID.
4274
+ * @param lineItemChanges - Details of changes to apply per line item.
4275
+ * @public
4276
+ * @documentationMaturity preview
4277
+ * @requiredField draftOrderId
4278
+ * @requiredField lineItemChanges
4279
+ * @requiredField lineItemChanges.lineItemId
4280
+ * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
4281
+ * @applicableIdentity APP
4282
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
4283
+ */
4284
+ declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`>[]): Promise<NonNullablePaths<UpdateLineItemsResponse, {
4285
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4286
+ }[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`> & {
4287
+ __applicationErrorsType?: UpdateLineItemsApplicationErrors;
4288
+ }>;
4289
+ /**
4290
+ * Applies or unapplies discounts on a draft order.
4291
+ *
4292
+ * Unapplied discounts are still part of the draft order, but do not affect balance.
4293
+ * Existing discounts that are not passed in the request will keep their current state.
4294
+ * @param draftOrderId - Draft order ID.
4295
+ * @param discounts - Discounts to set on the draft order.
4296
+ *
4297
+ * Any existing discounts that are not passed will not change.
4298
+ * @public
4299
+ * @documentationMaturity preview
4300
+ * @requiredField discounts
4301
+ * @requiredField discounts._id
4302
+ * @requiredField discounts.applied
4303
+ * @requiredField draftOrderId
4304
+ * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
4305
+ * @applicableIdentity APP
4306
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
4307
+ */
4308
+ declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetDiscountsResponse, {
4309
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4310
+ }[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`> & {
4311
+ __applicationErrorsType?: SetDiscountsApplicationErrors;
4312
+ }>;
4313
+ /**
4314
+ * Creates custom discounts.
4315
+ *
4316
+ * Newly created discounts are unapplied by default.
4317
+ * To apply them, use Set Discounts.
4318
+ * @param draftOrderId - Draft order ID.
4319
+ * @public
4320
+ * @documentationMaturity preview
4321
+ * @requiredField draftOrderId
4322
+ * @requiredField options.discounts.amount.amount
4323
+ * @requiredField options.discounts.discountType
4324
+ * @requiredField options.discounts.priceAmount.amount
4325
+ * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
4326
+ * @applicableIdentity APP
4327
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
4328
+ */
4329
+ declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount.amount` | `discounts.${number}.discountType` | `discounts.${number}.priceAmount.amount`>): Promise<NonNullablePaths<CreateCustomDiscountsResponse, {
4330
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4331
+ }[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`> & {
4332
+ __applicationErrorsType?: CreateCustomDiscountsApplicationErrors;
4333
+ }>;
3927
4334
  interface CreateCustomDiscountsOptions {
3928
4335
  /**
3929
4336
  * Custom discounts to create.
@@ -3934,6 +4341,68 @@ interface CreateCustomDiscountsOptions {
3934
4341
  */
3935
4342
  discounts?: DiscountOption[];
3936
4343
  }
4344
+ /**
4345
+ * Removes custom discounts from a draft order.
4346
+ * @param draftOrderId - Draft order ID.
4347
+ * @param discountIds - IDs of the discounts to remove from the draft order.
4348
+ * @public
4349
+ * @documentationMaturity preview
4350
+ * @requiredField discountIds
4351
+ * @requiredField draftOrderId
4352
+ * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
4353
+ * @applicableIdentity APP
4354
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
4355
+ */
4356
+ declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<NonNullablePaths<DeleteCustomDiscountsResponse, {
4357
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4358
+ }[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`> & {
4359
+ __applicationErrorsType?: DeleteCustomDiscountsApplicationErrors;
4360
+ }>;
4361
+ /**
4362
+ * Applies or unapplies additional fees on a draft order.
4363
+ *
4364
+ * Additional fees that are not applied are still part of the draft order, but do not affect balance.
4365
+ * Existing additional fees that are not passed in the request will keep their current state.
4366
+ * @param draftOrderId - Draft order ID.
4367
+ * @param additionalFees - Additional fees to set on the draft order.
4368
+ *
4369
+ * Any existing additional fees that are not passed will not change.
4370
+ * @public
4371
+ * @documentationMaturity preview
4372
+ * @requiredField additionalFees
4373
+ * @requiredField additionalFees._id
4374
+ * @requiredField additionalFees.applied
4375
+ * @requiredField draftOrderId
4376
+ * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
4377
+ * @applicableIdentity APP
4378
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
4379
+ */
4380
+ declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
4381
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4382
+ }[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`> & {
4383
+ __applicationErrorsType?: SetAdditionalFeesApplicationErrors;
4384
+ }>;
4385
+ /**
4386
+ * Creates custom additional fees on a draft order.
4387
+ *
4388
+ * Newly created additional fees are not applied by default.
4389
+ * To apply them, use Set Additional Fees.
4390
+ * @param draftOrderId - Draft order ID.
4391
+ * @public
4392
+ * @documentationMaturity preview
4393
+ * @requiredField draftOrderId
4394
+ * @requiredField options.customAdditionalFees.name
4395
+ * @requiredField options.customAdditionalFees.price
4396
+ * @requiredField options.customAdditionalFees.price.amount
4397
+ * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
4398
+ * @applicableIdentity APP
4399
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
4400
+ */
4401
+ declare function createCustomAdditionalFees(draftOrderId: string, options?: NonNullablePaths<CreateCustomAdditionalFeesOptions, `customAdditionalFees.${number}.name` | `customAdditionalFees.${number}.price` | `customAdditionalFees.${number}.price.amount`>): Promise<NonNullablePaths<CreateCustomAdditionalFeesResponse, {
4402
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4403
+ }[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`> & {
4404
+ __applicationErrorsType?: CreateCustomAdditionalFeesApplicationErrors;
4405
+ }>;
3937
4406
  interface CreateCustomAdditionalFeesOptions {
3938
4407
  /**
3939
4408
  * Custom additional fees to create.
@@ -3944,6 +4413,38 @@ interface CreateCustomAdditionalFeesOptions {
3944
4413
  */
3945
4414
  customAdditionalFees?: AdditionalFeeOption[];
3946
4415
  }
4416
+ /**
4417
+ * Removes custom additional fees from a draft order.
4418
+ * @param draftOrderId - Draft order ID.
4419
+ * @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
4420
+ * @public
4421
+ * @documentationMaturity preview
4422
+ * @requiredField customAdditionalFees
4423
+ * @requiredField draftOrderId
4424
+ * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
4425
+ * @applicableIdentity APP
4426
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
4427
+ */
4428
+ declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<NonNullablePaths<DeleteCustomAdditionalFeesResponse, {
4429
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4430
+ }[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`> & {
4431
+ __applicationErrorsType?: DeleteCustomAdditionalFeesApplicationErrors;
4432
+ }>;
4433
+ /**
4434
+ * Sets shipping information on a draft order.
4435
+ * @param draftOrderId - Draft order ID.
4436
+ * @public
4437
+ * @documentationMaturity preview
4438
+ * @requiredField draftOrderId
4439
+ * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
4440
+ * @applicableIdentity APP
4441
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
4442
+ */
4443
+ declare function setShippingInfo(draftOrderId: string, options?: SetShippingInfoOptions): Promise<NonNullablePaths<SetShippingInfoResponse, {
4444
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4445
+ }[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`> & {
4446
+ __applicationErrorsType?: SetShippingInfoApplicationErrors;
4447
+ }>;
3947
4448
  interface SetShippingInfoOptions {
3948
4449
  /**
3949
4450
  * Shipping info to set on the draft order.
@@ -3952,6 +4453,21 @@ interface SetShippingInfoOptions {
3952
4453
  */
3953
4454
  shippingInfo?: V1ShippingInformation;
3954
4455
  }
4456
+ /**
4457
+ * Sets buyer info on a draft order.
4458
+ * @param draftOrderId - Draft order ID.
4459
+ * @public
4460
+ * @documentationMaturity preview
4461
+ * @requiredField draftOrderId
4462
+ * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
4463
+ * @applicableIdentity APP
4464
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
4465
+ */
4466
+ declare function setBuyerInfo(draftOrderId: string, options?: SetBuyerInfoOptions): Promise<NonNullablePaths<SetBuyerInfoResponse, {
4467
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4468
+ }[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`> & {
4469
+ __applicationErrorsType?: SetBuyerInfoApplicationErrors;
4470
+ }>;
3955
4471
  interface SetBuyerInfoOptions {
3956
4472
  /**
3957
4473
  * Shipping info to set on the draft order.
@@ -3960,6 +4476,21 @@ interface SetBuyerInfoOptions {
3960
4476
  */
3961
4477
  buyerInfo?: BuyerInfo;
3962
4478
  }
4479
+ /**
4480
+ * Sets recipient info on a draft order.
4481
+ * @param draftOrderId - Draft order ID.
4482
+ * @public
4483
+ * @documentationMaturity preview
4484
+ * @requiredField draftOrderId
4485
+ * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
4486
+ * @applicableIdentity APP
4487
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
4488
+ */
4489
+ declare function setRecipientInfo(draftOrderId: string, options?: SetRecipientInfoOptions): Promise<NonNullablePaths<SetRecipientInfoResponse, {
4490
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4491
+ }[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`> & {
4492
+ __applicationErrorsType?: SetRecipientInfoApplicationErrors;
4493
+ }>;
3963
4494
  interface SetRecipientInfoOptions {
3964
4495
  /**
3965
4496
  * Recipient address and contact details.
@@ -3968,6 +4499,21 @@ interface SetRecipientInfoOptions {
3968
4499
  */
3969
4500
  recipientInfo?: AddressWithContact;
3970
4501
  }
4502
+ /**
4503
+ * Sets billing info on a draft order.
4504
+ * @param draftOrderId - Draft order ID.
4505
+ * @public
4506
+ * @documentationMaturity preview
4507
+ * @requiredField draftOrderId
4508
+ * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
4509
+ * @applicableIdentity APP
4510
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
4511
+ */
4512
+ declare function setBillingInfo(draftOrderId: string, options?: SetBillingInfoOptions): Promise<NonNullablePaths<SetBillingInfoResponse, {
4513
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4514
+ }[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`> & {
4515
+ __applicationErrorsType?: SetBillingInfoApplicationErrors;
4516
+ }>;
3971
4517
  interface SetBillingInfoOptions {
3972
4518
  /**
3973
4519
  * Billing address and contact details.
@@ -3976,6 +4522,66 @@ interface SetBillingInfoOptions {
3976
4522
  */
3977
4523
  billingInfo?: AddressWithContact;
3978
4524
  }
4525
+ /**
4526
+ * Retrieves a draft order.
4527
+ *
4528
+ * The retrieved draft order contains the latest calculations:
4529
+ * + Line items, shipping details, and buyer information.
4530
+ * + Tax details and price totals.
4531
+ * + Automatic discounts and automatic additional fees, along with updated eligibility.
4532
+ *
4533
+ * > **Note:** When retrieving a committed draft order, it **is not recalculated**.
4534
+ * @param draftOrderId - Draft order ID.
4535
+ * @public
4536
+ * @documentationMaturity preview
4537
+ * @requiredField draftOrderId
4538
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4539
+ * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4540
+ * @applicableIdentity APP
4541
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
4542
+ */
4543
+ declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<GetDraftOrderResponse, {
4544
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4545
+ }[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`> & {
4546
+ __applicationErrorsType?: GetDraftOrderApplicationErrors;
4547
+ }>;
4548
+ /**
4549
+ * Checks whether a draft can be created for an order.
4550
+ *
4551
+ * If `orderDraftable` returns as `true`, the order can be used to create a draft order.
4552
+ *
4553
+ * If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
4554
+ * @param orderId - Order ID.
4555
+ * @public
4556
+ * @documentationMaturity preview
4557
+ * @requiredField orderId
4558
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4559
+ * @applicableIdentity APP
4560
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
4561
+ */
4562
+ declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullablePaths<GetOrderDraftabilityStatusResponse, `orderId` | `orderDraftable` | `nonDraftableReasons`>>;
4563
+ /**
4564
+ * Finalizes a draft order and applies its modifications to the associated order.
4565
+ * You can also control which side-effects are executed on commit.
4566
+ *
4567
+ * > **Notes:**
4568
+ * > + The draft order's status is set to `COMMITTED`.
4569
+ * > + Commiting a draft order cannot be undone or reverted.
4570
+ * > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
4571
+ * @param draftOrderId - Draft order ID.
4572
+ * @public
4573
+ * @documentationMaturity preview
4574
+ * @requiredField draftOrderId
4575
+ * @permissionId ECOM.DRAFT_ORDERS_COMMIT
4576
+ * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4577
+ * @applicableIdentity APP
4578
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
4579
+ */
4580
+ declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<NonNullablePaths<CommitDraftOrderResponse, {
4581
+ [P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
4582
+ }[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}.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}.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}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `orderAfterCommit.lineItems.${number}.priceDescription.original` | `orderAfterCommit.lineItems.${number}.taxableAddress.addressType` | `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.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.tags.privateTags.tagIds` | `orderAfterCommit.businessLocation._id` | `orderAfterCommit.businessLocation.name`> & {
4583
+ __applicationErrorsType?: CommitDraftOrderApplicationErrors;
4584
+ }>;
3979
4585
  interface CommitDraftOrderOptions {
3980
4586
  /** Optional side effects to trigger. */
3981
4587
  commitSettings?: DraftOrderCommitSettings;
@@ -3985,6 +4591,27 @@ interface CommitDraftOrderOptions {
3985
4591
  */
3986
4592
  reason?: string | null;
3987
4593
  }
4594
+ /**
4595
+ * Creates a new order from a draft, while specifying which side-effects are executed.
4596
+ *
4597
+ * > **Notes:**
4598
+ * > + The draft order's status is set to `COMMITTED`.
4599
+ * > + Commiting a draft order cannot be undone or reverted.
4600
+ * > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
4601
+ * @param draftOrderId - Draft order ID.
4602
+ * @public
4603
+ * @documentationMaturity preview
4604
+ * @requiredField draftOrderId
4605
+ * @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
4606
+ * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4607
+ * @applicableIdentity APP
4608
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
4609
+ */
4610
+ declare function createOrderFromDraft(draftOrderId: string, options?: CreateOrderFromDraftOptions): Promise<NonNullablePaths<CreateOrderFromDraftResponse, {
4611
+ [P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
4612
+ }[DraftOrderNonNullablePaths] | `createdOrder.number` | `createdOrder.lineItems` | `createdOrder.lineItems.${number}._id` | `createdOrder.lineItems.${number}.productName.original` | `createdOrder.lineItems.${number}.catalogReference.catalogItemId` | `createdOrder.lineItems.${number}.catalogReference.appId` | `createdOrder.lineItems.${number}.quantity` | `createdOrder.lineItems.${number}.totalDiscount.amount` | `createdOrder.lineItems.${number}.totalDiscount.formattedAmount` | `createdOrder.lineItems.${number}.physicalProperties.shippable` | `createdOrder.lineItems.${number}.itemType.preset` | `createdOrder.lineItems.${number}.itemType.custom` | `createdOrder.lineItems.${number}.paymentOption` | `createdOrder.lineItems.${number}.taxDetails.taxRate` | `createdOrder.lineItems.${number}.taxInfo.taxIncludedInPrice` | `createdOrder.lineItems.${number}.digitalFile.fileId` | `createdOrder.lineItems.${number}.subscriptionInfo.cycleNumber` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `createdOrder.lineItems.${number}.priceDescription.original` | `createdOrder.lineItems.${number}.taxableAddress.addressType` | `createdOrder.buyerInfo.visitorId` | `createdOrder.buyerInfo.memberId` | `createdOrder.paymentStatus` | `createdOrder.fulfillmentStatus` | `createdOrder.weightUnit` | `createdOrder.taxIncludedInPrices` | `createdOrder.billingInfo.address.streetAddress.number` | `createdOrder.billingInfo.address.streetAddress.name` | `createdOrder.billingInfo.contactDetails.vatId._id` | `createdOrder.billingInfo.contactDetails.vatId.type` | `createdOrder.shippingInfo.title` | `createdOrder.shippingInfo.logistics.pickupDetails.pickupMethod` | `createdOrder.status` | `createdOrder.taxInfo.taxBreakdown` | `createdOrder.taxInfo.taxBreakdown.${number}.taxName` | `createdOrder.taxInfo.taxBreakdown.${number}.taxType` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdiction` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdictionType` | `createdOrder.taxInfo.taxBreakdown.${number}.rate` | `createdOrder.appliedDiscounts` | `createdOrder.appliedDiscounts.${number}.coupon._id` | `createdOrder.appliedDiscounts.${number}.coupon.code` | `createdOrder.appliedDiscounts.${number}.coupon.name` | `createdOrder.appliedDiscounts.${number}.merchantDiscount.discountReason` | `createdOrder.appliedDiscounts.${number}.discountRule._id` | `createdOrder.appliedDiscounts.${number}.discountRule.name.original` | `createdOrder.appliedDiscounts.${number}.discountType` | `createdOrder.activities` | `createdOrder.activities.${number}.customActivity.appId` | `createdOrder.activities.${number}.customActivity.type` | `createdOrder.activities.${number}.merchantComment.message` | `createdOrder.activities.${number}.orderRefunded.manual` | `createdOrder.activities.${number}.orderRefunded.reason` | `createdOrder.activities.${number}.type` | `createdOrder.attributionSource` | `createdOrder.createdBy.userId` | `createdOrder.createdBy.memberId` | `createdOrder.createdBy.visitorId` | `createdOrder.createdBy.appId` | `createdOrder.channelInfo.type` | `createdOrder.customFields` | `createdOrder.customFields.${number}.title` | `createdOrder.balanceSummary.balance.amount` | `createdOrder.balanceSummary.balance.formattedAmount` | `createdOrder.additionalFees` | `createdOrder.additionalFees.${number}.name` | `createdOrder.additionalFees.${number}._id` | `createdOrder.tags.privateTags.tagIds` | `createdOrder.businessLocation._id` | `createdOrder.businessLocation.name`> & {
4613
+ __applicationErrorsType?: CreateOrderFromDraftApplicationErrors;
4614
+ }>;
3988
4615
  interface CreateOrderFromDraftOptions {
3989
4616
  /** Optional side effects to trigger. */
3990
4617
  createSettings?: OrderCreateSettings;
@@ -3996,6 +4623,34 @@ interface CreateOrderFromDraftOptions {
3996
4623
  /** Information about the sales channel that submitted this order. */
3997
4624
  channelInfo?: ChannelInfo;
3998
4625
  }
4626
+ /**
4627
+ * Deletes a draft order along with all its pending changes.
4628
+ *
4629
+ * Draft orders with status 'COMMITTED' cannot be deleted.
4630
+ * @param draftOrderId - Draft order ID.
4631
+ * @public
4632
+ * @documentationMaturity preview
4633
+ * @requiredField draftOrderId
4634
+ * @permissionId ECOM.DRAFT_ORDERS_DELETE
4635
+ * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
4636
+ * @applicableIdentity APP
4637
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
4638
+ */
4639
+ declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
4640
+ __applicationErrorsType?: DeleteDraftOrderApplicationErrors;
4641
+ }>;
4642
+ /**
4643
+ * Retrieves a list of up to 100 draft orders, given the provided paging, filtering, and sorting.
4644
+ *
4645
+ * For field support, see [supported filters and sorting](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/draft-orders/supported-filters-and-sorting).
4646
+ * To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
4647
+ * @public
4648
+ * @documentationMaturity preview
4649
+ * @permissionId ECOM.DRAFT_ORDERS_READ
4650
+ * @applicableIdentity APP
4651
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
4652
+ */
4653
+ declare function queryDraftOrders(): DraftOrdersQueryBuilder;
3999
4654
  interface QueryCursorResult {
4000
4655
  cursors: Cursors;
4001
4656
  hasNext: () => boolean;
@@ -4073,10 +4728,49 @@ interface DraftOrdersQueryBuilder {
4073
4728
  /** @documentationMaturity preview */
4074
4729
  find: () => Promise<DraftOrdersQueryResult>;
4075
4730
  }
4731
+ /**
4732
+ * Updates extended fields on a draft order.
4733
+ * @param _id - ID of the entity to update.
4734
+ * @param namespace - Identifier for the app whose extended fields are being updated.
4735
+ * @public
4736
+ * @documentationMaturity preview
4737
+ * @requiredField _id
4738
+ * @requiredField namespace
4739
+ * @requiredField options
4740
+ * @requiredField options.namespaceData
4741
+ * @permissionId ECOM.DRAFT_ORDER_UPDATE_EXTENDED_FIELDS
4742
+ * @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
4743
+ * @applicableIdentity APP
4744
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateExtendedFields
4745
+ */
4746
+ declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
4747
+ [P in DraftOrderNonNullablePaths]: `draftOrder.${P}`;
4748
+ }[DraftOrderNonNullablePaths]> & {
4749
+ __applicationErrorsType?: UpdateExtendedFieldsApplicationErrors;
4750
+ }>;
4076
4751
  interface UpdateExtendedFieldsOptions {
4077
4752
  /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
4078
4753
  namespaceData: Record<string, any> | null;
4079
4754
  }
4755
+ /**
4756
+ * Sets whether a draft order is tax-exempt.
4757
+ *
4758
+ * A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
4759
+ * @param draftOrderId - Draft order ID.
4760
+ * @public
4761
+ * @documentationMaturity preview
4762
+ * @requiredField draftOrderId
4763
+ * @requiredField options
4764
+ * @requiredField options.taxExempt
4765
+ * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
4766
+ * @applicableIdentity APP
4767
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
4768
+ */
4769
+ declare function setTaxExemption(draftOrderId: string, options: NonNullablePaths<SetTaxExemptionOptions, `taxExempt`>): Promise<NonNullablePaths<SetTaxExemptionResponse, {
4770
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4771
+ }[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`> & {
4772
+ __applicationErrorsType?: SetTaxExemptionApplicationErrors;
4773
+ }>;
4080
4774
  interface SetTaxExemptionOptions {
4081
4775
  /**
4082
4776
  * Whether the draft order is exempt from tax calculations.
@@ -4085,9 +4779,27 @@ interface SetTaxExemptionOptions {
4085
4779
  */
4086
4780
  taxExempt: boolean | null;
4087
4781
  }
4782
+ /**
4783
+ * Sets business location on a draft order.
4784
+ *
4785
+ * When committed, the order will become associated to a specific business location. This affects who can see and manage this order, and how it is calculated in reports.
4786
+ * @param draftOrderId - Draft order ID.
4787
+ * @public
4788
+ * @documentationMaturity preview
4789
+ * @requiredField draftOrderId
4790
+ * @requiredField options.businessLocation._id
4791
+ * @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
4792
+ * @applicableIdentity APP
4793
+ * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
4794
+ */
4795
+ declare function setBusinessLocation(draftOrderId: string, options?: NonNullablePaths<SetBusinessLocationOptions, `businessLocation._id`>): Promise<NonNullablePaths<SetBusinessLocationResponse, {
4796
+ [P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
4797
+ }[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`> & {
4798
+ __applicationErrorsType?: SetBusinessLocationApplicationErrors;
4799
+ }>;
4088
4800
  interface SetBusinessLocationOptions {
4089
4801
  /** Business location. */
4090
4802
  businessLocation?: Location;
4091
4803
  }
4092
4804
 
4093
- export { PickupMethod as $, type AddLineItemsToDraftOrderOptions as A, type SetBusinessLocationOptions as B, type CreateDraftOrderResponse as C, type DeleteCustomDiscountsResponse as D, type SetBusinessLocationResponse as E, type DraftOrderCreatedEnvelope as F, type GetDraftOrderResponse as G, type DraftOrderDeletedEnvelope as H, type IdAndApplied as I, type DraftOrderUpdatedEnvelope as J, DescriptionLineType as K, type LineItemChangeDetails as L, ItemTypeItemType as M, JurisdictionType as N, SubscriptionFrequency as O, PaymentOptionType as P, AdjustmentType as Q, PickupDetailsPickupMethod as R, type SetDiscountsResponse as S, TaxableAddressType as T, type UpdateLineItemsResponse as U, VatType as V, SourceType as W, AppliedDiscountDiscountType as X, DiscountReason as Y, EditingStatus as Z, WeightUnit as _, type CreateEmptyDraftOrderResponse as a, type V1DeliveryTimeSlot as a$, RuleType as a0, FileType as a1, DiscountType as a2, NonDraftableReason as a3, PaymentStatus as a4, FulfillmentStatus as a5, OrderStatus as a6, LineItemQuantityChangeType as a7, ActivityType as a8, AttributionSource as a9, type SubscriptionTitle as aA, type SubscriptionDescription as aB, type SubscriptionSettings as aC, type FreeTrialPeriod as aD, type BillingAdjustment as aE, type BillingAdjustmentPriceSummary as aF, type LocationAndQuantity as aG, type TaxableAddress as aH, type TaxableAddressTaxableAddressDataOneOf as aI, type ExtendedFields as aJ, type ModifierGroup as aK, type TranslatableString as aL, type ItemModifier as aM, type ItemChangedDetails as aN, type ShippingDetails as aO, type ShippingDetailsChangeTypeOneOf as aP, type V1ShippingInformation as aQ, type V1DeliveryLogistics as aR, type V1DeliveryLogisticsAddressOneOf as aS, type AddressWithContact as aT, type Address as aU, type StreetAddress as aV, type AddressLocation as aW, type FullAddressContactDetails as aX, type VatId as aY, type V1PickupDetails as aZ, type PickupAddress as a_, ChannelType as aa, SortOrder as ab, WebhookIdentityType as ac, type DraftOrder as ad, type ItemDetails as ae, type ItemDetailsChangeTypeOneOf as af, type Price as ag, type PriceDescription as ah, type OrderLineItem as ai, type ProductName as aj, type CatalogReference as ak, type DescriptionLine as al, type DescriptionLineValueOneOf as am, type DescriptionLineDescriptionLineValueOneOf as an, type DescriptionLineName as ao, type PlainTextValue as ap, type Color as aq, type FocalPoint as ar, type PhysicalProperties as as, type ItemType as at, type ItemTypeItemTypeDataOneOf as au, type ItemTaxFullDetails as av, type LineItemTaxInfo as aw, type LineItemTaxBreakdown as ax, type DigitalFile as ay, type SubscriptionInfo as az, type AddLineItemsToDraftOrderResponse as b, type SetDiscountsRequest as b$, type V1ShippingPrice as b0, type ShippingRegion as b1, type ShippingChangedDetails as b2, type BuyerInfo as b3, type BuyerInfoIdOneOf as b4, type AdditionalFeeDetails as b5, type AdditionalFee as b6, type TaxDetails as b7, type DiscountDetails as b8, type AppliedDiscount as b9, type BusinessLocationDetails as bA, type BusinessLocationDetailsChangeTypeOneOf as bB, type Location as bC, type BusinessLocationChangedDetails as bD, type CreateDraftOrderRequest as bE, type CalculatedDraftOrder as bF, type ShippingOption as bG, type DeliveryLogistics as bH, type PickupDetails as bI, type DeliveryTimeSlot as bJ, type ShippingPrice as bK, type CalculationErrors as bL, type CalculationErrorsShippingCalculationErrorOneOf as bM, type Details as bN, type DetailsKindOneOf as bO, type ApplicationError as bP, type ValidationError as bQ, type FieldViolation as bR, type SystemError as bS, type CarrierErrors as bT, type CarrierError as bU, type CreateEmptyDraftOrderRequest as bV, type AddLineItemsToDraftOrderRequest as bW, type CatalogReferenceLineItem as bX, type CustomLineItem as bY, type SecuredMedia as bZ, type UpdateLineItemsRequest as b_, type AppliedDiscountDiscountSourceOneOf as ba, type Coupon as bb, type MerchantDiscount as bc, type MerchantDiscountMerchantDiscountReasonOneOf as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type CreatedBy as bh, type CreatedByStringOneOf as bi, type PriceSummary as bj, type TaxSummary as bk, type BalanceSummary as bl, type Balance as bm, type DraftOrderCommitSettings as bn, type InventoryUpdate as bo, type RecipientInfoDetails as bp, type RecipientInfoDetailsChangeTypeOneOf as bq, type RecipientInfoChangedDetails as br, type OrderTaxInfo as bs, type OrderTaxBreakdown as bt, type BuyerDetails as bu, type BuyerDetailsChangeTypeOneOf as bv, type BuyerChangedDetails as bw, type BillingDetails as bx, type BillingDetailsChangeTypeOneOf as by, type BillingChangedDetails as bz, type CreateCustomDiscountsOptions as c, type ReceiptCreated as c$, type CreateCustomDiscountsRequest as c0, type DiscountOption as c1, type DiscountOptionDiscountAmountOneOf as c2, type DeleteCustomDiscountsRequest as c3, type SetAdditionalFeesRequest as c4, type CreateCustomAdditionalFeesRequest as c5, type AdditionalFeeOption as c6, type DeleteCustomAdditionalFeesRequest as c7, type SetShippingInfoRequest as c8, type SetBuyerInfoRequest as c9, type LineItemAmount as cA, type ManagedAdditionalFee as cB, type TotalPriceChange as cC, type ShippingInformationChange as cD, type ShippingInformation as cE, type SavedPaymentMethod as cF, type AuthorizedPaymentCreated as cG, type AuthorizedPaymentCaptured as cH, type AuthorizedPaymentVoided as cI, type RefundInitiated as cJ, type RefundedPayment as cK, type RefundedPaymentKindOneOf as cL, type RegularPaymentRefund as cM, type GiftCardPaymentRefund as cN, type MembershipPaymentRefund as cO, type PaymentRefunded as cP, type PaymentRefundFailed as cQ, type RefundedAsStoreCredit as cR, type PaymentPending as cS, type PaymentPendingPaymentDetailsOneOf as cT, type RegularPayment as cU, type RegularPaymentPaymentMethodDetailsOneOf as cV, type CreditCardDetails as cW, type PaymentCanceled as cX, type PaymentCanceledPaymentDetailsOneOf as cY, type PaymentDeclined as cZ, type PaymentDeclinedPaymentDetailsOneOf as c_, type SetRecipientInfoRequest as ca, type SetBillingInfoRequest as cb, type UpdateShippingInfoRequest as cc, type UpdateShippingInfoResponse as cd, type GetDraftOrderRequest as ce, type GetOrderDraftabilityStatusRequest as cf, type CommitDraftOrderRequest as cg, type Order as ch, type CurrencyConversionDetails as ci, type Activity as cj, type ActivityContentOneOf as ck, type CustomActivity as cl, type MerchantComment as cm, type OrderRefunded as cn, type OrderCreatedFromExchange as co, type NewExchangeOrderCreated as cp, type LineItemExchangeData as cq, type DraftOrderChangesApplied as cr, type OrderChange as cs, type OrderChangeValueOneOf as ct, type LineItemChanges as cu, type LineItemQuantityChange as cv, type LineItemPriceChange as cw, type ManagedLineItem as cx, type ManagedDiscount as cy, type TranslatedValue as cz, type CreateCustomDiscountsResponse as d, type ReceiptCreatedReceiptInfoOneOf as d0, type WixReceipt as d1, type ExternalReceipt as d2, type ReceiptSent as d3, type ReceiptSentReceiptInfoOneOf as d4, type V1CreatedBy as d5, type V1CreatedByStringOneOf as d6, type ChannelInfo as d7, type CustomField as d8, type V1BalanceSummary as d9, type ActionEvent as dA, type MessageEnvelope as dB, type IdentificationData as dC, type IdentificationDataIdOneOf as dD, type BaseEventMetadata as dE, type EventMetadata as dF, type DraftOrdersQueryResult as dG, type FulfillmentStatusesAggregate as da, type Tags as db, type TagList as dc, type CreateOrderFromDraftRequest as dd, type OrderCreateSettings as de, type OrderCreateNotifications as df, type DeleteDraftOrderRequest as dg, type DeleteDraftOrderResponse as dh, type QueryDraftOrdersRequest as di, type CursorQuery as dj, type CursorQueryPagingMethodOneOf as dk, type Sorting as dl, type CursorPaging as dm, type QueryDraftOrdersResponse as dn, type CursorPagingMetadata as dp, type Cursors as dq, type UpdateExtendedFieldsRequest as dr, type SetTaxExemptionRequest as ds, type SetBusinessLocationRequest as dt, type DomainEvent as du, type DomainEventBodyOneOf as dv, type EntityCreatedEvent as dw, type RestoreInfo as dx, type EntityUpdatedEvent as dy, type EntityDeletedEvent as dz, type SetAdditionalFeesResponse as e, type CreateCustomAdditionalFeesOptions as f, type CreateCustomAdditionalFeesResponse as g, type DeleteCustomAdditionalFeesResponse as h, type SetShippingInfoOptions as i, type SetShippingInfoResponse as j, type SetBuyerInfoOptions as k, type SetBuyerInfoResponse as l, type SetRecipientInfoOptions as m, type SetRecipientInfoResponse as n, type SetBillingInfoOptions as o, type SetBillingInfoResponse as p, type GetOrderDraftabilityStatusResponse as q, type CommitDraftOrderOptions as r, type CommitDraftOrderResponse as s, type CreateOrderFromDraftOptions as t, type CreateOrderFromDraftResponse as u, type DraftOrdersQueryBuilder as v, type UpdateExtendedFieldsOptions as w, type UpdateExtendedFieldsResponse as x, type SetTaxExemptionOptions as y, type SetTaxExemptionResponse as z };
4805
+ export { type ActionEvent, type Activity, type ActivityContentOneOf, ActivityType, type ActivityTypeWithLiterals, type AddLineItemsToDraftOrderApplicationErrors, type AddLineItemsToDraftOrderOptions, type AddLineItemsToDraftOrderRequest, type AddLineItemsToDraftOrderResponse, type AdditionalFee, type AdditionalFeeDetails, type AdditionalFeeOption, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, AttributionSource, type AttributionSourceWithLiterals, type AuthorizedPaymentCaptured, type AuthorizedPaymentCreated, type AuthorizedPaymentVoided, type Balance, type BalanceSummary, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingChangedDetails, type BillingDetails, type BillingDetailsChangeTypeOneOf, type BusinessLocationChangedDetails, type BusinessLocationDetails, type BusinessLocationDetailsChangeTypeOneOf, type BuyerChangedDetails, type BuyerDetails, type BuyerDetailsChangeTypeOneOf, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedDraftOrder, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type CatalogReference, type CatalogReferenceLineItem, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, type Color, type CommitDraftOrderApplicationErrors, type CommitDraftOrderOptions, type CommitDraftOrderRequest, type CommitDraftOrderResponse, type Coupon, type CreateCustomAdditionalFeesApplicationErrors, type CreateCustomAdditionalFeesOptions, type CreateCustomAdditionalFeesRequest, type CreateCustomAdditionalFeesResponse, type CreateCustomDiscountsApplicationErrors, type CreateCustomDiscountsOptions, type CreateCustomDiscountsRequest, type CreateCustomDiscountsResponse, type CreateDraftOrderApplicationErrors, type CreateDraftOrderRequest, type CreateDraftOrderResponse, type CreateEmptyDraftOrderApplicationErrors, type CreateEmptyDraftOrderRequest, type CreateEmptyDraftOrderResponse, type CreateOrderFromDraftApplicationErrors, type CreateOrderFromDraftOptions, type CreateOrderFromDraftRequest, type CreateOrderFromDraftResponse, type CreatedBy, type CreatedByStringOneOf, type CreditCardDetails, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomActivity, type CustomField, type CustomLineItem, type DeleteCustomAdditionalFeesApplicationErrors, type DeleteCustomAdditionalFeesRequest, type DeleteCustomAdditionalFeesResponse, type DeleteCustomDiscountsApplicationErrors, type DeleteCustomDiscountsRequest, type DeleteCustomDiscountsResponse, type DeleteDraftOrderApplicationErrors, type DeleteDraftOrderRequest, type DeleteDraftOrderResponse, type DeliveryLogistics, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DigitalFile, type DiscountDetails, type DiscountOption, type DiscountOptionDiscountAmountOneOf, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type DraftOrder, type DraftOrderChangesApplied, type DraftOrderCommitSettings, type DraftOrderCreatedEnvelope, type DraftOrderDeletedEnvelope, type DraftOrderUpdatedEnvelope, type DraftOrdersQueryBuilder, type DraftOrdersQueryResult, EditingStatus, type EditingStatusWithLiterals, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReceipt, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, FulfillmentStatus, type FulfillmentStatusWithLiterals, type FulfillmentStatusesAggregate, type FullAddressContactDetails, type GetDraftOrderApplicationErrors, type GetDraftOrderRequest, type GetDraftOrderResponse, type GetOrderDraftabilityStatusRequest, type GetOrderDraftabilityStatusResponse, type GiftCardPaymentRefund, type IdAndApplied, type IdentificationData, type IdentificationDataIdOneOf, type InventoryUpdate, type ItemChangedDetails, type ItemDetails, type ItemDetailsChangeTypeOneOf, type ItemModifier, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemAmount, type LineItemChangeDetails, type LineItemChanges, type LineItemDiscount, type LineItemExchangeData, type LineItemPriceChange, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MembershipPaymentRefund, type MerchantComment, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type NewExchangeOrderCreated, NonDraftableReason, type NonDraftableReasonWithLiterals, type Order, type OrderChange, type OrderChangeValueOneOf, type OrderCreateNotifications, type OrderCreateSettings, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, OrderStatus, type OrderStatusWithLiterals, type OrderTaxBreakdown, type OrderTaxInfo, type PaymentCanceled, type PaymentCanceledPaymentDetailsOneOf, type PaymentDeclined, type PaymentDeclinedPaymentDetailsOneOf, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentPending, type PaymentPendingPaymentDetailsOneOf, type PaymentRefundFailed, type PaymentRefunded, PaymentStatus, type PaymentStatusWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupDetailsPickupMethod, type PickupDetailsPickupMethodWithLiterals, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type Price, type PriceDescription, type PriceSummary, type ProductName, type QueryDraftOrdersRequest, type QueryDraftOrdersResponse, type ReceiptCreated, type ReceiptCreatedReceiptInfoOneOf, type ReceiptSent, type ReceiptSentReceiptInfoOneOf, type RecipientInfoChangedDetails, type RecipientInfoDetails, type RecipientInfoDetailsChangeTypeOneOf, type RefundInitiated, type RefundedAsStoreCredit, type RefundedPayment, type RefundedPaymentKindOneOf, type RegularPayment, type RegularPaymentPaymentMethodDetailsOneOf, type RegularPaymentRefund, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type SavedPaymentMethod, type SecuredMedia, type SetAdditionalFeesApplicationErrors, type SetAdditionalFeesRequest, type SetAdditionalFeesResponse, type SetBillingInfoApplicationErrors, type SetBillingInfoOptions, type SetBillingInfoRequest, type SetBillingInfoResponse, type SetBusinessLocationApplicationErrors, type SetBusinessLocationOptions, type SetBusinessLocationRequest, type SetBusinessLocationResponse, type SetBuyerInfoApplicationErrors, type SetBuyerInfoOptions, type SetBuyerInfoRequest, type SetBuyerInfoResponse, type SetDiscountsApplicationErrors, type SetDiscountsRequest, type SetDiscountsResponse, type SetRecipientInfoApplicationErrors, type SetRecipientInfoOptions, type SetRecipientInfoRequest, type SetRecipientInfoResponse, type SetShippingInfoApplicationErrors, type SetShippingInfoOptions, type SetShippingInfoRequest, type SetShippingInfoResponse, type SetTaxExemptionApplicationErrors, type SetTaxExemptionOptions, type SetTaxExemptionRequest, type SetTaxExemptionResponse, type ShippingChangedDetails, type ShippingDetails, type ShippingDetailsChangeTypeOneOf, type ShippingInformation, type ShippingInformationChange, type ShippingOption, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SourceType, type SourceTypeWithLiterals, type StreetAddress, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, type SubscriptionTitle, type SystemError, type TagList, type Tags, type TaxDetails, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateExtendedFieldsApplicationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateLineItemsApplicationErrors, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type UpdateShippingInfoRequest, type UpdateShippingInfoResponse, type V1BalanceSummary, type V1CreatedBy, type V1CreatedByStringOneOf, type V1DeliveryLogistics, type V1DeliveryLogisticsAddressOneOf, type V1DeliveryTimeSlot, type V1PickupDetails, type V1ShippingInformation, type V1ShippingPrice, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, type WixReceipt, addLineItemsToDraftOrder, commitDraftOrder, createCustomAdditionalFees, createCustomDiscounts, createDraftOrder, createEmptyDraftOrder, createOrderFromDraft, deleteCustomAdditionalFees, deleteCustomDiscounts, deleteDraftOrder, getDraftOrder, getOrderDraftabilityStatus, onDraftOrderCreated, onDraftOrderDeleted, onDraftOrderUpdated, queryDraftOrders, setAdditionalFees, setBillingInfo, setBusinessLocation, setBuyerInfo, setDiscounts, setRecipientInfo, setShippingInfo, setTaxExemption, updateExtendedFields, updateLineItems };