@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
|
@@ -2212,6 +2212,12 @@ interface LineItemChangeDetails {
|
|
|
2212
2212
|
* For example, when price is `0` but additional details about the actual price are needed - `"Starts at $67"`.
|
|
2213
2213
|
*/
|
|
2214
2214
|
newPriceDescription?: PriceDescription;
|
|
2215
|
+
/** New product name. */
|
|
2216
|
+
newProductName?: ProductName;
|
|
2217
|
+
/** New description lines. */
|
|
2218
|
+
newDescriptionLines?: DescriptionLinesOverride;
|
|
2219
|
+
/** New modifier groups. */
|
|
2220
|
+
newModifierGroups?: ModifiersGroupsOverride;
|
|
2215
2221
|
}
|
|
2216
2222
|
interface ModifiersGroupsOverride {
|
|
2217
2223
|
/**
|
|
@@ -4944,7 +4950,6 @@ interface DraftOrderCreatedEnvelope {
|
|
|
4944
4950
|
* @webhook
|
|
4945
4951
|
* @eventType wix.ecom.v1.draft_order_created
|
|
4946
4952
|
* @slug created
|
|
4947
|
-
* @documentationMaturity preview
|
|
4948
4953
|
*/
|
|
4949
4954
|
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4950
4955
|
interface DraftOrderDeletedEnvelope {
|
|
@@ -4965,7 +4970,6 @@ interface DraftOrderDeletedEnvelope {
|
|
|
4965
4970
|
* @webhook
|
|
4966
4971
|
* @eventType wix.ecom.v1.draft_order_deleted
|
|
4967
4972
|
* @slug deleted
|
|
4968
|
-
* @documentationMaturity preview
|
|
4969
4973
|
*/
|
|
4970
4974
|
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
4971
4975
|
interface DraftOrderUpdatedEnvelope {
|
|
@@ -4988,7 +4992,6 @@ interface DraftOrderUpdatedEnvelope {
|
|
|
4988
4992
|
* @webhook
|
|
4989
4993
|
* @eventType wix.ecom.v1.draft_order_updated
|
|
4990
4994
|
* @slug updated
|
|
4991
|
-
* @documentationMaturity preview
|
|
4992
4995
|
*/
|
|
4993
4996
|
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4994
4997
|
/**
|
|
@@ -4998,7 +5001,6 @@ declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope)
|
|
|
4998
5001
|
* To complete a draft and update the original order, call Commit Draft Order.
|
|
4999
5002
|
* @param orderId - ID of the order to create a draft for.
|
|
5000
5003
|
* @public
|
|
5001
|
-
* @documentationMaturity preview
|
|
5002
5004
|
* @requiredField orderId
|
|
5003
5005
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5004
5006
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5014,7 +5016,6 @@ declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<Cre
|
|
|
5014
5016
|
*
|
|
5015
5017
|
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
5016
5018
|
* @public
|
|
5017
|
-
* @documentationMaturity preview
|
|
5018
5019
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
5019
5020
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
5020
5021
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
@@ -5028,7 +5029,6 @@ declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDr
|
|
|
5028
5029
|
* Adds catalog or custom line items to a draft order.
|
|
5029
5030
|
* @param draftOrderId - Draft order ID.
|
|
5030
5031
|
* @public
|
|
5031
|
-
* @documentationMaturity preview
|
|
5032
5032
|
* @requiredField draftOrderId
|
|
5033
5033
|
* @requiredField options.catalogLineItems.catalogReference
|
|
5034
5034
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
@@ -5063,15 +5063,16 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
5063
5063
|
* @param draftOrderId - Draft order ID.
|
|
5064
5064
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
5065
5065
|
* @public
|
|
5066
|
-
* @documentationMaturity preview
|
|
5067
5066
|
* @requiredField draftOrderId
|
|
5068
5067
|
* @requiredField lineItemChanges
|
|
5069
5068
|
* @requiredField lineItemChanges.lineItemId
|
|
5069
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups._id
|
|
5070
|
+
* @requiredField lineItemChanges.newModifierGroups.modifierGroups.modifiers._id
|
|
5070
5071
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
5071
5072
|
* @applicableIdentity APP
|
|
5072
5073
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
5073
5074
|
*/
|
|
5074
|
-
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> & {
|
|
5075
5076
|
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
5076
5077
|
}>;
|
|
5077
5078
|
interface SetDepositOptions {
|
|
@@ -5091,7 +5092,6 @@ interface SetDepositOptions {
|
|
|
5091
5092
|
*
|
|
5092
5093
|
* Any existing discounts that are not passed will not change.
|
|
5093
5094
|
* @public
|
|
5094
|
-
* @documentationMaturity preview
|
|
5095
5095
|
* @requiredField discounts
|
|
5096
5096
|
* @requiredField discounts._id
|
|
5097
5097
|
* @requiredField discounts.applied
|
|
@@ -5110,7 +5110,6 @@ declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<
|
|
|
5110
5110
|
* To apply them, use Set Discounts.
|
|
5111
5111
|
* @param draftOrderId - Draft order ID.
|
|
5112
5112
|
* @public
|
|
5113
|
-
* @documentationMaturity preview
|
|
5114
5113
|
* @requiredField draftOrderId
|
|
5115
5114
|
* @requiredField options.discounts.amount.amount
|
|
5116
5115
|
* @requiredField options.discounts.discountType
|
|
@@ -5137,7 +5136,6 @@ interface CreateCustomDiscountsOptions {
|
|
|
5137
5136
|
* @param draftOrderId - Draft order ID.
|
|
5138
5137
|
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
5139
5138
|
* @public
|
|
5140
|
-
* @documentationMaturity preview
|
|
5141
5139
|
* @requiredField discountIds
|
|
5142
5140
|
* @requiredField draftOrderId
|
|
5143
5141
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
@@ -5157,7 +5155,6 @@ declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string
|
|
|
5157
5155
|
*
|
|
5158
5156
|
* Any existing additional fees that are not passed will not change.
|
|
5159
5157
|
* @public
|
|
5160
|
-
* @documentationMaturity preview
|
|
5161
5158
|
* @requiredField additionalFees
|
|
5162
5159
|
* @requiredField additionalFees._id
|
|
5163
5160
|
* @requiredField additionalFees.applied
|
|
@@ -5176,7 +5173,6 @@ declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNull
|
|
|
5176
5173
|
* To apply them, use Set Additional Fees.
|
|
5177
5174
|
* @param draftOrderId - Draft order ID.
|
|
5178
5175
|
* @public
|
|
5179
|
-
* @documentationMaturity preview
|
|
5180
5176
|
* @requiredField draftOrderId
|
|
5181
5177
|
* @requiredField options.customAdditionalFees.name
|
|
5182
5178
|
* @requiredField options.customAdditionalFees.price
|
|
@@ -5203,7 +5199,6 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
5203
5199
|
* @param draftOrderId - Draft order ID.
|
|
5204
5200
|
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
5205
5201
|
* @public
|
|
5206
|
-
* @documentationMaturity preview
|
|
5207
5202
|
* @requiredField customAdditionalFees
|
|
5208
5203
|
* @requiredField draftOrderId
|
|
5209
5204
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
@@ -5217,7 +5212,6 @@ declare function deleteCustomAdditionalFees(draftOrderId: string, customAddition
|
|
|
5217
5212
|
* Sets shipping information on a draft order.
|
|
5218
5213
|
* @param draftOrderId - Draft order ID.
|
|
5219
5214
|
* @public
|
|
5220
|
-
* @documentationMaturity preview
|
|
5221
5215
|
* @requiredField draftOrderId
|
|
5222
5216
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
5223
5217
|
* @applicableIdentity APP
|
|
@@ -5238,7 +5232,6 @@ interface SetShippingInfoOptions {
|
|
|
5238
5232
|
* Sets buyer info on a draft order.
|
|
5239
5233
|
* @param draftOrderId - Draft order ID.
|
|
5240
5234
|
* @public
|
|
5241
|
-
* @documentationMaturity preview
|
|
5242
5235
|
* @requiredField draftOrderId
|
|
5243
5236
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
5244
5237
|
* @applicableIdentity APP
|
|
@@ -5259,7 +5252,6 @@ interface SetBuyerInfoOptions {
|
|
|
5259
5252
|
* Sets recipient info on a draft order.
|
|
5260
5253
|
* @param draftOrderId - Draft order ID.
|
|
5261
5254
|
* @public
|
|
5262
|
-
* @documentationMaturity preview
|
|
5263
5255
|
* @requiredField draftOrderId
|
|
5264
5256
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
5265
5257
|
* @applicableIdentity APP
|
|
@@ -5280,7 +5272,6 @@ interface SetRecipientInfoOptions {
|
|
|
5280
5272
|
* Sets billing info on a draft order.
|
|
5281
5273
|
* @param draftOrderId - Draft order ID.
|
|
5282
5274
|
* @public
|
|
5283
|
-
* @documentationMaturity preview
|
|
5284
5275
|
* @requiredField draftOrderId
|
|
5285
5276
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
5286
5277
|
* @applicableIdentity APP
|
|
@@ -5308,7 +5299,6 @@ interface SetBillingInfoOptions {
|
|
|
5308
5299
|
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
5309
5300
|
* @param draftOrderId - Draft order ID.
|
|
5310
5301
|
* @public
|
|
5311
|
-
* @documentationMaturity preview
|
|
5312
5302
|
* @requiredField draftOrderId
|
|
5313
5303
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5314
5304
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5326,7 +5316,6 @@ declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<G
|
|
|
5326
5316
|
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
5327
5317
|
* @param orderId - Order ID.
|
|
5328
5318
|
* @public
|
|
5329
|
-
* @documentationMaturity preview
|
|
5330
5319
|
* @requiredField orderId
|
|
5331
5320
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5332
5321
|
* @applicableIdentity APP
|
|
@@ -5343,7 +5332,6 @@ declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullabl
|
|
|
5343
5332
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5344
5333
|
* @param draftOrderId - Draft order ID.
|
|
5345
5334
|
* @public
|
|
5346
|
-
* @documentationMaturity preview
|
|
5347
5335
|
* @requiredField draftOrderId
|
|
5348
5336
|
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
5349
5337
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5371,7 +5359,6 @@ interface CommitDraftOrderOptions {
|
|
|
5371
5359
|
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
5372
5360
|
* @param draftOrderId - Draft order ID.
|
|
5373
5361
|
* @public
|
|
5374
|
-
* @documentationMaturity preview
|
|
5375
5362
|
* @requiredField draftOrderId
|
|
5376
5363
|
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
5377
5364
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
@@ -5398,7 +5385,6 @@ interface CreateOrderFromDraftOptions {
|
|
|
5398
5385
|
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
5399
5386
|
* @param draftOrderId - Draft order ID.
|
|
5400
5387
|
* @public
|
|
5401
|
-
* @documentationMaturity preview
|
|
5402
5388
|
* @requiredField draftOrderId
|
|
5403
5389
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
5404
5390
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
@@ -5414,7 +5400,6 @@ declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
|
5414
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).
|
|
5415
5401
|
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
5416
5402
|
* @public
|
|
5417
|
-
* @documentationMaturity preview
|
|
5418
5403
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
5419
5404
|
* @applicableIdentity APP
|
|
5420
5405
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
@@ -5436,65 +5421,46 @@ interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
|
5436
5421
|
interface DraftOrdersQueryBuilder {
|
|
5437
5422
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5438
5423
|
* @param value - Value to compare against.
|
|
5439
|
-
* @documentationMaturity preview
|
|
5440
5424
|
*/
|
|
5441
5425
|
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5442
5426
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5443
5427
|
* @param value - Value to compare against.
|
|
5444
|
-
* @documentationMaturity preview
|
|
5445
5428
|
*/
|
|
5446
5429
|
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5447
5430
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5448
5431
|
* @param value - Value to compare against.
|
|
5449
|
-
* @documentationMaturity preview
|
|
5450
5432
|
*/
|
|
5451
5433
|
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5452
5434
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5453
5435
|
* @param value - Value to compare against.
|
|
5454
|
-
* @documentationMaturity preview
|
|
5455
5436
|
*/
|
|
5456
5437
|
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5457
5438
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5458
5439
|
* @param value - Value to compare against.
|
|
5459
|
-
* @documentationMaturity preview
|
|
5460
5440
|
*/
|
|
5461
5441
|
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5462
5442
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
5463
5443
|
* @param value - Value to compare against.
|
|
5464
|
-
* @documentationMaturity preview
|
|
5465
5444
|
*/
|
|
5466
5445
|
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
5467
5446
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
5468
5447
|
* @param string - String to compare against. Case-insensitive.
|
|
5469
|
-
* @documentationMaturity preview
|
|
5470
5448
|
*/
|
|
5471
5449
|
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
5472
5450
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
5473
5451
|
* @param values - List of values to compare against.
|
|
5474
|
-
* @documentationMaturity preview
|
|
5475
5452
|
*/
|
|
5476
5453
|
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
5477
|
-
/** @documentationMaturity preview */
|
|
5478
5454
|
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
5479
|
-
/** @documentationMaturity preview */
|
|
5480
5455
|
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
5481
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5482
|
-
* @documentationMaturity preview
|
|
5483
|
-
*/
|
|
5456
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5484
5457
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5485
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
5486
|
-
* @documentationMaturity preview
|
|
5487
|
-
*/
|
|
5458
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
5488
5459
|
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
5489
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
5490
|
-
* @documentationMaturity preview
|
|
5491
|
-
*/
|
|
5460
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
5492
5461
|
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
5493
|
-
/** @param cursor - A pointer to specific record
|
|
5494
|
-
* @documentationMaturity preview
|
|
5495
|
-
*/
|
|
5462
|
+
/** @param cursor - A pointer to specific record */
|
|
5496
5463
|
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
5497
|
-
/** @documentationMaturity preview */
|
|
5498
5464
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
5499
5465
|
}
|
|
5500
5466
|
/**
|
|
@@ -5569,7 +5535,6 @@ type DraftOrderQuery = {
|
|
|
5569
5535
|
* @param _id - ID of the entity to update.
|
|
5570
5536
|
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
5571
5537
|
* @public
|
|
5572
|
-
* @documentationMaturity preview
|
|
5573
5538
|
* @requiredField _id
|
|
5574
5539
|
* @requiredField namespace
|
|
5575
5540
|
* @requiredField options
|
|
@@ -5592,7 +5557,6 @@ interface UpdateExtendedFieldsOptions {
|
|
|
5592
5557
|
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
5593
5558
|
* @param draftOrderId - Draft order ID.
|
|
5594
5559
|
* @public
|
|
5595
|
-
* @documentationMaturity preview
|
|
5596
5560
|
* @requiredField draftOrderId
|
|
5597
5561
|
* @requiredField options
|
|
5598
5562
|
* @requiredField options.taxExempt
|
|
@@ -5617,7 +5581,6 @@ interface SetTaxExemptionOptions {
|
|
|
5617
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.
|
|
5618
5582
|
* @param draftOrderId - Draft order ID.
|
|
5619
5583
|
* @public
|
|
5620
|
-
* @documentationMaturity preview
|
|
5621
5584
|
* @requiredField draftOrderId
|
|
5622
5585
|
* @requiredField options.businessLocation._id
|
|
5623
5586
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|