@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
|
@@ -155,6 +155,11 @@ interface DraftOrder {
|
|
|
155
155
|
* @internal
|
|
156
156
|
*/
|
|
157
157
|
depositDetails?: DepositDetails;
|
|
158
|
+
/**
|
|
159
|
+
* Summary of all platform fees added to the order.
|
|
160
|
+
* @internal
|
|
161
|
+
*/
|
|
162
|
+
platformFeeSummary?: PlatformFeeSummary;
|
|
158
163
|
}
|
|
159
164
|
interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
160
165
|
/** Whether the line item was added as part of the draft. */
|
|
@@ -1341,7 +1346,27 @@ interface AdditionalFee {
|
|
|
1341
1346
|
* @max 999
|
|
1342
1347
|
*/
|
|
1343
1348
|
subscriptionCycles?: number | null;
|
|
1349
|
+
/**
|
|
1350
|
+
* Specifies the entity that added the additional fee.
|
|
1351
|
+
* @internal
|
|
1352
|
+
*/
|
|
1353
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
1354
|
+
}
|
|
1355
|
+
declare enum AdditionalFeeSource {
|
|
1356
|
+
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1357
|
+
/** The additional fee was added by an additional fee service plugin. */
|
|
1358
|
+
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
1359
|
+
/** The additional fee was added to the item by a catalog or custom line item. */
|
|
1360
|
+
ITEM = "ITEM",
|
|
1361
|
+
/** The additional fee was added manually on request. */
|
|
1362
|
+
MANUAL = "MANUAL",
|
|
1363
|
+
/** The additional fee was added by the shipping provider. */
|
|
1364
|
+
SHIPPING = "SHIPPING",
|
|
1365
|
+
/** The additional fee was added by the Wix eCommerce platform. */
|
|
1366
|
+
PLATFORM = "PLATFORM"
|
|
1344
1367
|
}
|
|
1368
|
+
/** @enumType */
|
|
1369
|
+
type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING' | 'PLATFORM';
|
|
1345
1370
|
interface TaxDetails {
|
|
1346
1371
|
/** Whether the additional fee is taxable. */
|
|
1347
1372
|
taxable?: boolean;
|
|
@@ -1862,6 +1887,56 @@ interface DepositDetailsDepositOneOf {
|
|
|
1862
1887
|
*/
|
|
1863
1888
|
percentage?: string | null;
|
|
1864
1889
|
}
|
|
1890
|
+
interface PlatformFeeSummary {
|
|
1891
|
+
/** Total sum of all platform fees. */
|
|
1892
|
+
total?: Price;
|
|
1893
|
+
/** Total amount of platform fees with `PASS_ON` charge type. */
|
|
1894
|
+
totalPassOn?: Price;
|
|
1895
|
+
/** Total amount of platform fees with `ABSORBED` charge type. */
|
|
1896
|
+
totalAbsorbed?: Price;
|
|
1897
|
+
/**
|
|
1898
|
+
* Specific information about each platform fee.
|
|
1899
|
+
* @maxSize 300
|
|
1900
|
+
*/
|
|
1901
|
+
fees?: PlatformFee[];
|
|
1902
|
+
}
|
|
1903
|
+
interface PlatformFee {
|
|
1904
|
+
/** Platform fee name. */
|
|
1905
|
+
name?: TranslatableString;
|
|
1906
|
+
/** Platform fee amount. */
|
|
1907
|
+
amount?: Price;
|
|
1908
|
+
/**
|
|
1909
|
+
* ID of the line item the platform fee applies to.
|
|
1910
|
+
* @format GUID
|
|
1911
|
+
*/
|
|
1912
|
+
lineItemId?: string;
|
|
1913
|
+
/** Platform fee charge type. */
|
|
1914
|
+
chargeType?: ChargeTypeWithLiterals;
|
|
1915
|
+
/**
|
|
1916
|
+
* Percentage rate charged as platform fee.
|
|
1917
|
+
* The fee rate expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
|
|
1918
|
+
* @format DECIMAL_VALUE
|
|
1919
|
+
* @decimalValue options { gte:0, lte:1, maxScale:4 }
|
|
1920
|
+
*/
|
|
1921
|
+
percentageRate?: string;
|
|
1922
|
+
}
|
|
1923
|
+
declare enum ChargeType {
|
|
1924
|
+
UNKNOWN_CHARGE_TYPE = "UNKNOWN_CHARGE_TYPE",
|
|
1925
|
+
/**
|
|
1926
|
+
* Platform fee passed on to buyer.
|
|
1927
|
+
*
|
|
1928
|
+
* This type increases the order total, and is visible to the buyer and merchant as an additional fee.
|
|
1929
|
+
*/
|
|
1930
|
+
PASS_ON = "PASS_ON",
|
|
1931
|
+
/**
|
|
1932
|
+
* Platform fee absorbed by merchant.
|
|
1933
|
+
*
|
|
1934
|
+
* This type does not increase the order total, and is only visible to the merchant.
|
|
1935
|
+
*/
|
|
1936
|
+
ABSORBED = "ABSORBED"
|
|
1937
|
+
}
|
|
1938
|
+
/** @enumType */
|
|
1939
|
+
type ChargeTypeWithLiterals = ChargeType | 'UNKNOWN_CHARGE_TYPE' | 'PASS_ON' | 'ABSORBED';
|
|
1865
1940
|
interface CreateDraftOrderRequest {
|
|
1866
1941
|
/**
|
|
1867
1942
|
* ID of the order to create a draft for.
|
|
@@ -2298,20 +2373,11 @@ interface LineItemChangeDetails {
|
|
|
2298
2373
|
* For example, when price is `0` but additional details about the actual price are needed - `"Starts at $67"`.
|
|
2299
2374
|
*/
|
|
2300
2375
|
newPriceDescription?: PriceDescription;
|
|
2301
|
-
/**
|
|
2302
|
-
* New product name.
|
|
2303
|
-
* @internal
|
|
2304
|
-
*/
|
|
2376
|
+
/** New product name. */
|
|
2305
2377
|
newProductName?: ProductName;
|
|
2306
|
-
/**
|
|
2307
|
-
* New description lines.
|
|
2308
|
-
* @internal
|
|
2309
|
-
*/
|
|
2378
|
+
/** New description lines. */
|
|
2310
2379
|
newDescriptionLines?: DescriptionLinesOverride;
|
|
2311
|
-
/**
|
|
2312
|
-
* New modifier groups.
|
|
2313
|
-
* @internal
|
|
2314
|
-
*/
|
|
2380
|
+
/** New modifier groups. */
|
|
2315
2381
|
newModifierGroups?: ModifiersGroupsOverride;
|
|
2316
2382
|
}
|
|
2317
2383
|
interface ModifiersGroupsOverride {
|
|
@@ -2915,6 +2981,11 @@ interface Order {
|
|
|
2915
2981
|
* @maxSize 1000
|
|
2916
2982
|
*/
|
|
2917
2983
|
forms?: FormInfo[];
|
|
2984
|
+
/**
|
|
2985
|
+
* Summary of all platform fees added to the order.
|
|
2986
|
+
* @internal
|
|
2987
|
+
*/
|
|
2988
|
+
platformFeeSummary?: PlatformFeeSummary;
|
|
2918
2989
|
}
|
|
2919
2990
|
declare enum PaymentStatus {
|
|
2920
2991
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -4202,6 +4273,20 @@ interface V1BalanceSummary {
|
|
|
4202
4273
|
* @readonly
|
|
4203
4274
|
*/
|
|
4204
4275
|
chargebackReversal?: Price;
|
|
4276
|
+
/**
|
|
4277
|
+
* Sum of all charged platform fees.
|
|
4278
|
+
*
|
|
4279
|
+
* Note: `order.platformFeeSummary` holds the expected sum of platform fees.
|
|
4280
|
+
* @internal
|
|
4281
|
+
* @readonly
|
|
4282
|
+
*/
|
|
4283
|
+
platformFee?: Price;
|
|
4284
|
+
/**
|
|
4285
|
+
* Order total after platform fee.
|
|
4286
|
+
* @internal
|
|
4287
|
+
* @readonly
|
|
4288
|
+
*/
|
|
4289
|
+
totalAfterPlatformFee?: Price;
|
|
4205
4290
|
}
|
|
4206
4291
|
interface FulfillmentStatusesAggregate {
|
|
4207
4292
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -5080,7 +5165,6 @@ interface DraftOrderCreatedEnvelope {
|
|
|
5080
5165
|
* @webhook
|
|
5081
5166
|
* @eventType wix.ecom.v1.draft_order_created
|
|
5082
5167
|
* @slug created
|
|
5083
|
-
* @documentationMaturity preview
|
|
5084
5168
|
*/
|
|
5085
5169
|
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
5086
5170
|
interface DraftOrderDeletedEnvelope {
|
|
@@ -5101,7 +5185,6 @@ interface DraftOrderDeletedEnvelope {
|
|
|
5101
5185
|
* @webhook
|
|
5102
5186
|
* @eventType wix.ecom.v1.draft_order_deleted
|
|
5103
5187
|
* @slug deleted
|
|
5104
|
-
* @documentationMaturity preview
|
|
5105
5188
|
*/
|
|
5106
5189
|
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
5107
5190
|
interface DraftOrderUpdatedEnvelope {
|
|
@@ -5124,7 +5207,6 @@ interface DraftOrderUpdatedEnvelope {
|
|
|
5124
5207
|
* @webhook
|
|
5125
5208
|
* @eventType wix.ecom.v1.draft_order_updated
|
|
5126
5209
|
* @slug updated
|
|
5127
|
-
* @documentationMaturity preview
|
|
5128
5210
|
*/
|
|
5129
5211
|
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
5130
5212
|
/**
|
|
@@ -5134,7 +5216,6 @@ declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope)
|
|
|
5134
5216
|
* To complete a draft and update the original order, call Commit Draft Order.
|
|
5135
5217
|
* @param orderId - ID of the order to create a draft for.
|
|
5136
5218
|
* @public
|
|
5137
|
-
* @documentationMaturity preview
|
|
5138
5219
|
* @requiredField orderId
|
|
5139
5220
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5140
5221
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5150,7 +5231,6 @@ declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<Cre
|
|
|
5150
5231
|
*
|
|
5151
5232
|
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
5152
5233
|
* @public
|
|
5153
|
-
* @documentationMaturity preview
|
|
5154
5234
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5155
5235
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
5156
5236
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
@@ -5164,7 +5244,6 @@ declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDr
|
|
|
5164
5244
|
* Adds catalog or custom line items to a draft order.
|
|
5165
5245
|
* @param draftOrderId - Draft order ID.
|
|
5166
5246
|
* @public
|
|
5167
|
-
* @documentationMaturity preview
|
|
5168
5247
|
* @requiredField draftOrderId
|
|
5169
5248
|
* @requiredField options.catalogLineItems.catalogReference
|
|
5170
5249
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
@@ -5199,15 +5278,16 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
5199
5278
|
* @param draftOrderId - Draft order ID.
|
|
5200
5279
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
5201
5280
|
* @public
|
|
5202
|
-
* @documentationMaturity preview
|
|
5203
5281
|
* @requiredField draftOrderId
|
|
5204
5282
|
* @requiredField lineItemChanges
|
|
5205
5283
|
* @requiredField lineItemChanges.lineItemId
|
|
5284
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups._id
|
|
5285
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups.modifiers._id
|
|
5206
5286
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
5207
5287
|
* @applicableIdentity APP
|
|
5208
5288
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
5209
5289
|
*/
|
|
5210
|
-
declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`,
|
|
5290
|
+
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> & {
|
|
5211
5291
|
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
5212
5292
|
}>;
|
|
5213
5293
|
/**
|
|
@@ -5247,7 +5327,6 @@ interface SetDepositOptions {
|
|
|
5247
5327
|
*
|
|
5248
5328
|
* Any existing discounts that are not passed will not change.
|
|
5249
5329
|
* @public
|
|
5250
|
-
* @documentationMaturity preview
|
|
5251
5330
|
* @requiredField discounts
|
|
5252
5331
|
* @requiredField discounts._id
|
|
5253
5332
|
* @requiredField discounts.applied
|
|
@@ -5266,7 +5345,6 @@ declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<
|
|
|
5266
5345
|
* To apply them, use Set Discounts.
|
|
5267
5346
|
* @param draftOrderId - Draft order ID.
|
|
5268
5347
|
* @public
|
|
5269
|
-
* @documentationMaturity preview
|
|
5270
5348
|
* @requiredField draftOrderId
|
|
5271
5349
|
* @requiredField options.discounts.amount.amount
|
|
5272
5350
|
* @requiredField options.discounts.discountType
|
|
@@ -5293,7 +5371,6 @@ interface CreateCustomDiscountsOptions {
|
|
|
5293
5371
|
* @param draftOrderId - Draft order ID.
|
|
5294
5372
|
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
5295
5373
|
* @public
|
|
5296
|
-
* @documentationMaturity preview
|
|
5297
5374
|
* @requiredField discountIds
|
|
5298
5375
|
* @requiredField draftOrderId
|
|
5299
5376
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
@@ -5313,7 +5390,6 @@ declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string
|
|
|
5313
5390
|
*
|
|
5314
5391
|
* Any existing additional fees that are not passed will not change.
|
|
5315
5392
|
* @public
|
|
5316
|
-
* @documentationMaturity preview
|
|
5317
5393
|
* @requiredField additionalFees
|
|
5318
5394
|
* @requiredField additionalFees._id
|
|
5319
5395
|
* @requiredField additionalFees.applied
|
|
@@ -5332,7 +5408,6 @@ declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNull
|
|
|
5332
5408
|
* To apply them, use Set Additional Fees.
|
|
5333
5409
|
* @param draftOrderId - Draft order ID.
|
|
5334
5410
|
* @public
|
|
5335
|
-
* @documentationMaturity preview
|
|
5336
5411
|
* @requiredField draftOrderId
|
|
5337
5412
|
* @requiredField options.customAdditionalFees.name
|
|
5338
5413
|
* @requiredField options.customAdditionalFees.price
|
|
@@ -5359,7 +5434,6 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
5359
5434
|
* @param draftOrderId - Draft order ID.
|
|
5360
5435
|
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
5361
5436
|
* @public
|
|
5362
|
-
* @documentationMaturity preview
|
|
5363
5437
|
* @requiredField customAdditionalFees
|
|
5364
5438
|
* @requiredField draftOrderId
|
|
5365
5439
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
@@ -5373,7 +5447,6 @@ declare function deleteCustomAdditionalFees(draftOrderId: string, customAddition
|
|
|
5373
5447
|
* Sets shipping information on a draft order.
|
|
5374
5448
|
* @param draftOrderId - Draft order ID.
|
|
5375
5449
|
* @public
|
|
5376
|
-
* @documentationMaturity preview
|
|
5377
5450
|
* @requiredField draftOrderId
|
|
5378
5451
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
5379
5452
|
* @applicableIdentity APP
|
|
@@ -5394,7 +5467,6 @@ interface SetShippingInfoOptions {
|
|
|
5394
5467
|
* Sets buyer info on a draft order.
|
|
5395
5468
|
* @param draftOrderId - Draft order ID.
|
|
5396
5469
|
* @public
|
|
5397
|
-
* @documentationMaturity preview
|
|
5398
5470
|
* @requiredField draftOrderId
|
|
5399
5471
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
5400
5472
|
* @applicableIdentity APP
|
|
@@ -5415,7 +5487,6 @@ interface SetBuyerInfoOptions {
|
|
|
5415
5487
|
* Sets recipient info on a draft order.
|
|
5416
5488
|
* @param draftOrderId - Draft order ID.
|
|
5417
5489
|
* @public
|
|
5418
|
-
* @documentationMaturity preview
|
|
5419
5490
|
* @requiredField draftOrderId
|
|
5420
5491
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
5421
5492
|
* @applicableIdentity APP
|
|
@@ -5436,7 +5507,6 @@ interface SetRecipientInfoOptions {
|
|
|
5436
5507
|
* Sets billing info on a draft order.
|
|
5437
5508
|
* @param draftOrderId - Draft order ID.
|
|
5438
5509
|
* @public
|
|
5439
|
-
* @documentationMaturity preview
|
|
5440
5510
|
* @requiredField draftOrderId
|
|
5441
5511
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
5442
5512
|
* @applicableIdentity APP
|
|
@@ -5464,7 +5534,6 @@ interface SetBillingInfoOptions {
|
|
|
5464
5534
|
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
5465
5535
|
* @param draftOrderId - Draft order ID.
|
|
5466
5536
|
* @public
|
|
5467
|
-
* @documentationMaturity preview
|
|
5468
5537
|
* @requiredField draftOrderId
|
|
5469
5538
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5470
5539
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5482,7 +5551,6 @@ declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<G
|
|
|
5482
5551
|
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
5483
5552
|
* @param orderId - Order ID.
|
|
5484
5553
|
* @public
|
|
5485
|
-
* @documentationMaturity preview
|
|
5486
5554
|
* @requiredField orderId
|
|
5487
5555
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5488
5556
|
* @applicableIdentity APP
|
|
@@ -5499,7 +5567,6 @@ declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullabl
|
|
|
5499
5567
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5500
5568
|
* @param draftOrderId - Draft order ID.
|
|
5501
5569
|
* @public
|
|
5502
|
-
* @documentationMaturity preview
|
|
5503
5570
|
* @requiredField draftOrderId
|
|
5504
5571
|
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
5505
5572
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5527,7 +5594,6 @@ interface CommitDraftOrderOptions {
|
|
|
5527
5594
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5528
5595
|
* @param draftOrderId - Draft order ID.
|
|
5529
5596
|
* @public
|
|
5530
|
-
* @documentationMaturity preview
|
|
5531
5597
|
* @requiredField draftOrderId
|
|
5532
5598
|
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
5533
5599
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5554,7 +5620,6 @@ interface CreateOrderFromDraftOptions {
|
|
|
5554
5620
|
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
5555
5621
|
* @param draftOrderId - Draft order ID.
|
|
5556
5622
|
* @public
|
|
5557
|
-
* @documentationMaturity preview
|
|
5558
5623
|
* @requiredField draftOrderId
|
|
5559
5624
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
5560
5625
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
@@ -5570,7 +5635,6 @@ declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
|
5570
5635
|
* 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).
|
|
5571
5636
|
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
5572
5637
|
* @public
|
|
5573
|
-
* @documentationMaturity preview
|
|
5574
5638
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5575
5639
|
* @applicableIdentity APP
|
|
5576
5640
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
@@ -5592,65 +5656,46 @@ interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
|
5592
5656
|
interface DraftOrdersQueryBuilder {
|
|
5593
5657
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5594
5658
|
* @param value - Value to compare against.
|
|
5595
|
-
* @documentationMaturity preview
|
|
5596
5659
|
*/
|
|
5597
5660
|
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5598
5661
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5599
5662
|
* @param value - Value to compare against.
|
|
5600
|
-
* @documentationMaturity preview
|
|
5601
5663
|
*/
|
|
5602
5664
|
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5603
5665
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5604
5666
|
* @param value - Value to compare against.
|
|
5605
|
-
* @documentationMaturity preview
|
|
5606
5667
|
*/
|
|
5607
5668
|
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5608
5669
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5609
5670
|
* @param value - Value to compare against.
|
|
5610
|
-
* @documentationMaturity preview
|
|
5611
5671
|
*/
|
|
5612
5672
|
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5613
5673
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5614
5674
|
* @param value - Value to compare against.
|
|
5615
|
-
* @documentationMaturity preview
|
|
5616
5675
|
*/
|
|
5617
5676
|
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5618
5677
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5619
5678
|
* @param value - Value to compare against.
|
|
5620
|
-
* @documentationMaturity preview
|
|
5621
5679
|
*/
|
|
5622
5680
|
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5623
5681
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
5624
5682
|
* @param string - String to compare against. Case-insensitive.
|
|
5625
|
-
* @documentationMaturity preview
|
|
5626
5683
|
*/
|
|
5627
5684
|
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
5628
5685
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
5629
5686
|
* @param values - List of values to compare against.
|
|
5630
|
-
* @documentationMaturity preview
|
|
5631
5687
|
*/
|
|
5632
5688
|
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
5633
|
-
/** @documentationMaturity preview */
|
|
5634
5689
|
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5635
|
-
/** @documentationMaturity preview */
|
|
5636
5690
|
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
5637
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5638
|
-
* @documentationMaturity preview
|
|
5639
|
-
*/
|
|
5691
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5640
5692
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5641
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5642
|
-
* @documentationMaturity preview
|
|
5643
|
-
*/
|
|
5693
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5644
5694
|
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5645
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
5646
|
-
* @documentationMaturity preview
|
|
5647
|
-
*/
|
|
5695
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
5648
5696
|
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
5649
|
-
/** @param cursor - A pointer to specific record
|
|
5650
|
-
* @documentationMaturity preview
|
|
5651
|
-
*/
|
|
5697
|
+
/** @param cursor - A pointer to specific record */
|
|
5652
5698
|
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
5653
|
-
/** @documentationMaturity preview */
|
|
5654
5699
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
5655
5700
|
}
|
|
5656
5701
|
/**
|
|
@@ -5725,7 +5770,6 @@ type DraftOrderQuery = {
|
|
|
5725
5770
|
* @param _id - ID of the entity to update.
|
|
5726
5771
|
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
5727
5772
|
* @public
|
|
5728
|
-
* @documentationMaturity preview
|
|
5729
5773
|
* @requiredField _id
|
|
5730
5774
|
* @requiredField namespace
|
|
5731
5775
|
* @requiredField options
|
|
@@ -5748,7 +5792,6 @@ interface UpdateExtendedFieldsOptions {
|
|
|
5748
5792
|
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
5749
5793
|
* @param draftOrderId - Draft order ID.
|
|
5750
5794
|
* @public
|
|
5751
|
-
* @documentationMaturity preview
|
|
5752
5795
|
* @requiredField draftOrderId
|
|
5753
5796
|
* @requiredField options
|
|
5754
5797
|
* @requiredField options.taxExempt
|
|
@@ -5773,7 +5816,6 @@ interface SetTaxExemptionOptions {
|
|
|
5773
5816
|
* 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.
|
|
5774
5817
|
* @param draftOrderId - Draft order ID.
|
|
5775
5818
|
* @public
|
|
5776
|
-
* @documentationMaturity preview
|
|
5777
5819
|
* @requiredField draftOrderId
|
|
5778
5820
|
* @requiredField options.businessLocation._id
|
|
5779
5821
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
@@ -5788,4 +5830,4 @@ interface SetBusinessLocationOptions {
|
|
|
5788
5830
|
businessLocation?: Location;
|
|
5789
5831
|
}
|
|
5790
5832
|
|
|
5791
|
-
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, setDeposit, setDiscounts, setRecipientInfo, setShippingInfo, setTaxExemption, typedQueryDraftOrders, updateExtendedFields, updateLineItems };
|
|
5833
|
+
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, setDeposit, setDiscounts, setRecipientInfo, setShippingInfo, setTaxExemption, typedQueryDraftOrders, updateExtendedFields, updateLineItems };
|
|
@@ -3261,6 +3261,15 @@ var PickupDetailsPickupMethod = /* @__PURE__ */ ((PickupDetailsPickupMethod2) =>
|
|
|
3261
3261
|
PickupDetailsPickupMethod2["PICKUP_POINT"] = "PICKUP_POINT";
|
|
3262
3262
|
return PickupDetailsPickupMethod2;
|
|
3263
3263
|
})(PickupDetailsPickupMethod || {});
|
|
3264
|
+
var AdditionalFeeSource = /* @__PURE__ */ ((AdditionalFeeSource2) => {
|
|
3265
|
+
AdditionalFeeSource2["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
|
|
3266
|
+
AdditionalFeeSource2["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
|
|
3267
|
+
AdditionalFeeSource2["ITEM"] = "ITEM";
|
|
3268
|
+
AdditionalFeeSource2["MANUAL"] = "MANUAL";
|
|
3269
|
+
AdditionalFeeSource2["SHIPPING"] = "SHIPPING";
|
|
3270
|
+
AdditionalFeeSource2["PLATFORM"] = "PLATFORM";
|
|
3271
|
+
return AdditionalFeeSource2;
|
|
3272
|
+
})(AdditionalFeeSource || {});
|
|
3264
3273
|
var SourceType = /* @__PURE__ */ ((SourceType2) => {
|
|
3265
3274
|
SourceType2["ORIGINAL_ORDER"] = "ORIGINAL_ORDER";
|
|
3266
3275
|
SourceType2["AUTOMATIC"] = "AUTOMATIC";
|
|
@@ -3290,6 +3299,12 @@ var WeightUnit = /* @__PURE__ */ ((WeightUnit2) => {
|
|
|
3290
3299
|
WeightUnit2["LB"] = "LB";
|
|
3291
3300
|
return WeightUnit2;
|
|
3292
3301
|
})(WeightUnit || {});
|
|
3302
|
+
var ChargeType = /* @__PURE__ */ ((ChargeType2) => {
|
|
3303
|
+
ChargeType2["UNKNOWN_CHARGE_TYPE"] = "UNKNOWN_CHARGE_TYPE";
|
|
3304
|
+
ChargeType2["PASS_ON"] = "PASS_ON";
|
|
3305
|
+
ChargeType2["ABSORBED"] = "ABSORBED";
|
|
3306
|
+
return ChargeType2;
|
|
3307
|
+
})(ChargeType || {});
|
|
3293
3308
|
var PickupMethod = /* @__PURE__ */ ((PickupMethod2) => {
|
|
3294
3309
|
PickupMethod2["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
|
|
3295
3310
|
PickupMethod2["STORE_PICKUP"] = "STORE_PICKUP";
|
|
@@ -5253,10 +5268,12 @@ async function setBusinessLocation2(draftOrderId, options) {
|
|
|
5253
5268
|
}
|
|
5254
5269
|
export {
|
|
5255
5270
|
ActivityType,
|
|
5271
|
+
AdditionalFeeSource,
|
|
5256
5272
|
AdjustmentType,
|
|
5257
5273
|
AppliedDiscountDiscountType,
|
|
5258
5274
|
AttributionSource,
|
|
5259
5275
|
ChannelType,
|
|
5276
|
+
ChargeType,
|
|
5260
5277
|
DescriptionLineType,
|
|
5261
5278
|
DiscountReason,
|
|
5262
5279
|
DiscountType,
|