@wix/auto_sdk_ecom_draft-orders 1.0.23 → 1.0.25

package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js

@@ -112,9 +112,13 @@ export var DiscountReason;
 })(DiscountReason || (DiscountReason = {}));
 export var EditingStatus;
 (function (EditingStatus) {
-    /** Draft order can be modified and committed. */
+    /** Draft order is being edited. */
     EditingStatus["DRAFT"] = "DRAFT";
-    /** Draft order is already committed. No further modifications allowed. */
+    /**
+     * Draft order has been committed - No further modifications allowed.
+     *
+     * Draft orders with status 'COMMITTED' cannot be deleted.
+     */
     EditingStatus["COMMITTED"] = "COMMITTED";
 })(EditingStatus || (EditingStatus = {}));
 export var WeightUnit;
@@ -129,9 +133,9 @@ export var WeightUnit;
 export var PickupMethod;
 (function (PickupMethod) {
     PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
-    /** Pickup is from the merchant's brick and mortar store. */
+    /** Store pickup. */
     PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
-    /** Item is shipped to a specified pickup point. */
+    /** Pickup point. */
     PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
 })(PickupMethod || (PickupMethod = {}));
 export var RuleType;
@@ -170,11 +174,11 @@ export var FileType;
 export var DiscountType;
 (function (DiscountType) {
     DiscountType["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
-    /** Discount applies to entire order. */
+    /** Discount applies to the entire order. */
     DiscountType["GLOBAL"] = "GLOBAL";
-    /** Discount applies to specific items. */
+    /** Discount applies to a specific item. */
     DiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
-    /** Discount applies to shipping. For example, free shipping. */
+    /** Discount applies to shipping fee. */
     DiscountType["SHIPPING"] = "SHIPPING";
 })(DiscountType || (DiscountType = {}));
 export var NonDraftableReason;
@@ -380,11 +384,11 @@ export var WebhookIdentityType;
     WebhookIdentityType["APP"] = "APP";
 })(WebhookIdentityType || (WebhookIdentityType = {}));
 /**
- * Creates or gets a draft order.
+ * Creates or retrieves a draft order based on the specified order ID.
  *
- * When passing the ID of an order that is already in draft, the existing draft order will be returned.
- * To complete a draft and update the order, call Commit Draft Order([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/commit-draft-order) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/commit-draft-order)).
- * @param orderId - Existing order ID to create draft from.
+ * When passing the ID of an order that is already in draft, the existing draft order is returned.
+ * To complete a draft and update the original order, call Commit Draft Order.
+ * @param orderId - ID of the order to create a draft for.
  * @public
  * @documentationMaturity preview
  * @requiredField orderId
@@ -393,6 +397,8 @@ export var WebhookIdentityType;
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -465,6 +471,8 @@ export async function createDraftOrder(orderId) {
 }
 /**
  * Creates an empty draft order.
+ *
+ * After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.DRAFT_ORDERS_CREATE
@@ -472,6 +480,8 @@ export async function createDraftOrder(orderId) {
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -543,7 +553,7 @@ export async function createEmptyDraftOrder() {
     }
 }
 /**
- * Adds line items to a draft order.
+ * Adds catalog or custom line items to a draft order.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -552,6 +562,8 @@ export async function createEmptyDraftOrder() {
  * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -642,11 +654,11 @@ export async function addLineItemsToDraftOrder(draftOrderId, options) {
 /**
  * Updates a draft order's line items.
  *
- * Using this API, you can update a line item's quantity, price, and description.
+ * You can update a line item's quantity, price, and description.
  * > **Notes:**
- * > + Passing a quantity of `0` will remove the line item.
+ * > + Specifying a quantity of `0` will remove the line item.
  * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
- * > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
+ * > + Quantity cannot be decreased for fulfilled line items. To retrieve fulfillment information, specify the order ID when calling List Fulfillments For Single Order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-fulfillments/list-fulfillments-for-single-order) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order)).
  * @param draftOrderId - Draft order ID.
  * @param lineItemChanges - Details of changes to apply per line item.
  * @public
@@ -657,6 +669,8 @@ export async function addLineItemsToDraftOrder(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -736,11 +750,12 @@ export async function updateLineItems(draftOrderId, lineItemChanges) {
 /**
  * Applies or unapplies discounts on a draft order.
  *
- * Unapplied discounts are still part of draft order, but do not affect balance.
- * Existing discounts, not mentioned in request, will keep their current state.
+ * Unapplied discounts are still part of the draft order, but do not affect balance.
+ * Existing discounts that are not passed in the request will keep their current state.
  * @param draftOrderId - Draft order ID.
- * @param discounts - Discount IDs to apply/unapply.
- * Existing discounts, not mentioned in request, will keep their current state.
+ * @param discounts - Discounts to set on the draft order.
+ *
+ * Any existing discounts that are not passed will not change.
  * @public
  * @documentationMaturity preview
  * @requiredField discounts
@@ -750,6 +765,8 @@ export async function updateLineItems(draftOrderId, lineItemChanges) {
  * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -824,10 +841,10 @@ export async function setDiscounts(draftOrderId, discounts) {
     }
 }
 /**
- * Create custom discounts on a draft order.
+ * Creates custom discounts.
  *
- * Newly added discounts are unapplied by default.
- * To apply them, use Set Discounts ([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/set-discounts) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/set-discounts)).
+ * Newly created discounts are unapplied by default.
+ * To apply them, use Set Discounts.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -838,6 +855,8 @@ export async function setDiscounts(draftOrderId, discounts) {
  * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -915,9 +934,9 @@ export async function createCustomDiscounts(draftOrderId, options) {
     }
 }
 /**
- * Remove custom discounts from the order.
+ * Removes custom discounts from a draft order.
  * @param draftOrderId - Draft order ID.
- * @param discountIds - Ids of discounts to remove.
+ * @param discountIds - IDs of the discounts to remove from the draft order.
  * @public
  * @documentationMaturity preview
  * @requiredField discountIds
@@ -925,6 +944,8 @@ export async function createCustomDiscounts(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1001,11 +1022,12 @@ export async function deleteCustomDiscounts(draftOrderId, discountIds) {
 /**
  * Applies or unapplies additional fees on a draft order.
  *
- * Unapplied fees are still part of draft order, but do not affect balance.
- * Existing additional fees, not mentioned in request, will keep their current state.
+ * Additional fees that are not applied are still part of the draft order, but do not affect balance.
+ * Existing additional fees that are not passed in the request will keep their current state.
  * @param draftOrderId - Draft order ID.
- * @param additionalFees - Additional fee IDs to apply/unapply.
- * Existing additional fees, not mentioned in this list, will keep their current state.
+ * @param additionalFees - Additional fees to set on the draft order.
+ *
+ * Any existing additional fees that are not passed will not change.
  * @public
  * @documentationMaturity preview
  * @requiredField additionalFees
@@ -1015,6 +1037,8 @@ export async function deleteCustomDiscounts(draftOrderId, discountIds) {
  * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1094,8 +1118,8 @@ export async function setAdditionalFees(draftOrderId, additionalFees) {
 /**
  * Creates custom additional fees on a draft order.
  *
- * Newly added additional fees are unapplied by default.
- * To apply them, use Set Additional Fees ([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/set-additional-fees) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/set-additional-fees)).
+ * Newly created additional fees are not applied by default.
+ * To apply them, use Set Additional Fees.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -1106,6 +1130,8 @@ export async function setAdditionalFees(draftOrderId, additionalFees) {
  * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1183,9 +1209,9 @@ export async function createCustomAdditionalFees(draftOrderId, options) {
     }
 }
 /**
- * Remove custom additional fees from the order.
+ * Removes custom additional fees from a draft order.
  * @param draftOrderId - Draft order ID.
- * @param customAdditionalFees - Ids of additional fees to remove.
+ * @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
  * @public
  * @documentationMaturity preview
  * @requiredField customAdditionalFees
@@ -1193,6 +1219,8 @@ export async function createCustomAdditionalFees(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1278,6 +1306,8 @@ export async function deleteCustomAdditionalFees(draftOrderId, customAdditionalF
  * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1371,6 +1401,8 @@ export async function setShippingInfo(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1456,6 +1488,8 @@ export async function setBuyerInfo(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1546,6 +1580,8 @@ export async function setRecipientInfo(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1628,12 +1664,14 @@ export async function setBillingInfo(draftOrderId, options) {
     }
 }
 /**
- * Gets a draft order.
+ * Retrieves a draft order.
  *
- * Draft order is recalculated and contains latest tax and totals (unless already committed).
- * Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.
- * Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.
- * When retrieving an already committed draft, it's not recalculated and contains data calculated during commit.
+ * The retrieved draft order contains the latest calculations:
+ * + Line items, shipping details, and buyer information.
+ * + Tax details and price totals.
+ * + Automatic discounts and automatic additional fees, along with updated eligibility.
+ *
+ * > **Note:** When retrieving a committed draft order, it **is not recalculated**.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -1642,6 +1680,8 @@ export async function setBillingInfo(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1715,14 +1755,16 @@ export async function getDraftOrder(draftOrderId) {
     }
 }
 /**
- * Checks whether a draft can be created for this order.
- * @param orderId - Order Id.
+ * Checks whether a draft can be created for an order.
+ * @param orderId - Order ID.
  * @public
  * @documentationMaturity preview
  * @requiredField orderId
  * @permissionId ECOM.DRAFT_ORDERS_READ
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1752,10 +1794,13 @@ export async function getOrderDraftabilityStatus(orderId) {
     }
 }
 /**
- * Commit latest changes to the baseline order and control which side-effects are executed.
+ * Finalizes a draft order and applies its modifications to the associated order.
+ * You can also control which side-effects are executed on commit.
  *
- * Commit cannot be undone or reverted.
- * Committed draft will become closed for further modifications, however it's kept for reference and can be retrieved.
+ * > **Notes:**
+ * > + The draft order's status is set to `COMMITTED`.
+ * > + Commiting a draft order cannot be undone or reverted.
+ * > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -1764,6 +1809,8 @@ export async function getOrderDraftabilityStatus(orderId) {
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1843,10 +1890,12 @@ export async function commitDraftOrder(draftOrderId, options) {
     }
 }
 /**
- * Creates a new order while specifying which side-effects are executed.
+ * Creates a new order from a draft, while specifying which side-effects are executed.
  *
- * Commit cannot be undone or reverted.
- * Committed draft will become closed for further modifications, however it's kept for reference and can be retrieved.
+ * > **Notes:**
+ * > + The draft order's status is set to `COMMITTED`.
+ * > + Commiting a draft order cannot be undone or reverted.
+ * > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -1855,6 +1904,8 @@ export async function commitDraftOrder(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1938,7 +1989,7 @@ export async function createOrderFromDraft(draftOrderId, options) {
 /**
  * Deletes a draft order along with all its pending changes.
  *
- * Draft orders in status 'COMMITTED' cannot be deleted.
+ * Draft orders with status 'COMMITTED' cannot be deleted.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -1947,6 +1998,8 @@ export async function createOrderFromDraft(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -1986,11 +2039,14 @@ export async function deleteDraftOrder(draftOrderId) {
  * | `_updatedDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable     |
  * | `status`       | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`                                 | Sortable     |
  * | `orderId`      | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `startsWith()`                 |              |
+ *
  * To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public
  * @documentationMaturity preview
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -2087,12 +2143,16 @@ export function queryDraftOrders() {
  * @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -2163,7 +2223,9 @@ export async function updateExtendedFields(_id, namespace, options) {
     }
 }
 /**
- * Sets tax exemption on a draft order.
+ * Sets whether a draft order is tax-exempt.
+ *
+ * A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -2173,6 +2235,8 @@ export async function updateExtendedFields(_id, namespace, options) {
  * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -2251,6 +2315,8 @@ export async function setTaxExemption(draftOrderId, options) {
 }
 /**
  * Sets business location on a draft order.
+ *
+ * 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.
  * @param draftOrderId - Draft order ID.
  * @public
  * @documentationMaturity preview
@@ -2259,6 +2325,8 @@ export async function setTaxExemption(draftOrderId, options) {
  * @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions