@wix/auto_sdk_ecom_draft-orders 1.0.98 → 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 +1 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +13 -50
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +6 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +13 -50
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +6 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +10 -62
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +6 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +10 -62
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +6 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2373,20 +2373,11 @@ interface LineItemChangeDetails {
|
|
|
2373
2373
|
* For example, when price is `0` but additional details about the actual price are needed - `"Starts at $67"`.
|
|
2374
2374
|
*/
|
|
2375
2375
|
newPriceDescription?: PriceDescription;
|
|
2376
|
-
/**
|
|
2377
|
-
* New product name.
|
|
2378
|
-
* @internal
|
|
2379
|
-
*/
|
|
2376
|
+
/** New product name. */
|
|
2380
2377
|
newProductName?: ProductName;
|
|
2381
|
-
/**
|
|
2382
|
-
* New description lines.
|
|
2383
|
-
* @internal
|
|
2384
|
-
*/
|
|
2378
|
+
/** New description lines. */
|
|
2385
2379
|
newDescriptionLines?: DescriptionLinesOverride;
|
|
2386
|
-
/**
|
|
2387
|
-
* New modifier groups.
|
|
2388
|
-
* @internal
|
|
2389
|
-
*/
|
|
2380
|
+
/** New modifier groups. */
|
|
2390
2381
|
newModifierGroups?: ModifiersGroupsOverride;
|
|
2391
2382
|
}
|
|
2392
2383
|
interface ModifiersGroupsOverride {
|
|
@@ -5174,7 +5165,6 @@ interface DraftOrderCreatedEnvelope {
|
|
|
5174
5165
|
* @webhook
|
|
5175
5166
|
* @eventType wix.ecom.v1.draft_order_created
|
|
5176
5167
|
* @slug created
|
|
5177
|
-
* @documentationMaturity preview
|
|
5178
5168
|
*/
|
|
5179
5169
|
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
5180
5170
|
interface DraftOrderDeletedEnvelope {
|
|
@@ -5195,7 +5185,6 @@ interface DraftOrderDeletedEnvelope {
|
|
|
5195
5185
|
* @webhook
|
|
5196
5186
|
* @eventType wix.ecom.v1.draft_order_deleted
|
|
5197
5187
|
* @slug deleted
|
|
5198
|
-
* @documentationMaturity preview
|
|
5199
5188
|
*/
|
|
5200
5189
|
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
5201
5190
|
interface DraftOrderUpdatedEnvelope {
|
|
@@ -5218,7 +5207,6 @@ interface DraftOrderUpdatedEnvelope {
|
|
|
5218
5207
|
* @webhook
|
|
5219
5208
|
* @eventType wix.ecom.v1.draft_order_updated
|
|
5220
5209
|
* @slug updated
|
|
5221
|
-
* @documentationMaturity preview
|
|
5222
5210
|
*/
|
|
5223
5211
|
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
5224
5212
|
/**
|
|
@@ -5228,7 +5216,6 @@ declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope)
|
|
|
5228
5216
|
* To complete a draft and update the original order, call Commit Draft Order.
|
|
5229
5217
|
* @param orderId - ID of the order to create a draft for.
|
|
5230
5218
|
* @public
|
|
5231
|
-
* @documentationMaturity preview
|
|
5232
5219
|
* @requiredField orderId
|
|
5233
5220
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5234
5221
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5244,7 +5231,6 @@ declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<Cre
|
|
|
5244
5231
|
*
|
|
5245
5232
|
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
5246
5233
|
* @public
|
|
5247
|
-
* @documentationMaturity preview
|
|
5248
5234
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5249
5235
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
5250
5236
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
@@ -5258,7 +5244,6 @@ declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDr
|
|
|
5258
5244
|
* Adds catalog or custom line items to a draft order.
|
|
5259
5245
|
* @param draftOrderId - Draft order ID.
|
|
5260
5246
|
* @public
|
|
5261
|
-
* @documentationMaturity preview
|
|
5262
5247
|
* @requiredField draftOrderId
|
|
5263
5248
|
* @requiredField options.catalogLineItems.catalogReference
|
|
5264
5249
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
@@ -5293,15 +5278,16 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
5293
5278
|
* @param draftOrderId - Draft order ID.
|
|
5294
5279
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
5295
5280
|
* @public
|
|
5296
|
-
* @documentationMaturity preview
|
|
5297
5281
|
* @requiredField draftOrderId
|
|
5298
5282
|
* @requiredField lineItemChanges
|
|
5299
5283
|
* @requiredField lineItemChanges.lineItemId
|
|
5284
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups._id
|
|
5285
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups.modifiers._id
|
|
5300
5286
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
5301
5287
|
* @applicableIdentity APP
|
|
5302
5288
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
5303
5289
|
*/
|
|
5304
|
-
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> & {
|
|
5305
5291
|
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
5306
5292
|
}>;
|
|
5307
5293
|
/**
|
|
@@ -5341,7 +5327,6 @@ interface SetDepositOptions {
|
|
|
5341
5327
|
*
|
|
5342
5328
|
* Any existing discounts that are not passed will not change.
|
|
5343
5329
|
* @public
|
|
5344
|
-
* @documentationMaturity preview
|
|
5345
5330
|
* @requiredField discounts
|
|
5346
5331
|
* @requiredField discounts._id
|
|
5347
5332
|
* @requiredField discounts.applied
|
|
@@ -5360,7 +5345,6 @@ declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<
|
|
|
5360
5345
|
* To apply them, use Set Discounts.
|
|
5361
5346
|
* @param draftOrderId - Draft order ID.
|
|
5362
5347
|
* @public
|
|
5363
|
-
* @documentationMaturity preview
|
|
5364
5348
|
* @requiredField draftOrderId
|
|
5365
5349
|
* @requiredField options.discounts.amount.amount
|
|
5366
5350
|
* @requiredField options.discounts.discountType
|
|
@@ -5387,7 +5371,6 @@ interface CreateCustomDiscountsOptions {
|
|
|
5387
5371
|
* @param draftOrderId - Draft order ID.
|
|
5388
5372
|
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
5389
5373
|
* @public
|
|
5390
|
-
* @documentationMaturity preview
|
|
5391
5374
|
* @requiredField discountIds
|
|
5392
5375
|
* @requiredField draftOrderId
|
|
5393
5376
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
@@ -5407,7 +5390,6 @@ declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string
|
|
|
5407
5390
|
*
|
|
5408
5391
|
* Any existing additional fees that are not passed will not change.
|
|
5409
5392
|
* @public
|
|
5410
|
-
* @documentationMaturity preview
|
|
5411
5393
|
* @requiredField additionalFees
|
|
5412
5394
|
* @requiredField additionalFees._id
|
|
5413
5395
|
* @requiredField additionalFees.applied
|
|
@@ -5426,7 +5408,6 @@ declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNull
|
|
|
5426
5408
|
* To apply them, use Set Additional Fees.
|
|
5427
5409
|
* @param draftOrderId - Draft order ID.
|
|
5428
5410
|
* @public
|
|
5429
|
-
* @documentationMaturity preview
|
|
5430
5411
|
* @requiredField draftOrderId
|
|
5431
5412
|
* @requiredField options.customAdditionalFees.name
|
|
5432
5413
|
* @requiredField options.customAdditionalFees.price
|
|
@@ -5453,7 +5434,6 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
5453
5434
|
* @param draftOrderId - Draft order ID.
|
|
5454
5435
|
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
5455
5436
|
* @public
|
|
5456
|
-
* @documentationMaturity preview
|
|
5457
5437
|
* @requiredField customAdditionalFees
|
|
5458
5438
|
* @requiredField draftOrderId
|
|
5459
5439
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
@@ -5467,7 +5447,6 @@ declare function deleteCustomAdditionalFees(draftOrderId: string, customAddition
|
|
|
5467
5447
|
* Sets shipping information on a draft order.
|
|
5468
5448
|
* @param draftOrderId - Draft order ID.
|
|
5469
5449
|
* @public
|
|
5470
|
-
* @documentationMaturity preview
|
|
5471
5450
|
* @requiredField draftOrderId
|
|
5472
5451
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
5473
5452
|
* @applicableIdentity APP
|
|
@@ -5488,7 +5467,6 @@ interface SetShippingInfoOptions {
|
|
|
5488
5467
|
* Sets buyer info on a draft order.
|
|
5489
5468
|
* @param draftOrderId - Draft order ID.
|
|
5490
5469
|
* @public
|
|
5491
|
-
* @documentationMaturity preview
|
|
5492
5470
|
* @requiredField draftOrderId
|
|
5493
5471
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
5494
5472
|
* @applicableIdentity APP
|
|
@@ -5509,7 +5487,6 @@ interface SetBuyerInfoOptions {
|
|
|
5509
5487
|
* Sets recipient info on a draft order.
|
|
5510
5488
|
* @param draftOrderId - Draft order ID.
|
|
5511
5489
|
* @public
|
|
5512
|
-
* @documentationMaturity preview
|
|
5513
5490
|
* @requiredField draftOrderId
|
|
5514
5491
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
5515
5492
|
* @applicableIdentity APP
|
|
@@ -5530,7 +5507,6 @@ interface SetRecipientInfoOptions {
|
|
|
5530
5507
|
* Sets billing info on a draft order.
|
|
5531
5508
|
* @param draftOrderId - Draft order ID.
|
|
5532
5509
|
* @public
|
|
5533
|
-
* @documentationMaturity preview
|
|
5534
5510
|
* @requiredField draftOrderId
|
|
5535
5511
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
5536
5512
|
* @applicableIdentity APP
|
|
@@ -5558,7 +5534,6 @@ interface SetBillingInfoOptions {
|
|
|
5558
5534
|
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
5559
5535
|
* @param draftOrderId - Draft order ID.
|
|
5560
5536
|
* @public
|
|
5561
|
-
* @documentationMaturity preview
|
|
5562
5537
|
* @requiredField draftOrderId
|
|
5563
5538
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5564
5539
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5576,7 +5551,6 @@ declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<G
|
|
|
5576
5551
|
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
5577
5552
|
* @param orderId - Order ID.
|
|
5578
5553
|
* @public
|
|
5579
|
-
* @documentationMaturity preview
|
|
5580
5554
|
* @requiredField orderId
|
|
5581
5555
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5582
5556
|
* @applicableIdentity APP
|
|
@@ -5593,7 +5567,6 @@ declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullabl
|
|
|
5593
5567
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5594
5568
|
* @param draftOrderId - Draft order ID.
|
|
5595
5569
|
* @public
|
|
5596
|
-
* @documentationMaturity preview
|
|
5597
5570
|
* @requiredField draftOrderId
|
|
5598
5571
|
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
5599
5572
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5621,7 +5594,6 @@ interface CommitDraftOrderOptions {
|
|
|
5621
5594
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5622
5595
|
* @param draftOrderId - Draft order ID.
|
|
5623
5596
|
* @public
|
|
5624
|
-
* @documentationMaturity preview
|
|
5625
5597
|
* @requiredField draftOrderId
|
|
5626
5598
|
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
5627
5599
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5648,7 +5620,6 @@ interface CreateOrderFromDraftOptions {
|
|
|
5648
5620
|
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
5649
5621
|
* @param draftOrderId - Draft order ID.
|
|
5650
5622
|
* @public
|
|
5651
|
-
* @documentationMaturity preview
|
|
5652
5623
|
* @requiredField draftOrderId
|
|
5653
5624
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
5654
5625
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
@@ -5664,7 +5635,6 @@ declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
|
5664
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).
|
|
5665
5636
|
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
5666
5637
|
* @public
|
|
5667
|
-
* @documentationMaturity preview
|
|
5668
5638
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5669
5639
|
* @applicableIdentity APP
|
|
5670
5640
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
@@ -5686,65 +5656,46 @@ interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
|
5686
5656
|
interface DraftOrdersQueryBuilder {
|
|
5687
5657
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5688
5658
|
* @param value - Value to compare against.
|
|
5689
|
-
* @documentationMaturity preview
|
|
5690
5659
|
*/
|
|
5691
5660
|
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5692
5661
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5693
5662
|
* @param value - Value to compare against.
|
|
5694
|
-
* @documentationMaturity preview
|
|
5695
5663
|
*/
|
|
5696
5664
|
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5697
5665
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5698
5666
|
* @param value - Value to compare against.
|
|
5699
|
-
* @documentationMaturity preview
|
|
5700
5667
|
*/
|
|
5701
5668
|
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5702
5669
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5703
5670
|
* @param value - Value to compare against.
|
|
5704
|
-
* @documentationMaturity preview
|
|
5705
5671
|
*/
|
|
5706
5672
|
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5707
5673
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5708
5674
|
* @param value - Value to compare against.
|
|
5709
|
-
* @documentationMaturity preview
|
|
5710
5675
|
*/
|
|
5711
5676
|
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5712
5677
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5713
5678
|
* @param value - Value to compare against.
|
|
5714
|
-
* @documentationMaturity preview
|
|
5715
5679
|
*/
|
|
5716
5680
|
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5717
5681
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
5718
5682
|
* @param string - String to compare against. Case-insensitive.
|
|
5719
|
-
* @documentationMaturity preview
|
|
5720
5683
|
*/
|
|
5721
5684
|
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
5722
5685
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
5723
5686
|
* @param values - List of values to compare against.
|
|
5724
|
-
* @documentationMaturity preview
|
|
5725
5687
|
*/
|
|
5726
5688
|
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
5727
|
-
/** @documentationMaturity preview */
|
|
5728
5689
|
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5729
|
-
/** @documentationMaturity preview */
|
|
5730
5690
|
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
5731
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5732
|
-
* @documentationMaturity preview
|
|
5733
|
-
*/
|
|
5691
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5734
5692
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5735
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5736
|
-
* @documentationMaturity preview
|
|
5737
|
-
*/
|
|
5693
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5738
5694
|
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5739
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
5740
|
-
* @documentationMaturity preview
|
|
5741
|
-
*/
|
|
5695
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
5742
5696
|
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
5743
|
-
/** @param cursor - A pointer to specific record
|
|
5744
|
-
* @documentationMaturity preview
|
|
5745
|
-
*/
|
|
5697
|
+
/** @param cursor - A pointer to specific record */
|
|
5746
5698
|
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
5747
|
-
/** @documentationMaturity preview */
|
|
5748
5699
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
5749
5700
|
}
|
|
5750
5701
|
/**
|
|
@@ -5819,7 +5770,6 @@ type DraftOrderQuery = {
|
|
|
5819
5770
|
* @param _id - ID of the entity to update.
|
|
5820
5771
|
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
5821
5772
|
* @public
|
|
5822
|
-
* @documentationMaturity preview
|
|
5823
5773
|
* @requiredField _id
|
|
5824
5774
|
* @requiredField namespace
|
|
5825
5775
|
* @requiredField options
|
|
@@ -5842,7 +5792,6 @@ interface UpdateExtendedFieldsOptions {
|
|
|
5842
5792
|
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
5843
5793
|
* @param draftOrderId - Draft order ID.
|
|
5844
5794
|
* @public
|
|
5845
|
-
* @documentationMaturity preview
|
|
5846
5795
|
* @requiredField draftOrderId
|
|
5847
5796
|
* @requiredField options
|
|
5848
5797
|
* @requiredField options.taxExempt
|
|
@@ -5867,7 +5816,6 @@ interface SetTaxExemptionOptions {
|
|
|
5867
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.
|
|
5868
5817
|
* @param draftOrderId - Draft order ID.
|
|
5869
5818
|
* @public
|
|
5870
|
-
* @documentationMaturity preview
|
|
5871
5819
|
* @requiredField draftOrderId
|
|
5872
5820
|
* @requiredField options.businessLocation._id
|
|
5873
5821
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|