@wix/auto_sdk_ecom_draft-orders 1.0.97 → 1.0.99
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +19 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +79 -51
- package/build/cjs/index.typings.js +19 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +72 -1
- package/build/cjs/meta.js +19 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +17 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +79 -51
- package/build/es/index.typings.mjs +17 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +72 -1
- package/build/es/meta.mjs +17 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +19 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +105 -63
- package/build/internal/cjs/index.typings.js +19 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +72 -1
- package/build/internal/cjs/meta.js +19 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +17 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +105 -63
- package/build/internal/es/index.typings.mjs +17 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +72 -1
- package/build/internal/es/meta.mjs +17 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1261,6 +1261,21 @@ interface AdditionalFee {
|
|
|
1261
1261
|
*/
|
|
1262
1262
|
lineItemIds?: string[];
|
|
1263
1263
|
}
|
|
1264
|
+
declare enum AdditionalFeeSource {
|
|
1265
|
+
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1266
|
+
/** The additional fee was added by an additional fee service plugin. */
|
|
1267
|
+
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
1268
|
+
/** The additional fee was added to the item by a catalog or custom line item. */
|
|
1269
|
+
ITEM = "ITEM",
|
|
1270
|
+
/** The additional fee was added manually on request. */
|
|
1271
|
+
MANUAL = "MANUAL",
|
|
1272
|
+
/** The additional fee was added by the shipping provider. */
|
|
1273
|
+
SHIPPING = "SHIPPING",
|
|
1274
|
+
/** The additional fee was added by the Wix eCommerce platform. */
|
|
1275
|
+
PLATFORM = "PLATFORM"
|
|
1276
|
+
}
|
|
1277
|
+
/** @enumType */
|
|
1278
|
+
type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING' | 'PLATFORM';
|
|
1264
1279
|
interface TaxDetails {
|
|
1265
1280
|
/** Whether the additional fee is taxable. */
|
|
1266
1281
|
taxable?: boolean;
|
|
@@ -1755,6 +1770,56 @@ interface DepositDetailsDepositOneOf {
|
|
|
1755
1770
|
*/
|
|
1756
1771
|
percentage?: string | null;
|
|
1757
1772
|
}
|
|
1773
|
+
interface PlatformFeeSummary {
|
|
1774
|
+
/** Total sum of all platform fees. */
|
|
1775
|
+
total?: Price;
|
|
1776
|
+
/** Total amount of platform fees with `PASS_ON` charge type. */
|
|
1777
|
+
totalPassOn?: Price;
|
|
1778
|
+
/** Total amount of platform fees with `ABSORBED` charge type. */
|
|
1779
|
+
totalAbsorbed?: Price;
|
|
1780
|
+
/**
|
|
1781
|
+
* Specific information about each platform fee.
|
|
1782
|
+
* @maxSize 300
|
|
1783
|
+
*/
|
|
1784
|
+
fees?: PlatformFee[];
|
|
1785
|
+
}
|
|
1786
|
+
interface PlatformFee {
|
|
1787
|
+
/** Platform fee name. */
|
|
1788
|
+
name?: TranslatableString;
|
|
1789
|
+
/** Platform fee amount. */
|
|
1790
|
+
amount?: Price;
|
|
1791
|
+
/**
|
|
1792
|
+
* ID of the line item the platform fee applies to.
|
|
1793
|
+
* @format GUID
|
|
1794
|
+
*/
|
|
1795
|
+
lineItemId?: string;
|
|
1796
|
+
/** Platform fee charge type. */
|
|
1797
|
+
chargeType?: ChargeTypeWithLiterals;
|
|
1798
|
+
/**
|
|
1799
|
+
* Percentage rate charged as platform fee.
|
|
1800
|
+
* The fee rate expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
|
|
1801
|
+
* @format DECIMAL_VALUE
|
|
1802
|
+
* @decimalValue options { gte:0, lte:1, maxScale:4 }
|
|
1803
|
+
*/
|
|
1804
|
+
percentageRate?: string;
|
|
1805
|
+
}
|
|
1806
|
+
declare enum ChargeType {
|
|
1807
|
+
UNKNOWN_CHARGE_TYPE = "UNKNOWN_CHARGE_TYPE",
|
|
1808
|
+
/**
|
|
1809
|
+
* Platform fee passed on to buyer.
|
|
1810
|
+
*
|
|
1811
|
+
* This type increases the order total, and is visible to the buyer and merchant as an additional fee.
|
|
1812
|
+
*/
|
|
1813
|
+
PASS_ON = "PASS_ON",
|
|
1814
|
+
/**
|
|
1815
|
+
* Platform fee absorbed by merchant.
|
|
1816
|
+
*
|
|
1817
|
+
* This type does not increase the order total, and is only visible to the merchant.
|
|
1818
|
+
*/
|
|
1819
|
+
ABSORBED = "ABSORBED"
|
|
1820
|
+
}
|
|
1821
|
+
/** @enumType */
|
|
1822
|
+
type ChargeTypeWithLiterals = ChargeType | 'UNKNOWN_CHARGE_TYPE' | 'PASS_ON' | 'ABSORBED';
|
|
1758
1823
|
interface CreateDraftOrderRequest {
|
|
1759
1824
|
/**
|
|
1760
1825
|
* ID of the order to create a draft for.
|
|
@@ -2147,6 +2212,12 @@ interface LineItemChangeDetails {
|
|
|
2147
2212
|
* For example, when price is `0` but additional details about the actual price are needed - `"Starts at $67"`.
|
|
2148
2213
|
*/
|
|
2149
2214
|
newPriceDescription?: PriceDescription;
|
|
2215
|
+
/** New product name. */
|
|
2216
|
+
newProductName?: ProductName;
|
|
2217
|
+
/** New description lines. */
|
|
2218
|
+
newDescriptionLines?: DescriptionLinesOverride;
|
|
2219
|
+
/** New modifier groups. */
|
|
2220
|
+
newModifierGroups?: ModifiersGroupsOverride;
|
|
2150
2221
|
}
|
|
2151
2222
|
interface ModifiersGroupsOverride {
|
|
2152
2223
|
/**
|
|
@@ -4879,7 +4950,6 @@ interface DraftOrderCreatedEnvelope {
|
|
|
4879
4950
|
* @webhook
|
|
4880
4951
|
* @eventType wix.ecom.v1.draft_order_created
|
|
4881
4952
|
* @slug created
|
|
4882
|
-
* @documentationMaturity preview
|
|
4883
4953
|
*/
|
|
4884
4954
|
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4885
4955
|
interface DraftOrderDeletedEnvelope {
|
|
@@ -4900,7 +4970,6 @@ interface DraftOrderDeletedEnvelope {
|
|
|
4900
4970
|
* @webhook
|
|
4901
4971
|
* @eventType wix.ecom.v1.draft_order_deleted
|
|
4902
4972
|
* @slug deleted
|
|
4903
|
-
* @documentationMaturity preview
|
|
4904
4973
|
*/
|
|
4905
4974
|
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
4906
4975
|
interface DraftOrderUpdatedEnvelope {
|
|
@@ -4923,7 +4992,6 @@ interface DraftOrderUpdatedEnvelope {
|
|
|
4923
4992
|
* @webhook
|
|
4924
4993
|
* @eventType wix.ecom.v1.draft_order_updated
|
|
4925
4994
|
* @slug updated
|
|
4926
|
-
* @documentationMaturity preview
|
|
4927
4995
|
*/
|
|
4928
4996
|
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4929
4997
|
/**
|
|
@@ -4933,7 +5001,6 @@ declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope)
|
|
|
4933
5001
|
* To complete a draft and update the original order, call Commit Draft Order.
|
|
4934
5002
|
* @param orderId - ID of the order to create a draft for.
|
|
4935
5003
|
* @public
|
|
4936
|
-
* @documentationMaturity preview
|
|
4937
5004
|
* @requiredField orderId
|
|
4938
5005
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4939
5006
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -4949,7 +5016,6 @@ declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<Cre
|
|
|
4949
5016
|
*
|
|
4950
5017
|
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
4951
5018
|
* @public
|
|
4952
|
-
* @documentationMaturity preview
|
|
4953
5019
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4954
5020
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4955
5021
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
@@ -4963,7 +5029,6 @@ declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDr
|
|
|
4963
5029
|
* Adds catalog or custom line items to a draft order.
|
|
4964
5030
|
* @param draftOrderId - Draft order ID.
|
|
4965
5031
|
* @public
|
|
4966
|
-
* @documentationMaturity preview
|
|
4967
5032
|
* @requiredField draftOrderId
|
|
4968
5033
|
* @requiredField options.catalogLineItems.catalogReference
|
|
4969
5034
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
@@ -4998,15 +5063,16 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
4998
5063
|
* @param draftOrderId - Draft order ID.
|
|
4999
5064
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
5000
5065
|
* @public
|
|
5001
|
-
* @documentationMaturity preview
|
|
5002
5066
|
* @requiredField draftOrderId
|
|
5003
5067
|
* @requiredField lineItemChanges
|
|
5004
5068
|
* @requiredField lineItemChanges.lineItemId
|
|
5069
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups._id
|
|
5070
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups.modifiers._id
|
|
5005
5071
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
5006
5072
|
* @applicableIdentity APP
|
|
5007
5073
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
5008
5074
|
*/
|
|
5009
|
-
declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`,
|
|
5075
|
+
declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId` | `newModifierGroups.modifierGroups.${number}._id` | `newModifierGroups.modifierGroups.${number}.modifiers.${number}._id`, 7>[]): Promise<NonNullablePaths<UpdateLineItemsResponse, `calculatedDraftOrder.draftOrder.lineItems` | `calculatedDraftOrder.draftOrder.lineItems.${number}.added` | `calculatedDraftOrder.draftOrder.lineItems.${number}.changedDetails.priceBeforeChange.amount` | `calculatedDraftOrder.draftOrder.lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `calculatedDraftOrder.draftOrder.lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `calculatedDraftOrder.draftOrder.lineItems.${number}.removed` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem._id` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.productName.original` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.catalogReference.catalogItemId` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.catalogReference.appId` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.quantity` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.physicalProperties.shippable` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.itemType.preset` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.itemType.custom` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.paymentOption` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.taxDetails.taxRate` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.digitalFile.fileId` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.taxableAddress.addressType` | `calculatedDraftOrder.draftOrder.lineItems.${number}.lineItem.priceUndetermined` | `calculatedDraftOrder.draftOrder.shippingInfo.added` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.draftOrder.shippingInfo.removed` | `calculatedDraftOrder.draftOrder.buyerInfo.visitorId` | `calculatedDraftOrder.draftOrder.buyerInfo.memberId` | `calculatedDraftOrder.draftOrder.additionalFees` | `calculatedDraftOrder.draftOrder.additionalFees.${number}.additionalFee.name` | `calculatedDraftOrder.draftOrder.additionalFees.${number}.additionalFee._id` | `calculatedDraftOrder.draftOrder.additionalFees.${number}.taxDetails.taxable` | `calculatedDraftOrder.draftOrder.additionalFees.${number}.source` | `calculatedDraftOrder.draftOrder.additionalFees.${number}.applied` | `calculatedDraftOrder.draftOrder.discounts` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.coupon._id` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.coupon.code` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.coupon.name` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.merchantDiscount.discountReason` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.discountRule._id` | `calculatedDraftOrder.draftOrder.discounts.${number}.discount.discountType` | `calculatedDraftOrder.draftOrder.discounts.${number}.source` | `calculatedDraftOrder.draftOrder.discounts.${number}.applied` | `calculatedDraftOrder.draftOrder.createdBy.userId` | `calculatedDraftOrder.draftOrder.createdBy.appId` | `calculatedDraftOrder.draftOrder.status` | `calculatedDraftOrder.draftOrder.weightUnit` | `calculatedDraftOrder.draftOrder.balanceSummary.balance.amount` | `calculatedDraftOrder.draftOrder.balanceSummary.balance.formattedAmount` | `calculatedDraftOrder.draftOrder.commitSettings.updateInventory` | `calculatedDraftOrder.draftOrder.commitSettings.updateInventory.${number}.lineItemId` | `calculatedDraftOrder.draftOrder.recipientInfo.added` | `calculatedDraftOrder.draftOrder.recipientInfo.removed` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown.${number}.taxName` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown.${number}.taxType` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown.${number}.jurisdiction` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown.${number}.jurisdictionType` | `calculatedDraftOrder.draftOrder.taxInfo.taxBreakdown.${number}.rate` | `calculatedDraftOrder.draftOrder.buyerDetails.added` | `calculatedDraftOrder.draftOrder.buyerDetails.removed` | `calculatedDraftOrder.draftOrder.billingDetails.added` | `calculatedDraftOrder.draftOrder.billingDetails.removed` | `calculatedDraftOrder.draftOrder.businessLocationDetails.added` | `calculatedDraftOrder.draftOrder.businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `calculatedDraftOrder.draftOrder.businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `calculatedDraftOrder.draftOrder.businessLocationDetails.removed` | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `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`, 11> & {
|
|
5010
5076
|
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
5011
5077
|
}>;
|
|
5012
5078
|
interface SetDepositOptions {
|
|
@@ -5026,7 +5092,6 @@ interface SetDepositOptions {
|
|
|
5026
5092
|
*
|
|
5027
5093
|
* Any existing discounts that are not passed will not change.
|
|
5028
5094
|
* @public
|
|
5029
|
-
* @documentationMaturity preview
|
|
5030
5095
|
* @requiredField discounts
|
|
5031
5096
|
* @requiredField discounts._id
|
|
5032
5097
|
* @requiredField discounts.applied
|
|
@@ -5045,7 +5110,6 @@ declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<
|
|
|
5045
5110
|
* To apply them, use Set Discounts.
|
|
5046
5111
|
* @param draftOrderId - Draft order ID.
|
|
5047
5112
|
* @public
|
|
5048
|
-
* @documentationMaturity preview
|
|
5049
5113
|
* @requiredField draftOrderId
|
|
5050
5114
|
* @requiredField options.discounts.amount.amount
|
|
5051
5115
|
* @requiredField options.discounts.discountType
|
|
@@ -5072,7 +5136,6 @@ interface CreateCustomDiscountsOptions {
|
|
|
5072
5136
|
* @param draftOrderId - Draft order ID.
|
|
5073
5137
|
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
5074
5138
|
* @public
|
|
5075
|
-
* @documentationMaturity preview
|
|
5076
5139
|
* @requiredField discountIds
|
|
5077
5140
|
* @requiredField draftOrderId
|
|
5078
5141
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
@@ -5092,7 +5155,6 @@ declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string
|
|
|
5092
5155
|
*
|
|
5093
5156
|
* Any existing additional fees that are not passed will not change.
|
|
5094
5157
|
* @public
|
|
5095
|
-
* @documentationMaturity preview
|
|
5096
5158
|
* @requiredField additionalFees
|
|
5097
5159
|
* @requiredField additionalFees._id
|
|
5098
5160
|
* @requiredField additionalFees.applied
|
|
@@ -5111,7 +5173,6 @@ declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNull
|
|
|
5111
5173
|
* To apply them, use Set Additional Fees.
|
|
5112
5174
|
* @param draftOrderId - Draft order ID.
|
|
5113
5175
|
* @public
|
|
5114
|
-
* @documentationMaturity preview
|
|
5115
5176
|
* @requiredField draftOrderId
|
|
5116
5177
|
* @requiredField options.customAdditionalFees.name
|
|
5117
5178
|
* @requiredField options.customAdditionalFees.price
|
|
@@ -5138,7 +5199,6 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
5138
5199
|
* @param draftOrderId - Draft order ID.
|
|
5139
5200
|
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
5140
5201
|
* @public
|
|
5141
|
-
* @documentationMaturity preview
|
|
5142
5202
|
* @requiredField customAdditionalFees
|
|
5143
5203
|
* @requiredField draftOrderId
|
|
5144
5204
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
@@ -5152,7 +5212,6 @@ declare function deleteCustomAdditionalFees(draftOrderId: string, customAddition
|
|
|
5152
5212
|
* Sets shipping information on a draft order.
|
|
5153
5213
|
* @param draftOrderId - Draft order ID.
|
|
5154
5214
|
* @public
|
|
5155
|
-
* @documentationMaturity preview
|
|
5156
5215
|
* @requiredField draftOrderId
|
|
5157
5216
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
5158
5217
|
* @applicableIdentity APP
|
|
@@ -5173,7 +5232,6 @@ interface SetShippingInfoOptions {
|
|
|
5173
5232
|
* Sets buyer info on a draft order.
|
|
5174
5233
|
* @param draftOrderId - Draft order ID.
|
|
5175
5234
|
* @public
|
|
5176
|
-
* @documentationMaturity preview
|
|
5177
5235
|
* @requiredField draftOrderId
|
|
5178
5236
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
5179
5237
|
* @applicableIdentity APP
|
|
@@ -5194,7 +5252,6 @@ interface SetBuyerInfoOptions {
|
|
|
5194
5252
|
* Sets recipient info on a draft order.
|
|
5195
5253
|
* @param draftOrderId - Draft order ID.
|
|
5196
5254
|
* @public
|
|
5197
|
-
* @documentationMaturity preview
|
|
5198
5255
|
* @requiredField draftOrderId
|
|
5199
5256
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
5200
5257
|
* @applicableIdentity APP
|
|
@@ -5215,7 +5272,6 @@ interface SetRecipientInfoOptions {
|
|
|
5215
5272
|
* Sets billing info on a draft order.
|
|
5216
5273
|
* @param draftOrderId - Draft order ID.
|
|
5217
5274
|
* @public
|
|
5218
|
-
* @documentationMaturity preview
|
|
5219
5275
|
* @requiredField draftOrderId
|
|
5220
5276
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
5221
5277
|
* @applicableIdentity APP
|
|
@@ -5243,7 +5299,6 @@ interface SetBillingInfoOptions {
|
|
|
5243
5299
|
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
5244
5300
|
* @param draftOrderId - Draft order ID.
|
|
5245
5301
|
* @public
|
|
5246
|
-
* @documentationMaturity preview
|
|
5247
5302
|
* @requiredField draftOrderId
|
|
5248
5303
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5249
5304
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5261,7 +5316,6 @@ declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<G
|
|
|
5261
5316
|
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
5262
5317
|
* @param orderId - Order ID.
|
|
5263
5318
|
* @public
|
|
5264
|
-
* @documentationMaturity preview
|
|
5265
5319
|
* @requiredField orderId
|
|
5266
5320
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5267
5321
|
* @applicableIdentity APP
|
|
@@ -5278,7 +5332,6 @@ declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullabl
|
|
|
5278
5332
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5279
5333
|
* @param draftOrderId - Draft order ID.
|
|
5280
5334
|
* @public
|
|
5281
|
-
* @documentationMaturity preview
|
|
5282
5335
|
* @requiredField draftOrderId
|
|
5283
5336
|
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
5284
5337
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5306,7 +5359,6 @@ interface CommitDraftOrderOptions {
|
|
|
5306
5359
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5307
5360
|
* @param draftOrderId - Draft order ID.
|
|
5308
5361
|
* @public
|
|
5309
|
-
* @documentationMaturity preview
|
|
5310
5362
|
* @requiredField draftOrderId
|
|
5311
5363
|
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
5312
5364
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5333,7 +5385,6 @@ interface CreateOrderFromDraftOptions {
|
|
|
5333
5385
|
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
5334
5386
|
* @param draftOrderId - Draft order ID.
|
|
5335
5387
|
* @public
|
|
5336
|
-
* @documentationMaturity preview
|
|
5337
5388
|
* @requiredField draftOrderId
|
|
5338
5389
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
5339
5390
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
@@ -5349,7 +5400,6 @@ declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
|
5349
5400
|
* 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).
|
|
5350
5401
|
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
5351
5402
|
* @public
|
|
5352
|
-
* @documentationMaturity preview
|
|
5353
5403
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5354
5404
|
* @applicableIdentity APP
|
|
5355
5405
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
@@ -5371,65 +5421,46 @@ interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
|
5371
5421
|
interface DraftOrdersQueryBuilder {
|
|
5372
5422
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5373
5423
|
* @param value - Value to compare against.
|
|
5374
|
-
* @documentationMaturity preview
|
|
5375
5424
|
*/
|
|
5376
5425
|
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5377
5426
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5378
5427
|
* @param value - Value to compare against.
|
|
5379
|
-
* @documentationMaturity preview
|
|
5380
5428
|
*/
|
|
5381
5429
|
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5382
5430
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5383
5431
|
* @param value - Value to compare against.
|
|
5384
|
-
* @documentationMaturity preview
|
|
5385
5432
|
*/
|
|
5386
5433
|
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5387
5434
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5388
5435
|
* @param value - Value to compare against.
|
|
5389
|
-
* @documentationMaturity preview
|
|
5390
5436
|
*/
|
|
5391
5437
|
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5392
5438
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5393
5439
|
* @param value - Value to compare against.
|
|
5394
|
-
* @documentationMaturity preview
|
|
5395
5440
|
*/
|
|
5396
5441
|
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5397
5442
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5398
5443
|
* @param value - Value to compare against.
|
|
5399
|
-
* @documentationMaturity preview
|
|
5400
5444
|
*/
|
|
5401
5445
|
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5402
5446
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
5403
5447
|
* @param string - String to compare against. Case-insensitive.
|
|
5404
|
-
* @documentationMaturity preview
|
|
5405
5448
|
*/
|
|
5406
5449
|
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
5407
5450
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
5408
5451
|
* @param values - List of values to compare against.
|
|
5409
|
-
* @documentationMaturity preview
|
|
5410
5452
|
*/
|
|
5411
5453
|
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
5412
|
-
/** @documentationMaturity preview */
|
|
5413
5454
|
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5414
|
-
/** @documentationMaturity preview */
|
|
5415
5455
|
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
5416
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5417
|
-
* @documentationMaturity preview
|
|
5418
|
-
*/
|
|
5456
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5419
5457
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5420
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5421
|
-
* @documentationMaturity preview
|
|
5422
|
-
*/
|
|
5458
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5423
5459
|
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5424
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
5425
|
-
* @documentationMaturity preview
|
|
5426
|
-
*/
|
|
5460
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
5427
5461
|
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
5428
|
-
/** @param cursor - A pointer to specific record
|
|
5429
|
-
* @documentationMaturity preview
|
|
5430
|
-
*/
|
|
5462
|
+
/** @param cursor - A pointer to specific record */
|
|
5431
5463
|
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
5432
|
-
/** @documentationMaturity preview */
|
|
5433
5464
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
5434
5465
|
}
|
|
5435
5466
|
/**
|
|
@@ -5504,7 +5535,6 @@ type DraftOrderQuery = {
|
|
|
5504
5535
|
* @param _id - ID of the entity to update.
|
|
5505
5536
|
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
5506
5537
|
* @public
|
|
5507
|
-
* @documentationMaturity preview
|
|
5508
5538
|
* @requiredField _id
|
|
5509
5539
|
* @requiredField namespace
|
|
5510
5540
|
* @requiredField options
|
|
@@ -5527,7 +5557,6 @@ interface UpdateExtendedFieldsOptions {
|
|
|
5527
5557
|
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
5528
5558
|
* @param draftOrderId - Draft order ID.
|
|
5529
5559
|
* @public
|
|
5530
|
-
* @documentationMaturity preview
|
|
5531
5560
|
* @requiredField draftOrderId
|
|
5532
5561
|
* @requiredField options
|
|
5533
5562
|
* @requiredField options.taxExempt
|
|
@@ -5552,7 +5581,6 @@ interface SetTaxExemptionOptions {
|
|
|
5552
5581
|
* 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.
|
|
5553
5582
|
* @param draftOrderId - Draft order ID.
|
|
5554
5583
|
* @public
|
|
5555
|
-
* @documentationMaturity preview
|
|
5556
5584
|
* @requiredField draftOrderId
|
|
5557
5585
|
* @requiredField options.businessLocation._id
|
|
5558
5586
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
@@ -5567,4 +5595,4 @@ interface SetBusinessLocationOptions {
|
|
|
5567
5595
|
businessLocation?: Location;
|
|
5568
5596
|
}
|
|
5569
5597
|
|
|
5570
|
-
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 ChargebackCreated, type ChargebackReversed, type Color, type CommitDraftOrderApplicationErrors, type CommitDraftOrderOptions, type CommitDraftOrderRequest, type CommitDraftOrderResponse, type CommonQueryWithEntityContext, 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 CustomAllowedActions, 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 DepositDetails, type DepositDetailsDepositOneOf, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesOverride, 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 DraftOrderQuery, type DraftOrderQuerySpec, 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 FormIdentifier, type FormInfo, 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, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemAmount, type LineItemChangeDetails, type LineItemChanges, type LineItemDescriptionLineChange, type LineItemDiscount, type LineItemExchangeData, type LineItemModifiersChange, type LineItemPriceChange, type LineItemProductNameChange, 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 ModifiersGroupsOverride, type NewExchangeOrderCreated, NonDraftableReason, type NonDraftableReasonWithLiterals, type Order, OrderActionType, type OrderActionTypeWithLiterals, OrderActivityTypeEnumActivityType, type OrderActivityTypeEnumActivityTypeWithLiterals, type OrderChange, type OrderChangeValueOneOf, type OrderCreateNotifications, type OrderCreateSettings, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, type OrderSettings, type OrderSettingsAllowedActionsOneOf, 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 SetDepositApplicationErrors, type SetDepositOptions, type SetDepositRequest, type SetDepositResponse, 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, typedQueryDraftOrders, updateExtendedFields, updateLineItems };
|
|
5598
|
+
export { type ActionEvent, type Activity, type ActivityContentOneOf, ActivityType, type ActivityTypeWithLiterals, type AddLineItemsToDraftOrderApplicationErrors, type AddLineItemsToDraftOrderOptions, type AddLineItemsToDraftOrderRequest, type AddLineItemsToDraftOrderResponse, type AdditionalFee, type AdditionalFeeDetails, type AdditionalFeeOption, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, 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, ChargeType, type ChargeTypeWithLiterals, type ChargebackCreated, type ChargebackReversed, type Color, type CommitDraftOrderApplicationErrors, type CommitDraftOrderOptions, type CommitDraftOrderRequest, type CommitDraftOrderResponse, type CommonQueryWithEntityContext, 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 CustomAllowedActions, 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 DepositDetails, type DepositDetailsDepositOneOf, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesOverride, 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 DraftOrderQuery, type DraftOrderQuerySpec, 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 FormIdentifier, type FormInfo, 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, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemAmount, type LineItemChangeDetails, type LineItemChanges, type LineItemDescriptionLineChange, type LineItemDiscount, type LineItemExchangeData, type LineItemModifiersChange, type LineItemPriceChange, type LineItemProductNameChange, 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 ModifiersGroupsOverride, type NewExchangeOrderCreated, NonDraftableReason, type NonDraftableReasonWithLiterals, type Order, OrderActionType, type OrderActionTypeWithLiterals, OrderActivityTypeEnumActivityType, type OrderActivityTypeEnumActivityTypeWithLiterals, type OrderChange, type OrderChangeValueOneOf, type OrderCreateNotifications, type OrderCreateSettings, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, type OrderSettings, type OrderSettingsAllowedActionsOneOf, 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 PlatformFee, type PlatformFeeSummary, 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 SetDepositApplicationErrors, type SetDepositOptions, type SetDepositRequest, type SetDepositResponse, 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, typedQueryDraftOrders, updateExtendedFields, updateLineItems };
|
|
@@ -21,10 +21,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
21
21
|
var index_typings_exports = {};
|
|
22
22
|
__export(index_typings_exports, {
|
|
23
23
|
ActivityType: () => ActivityType,
|
|
24
|
+
AdditionalFeeSource: () => AdditionalFeeSource,
|
|
24
25
|
AdjustmentType: () => AdjustmentType,
|
|
25
26
|
AppliedDiscountDiscountType: () => AppliedDiscountDiscountType,
|
|
26
27
|
AttributionSource: () => AttributionSource,
|
|
27
28
|
ChannelType: () => ChannelType,
|
|
29
|
+
ChargeType: () => ChargeType,
|
|
28
30
|
DescriptionLineType: () => DescriptionLineType,
|
|
29
31
|
DiscountReason: () => DiscountReason,
|
|
30
32
|
DiscountType: () => DiscountType,
|
|
@@ -3338,6 +3340,15 @@ var PickupDetailsPickupMethod = /* @__PURE__ */ ((PickupDetailsPickupMethod2) =>
|
|
|
3338
3340
|
PickupDetailsPickupMethod2["PICKUP_POINT"] = "PICKUP_POINT";
|
|
3339
3341
|
return PickupDetailsPickupMethod2;
|
|
3340
3342
|
})(PickupDetailsPickupMethod || {});
|
|
3343
|
+
var AdditionalFeeSource = /* @__PURE__ */ ((AdditionalFeeSource2) => {
|
|
3344
|
+
AdditionalFeeSource2["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
|
|
3345
|
+
AdditionalFeeSource2["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
|
|
3346
|
+
AdditionalFeeSource2["ITEM"] = "ITEM";
|
|
3347
|
+
AdditionalFeeSource2["MANUAL"] = "MANUAL";
|
|
3348
|
+
AdditionalFeeSource2["SHIPPING"] = "SHIPPING";
|
|
3349
|
+
AdditionalFeeSource2["PLATFORM"] = "PLATFORM";
|
|
3350
|
+
return AdditionalFeeSource2;
|
|
3351
|
+
})(AdditionalFeeSource || {});
|
|
3341
3352
|
var SourceType = /* @__PURE__ */ ((SourceType2) => {
|
|
3342
3353
|
SourceType2["ORIGINAL_ORDER"] = "ORIGINAL_ORDER";
|
|
3343
3354
|
SourceType2["AUTOMATIC"] = "AUTOMATIC";
|
|
@@ -3367,6 +3378,12 @@ var WeightUnit = /* @__PURE__ */ ((WeightUnit2) => {
|
|
|
3367
3378
|
WeightUnit2["LB"] = "LB";
|
|
3368
3379
|
return WeightUnit2;
|
|
3369
3380
|
})(WeightUnit || {});
|
|
3381
|
+
var ChargeType = /* @__PURE__ */ ((ChargeType2) => {
|
|
3382
|
+
ChargeType2["UNKNOWN_CHARGE_TYPE"] = "UNKNOWN_CHARGE_TYPE";
|
|
3383
|
+
ChargeType2["PASS_ON"] = "PASS_ON";
|
|
3384
|
+
ChargeType2["ABSORBED"] = "ABSORBED";
|
|
3385
|
+
return ChargeType2;
|
|
3386
|
+
})(ChargeType || {});
|
|
3370
3387
|
var PickupMethod = /* @__PURE__ */ ((PickupMethod2) => {
|
|
3371
3388
|
PickupMethod2["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
|
|
3372
3389
|
PickupMethod2["STORE_PICKUP"] = "STORE_PICKUP";
|
|
@@ -5331,10 +5348,12 @@ async function setBusinessLocation2(draftOrderId, options) {
|
|
|
5331
5348
|
// Annotate the CommonJS export names for ESM import in node:
|
|
5332
5349
|
0 && (module.exports = {
|
|
5333
5350
|
ActivityType,
|
|
5351
|
+
AdditionalFeeSource,
|
|
5334
5352
|
AdjustmentType,
|
|
5335
5353
|
AppliedDiscountDiscountType,
|
|
5336
5354
|
AttributionSource,
|
|
5337
5355
|
ChannelType,
|
|
5356
|
+
ChargeType,
|
|
5338
5357
|
DescriptionLineType,
|
|
5339
5358
|
DiscountReason,
|
|
5340
5359
|
DiscountType,
|