@wix/auto_sdk_ecom_checkout 1.0.35 → 1.0.36

package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts

@@ -20,7 +20,7 @@ export interface Checkout {
     /** Shipping information. */
     shippingInfo?: ShippingInfo;
     /**
-     * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
+     * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
      * @maxLength 1000
      */
     buyerNote?: string | null;
@@ -139,7 +139,7 @@ export interface Checkout {
      */
     cartId?: string | null;
     /**
-     * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
+     * List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
      * @readonly
      */
     violations?: Violation[];
@@ -158,7 +158,9 @@ export interface Checkout {
     /**
      * Additional settings for customization of the checkout process.
      *
-     * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
+     * > **Notes:**
+     * > * Custom settings can only be set when creating a checkout.
+     * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
      * @immutable
      */
     customSettings?: CustomSettings;
@@ -210,7 +212,7 @@ export interface LineItem {
      * @max 100000
      */
     quantity?: number;
-    /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
+    /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
     catalogReference?: CatalogReference;
     /**
      * Item name.
@@ -266,7 +268,7 @@ export interface LineItem {
      */
     discount?: MultiCurrencyPrice;
     /**
-     * Line item description lines. Used for displaying the cart, checkout and order.
+     * Line item description lines. Used for display purposes for the cart, checkout and order.
      * @readonly
      */
     descriptionLines?: DescriptionLine[];
@@ -296,11 +298,9 @@ export interface LineItem {
      */
     subscriptionOptionInfo?: SubscriptionOptionInfo;
     /**
-     * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
-     * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
-     * + `"FULL_PAYMENT_OFFLINE"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
-     * + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
-     * + `"DEPOSIT_ONLINE"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
+     * Type of selected payment option for current item.
+     *
+     * Default: `FULL_PAYMENT_ONLINE`
      * @readonly
      */
     paymentOption?: PaymentOptionTypeWithLiterals;
@@ -419,11 +419,9 @@ export interface CatalogReference {
      */
     appId?: string;
     /**
-     * Additional item details in key:value pairs.
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
      *
-     * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
-     *
-     * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
+     * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
      */
     options?: Record<string, any> | null;
 }
@@ -648,7 +646,7 @@ export declare enum ItemAvailabilityStatus {
 /** @enumType */
 export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
 export interface PhysicalProperties {
-    /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
+    /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
     weight?: number | null;
     /**
      * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
@@ -1338,19 +1336,19 @@ export interface OtherCharge {
 }
 export interface BuyerInfo extends BuyerInfoIdOneOf {
     /**
-     * Visitor ID - if the buyer is **not** a site member.
+     * Visitor ID (if site visitor is **not** a member).
      * @format GUID
      * @readonly
      */
     visitorId?: string;
     /**
-     * Member ID - If the buyer is a site member.
+     * Member ID (if site visitor is a site member).
      * @format GUID
      * @readonly
      */
     memberId?: string;
     /**
-     * Contact ID. For more information, see the Contacts API.
+     * Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
      * @format GUID
      * @readonly
      */
@@ -1364,13 +1362,13 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
 /** @oneof */
 export interface BuyerInfoIdOneOf {
     /**
-     * Visitor ID - if the buyer is **not** a site member.
+     * Visitor ID (if site visitor is **not** a member).
      * @format GUID
      * @readonly
      */
     visitorId?: string;
     /**
-     * Member ID - If the buyer is a site member.
+     * Member ID (if site visitor is a site member).
      * @format GUID
      * @readonly
      */
@@ -1557,7 +1555,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
     /** Discount type. */
     discountType?: DiscountTypeWithLiterals;
     /**
-     * IDs of the line items the discount applies to.
+     * IDs of line items the discount applies to.
      * @format GUID
      * @deprecated IDs of line items the discount applies to.
      * @replacedBy line_items_discounts
@@ -1873,7 +1871,7 @@ export interface Membership {
     /** The name of this membership. */
     name?: MembershipName;
     /**
-     * Line item IDs which are "paid for" by this membership.
+     * Line item IDs which are "paid" for by this membership.
      * @minSize 1
      * @maxSize 300
      * @minLength 1
@@ -2177,7 +2175,7 @@ export interface UpdatedCheckoutMessage {
 export interface CreateCheckoutRequest {
     /** Checkout information. */
     checkoutInfo?: Checkout;
-    /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
+    /** Coupon code. */
     couponCode?: string | null;
     /**
      * Catalog line items to add to the checkout.
@@ -2205,7 +2203,9 @@ export interface CreateCheckoutRequest {
     /**
      * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
      *
-     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
+     * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
+     * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
      * @maxLength 1000
      */
     overrideCheckoutUrl?: string | null;
@@ -2221,7 +2221,7 @@ export interface CustomLineItem {
      */
     quantity?: number;
     /**
-     * Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
+     * Custom line item price. For security reasons, the `price` field should come from backend code, and not be passed from the frontend.
      * @format DECIMAL_VALUE
      * @decimalValue options { gte:0, lte:1000000000000000 }
      */
@@ -2229,7 +2229,7 @@ export interface CustomLineItem {
     /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
     priceDescription?: PriceDescription;
     /**
-     * Custom line item description lines. Used for displaying the cart, checkout and order.
+     * Custom line item description lines. Used for display purposes for the cart, checkout and order.
      * @maxSize 10
      */
     descriptionLines?: DescriptionLine[];
@@ -2388,7 +2388,7 @@ export interface MerchantDiscountInput {
      */
     amount?: string;
     /**
-     * IDs of the line items the discount applies to.
+     * IDs of line items the discount applies to.
      * @format GUID
      * @maxSize 300
      */
@@ -2465,14 +2465,20 @@ export interface GetCheckoutURLResponse {
 export interface UpdateCheckoutRequest {
     /** Checkout information. */
     checkout: Checkout;
-    /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
+    /**
+     * Coupon code.
+     *
+     * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
+     */
     couponCode?: string | null;
     /** Gift card code. */
     giftCardCode?: string | null;
     /**
      * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
      *
-     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
+     * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
+     * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
      * @maxLength 1000
      */
     overrideCheckoutUrl?: string | null;
@@ -2559,6 +2565,10 @@ export interface RemoveLineItemsRequest {
     _id: string;
     /**
      * IDs of the line items to remove from the checkout.
+     *
+     * To find the IDs of the checkout line items you'd like to remove,
+     * pass the checkout ID to Get Checkout and look for the IDs under
+     * `lineItems`.
      * @format GUID
      * @minSize 1
      * @maxSize 300
@@ -2582,7 +2592,7 @@ export interface CreateOrderRequest {
 }
 export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
     /**
-     * ID of the newly created order.
+     * ID of newly created order.
      * @format GUID
      */
     orderId?: string;
@@ -2595,10 +2605,11 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
      * Payment gateway order ID.
      *
      * For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
+     * `paymentGatewayOrderId` will be returned if money needs to be charged.
      *
-     * This field will be returned if money needs to be charged. In some cases, money cannot be charged:
-     * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0. For example, in the case of a free item or an item with a 100% discount.
-     * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
+     * In some cases, money cannot be charged:
+     * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
+     * + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
      */
     paymentGatewayOrderId?: string | null;
 }
@@ -2667,12 +2678,11 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
     /** Payment response token. */
     paymentResponseToken?: string | null;
     /**
-     * For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.
-     * `paymentGatewayOrderId` will be returned if money needs to be charged.
-     *
-     * In some cases, money should not be charged:
-     * + If the total price is 0. For example, in the case of a free item or an item with 100% discount.
-     * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
+     * The payment gateway is cashier.
+     * payment_gateway_order_id will be returned given that money was charged.
+     * In some cases, money will not be charged:
+     * If the total price is 0 - For example, could be a free item or a an item with 100% discount
+     * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
      */
     paymentGatewayOrderId?: string | null;
 }
@@ -3669,14 +3679,9 @@ type CheckoutNonNullablePaths = `lineItems` | `lineItems.${number}.quantity` | `
 /**
  * Creates a checkout.
  *
+ * A checkout must include at least 1 item in `lineItems` or `customLineItems`.
  *
- * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
- *
- * > **Notes:**
- * > + Checkout must include at least 1 item in the `options.lineItems` array.
- * > + `options.channelType` is required.
- * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
- * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
+ * If passing `checkoutInfo.customFields`, then `checkoutInfo.customFields.value` is a required field.
  * @public
  * @requiredField options.channelType
  * @requiredField options.checkoutInfo.customFields.value
@@ -3718,14 +3723,14 @@ type CheckoutNonNullablePaths = `lineItems` | `lineItems.${number}.quantity` | `
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - the newly created checkout.
+ * @returns Newly created checkout.
  * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
  */
 export declare function createCheckout(options?: NonNullablePaths<CreateCheckoutOptions, `channelType` | `checkoutInfo.customFields.${number}.value` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}._id` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.appId` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.lineItemIds` | `customLineItems.${number}.descriptionLines` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.price` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
 export interface CreateCheckoutOptions {
     /** Checkout information. */
     checkoutInfo?: Checkout;
-    /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
+    /** Coupon code. */
     couponCode?: string | null;
     /**
      * Catalog line items to add to the checkout.
@@ -3753,16 +3758,15 @@ export interface CreateCheckoutOptions {
     /**
      * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
      *
-     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
+     * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
+     * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
      * @maxLength 1000
      */
     overrideCheckoutUrl?: string | null;
 }
 /**
  * Retrieves a checkout.
- *
- *
- * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
  * @param _id - Checkout ID.
  * @public
  * @requiredField _id
@@ -3785,7 +3789,7 @@ export interface CreateCheckoutOptions {
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - the requested checkout.
+ * @returns Retrieved checkout.
  * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
  */
 export declare function getCheckout(_id: string): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
@@ -3851,8 +3855,15 @@ export declare function getCheckoutUrl(_id: string): Promise<NonNullablePaths<Ge
 /**
  * Updates a checkout.
  *
+ * Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.
  *
- * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
+ * To update a checkout's `lineItems`, `completed` status, or to remove coupons and gift cards, see these methods:
+ * + Add to Checkout: Add line items to the checkout.
+ * + Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout.
+ * + Remove Line Items: Remove a line item from the checkout.
+ * + Mark Checkout As Completed: To update `completed` to `true` if the checkout was completed through a non-Wix orders or payments system.
+ * + Remove Coupon: To remove an applied coupon from the checkout.
+ * + Remove Gift Card: To remove an applied gift card from the checkout.
  *
  * >**Notes:**
  * > + If nothing is passed in the request, the call will fail.
@@ -3924,7 +3935,7 @@ export interface UpdateCheckout {
     /** Shipping information. */
     shippingInfo?: ShippingInfo;
     /**
-     * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
+     * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
      * @maxLength 1000
      */
     buyerNote?: string | null;
@@ -4043,7 +4054,7 @@ export interface UpdateCheckout {
      */
     cartId?: string | null;
     /**
-     * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
+     * List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
      * @readonly
      */
     violations?: Violation[];
@@ -4062,7 +4073,9 @@ export interface UpdateCheckout {
     /**
      * Additional settings for customization of the checkout process.
      *
-     * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
+     * > **Notes:**
+     * > * Custom settings can only be set when creating a checkout.
+     * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
      * @immutable
      */
     customSettings?: CustomSettings;
@@ -4099,14 +4112,20 @@ export interface UpdateCheckout {
     paymentCurrency?: string;
 }
 export interface UpdateCheckoutOptions {
-    /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
+    /**
+     * Coupon code.
+     *
+     * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
+     */
     couponCode?: string | null;
     /** Gift card code. */
     giftCardCode?: string | null;
     /**
      * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
      *
-     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+     * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
+     * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
+     * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
      * @maxLength 1000
      */
     overrideCheckoutUrl?: string | null;
@@ -4126,11 +4145,6 @@ export interface UpdateCheckoutOptions {
 }
 /**
  * Removes the coupon from a specified checkout.
- *
- *
- * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
- *
- * >**Note:** A checkout can only hold 1 coupon.
  * @param _id - ID of the checkout to remove the coupon from.
  * @public
  * @requiredField _id
@@ -4155,10 +4169,7 @@ export declare function removeCoupon(_id: string): Promise<NonNullablePaths<Remo
 /**
  * Removes the gift card from a specified checkout.
  *
- *
- * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
- *
- * >**Note:** A checkout can only hold 1 gift card.
+ * A checkout can only hold 1 gift card.
  * @param _id - ID of the checkout to remove the gift card from.
  * @public
  * @requiredField _id
@@ -4209,9 +4220,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<NonNulla
 /**
  * Adds catalog line items and/or custom line items to a checkout.
  *
- *
- * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
- * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
+ * When adding catalog ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)) items
+ * to a checkout, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
  * @param _id - Checkout ID.
  * @public
  * @requiredField _id
@@ -4271,15 +4281,15 @@ export interface AddToCheckoutOptions {
 }
 /**
  * Removes line items from the specified checkout.
- *
- *
- * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
  * @param _id - ID of the checkout to remove line items from.
+ * @param lineItemIds - IDs of the line items to remove from the checkout.
+ *
+ * To find the IDs of the checkout line items you'd like to remove,
+ * pass the checkout ID to Get Checkout and look for the IDs under
+ * `lineItems`.
  * @public
  * @requiredField _id
  * @requiredField lineItemIds
- * @param lineItemIds - IDs of the line items to be removed.
- * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
  * @permissionId ECOM.MODIFY_CHECKOUTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -4301,20 +4311,17 @@ export declare function removeLineItems(_id: string, lineItemIds: string[]): Pro
 /**
  * Creates an order from a specified checkout.
  *
- * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
- * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
- *
- * > **Note:** The following requirements must be met for an order to be created from a checkout.
- * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
- * > + A checkout must have at least 1 line item.
- * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
- * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
- * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
- * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
+ * For an order to be created from a checkout, the following requirements must be met:
+ * + A checkout cannot have calculation errors. Pass the checkout ID to Get Checkout and review the `calculationErrors` field.
+ * + A checkout must have at least 1 line item or custom line item.
+ * + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
+ * + If there is a payment to be made, meaning that `priceSummary.total` is greater than `0`, the `billingInfo.address` field are required.
+ * + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields are required.
+ * + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field are required.
  * @param _id - Checkout ID.
  * @public
  * @requiredField _id
- * @param options - Further order creation options.
+ * @param options - Additional order creation options.
  * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -4368,10 +4375,11 @@ export interface CreateOrderAndChargeOptions {
  */
 export declare function markCheckoutAsCompletedAndRedirectToUrl(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
 /**
- * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
- *
+ * Sets `completed` to `true` to mark a checkout as completed.
  *
- * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
+ * When an order is completed through Wix, the `completed` field in the associated checkout object
+ * will automatically be updated to `true`. If an order is completed through a separate system,
+ * use this method to manually mark the checkout as completed.
  * @param _id - Checkout ID.
  * @public
  * @requiredField _id
@@ -4394,11 +4402,11 @@ export declare function markCheckoutAsCompleted(_id: string): Promise<void>;
 /**
  * Updates the quantity of one or more line items in a checkout.
  *
- * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
- * the checkout, use [`removeLineItems()`](#removelineitems).
- * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
+ * This method is only for updating the quantity of line items. To entirely remove a line item from
+ * the checkout, use the Remove Line Items method.
+ * To add a new line item to the checkout, use the Add to Checkout method.
  *
- * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
+ * This method checks the amount of stock remaining for this line item. If the specified `quantity`
  * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
  * of remaining stock.
  * @param _id - Checkout ID.