@wix/ditto-codegen-public 1.0.162 → 1.0.163

package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt

@@ -0,0 +1,1040 @@
+<ecom_orders_bulkUpdateOrders>
+<description>
+# Method name:
+
+ecom.orders.bulkUpdateOrders(orders: Array<MaskedOrder>, options: BulkUpdateOrdersOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/bulk-update-orders
+
+# Method Description:
+
+Updates up to 100 orders.
+
+
+The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
+
+Currently, the following fields can be updated:
++ `order.buyerInfo.email`
++ `order.buyerLanguage`
++ `order.weightUnit`
++ `order.billingInfo.address`
++ `order.billingInfo.contactDetails`
++ `order.archived`
++ `order.attributionSource`
++ `order.seenByAHuman`
++ `order.recipientInfo.address`
++ `order.recipientInfo.contactDetails`
++ `order.shippingInfo.logistics.shippingDestination.address`
++ `order.shippingInfo.logistics.shippingDestination.contactDetails`
+
+To update a field's value, include the new value in the `orders.order` object in the method parameters.
+To remove a field's value, pass `null`.
+
+> **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
+
+To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
+
+# Method Permissions:
+
+- ECOM.MODIFY_ORDERS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Update multiple orders 
+
+```javascript
+import { orders } from "@wix/ecom";
+
+/* Sample ordersToUpdate value:
+* [
+*   {
+*     order: {
+*       id: 'efc0f204-d83a-4391-b576-e9cf816f6bc9',
+*       archived: true
+*     }
+*   },
+*   {
+*     order: {
+*       id: '6bfb7f73-3269-41d6-b396-64f6bb5947ff',
+*       archived: true
+*     }
+*   }
+* ]
+*/
+
+/* Sample options value:
+* { returnEntity: false }
+*/
+
+export async function myBulkUpdateOrders(ordersToUpdate, options) {
+ try {
+   const bulkUpdateOrdersResponse = await orders.bulkUpdateOrders(ordersToUpdate, options);
+   console.log("Bulk update orders response:", bulkUpdateOrdersResponse);
+
+   return bulkUpdateOrdersResponse;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+}
+
+/* Promise resolves to:
+* {
+*   "results": [
+*     {
+*       "itemMetadata": {
+*         "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
+*         "originalIndex": 0,
+*         "success": true
+*       }
+*     },
+*     {
+*       "itemMetadata": {
+*         "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
+*         "originalIndex": 1,
+*         "success": true
+*       }
+*     }
+*   ],
+*   "bulkActionMetadata": {
+*     "totalSuccesses": 2,
+*     "totalFailures": 0,
+*     "undetailedFailures": 0
+*   }
+* }
+*/
+```
+
+## Update multiple orders (with elevated permissions) 
+
+```javascript
+import { orders } from "@wix/ecom";
+import { auth } from "@wix/essentials";
+
+/* Sample ordersToUpdate value:
+* [
+*   {
+*     order: {
+*       id: 'efc0f204-d83a-4391-b576-e9cf816f6bc9',
+*       archived: true
+*     }
+*   },
+*   {
+*     order: {
+*       id: '6bfb7f73-3269-41d6-b396-64f6bb5947ff',
+*       archived: true
+*     }
+*   }
+* ]
+*/
+
+/* Sample options value:
+* { returnEntity: false }
+*/
+
+const elevatedBulkUpdateOrders = auth.elevate(orders.bulkUpdateOrders);
+
+export async function myBulkUpdateOrders(ordersToUpdate, options) {
+ try {
+   const bulkUpdateOrdersResponse = await elevatedBulkUpdateOrders(ordersToUpdate, options);
+   console.log("Bulk update orders response:", bulkUpdateOrdersResponse);
+
+   return bulkUpdateOrdersResponse;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+}
+
+/* Promise resolves to:
+* {
+*   "results": [
+*     {
+*       "itemMetadata": {
+*         "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
+*         "originalIndex": 0,
+*         "success": true
+*       }
+*     },
+*     {
+*       "itemMetadata": {
+*         "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
+*         "originalIndex": 1,
+*         "success": true
+*       }
+*     }
+*   ],
+*   "bulkActionMetadata": {
+*     "totalSuccesses": 2,
+*     "totalFailures": 0,
+*     "undetailedFailures": 0
+*   }
+* }
+*/
+```
+
+## Updates multiple orders from input on the site's page (with $w) 
+
+```javascript
+/***********************************************
+* Backend code - bulk-update-orders.web.js/ts *
+**********************************************/
+
+import {Permissions, webMethod} from "@wix/web-methods";
+import {orders} from "@wix/ecom";
+import { auth } from "@wix/essentials";
+
+const myElevatedFunction = await auth.elevate(orders.bulkUpdateOrders)
+
+export const myBulkUpdateOrdersFunction = webMethod(
+   Permissions.Anyone,
+   async (ordersUpdateInfo, options) => {
+     try {
+       const updatedOrders = await myElevatedFunction(ordersUpdateInfo, options);
+       return updatedOrders;
+     } catch (error) {
+       console.error(error);
+       throw new Error(error);
+     }
+   },
+);
+
+/*************
+* Page code *
+************/
+
+import {myBulkUpdateOrdersFunction} from "backend/create-location.web";
+
+$w.onReady(() => {
+ $w("#bulkUpdateOrdersBtn").onClick(async () => {
+   const ordersUpdateInfo = [
+     {
+       order: {
+         id: 'efc0f204-d83a-4391-b576-e9cf816f6bc9',
+         archived: true
+       },
+     },
+     {
+       order: {
+         id: '6bfb7f73-3269-41d6-b396-64f6bb5947ff',
+         archived: true
+       },
+     },
+   ];
+
+   const options = {
+     returnEntity: false
+   };
+
+   const updatedOrders = await myBulkUpdateOrdersFunction(ordersUpdateInfo, options);
+   console.log("You have successfully updated multiple orders.\n", updatedOrders);
+   $w("#updatedOrdersSuccessMsg").show();
+ });
+});
+
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await orders.bulkUpdateOrders([
+         {
+             order: {
+                 _id: "535eb6ef-fb85-4c02-a6ce-7a7d9878041f",
+                 buyerInfo: {
+                     email: "john.doe@example.com",
+                     contactId: "beaef03a-aaf7-4193-8346-f6c7b748912f"
+                 },
+                 billingInfo: {
+                     address: {
+                         addressLine1: "123 Main St",
+                         city: "Springfield",
+                         country: "US",
+                         postalCode: "12345",
+                         streetAddress: { name: "Main St", number: "123" }
+                     },
+                     contactDetails: {
+                         firstName: "John",
+                         lastName: "Doe",
+                         phone: "+972501234567"
+                     }
+                 },
+                 archived: false,
+                 buyerLanguage: "en",
+                 shippingInfo: {
+                     logistics: {
+                         shippingDestination: {
+                             address: {
+                                 country: "US",
+                                 city: "Springfield",
+                                 postalCode: "12345"
+                             },
+                             contactDetails: {
+                                 firstName: "John",
+                                 lastName: "Doe",
+                                 phone: "+972501234567"
+                             }
+                         }
+                     }
+                 },
+                 paymentStatus: "PAID",
+                 purchaseFlowId: "04544999-991e-4106-937c-434d9c63c126"
+             }
+         }
+     ], { returnEntity: true });
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: ecom.orders.bulkUpdateOrders(orders, options)
+Description: Updates up to 100 orders.   The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.  Currently, the following fields can be updated: + `order.buyerInfo.email` + `order.buyerLanguage` + `order.weightUnit` + `order.billingInfo.address` + `order.billingInfo.contactDetails` + `order.archived` + `order.attributionSource` + `order.seenByAHuman` + `order.recipientInfo.address` + `order.recipientInfo.contactDetails` + `order.shippingInfo.logistics.shippingDestination.address` + `order.shippingInfo.logistics.shippingDestination.contactDetails`  To update a field's value, include the new value in the `orders.order` object in the method parameters. To remove a field's value, pass `null`.  > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.  To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
+Method parameters:
+  param name:  orders | type: Array<MaskedOrder> | description:  Orders to update. | required: true
+        - name: order  | type: Order | description:  Order to be updated. 
+            - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional fees applied to the order. 
+                  - name: _id  | type: string | description:  Additional fee's id. 
+                  - name: code  | type: string | description:  Additional fee's unique code for future processing. 
+                  - name: lineItemIds  | type: Array<string> | description:  Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. 
+                  - name: name  | type: string | description:  Name of additional fee. 
+                  - name: price  | type: Price | description:  Additional fee's price. 
+                      - name: amount  | type: string | description:  Amount. 
+                  - name: priceAfterTax  | type: Price | description:  Additional fee's price after tax. 
+                  - name: priceBeforeTax  | type: Price | description:  Additional fee's price before tax. 
+                  - name: providerAppId  | type: string | description:  SPI implementer's `appId`. 
+                  - name: taxInfo  | type: LineItemTaxInfo | description:  Represents all the relevant tax details for additional fee. 
+                      - name: taxAmount  | type: Price | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+                      - name: taxBreakdown  | type: Array<LineItemTaxBreakdown> | description:  Tax information for a line item. 
+                            - name: jurisdiction  | type: string | description:  Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". 
+                            - name: jurisdictionType  | type: JurisdictionType | description:  Type of jurisdiction that taxes were calculated for. 
+                                enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
+                            - name: nonTaxableAmount  | type: Price | description:  Non-taxable amount of the line item price. 
+                            - name: rate  | type: string | description:  Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. 
+                            - name: taxAmount  | type: Price | description:  Amount of tax calculated for this line item. 
+                            - name: taxName  | type: string | description:  The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. 
+                            - name: taxType  | type: string | description:  The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. 
+                            - name: taxableAmount  | type: Price | description:  Taxable amount of the line item price. 
+                      - name: taxGroupId  | type: string | description:  Tax group GUID. 
+                      - name: taxIncludedInPrice  | type: boolean | description:  Indicates whether the price already includes tax. 
+                      - name: taxRate  | type: string | description:  Tax rate %, as a decimal point. 
+                      - name: taxableAmount  | type: Price | description:  Amount for which tax is calculated. 
+            - name: appliedDiscounts  | type: Array<AppliedDiscount> | description:  Applied discounts. 
+                  - name: _id  | type: string | description:  Discount id. 
+                  - name: discountType  | type: DiscountType | description:  Discount type. * `"GLOBAL"` - discount applies to entire order. * `"SPECIFIC-ITEMS"` - discount applies to specific items. * `"SHIPPING"` - discount applies to shipping. For example, free shipping. 
+                      enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
+                  - ONE-OF: 
+                    - name: coupon  | type: Coupon | description:  Applied coupon info. 
+                        - name: _id  | type: string | description:  Coupon GUID. 
+                        - name: amount  | type: Price | description:  Coupon value. 
+                        - name: code  | type: string | description:  Coupon code. 
+                        - name: name  | type: string | description:  Coupon name. 
+                    - name: discountRule  | type: DiscountRule | description:  Automatic Discount 
+                        - name: _id  | type: string | description:  Discount rule GUID 
+                        - name: amount  | type: Price | description:  Discount value. 
+                        - name: name  | type: DiscountRuleName | description:  Discount rule name 
+                            - name: original  | type: string | description:  Original discount rule name (in site's default language). 
+                            - name: translated  | type: string | description:  Translated discount rule name according to buyer language. Defaults to `original` when not provided. 
+                    - name: merchantDiscount  | type: MerchantDiscount | description:  Merchant discount. 
+                        - name: amount  | type: Price | description:  Discount amount. 
+                        - ONE-OF: 
+                          - name: description  | type: string | description:  Discount description as free text (optional). 
+                          - name: discountReason  | type: DiscountReason | description:  Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange. 
+                              enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
+            - name: archived  | type: boolean | description:  Whether order is archived. 
+            - name: attributionSource  | type: AttributionSource | description:  Order attribution source. 
+                enum: FACEBOOK_ADS, UNSPECIFIED
+            - name: billingInfo  | type: AddressWithContact | description:  Billing address and contact details. 
+                - name: address  | type: Address | description:  Address. 
+                    - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                    - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                    - name: city  | type: string | description:  City name. 
+                    - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                    - name: location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                        - name: latitude  | type: number | description:  Address latitude. 
+                        - name: longitude  | type: number | description:  Address longitude. 
+                    - name: postalCode  | type: string | description:  Postal or zip code. 
+                    - name: streetAddress  | type: StreetAddress | description:  Street address. 
+                        - name: name  | type: string | description:  Street name. 
+                        - name: number  | type: string | description:  Street number. 
+                    - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                - name: contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+                    - name: company  | type: string | description:  Company name. 
+                    - name: firstName  | type: string | description:  First name. 
+                    - name: lastName  | type: string | description:  Last name. 
+                    - name: phone  | type: string | description:  Phone number. 
+                    - name: vatId  | type: VatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                        - name: _id  | type: string | description:  Customer's tax GUID. 
+                        - name: type  | type: VatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                            enum: 
+                                 CNPJ: CNPJ - for corporations
+                                 CPF: CPF - for individual tax payers.
+                               UNSPECIFIED
+            - name: businessLocation  | type: Location | description:  Order Location 
+                - name: _id  | type: string | description:  Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction). 
+            - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+                - name: contactId  | type: string | description:  Contact GUID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction). 
+                - name: email  | type: string | description:  Buyer email address. 
+                - ONE-OF: 
+                  - name: memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+                  - name: visitorId  | type: string | description:  Visitor GUID (if site visitor is not a member). 
+            - name: buyerLanguage  | type: string | description:  Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected. 
+            - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. 
+            - name: channelInfo  | type: ChannelInfo | description:  Information about the sales channel that submitted this order. 
+                - name: externalOrderId  | type: string | description:  Reference to an order GUID from an external system. 
+                - name: externalOrderUrl  | type: string | description:  URL to the order in the external system. 
+                - name: type  | type: ChannelType | description:  Sales channel that submitted the order. 
+                    enum: 
+                         AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
+                         BACKOFFICE_MERCHANT: Wix merchant backoffice.
+                         CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
+                         EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
+                         ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
+                         FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
+                         FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
+                         GLOBAL_E: Global-E sales channel.
+                         OTHER_PLATFORM: Other sales platform.
+                         PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
+                         POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
+                         TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
+                         UNSPECIFIED: Unspecified sales channel. This value is not supported.
+                         WEB: A web client.
+                         WISH: Wish sales channel.
+                         WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
+                         WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
+            - name: checkoutId  | type: string | description:  Checkout GUID. 
+            - name: currency  | type: string | description:  Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. 
+            - name: currencyConversionDetails  | type: CurrencyConversionDetails | description:  Currency conversion details. For use with multi-currency sites. 
+            - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+                  - name: title  | type: string | description:  Custom field title. 
+                  - name: translatedTitle  | type: string | description:  Translated custom field title. 
+                  - name: value  | type: any | description:  Custom field value. 
+            - name: extendedFields  | type: ExtendedFields | description:  Custom field data for the order object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+            - name: paymentStatus  | type: PaymentStatus | description:  Order payment status. 
+                enum: 
+                     CANCELED: One or more payments canceled.
+                     DECLINED: One or more payments declined.
+                     FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
+                     NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
+                     PAID: All required payments associated with this order are paid.
+                     PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details.
+                     PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
+                     PENDING: All payments pending.  This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
+                     PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider.  In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
+                   UNSPECIFIED
+            - name: purchaseFlowId  | type: string | description:  Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. 
+            - name: purchasedDate  | type: Date | description:  Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. 
+            - name: recipientInfo  | type: AddressWithContact | description:  Order recipient address and contact details.  This field may differ from the address in `shippingInfo.logistics` when: + The chosen shipping option is pickup point or store pickup. + No shipping option is selected. 
+            - name: seenByAHuman  | type: boolean | description:  Whether a human has seen the order. Set when an order is clicked on in the dashboard. 
+            - name: shippingInfo  | type: V1ShippingInformation | description:  Shipping info and selected shipping option details. 
+                - name: carrierId  | type: string | description:  App Def Id of external provider which was a source of shipping info 
+                - name: code  | type: string | description:  Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. 
+                - name: cost  | type: ShippingPrice | description:  Shipping costs. 
+                    - name: price  | type: Price | description:  Shipping price for display purposes. 
+                    - name: taxInfo  | type: LineItemTaxInfo | description:  Represents all the relevant tax details for a shipping. 
+                - name: logistics  | type: DeliveryLogistics | description:  Shipping logistics. 
+                    - name: deliveryTime  | type: string | description:  Expected delivery time in free text. For example, `"3-5 business days"`. 
+                    - name: deliveryTimeSlot  | type: DeliveryTimeSlot | description:  Expected delivery time. 
+                        - name: from  | type: Date | description:  Delivery slot starting time. 
+                        - name: to  | type: Date | description:  Delivery slot ending time. 
+                    - name: instructions  | type: string | description:  Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. 
+                    - ONE-OF: 
+                      - name: pickupDetails  | type: PickupDetails | description:  Pickup details. 
+                          - name: address  | type: PickupAddress | description:  Pickup address. 
+                              - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                              - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                              - name: city  | type: string | description:  City name. 
+                              - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                              - name: postalCode  | type: string | description:  Postal or zip code. 
+                              - name: streetAddress  | type: StreetAddress | description:  Street address object, with number, name, and apartment number in separate fields. 
+                              - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                          - name: pickupMethod  | type: PickupMethod | description:  Pickup method 
+                              enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
+                      - name: shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+                - name: region  | type: ShippingRegion | description:  Shipping region. 
+                    - name: name  | type: string | description:  Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. 
+                - name: title  | type: string | description:  Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. 
+            - name: status  | type: OrderStatus | description:  Order status. 
+                enum: 
+                     APPROVED: Order approved.  This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.
+                     CANCELED: Order canceled by the user.
+                     INITIALIZED: Order created, but not yet approved or canceled.
+                     PENDING: Order pending.
+                     REJECTED: Order rejected.  This happens when pending payments fail.
+            - name: tags  | type: Tags | description:  Order tags.  [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management. 
+                - name: privateTags  | type: TagList | description:  Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
+                    - name: tagIds  | type: Array<string> | description:  List of tag GUIDs 
+                - name: tags  | type: TagList | description:  Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
+            - name: taxIncludedInPrices  | type: boolean | description:  Whether tax is included in line item prices. 
+            - name: taxInfo  | type: OrderTaxInfo | description:  Tax information. 
+                - name: taxBreakdown  | type: Array<OrderTaxBreakdown> | description:  The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. 
+                      - name: aggregatedTaxAmount  | type: Price | description:  The sum of all the tax from line items that calculated by the tax identifiers. 
+                      - name: jurisdiction  | type: string | description:  The name of the jurisdiction in which this tax detail applies. 
+                      - name: jurisdictionType  | type: JurisdictionType | description:  The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). 
+                      - name: rate  | type: string | description:  The rate at which this tax detail was calculated. 
+                      - name: taxName  | type: string | description:  The name of the tax against which this tax amount was calculated. 
+                      - name: taxType  | type: string | description:  The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. 
+                - name: totalTax  | type: Price | description:  Calculated tax, added from line items. 
+            - name: weightUnit  | type: WeightUnit | description:  Weight measurement unit - defaults to site's weight unit. 
+                enum: 
+                     KG: Kilograms.
+                     LB: Pounds.
+                     UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+  param name:  options | type: BulkUpdateOrdersOptions | description:  none 
+      - name: returnEntity  | type: boolean | description:  Whether to return the full order entities.  Default: `false` 
+Return type: PROMISE<BulkUpdateOrdersResponse>
+      - name: bulkActionMetadata  | type: BulkActionMetadata | description:  Bulk action metadata. 
+          - name: bulkActionMetadata.totalFailures  | type: number | description:  Number of items that couldn't be processed. 
+          - name: bulkActionMetadata.totalSuccesses  | type: number | description:  Number of items that were successfully processed. 
+          - name: bulkActionMetadata.undetailedFailures  | type: number | description:  Number of failures without details because detailed failure threshold was exceeded. 
+      - name: results  | type: Array<BulkOrderResult> | description:  Bulk action results. 
+            - name: results[].item  | type: Order | description:  Updated order.  Returned when `returnFullEntity = true`. 
+                - name: results[].item._createdDate  | type: Date | description:  Date and time the order was created. 
+                - name: results[].item._id  | type: string | description:  Order GUID. 
+                - name: results[].item._updatedDate  | type: Date | description:  Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. 
+                - name: results[].item.activities  | type: Array<Activity> | description:  Order activities. 
+                      - name: results[].item.activities[]._createdDate  | type: Date | description:  Activity creation date and time. 
+                      - name: results[].item.activities[]._id  | type: string | description:  Activity GUID. 
+                      - name: results[].item.activities[].activityType  | type: OrderActivityTypeEnumActivityType | description:  Activity type. 
+                          enum: 
+                               AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured.
+                               AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured.
+                               AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided.
+                               CHARGEBACK_CREATED: Chargeback was created for one of the order's payments.
+                               CHARGEBACK_REVERSED: Chargeback was resolved in merchant's favor.
+                               CUSTOM_ACTIVITY: Custom activity created by a third-party application.
+                               DOWNLOAD_LINK_SENT: Download link was sent for digital items in the order.
+                               DRAFT_ORDER_CHANGES_APPLIED: Changes were applied to a draft order.
+                               EMAIL_EDITED: Order's contact email address was changed.
+                               FULFILLER_EMAIL_SENT: Notification email was sent to the order fulfiller.
+                               INVOICE_ADDED: Invoice document was added to the order.
+                               INVOICE_REMOVED: Invoice was removed from the order.
+                               INVOICE_SENT: Invoice was sent to the customer via email.
+                               MERCHANT_COMMENT: Comment added to the order by a merchant.
+                               NEW_EXCHANGE_ORDER_CREATED: New exchange order was created from this order.
+                               ORDER_CANCELED: Order was canceled by merchant or customer.
+                               ORDER_CREATED_FROM_EXCHANGE: Order was created as a result of an exchange.
+                               ORDER_FULFILLED: Order items were marked as fulfilled (shipped or ready for pickup).
+                               ORDER_NOT_FULFILLED: Order fulfillment status was changed to not fulfilled.
+                               ORDER_PAID: Order payment was completed and confirmed.
+                               ORDER_PARTIALLY_PAID: Partial payment was received for the order.
+                               ORDER_PENDING: Order is awaiting approval or processing.
+                               ORDER_PLACED: New order was created and placed.
+                               ORDER_REFUNDED: Order was refunded, either partially or fully.
+                               ORDER_REJECTED: Order was rejected by merchant.
+                               PAYMENT_CANCELED: Payment was canceled before completion.
+                               PAYMENT_DECLINED: Payment was declined by payment provider.
+                               PAYMENT_PENDING: Payment is awaiting processing or confirmation.
+                               PAYMENT_REFUNDED: Payment was successfully refunded.
+                               PAYMENT_REFUND_FAILED: Attempt to refund payment failed.
+                               PICKUP_READY_EMAIL_SENT: Email notification for pickup readiness was sent.
+                               RECEIPT_CREATED: Receipt was generated for a payment.
+                               RECEIPT_SENT: Receipt was sent to the customer.
+                               REFUNDED_AS_STORE_CREDIT: Refund was issued as store credit.
+                               REFUND_INITIATED: Refund process was initiated.
+                               SAVED_PAYMENT_METHOD: Payment method was saved for future use.
+                               SHIPPING_ADDRESS_EDITED: Order's shipping address was modified.
+                               SHIPPING_CONFIRMATION_EMAIL_SENT: Email confirming shipment was sent to the customer.
+                               TRACKING_LINK_ADDED: Tracking link for shipment was added to the order.
+                               TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order.
+                               TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified.
+                               UNKNOWN_ACTIVITY_TYPE: Default value. This value is unused.
+                      - name: results[].item.activities[].authorEmail  | type: string | description:  Activity author's email. 
+                      - ONE-OF: 
+                        - name: results[].item.activities[].authorizedPaymentCaptured  | type: AuthorizedPaymentCaptured | description:  Details of an authorized payment captured. 
+                            - name: results[].item.activities[].authorizedPaymentCaptured.amount  | type: Price | description:  Payment amount 
+                                - name: results[].item.activities[].authorizedPaymentCaptured.amount.amount  | type: string | description:  Amount. 
+                                - name: results[].item.activities[].authorizedPaymentCaptured.amount.formattedAmount  | type: string | description:  Amount formatted with currency symbol. 
+                            - name: results[].item.activities[].authorizedPaymentCaptured.brand  | type: string | description:  Card issuer's brand. 
+                            - name: results[].item.activities[].authorizedPaymentCaptured.lastFourDigits  | type: string | description:  The last 4 digits of the card number. 
+                            - name: results[].item.activities[].authorizedPaymentCaptured.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                        - name: results[].item.activities[].authorizedPaymentCreated  | type: AuthorizedPaymentCreated | description:  Details of an authorized payment created. 
+                            - name: results[].item.activities[].authorizedPaymentCreated.amount  | type: Price | description:  Payment amount 
+                            - name: results[].item.activities[].authorizedPaymentCreated.brand  | type: string | description:  Card issuer's brand. 
+                            - name: results[].item.activities[].authorizedPaymentCreated.lastFourDigits  | type: string | description:  The last 4 digits of the card number. 
+                            - name: results[].item.activities[].authorizedPaymentCreated.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                        - name: results[].item.activities[].authorizedPaymentVoided  | type: AuthorizedPaymentVoided | description:  Details of an authorized payment voided. 
+                            - name: results[].item.activities[].authorizedPaymentVoided.amount  | type: Price | description:  Payment amount 
+                            - name: results[].item.activities[].authorizedPaymentVoided.brand  | type: string | description:  Card issuer's brand. 
+                            - name: results[].item.activities[].authorizedPaymentVoided.lastFourDigits  | type: string | description:  The last 4 digits of the card number. 
+                            - name: results[].item.activities[].authorizedPaymentVoided.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                        - name: results[].item.activities[].chargebackCreated  | type: ChargebackCreated | description:  Order received a chargeback for one of its' payments. 
+                            - name: results[].item.activities[].chargebackCreated.amount  | type: Price | description:  Chargeback amount. 
+                            - name: results[].item.activities[].chargebackCreated.chargebackId  | type: string | description:  Chargeback GUID. 
+                            - name: results[].item.activities[].chargebackCreated.paymentDetails  | type: RegularPayment | description:  Payment details. 
+                                - name: results[].item.activities[].chargebackCreated.paymentDetails.amount  | type: Price | description:  Payment amount 
+                                - ONE-OF: 
+                                  - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails  | type: CreditCardDetails | description:  Whether regular card used 
+                                      - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.brand  | type: string | description:  Card issuer's brand. 
+                                      - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.lastFourDigits  | type: string | description:  The last 4 digits of the card number. 
+                            - name: results[].item.activities[].chargebackCreated.paymentId  | type: string | description:  GUID of the payment that received a chargeback. 
+                        - name: results[].item.activities[].chargebackReversed  | type: ChargebackReversed | description:  Chargeback reversed for one of the order's payments. 
+                            - name: results[].item.activities[].chargebackReversed.amount  | type: Price | description:  Chargeback amount. 
+                            - name: results[].item.activities[].chargebackReversed.chargebackId  | type: string | description:  Chargeback GUID. 
+                            - name: results[].item.activities[].chargebackReversed.paymentDetails  | type: RegularPayment | description:  Payment details. 
+                            - name: results[].item.activities[].chargebackReversed.paymentId  | type: string | description:  GUID of the payment involved with the chargeback. 
+                            - name: results[].item.activities[].chargebackReversed.reversalAmount  | type: Price | description:  Chargeback reversal amount. 
+                        - name: results[].item.activities[].customActivity  | type: CustomActivity | description:  Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. 
+                            - name: results[].item.activities[].customActivity.additionalData  | type: Record<string, string> | description:  Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. 
+                            - name: results[].item.activities[].customActivity.appId  | type: string | description:  GUID of the app that created the custom activity. 
+                            - name: results[].item.activities[].customActivity.type  | type: string | description:  Custom activity type. For example, `"Ticket number set"`. 
+                        - name: results[].item.activities[].draftOrderChangesApplied  | type: DraftOrderChangesApplied | description:  Details of changes made by the Draft Orders API. 
+                            - name: results[].item.activities[].draftOrderChangesApplied.changes  | type: Array<OrderChange> | description:  Changes applied to order. 
+                                  - ONE-OF: 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded  | type: ManagedAdditionalFee | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded._id  | type: string | description:  Additional fee id. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems  | type: Array<LineItemAmount> | description:  Line items additional fee applies to. 
+                                              - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[]._id  | type: string | description:  Order line item id 
+                                              - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].amount  | type: Price | description:  Amount associated with this item. (Discount amount for item / additional fee amount for item) 
+                                              - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name  | type: ProductName | description:  Item name. 
+                                                  - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.original  | type: string | description:  __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).  Min: 1 character. Max: 200 characters. 
+                                                  - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.translated  | type: string | description:  Item name translated into the buyer's language.  Min: 1 character. Max: 400 characters. Default: Same as `original`. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name  | type: TranslatedValue | description:  Additional fee name. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.original  | type: string | description:  Value in site default language. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.translated  | type: string | description:  Translated value. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.totalAmount  | type: Price | description:  Additional fee amount. 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeRemoved  | type: ManagedAdditionalFee | description:  none 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded  | type: ManagedDiscount | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded._id  | type: string | description:  Discount id. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.affectedLineItems  | type: Array<LineItemAmount> | description:  Line items discount applies to. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.name  | type: TranslatedValue | description:  Discount name: coupon name / discount rule name / merchant discount description. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.totalAmount  | type: Price | description:  Discount amount. 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountRemoved  | type: ManagedDiscount | description:  none 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded  | type: ManagedLineItem | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded._id  | type: string | description:  Line item GUID. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.name  | type: ProductName | description:  Item name. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.quantity  | type: number | description:  Added or removed item quantity. 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged  | type: LineItemChanges | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged._id  | type: string | description:  Line item GUID. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.name  | type: ProductName | description:  Item name after change. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price  | type: LineItemPriceChange | description:  Item price change. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.newPrice  | type: Price | description:  Item price after update. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.originalPrice  | type: Price | description:  Item price before update. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity  | type: LineItemQuantityChange | description:  Item quantity change. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.deltaType  | type: LineItemQuantityChangeType | description:  Type of quantity change: increase or decrease. 
+                                                enum: 
+                                                     QUANTITY_DECREASED: Quantity decreased.
+                                                     QUANTITY_INCREASED: Quantity increased.
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.diff  | type: number | description:  Difference between original and new quantity. Absolute value. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.newQuantity  | type: number | description:  Item quantity after update. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.originalQuantity  | type: number | description:  Item quantity before update. 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemRemoved  | type: ManagedLineItem | description:  none 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged  | type: ShippingInformationChange | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo  | type: ShippingInformation | description:  Order’s Shipping Information. After update 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.shippingTitle  | type: string | description:  Order’s shipping title. 
+                                            - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.total  | type: Price | description:  Order’s shipping price. 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.originalShippingInfo  | type: ShippingInformation | description:  Order’s Shipping Information. Before update 
+                                    - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged  | type: TotalPriceChange | description:  none 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.newTotal  | type: Price | description:  Order’s total price after discounts and tax. After update 
+                                        - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.originalTotal  | type: Price | description:  Order’s total price after discounts and tax. Before update 
+                            - name: results[].item.activities[].draftOrderChangesApplied.draftOrderId  | type: string | description:  Draft order id. 
+                            - name: results[].item.activities[].draftOrderChangesApplied.reason  | type: string | description:  Reason for edit, given by user (optional). 
+                        - name: results[].item.activities[].merchantComment  | type: MerchantComment | description:  Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. 
+                            - name: results[].item.activities[].merchantComment.message  | type: string | description:  Merchant comment message. 
+                        - name: results[].item.activities[].orderRefunded  | type: OrderRefunded | description:  Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. 
+                            - name: results[].item.activities[].orderRefunded.amount  | type: Price | description:  Refund amount. 
+                            - name: results[].item.activities[].orderRefunded.manual  | type: boolean | description:  Whether order was refunded manually. For example, via payment provider or using cash. 
+                            - name: results[].item.activities[].orderRefunded.reason  | type: string | description:  Reason for refund. 
+                        - name: results[].item.activities[].paymentCanceled  | type: PaymentCanceled | description:  Details of a canceled payment. 
+                            - name: results[].item.activities[].paymentCanceled.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                            - ONE-OF: 
+                              - name: results[].item.activities[].paymentCanceled.regular  | type: RegularPayment | description:  Regular payment. 
+                        - name: results[].item.activities[].paymentDeclined  | type: PaymentDeclined | description:  Details of a declined payment. 
+                            - name: results[].item.activities[].paymentDeclined.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                            - ONE-OF: 
+                              - name: results[].item.activities[].paymentDeclined.regular  | type: RegularPayment | description:  Regular payment. 
+                        - name: results[].item.activities[].paymentPending  | type: PaymentPending | description:  Details of a pending payment. 
+                            - name: results[].item.activities[].paymentPending.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                            - ONE-OF: 
+                              - name: results[].item.activities[].paymentPending.regular  | type: RegularPayment | description:  Regular payment. 
+                        - name: results[].item.activities[].paymentRefundFailed  | type: PaymentRefundFailed | description:  Details of a failed payment refund.  > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. 
+                            - name: results[].item.activities[].paymentRefundFailed.payment  | type: RefundedPayment | description:  Details about the failed payment refund. 
+                                - name: results[].item.activities[].paymentRefundFailed.payment.externalRefund  | type: boolean | description:  Whether refund was made externally and manually on the payment provider's side. 
+                                - name: results[].item.activities[].paymentRefundFailed.payment.paymentId  | type: string | description:  Payment GUID. 
+                                - ONE-OF: 
+                                  - name: results[].item.activities[].paymentRefundFailed.payment.giftCard  | type: GiftCardPaymentRefund | description:  Gift card payment refund. 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.amount  | type: Price | description:  Refund amount 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.giftCardPaymentId  | type: string | description:  Gift card payment GUID 
+                                  - name: results[].item.activities[].paymentRefundFailed.payment.membership  | type: MembershipPaymentRefund | description:  Membership payment refund. 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.membership.membershipId  | type: string | description:  Membership GUID 
+                                  - name: results[].item.activities[].paymentRefundFailed.payment.regular  | type: RegularPaymentRefund | description:  Regular payment refund. 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.regular.amount  | type: Price | description:  Refund amount 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.regular.brand  | type: string | description:  Card issuer's brand. 
+                                      - name: results[].item.activities[].paymentRefundFailed.payment.regular.lastFourDigits  | type: string | description:  The last 4 digits of the card number. 
+                            - name: results[].item.activities[].paymentRefundFailed.refundId  | type: string | description:  Refund GUID. 
+                        - name: results[].item.activities[].paymentRefunded  | type: PaymentRefunded | description:  Details of a refunded payment.  > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. 
+                            - name: results[].item.activities[].paymentRefunded.payment  | type: RefundedPayment | description:  Details about the refunded payment. 
+                            - name: results[].item.activities[].paymentRefunded.refundId  | type: string | description:  Refund GUID. 
+                        - name: results[].item.activities[].receiptCreated  | type: ReceiptCreated | description:  Receipt was added for associated payment. 
+                            - name: results[].item.activities[].receiptCreated.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                            - ONE-OF: 
+                              - name: results[].item.activities[].receiptCreated.externalReceipt  | type: ExternalReceipt | description:  Receipt created by an external system. 
+                                  - name: results[].item.activities[].receiptCreated.externalReceipt.displayNumber  | type: string | description:  Display number of receipt 
+                                  - name: results[].item.activities[].receiptCreated.externalReceipt.receiptId  | type: string | description:  Receipt GUID 
+                              - name: results[].item.activities[].receiptCreated.wixReceipt  | type: WixReceipt | description:  Receipt created by Wix 
+                                  - name: results[].item.activities[].receiptCreated.wixReceipt.displayNumber  | type: string | description:  Display number of receipt 
+                                  - name: results[].item.activities[].receiptCreated.wixReceipt.receiptId  | type: string | description:  Receipt GUID 
+                        - name: results[].item.activities[].receiptSent  | type: ReceiptSent | description:  Receipt sent to customer. 
+                            - name: results[].item.activities[].receiptSent.paymentId  | type: string | description:  Payment GUID of payment associated with this activity 
+                            - ONE-OF: 
+                              - name: results[].item.activities[].receiptSent.externalReceipt  | type: ExternalReceipt | description:  Receipt created by an external system. 
+                              - name: results[].item.activities[].receiptSent.wixReceipt  | type: WixReceipt | description:  Receipt created by Wix 
+                        - name: results[].item.activities[].refundInitiated  | type: RefundInitiated | description:  Details of an initiated refund process.  > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities. 
+                            - name: results[].item.activities[].refundInitiated.amount  | type: Price | description:  Refund amount. 
+                            - name: results[].item.activities[].refundInitiated.payments  | type: Array<RefundedPayment> | description:  Details about the payments being refunded. 
+                            - name: results[].item.activities[].refundInitiated.reason  | type: string | description:  Reason for refund. 
+                            - name: results[].item.activities[].refundInitiated.refundId  | type: string | description:  Refund GUID. 
+                        - name: results[].item.activities[].refundedAsStoreCredit  | type: RefundedAsStoreCredit | description:  Details of refund to store credit. 
+                            - name: results[].item.activities[].refundedAsStoreCredit.amount  | type: Price | description:  Refund amount 
+                            - name: results[].item.activities[].refundedAsStoreCredit.reason  | type: string | description:  Reason for refund 
+                        - name: results[].item.activities[].savedPaymentMethod  | type: SavedPaymentMethod | description:  Details of the payment method saved for order 
+                            - name: results[].item.activities[].savedPaymentMethod.description  | type: string | description:  Payment method description 
+                            - name: results[].item.activities[].savedPaymentMethod.name  | type: string | description:  Payment method name 
+                - name: results[].item.additionalFees  | type: Array<AdditionalFee> | description:  Additional fees applied to the order. 
+                      - name: results[].item.additionalFees[]._id  | type: string | description:  Additional fee's id. 
+                      - name: results[].item.additionalFees[].code  | type: string | description:  Additional fee's unique code for future processing. 
+                      - name: results[].item.additionalFees[].lineItemIds  | type: Array<string> | description:  Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. 
+                      - name: results[].item.additionalFees[].name  | type: string | description:  Name of additional fee. 
+                      - name: results[].item.additionalFees[].price  | type: Price | description:  Additional fee's price. 
+                      - name: results[].item.additionalFees[].priceAfterTax  | type: Price | description:  Additional fee's price after tax. 
+                      - name: results[].item.additionalFees[].priceBeforeTax  | type: Price | description:  Additional fee's price before tax. 
+                      - name: results[].item.additionalFees[].providerAppId  | type: string | description:  SPI implementer's `appId`. 
+                      - name: results[].item.additionalFees[].taxInfo  | type: LineItemTaxInfo | description:  Represents all the relevant tax details for additional fee. 
+                          - name: results[].item.additionalFees[].taxInfo.taxAmount  | type: Price | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+                          - name: results[].item.additionalFees[].taxInfo.taxBreakdown  | type: Array<LineItemTaxBreakdown> | description:  Tax information for a line item. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdiction  | type: string | description:  Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdictionType  | type: JurisdictionType | description:  Type of jurisdiction that taxes were calculated for. 
+                                    enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].nonTaxableAmount  | type: Price | description:  Non-taxable amount of the line item price. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].rate  | type: string | description:  Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxAmount  | type: Price | description:  Amount of tax calculated for this line item. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxName  | type: string | description:  The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxType  | type: string | description:  The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. 
+                                - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxableAmount  | type: Price | description:  Taxable amount of the line item price. 
+                          - name: results[].item.additionalFees[].taxInfo.taxGroupId  | type: string | description:  Tax group GUID. 
+                          - name: results[].item.additionalFees[].taxInfo.taxIncludedInPrice  | type: boolean | description:  Indicates whether the price already includes tax. 
+                          - name: results[].item.additionalFees[].taxInfo.taxRate  | type: string | description:  Tax rate %, as a decimal point. 
+                          - name: results[].item.additionalFees[].taxInfo.taxableAmount  | type: Price | description:  Amount for which tax is calculated. 
+                - name: results[].item.appliedDiscounts  | type: Array<AppliedDiscount> | description:  Applied discounts. 
+                      - name: results[].item.appliedDiscounts[]._id  | type: string | description:  Discount id. 
+                      - name: results[].item.appliedDiscounts[].discountType  | type: DiscountType | description:  Discount type. * `"GLOBAL"` - discount applies to entire order. * `"SPECIFIC-ITEMS"` - discount applies to specific items. * `"SHIPPING"` - discount applies to shipping. For example, free shipping. 
+                          enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
+                      - ONE-OF: 
+                        - name: results[].item.appliedDiscounts[].coupon  | type: Coupon | description:  Applied coupon info. 
+                            - name: results[].item.appliedDiscounts[].coupon._id  | type: string | description:  Coupon GUID. 
+                            - name: results[].item.appliedDiscounts[].coupon.amount  | type: Price | description:  Coupon value. 
+                            - name: results[].item.appliedDiscounts[].coupon.code  | type: string | description:  Coupon code. 
+                            - name: results[].item.appliedDiscounts[].coupon.name  | type: string | description:  Coupon name. 
+                        - name: results[].item.appliedDiscounts[].discountRule  | type: DiscountRule | description:  Automatic Discount 
+                            - name: results[].item.appliedDiscounts[].discountRule._id  | type: string | description:  Discount rule GUID 
+                            - name: results[].item.appliedDiscounts[].discountRule.amount  | type: Price | description:  Discount value. 
+                            - name: results[].item.appliedDiscounts[].discountRule.name  | type: DiscountRuleName | description:  Discount rule name 
+                                - name: results[].item.appliedDiscounts[].discountRule.name.original  | type: string | description:  Original discount rule name (in site's default language). 
+                                - name: results[].item.appliedDiscounts[].discountRule.name.translated  | type: string | description:  Translated discount rule name according to buyer language. Defaults to `original` when not provided. 
+                        - name: results[].item.appliedDiscounts[].merchantDiscount  | type: MerchantDiscount | description:  Merchant discount. 
+                            - name: results[].item.appliedDiscounts[].merchantDiscount.amount  | type: Price | description:  Discount amount. 
+                            - ONE-OF: 
+                              - name: results[].item.appliedDiscounts[].merchantDiscount.description  | type: string | description:  Discount description as free text (optional). 
+                              - name: results[].item.appliedDiscounts[].merchantDiscount.discountReason  | type: DiscountReason | description:  Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange. 
+                                  enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
+                - name: results[].item.archived  | type: boolean | description:  Whether order is archived. 
+                - name: results[].item.attributionSource  | type: AttributionSource | description:  Order attribution source. 
+                    enum: FACEBOOK_ADS, UNSPECIFIED
+                - name: results[].item.balanceSummary  | type: BalanceSummary | description:  Balance summary. 
+                    - name: results[].item.balanceSummary.authorized  | type: Price | description:  Sum of all authorized payments. 
+                    - name: results[].item.balanceSummary.balance  | type: Balance | description:  Current amount left to pay. 
+                        - name: results[].item.balanceSummary.balance.amount  | type: string | description:  Balance amount.  A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made. 
+                        - name: results[].item.balanceSummary.balance.formattedAmount  | type: string | description:  Amount formatted with currency symbol. 
+                    - name: results[].item.balanceSummary.chargeback  | type: Price | description:  Sum of all transaction chargebacks. 
+                    - name: results[].item.balanceSummary.chargebackReversal  | type: Price | description:  Sum of all chargeback reversals. 
+                    - name: results[].item.balanceSummary.paid  | type: Price | description:  Sum of all approved and successful payments.  The value includes payments that have subsequently been fully or partially refunded. 
+                    - name: results[].item.balanceSummary.pending  | type: Price | description:  Sum of all pending transactions. 
+                    - name: results[].item.balanceSummary.pendingRefund  | type: Price | description:  Sum of all pending refund transactions. 
+                    - name: results[].item.balanceSummary.refunded  | type: Price | description:  Sum of all successfully refunded payments. 
+                - name: results[].item.billingInfo  | type: AddressWithContact | description:  Billing address and contact details. 
+                    - name: results[].item.billingInfo.address  | type: Address | description:  Address. 
+                        - name: results[].item.billingInfo.address.addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                        - name: results[].item.billingInfo.address.addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                        - name: results[].item.billingInfo.address.city  | type: string | description:  City name. 
+                        - name: results[].item.billingInfo.address.country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                        - name: results[].item.billingInfo.address.countryFullname  | type: string | description:  Country's full name. 
+                        - name: results[].item.billingInfo.address.location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                            - name: results[].item.billingInfo.address.location.latitude  | type: number | description:  Address latitude. 
+                            - name: results[].item.billingInfo.address.location.longitude  | type: number | description:  Address longitude. 
+                        - name: results[].item.billingInfo.address.postalCode  | type: string | description:  Postal or zip code. 
+                        - name: results[].item.billingInfo.address.streetAddress  | type: StreetAddress | description:  Street address. 
+                            - name: results[].item.billingInfo.address.streetAddress.name  | type: string | description:  Street name. 
+                            - name: results[].item.billingInfo.address.streetAddress.number  | type: string | description:  Street number. 
+                        - name: results[].item.billingInfo.address.subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                        - name: results[].item.billingInfo.address.subdivisionFullname  | type: string | description:  Subdivision full-name. 
+                    - name: results[].item.billingInfo.contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+                        - name: results[].item.billingInfo.contactDetails.company  | type: string | description:  Company name. 
+                        - name: results[].item.billingInfo.contactDetails.firstName  | type: string | description:  First name. 
+                        - name: results[].item.billingInfo.contactDetails.lastName  | type: string | description:  Last name. 
+                        - name: results[].item.billingInfo.contactDetails.phone  | type: string | description:  Phone number. 
+                        - name: results[].item.billingInfo.contactDetails.vatId  | type: VatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                            - name: results[].item.billingInfo.contactDetails.vatId._id  | type: string | description:  Customer's tax GUID. 
+                            - name: results[].item.billingInfo.contactDetails.vatId.type  | type: VatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                                enum: 
+                                     CNPJ: CNPJ - for corporations
+                                     CPF: CPF - for individual tax payers.
+                                   UNSPECIFIED
+                - name: results[].item.businessLocation  | type: Location | description:  Order Location 
+                    - name: results[].item.businessLocation._id  | type: string | description:  Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction). 
+                    - name: results[].item.businessLocation.name  | type: string | description:  Location name. 
+                - name: results[].item.buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+                    - name: results[].item.buyerInfo.contactId  | type: string | description:  Contact GUID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction). 
+                    - name: results[].item.buyerInfo.email  | type: string | description:  Buyer email address. 
+                    - ONE-OF: 
+                      - name: results[].item.buyerInfo.memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+                      - name: results[].item.buyerInfo.visitorId  | type: string | description:  Visitor GUID (if site visitor is not a member). 
+                - name: results[].item.buyerLanguage  | type: string | description:  Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected. 
+                - name: results[].item.buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. 
+                - name: results[].item.channelInfo  | type: ChannelInfo | description:  Information about the sales channel that submitted this order. 
+                    - name: results[].item.channelInfo.externalOrderId  | type: string | description:  Reference to an order GUID from an external system. 
+                    - name: results[].item.channelInfo.externalOrderUrl  | type: string | description:  URL to the order in the external system. 
+                    - name: results[].item.channelInfo.type  | type: ChannelType | description:  Sales channel that submitted the order. 
+                        enum: 
+                             AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
+                             BACKOFFICE_MERCHANT: Wix merchant backoffice.
+                             CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
+                             EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
+                             ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
+                             FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
+                             FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
+                             GLOBAL_E: Global-E sales channel.
+                             OTHER_PLATFORM: Other sales platform.
+                             PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
+                             POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
+                             TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
+                             UNSPECIFIED: Unspecified sales channel. This value is not supported.
+                             WEB: A web client.
+                             WISH: Wish sales channel.
+                             WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
+                             WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
+                - name: results[].item.checkoutId  | type: string | description:  Checkout GUID. 
+                - name: results[].item.createdBy  | type: CreatedBy | description:  GUID of the order's initiator. 
+                    - ONE-OF: 
+                      - name: results[].item.createdBy.appId  | type: string | description:  App GUID - when the order was created by an external application. 
+                      - name: results[].item.createdBy.memberId  | type: string | description:  Member GUID - when the order was created by a **logged in** site visitor. 
+                      - name: results[].item.createdBy.userId  | type: string | description:  User GUID - when the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service). 
+                      - name: results[].item.createdBy.visitorId  | type: string | description:  Visitor GUID - when the order was created by a site visitor that was **not** logged in. 
+                - name: results[].item.currency  | type: string | description:  Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. 
+                - name: results[].item.currencyConversionDetails  | type: CurrencyConversionDetails | description:  Currency conversion details. For use with multi-currency sites. 
+                    - name: results[].item.currencyConversionDetails.conversionRate  | type: string | description:  The rate used for converting the original currency to the currency used for payment. 
+                    - name: results[].item.currencyConversionDetails.originalCurrency  | type: string | description:  Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.  This currency is used to calculate the pricing before conversion to the buyer's payment currency. 
+                - name: results[].item.customFields  | type: Array<CustomField> | description:  Custom fields. 
+                      - name: results[].item.customFields[].title  | type: string | description:  Custom field title. 
+                      - name: results[].item.customFields[].translatedTitle  | type: string | description:  Translated custom field title. 
+                      - name: results[].item.customFields[].value  | type: any | description:  Custom field value. 
+                - name: results[].item.extendedFields  | type: ExtendedFields | description:  Custom field data for the order object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                    - name: results[].item.extendedFields.namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+                - name: results[].item.fulfillmentStatus  | type: FulfillmentStatus | description:  Order fulfillment status. 
+                    enum: 
+                         FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled. Orders without shipping info are fulfilled automatically.
+                         NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled.
+                         PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled.
+                - name: results[].item.lineItems  | type: Array<OrderLineItem> | description:  Order line items. 
+                      - name: results[].item.lineItems[]._id  | type: string | description:  Line item GUID. 
+                      - name: results[].item.lineItems[].catalogReference  | type: CatalogReference | description:  Catalog and item reference. Holds GUIDs 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. 
+                          - name: results[].item.lineItems[].catalogReference.appId  | type: string | description:  GUID of the app providing the catalog.  You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).  For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"` 
+                          - name: results[].item.lineItems[].catalogReference.catalogItemId  | type: string | description:  GUID of the item within the catalog it belongs to. 
+                          - name: results[].item.lineItems[].catalogReference.options  | type: Record<string, any> | description:  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.  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). 
+                      - name: results[].item.lineItems[].depositAmount  | type: Price | description:  Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`. 
+                      - name: results[].item.lineItems[].descriptionLines  | type: Array<DescriptionLine> | description:  Line item description lines. Used for display purposes for the cart, checkout and order. 
+                            - name: results[].item.lineItems[].descriptionLines[].name  | type: DescriptionLineName | description:  Description line name. 
+                                - name: results[].item.lineItems[].descriptionLines[].name.original  | type: string | description:  Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+                                - name: results[].item.lineItems[].descriptionLines[].name.translated  | type: string | description:  Description line name translated into the buyer's language.  Default: Same as `original`. 
+                            - ONE-OF: 
+                              - name: results[].item.lineItems[].descriptionLines[].colorInfo  | type: Color | description:  Description line color value. 
+                                  - name: results[].item.lineItems[].descriptionLines[].colorInfo.code  | type: string | description:  HEX or RGB color code for display. 
+                                  - name: results[].item.lineItems[].descriptionLines[].colorInfo.original  | type: string | description:  Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+                                  - name: results[].item.lineItems[].descriptionLines[].colorInfo.translated  | type: string | description:  Description line color name translated into the buyer's language.  Default: Same as `original`. 
+                              - name: results[].item.lineItems[].descriptionLines[].plainText  | type: PlainTextValue | description:  Description line plain text value. 
+                                  - name: results[].item.lineItems[].descriptionLines[].plainText.original  | type: string | description:  Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+                                  - name: results[].item.lineItems[].descriptionLines[].plainText.translated  | type: string | description:  Description line plain text value translated into the buyer's language.  Default: Same as `original`. 
+                            - ONE-OF: 
+                      - name: results[].item.lineItems[].digitalFile  | type: DigitalFile | description:  Digital file identifier, relevant only for items with type DIGITAL. 
+                          - name: results[].item.lineItems[].digitalFile.expirationDate  | type: Date | description:  Link expiration time and date. 
+                          - name: results[].item.lineItems[].digitalFile.fileId  | type: string | description:  GUID of the secure file in media. 
+                          - name: results[].item.lineItems[].digitalFile.link  | type: string | description:  Link will exist after the digital links have been generated on the order. 
+                      - name: results[].item.lineItems[].extendedFields  | type: ExtendedFields | description:  Custom extended fields for the line item object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                      - name: results[].item.lineItems[].fulfillerId  | type: string | description:  Fulfiller GUID. Field is empty when the line item is self-fulfilled.  To get fulfillment information, pass the order GUID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder). 
+                      - name: results[].item.lineItems[].image  | type: string | description:  Line item image. 
+                      - name: results[].item.lineItems[].itemType  | type: ItemType | description:  Item type. Either a preset type or custom. 
+                          - ONE-OF: 
+                            - name: results[].item.lineItems[].itemType.custom  | type: string | description:  Custom item type. When none of the preset types are suitable, specifies the custom type. 
+                            - name: results[].item.lineItems[].itemType.preset  | type: ItemTypePreset | description:  Preset item type. 
+                                enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
+                      - name: results[].item.lineItems[].locations  | type: Array<LocationAndQuantity> | description:  Line item locations.  The location's total quantity must not exceed the line item quantity. 
+                            - name: results[].item.lineItems[].locations[]._id  | type: string | description:  Location id in the associated owner app. 
+                            - name: results[].item.lineItems[].locations[].name  | type: string | description:  Location name. 
+                            - name: results[].item.lineItems[].locations[].quantity  | type: number | description:  Quantity for specific location. 
+                      - name: results[].item.lineItems[].modifierGroups  | type: Array<ModifierGroup> | description:  Modifier groups that were added to the item. 
+                            - name: results[].item.lineItems[].modifierGroups[]._id  | type: string | description:  Modifier group GUID. 
+                            - name: results[].item.lineItems[].modifierGroups[].modifiers  | type: Array<ItemModifier> | description:  List of modifiers in this group. 
+                                  - name: results[].item.lineItems[].modifierGroups[].modifiers[]._id  | type: string | description:  Modifier GUID. 
+                                  - name: results[].item.lineItems[].modifierGroups[].modifiers[].details  | type: TranslatableString | description:  Additional details. 
+                                      - name: results[].item.lineItems[].modifierGroups[].modifiers[].details.original  | type: string | description:  __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).  Min: 1 character. Max: 200 characters. 
+                                      - name: results[].item.lineItems[].modifierGroups[].modifiers[].details.translated  | type: string | description:  String translated into the buyer's language.  Min: 1 character. Max: 400 characters. Default: Same as `original`. 
+                                  - name: results[].item.lineItems[].modifierGroups[].modifiers[].label  | type: TranslatableString | description:  Primary display label for the modifier. 
+                                  - name: results[].item.lineItems[].modifierGroups[].modifiers[].price  | type: Price | description:  The price of the modifier. 
+                                  - name: results[].item.lineItems[].modifierGroups[].modifiers[].quantity  | type: number | description:  The quantity of this modifier. 
+                            - name: results[].item.lineItems[].modifierGroups[].name  | type: TranslatableString | description:  Modifier group name. 
+                      - name: results[].item.lineItems[].paymentOption  | type: PaymentOptionType | description:  Type of selected payment option for current item.  Default: `FULL_PAYMENT_ONLINE` 
+                          enum: 
+                               DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
+                               FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
+                               FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
+                               MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
+                               MEMBERSHIP_OFFLINE: Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`.
+                               MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
+                      - name: results[].item.lineItems[].physicalProperties  | type: PhysicalProperties | description:  Physical properties of the item. When relevant, contains information such as SKU and item weight. 
+                          - name: results[].item.lineItems[].physicalProperties.shippable  | type: boolean | description:  Whether this line item is shippable. 
+                          - name: results[].item.lineItems[].physicalProperties.sku  | type: string | description:  Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). 
+                          - name: results[].item.lineItems[].physicalProperties.weight  | type: number | description:  Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. 
+                      - name: results[].item.lineItems[].price  | type: Price | description:  Line item price after line item discounts for display purposes. 
+                      - name: results[].item.lineItems[].priceBeforeDiscounts  | type: Price | description:  Line item price before line item discounts for display purposes. Defaults to `price` when not provided. 
+                      - name: results[].item.lineItems[].priceDescription  | type: PriceDescription | description:  Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". 
+                          - name: results[].item.lineItems[].priceDescription.original  | type: string | description:  __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+                          - name: results[].item.lineItems[].priceDescription.translated  | type: string | description:  Price description translated into the buyer's language.  Default: Same as `original`. 
+                      - name: results[].item.lineItems[].priceUndetermined  | type: boolean | description:  Whether the price is not yet defined, and will be updated after the order is created.  Default: `false` 
+                      - name: results[].item.lineItems[].productName  | type: ProductName | description:  Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name` 
+                      - name: results[].item.lineItems[].quantity  | type: number | description:  Line item quantity. 
+                      - name: results[].item.lineItems[].refundQuantity  | type: number | description:  Number of items that were refunded. 
+                      - name: results[].item.lineItems[].restockQuantity  | type: number | description:  Number of items restocked. 
+                      - name: results[].item.lineItems[].subscriptionInfo  | type: SubscriptionInfo | description:  Subscription info. 
+                          - name: results[].item.lineItems[].subscriptionInfo._id  | type: string | description:  Subscription GUID. 
+                          - name: results[].item.lineItems[].subscriptionInfo.chargesDescription  | type: string | description:  Description of the charges that will be applied for subscription. 
+                          - name: results[].item.lineItems[].subscriptionInfo.cycleNumber  | type: number | description:  Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. 
+                          - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings  | type: SubscriptionSettings | description:  Subscription detailed information. 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.autoRenewal  | type: boolean | description:  Whether subscription is renewed automatically at the end of each period. 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.billingCycles  | type: number | description:  Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.enableCustomerCancellation  | type: boolean | description:  Whether to allow the customer to cancel the subscription. 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod  | type: FreeTrialPeriod | description:  Period until first cycle starts. If None => no free trial 
+                                  - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency  | type: SubscriptionFrequency | description:  Frequency of period. Values: DAY, WEEK, MONTH, YEAR 
+                                      enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
+                                  - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval  | type: number | description:  interval of period 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.frequency  | type: SubscriptionFrequency | description:  Frequency of recurring payment. 
+                              - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.interval  | type: number | description:  Interval of recurring payment. 
+                      - name: results[].item.lineItems[].taxInfo  | type: LineItemTaxInfo | description:  Represents all the relevant tax details for a specific line item. 
+                      - name: results[].item.lineItems[].taxableAddress  | type: TaxableAddress | description:  Address used for tax calculation. 
+                          - ONE-OF: 
+                            - name: results[].item.lineItems[].taxableAddress.addressType  | type: TaxableAddressType | description:  taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. 
+                                enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
+                      - name: results[].item.lineItems[].totalDiscount  | type: Price | description:  Total discount for this line item's entire quantity. 
+                      - name: results[].item.lineItems[].totalPriceAfterTax  | type: Price | description:  Total price after all discounts and tax. 
+                      - name: results[].item.lineItems[].totalPriceBeforeTax  | type: Price | description:  Total price after discounts, and before tax. 
+                - name: results[].item.number  | type: string | description:  Order number displayed in the site owner's dashboard (auto-generated). 
+                - name: results[].item.payAfterFreeTrial  | type: PriceSummary | description:  Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period. 
+                    - name: results[].item.payAfterFreeTrial.discount  | type: Price | description:  Total calculated discount value. 
+                    - name: results[].item.payAfterFreeTrial.shipping  | type: Price | description:  Total shipping price, before discounts and before tax. 
+                    - name: results[].item.payAfterFreeTrial.subtotal  | type: Price | description:  Subtotal of all the line items, before discounts and before tax. 
+                    - name: results[].item.payAfterFreeTrial.tax  | type: Price | description:  Total tax on this order. 
+                    - name: results[].item.payAfterFreeTrial.total  | type: Price | description:  Order’s total price after discounts and tax. 
+                    - name: results[].item.payAfterFreeTrial.totalAdditionalFees  | type: Price | description:  Total price of additional fees before tax. 
+                - name: results[].item.paymentStatus  | type: PaymentStatus | description:  Order payment status. 
+                    enum: 
+                         CANCELED: One or more payments canceled.
+                         DECLINED: One or more payments declined.
+                         FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
+                         NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`. This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
+                         PAID: All required payments associated with this order are paid.
+                         PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details.
+                         PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
+                         PENDING: All payments pending.  This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
+                         PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider.  In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
+                       UNSPECIFIED
+                - name: results[].item.priceSummary  | type: PriceSummary | description:  Order price summary. 
+                - name: results[].item.purchaseFlowId  | type: string | description:  Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. 
+                - name: results[].item.purchasedDate  | type: Date | description:  Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems. 
+                - name: results[].item.recipientInfo  | type: AddressWithContact | description:  Order recipient address and contact details.  This field may differ from the address in `shippingInfo.logistics` when: + The chosen shipping option is pickup point or store pickup. + No shipping option is selected. 
+                - name: results[].item.seenByAHuman  | type: boolean | description:  Whether a human has seen the order. Set when an order is clicked on in the dashboard. 
+                - name: results[].item.shippingInfo  | type: V1ShippingInformation | description:  Shipping info and selected shipping option details. 
+                    - name: results[].item.shippingInfo.carrierId  | type: string | description:  App Def Id of external provider which was a source of shipping info 
+                    - name: results[].item.shippingInfo.code  | type: string | description:  Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`. 
+                    - name: results[].item.shippingInfo.cost  | type: ShippingPrice | description:  Shipping costs. 
+                        - name: results[].item.shippingInfo.cost.discount  | type: Price | description:  Shipping discount before tax. 
+                        - name: results[].item.shippingInfo.cost.price  | type: Price | description:  Shipping price for display purposes. 
+                        - name: results[].item.shippingInfo.cost.taxInfo  | type: LineItemTaxInfo | description:  Represents all the relevant tax details for a shipping. 
+                        - name: results[].item.shippingInfo.cost.totalPriceAfterTax  | type: Price | description:  Shipping price after all discounts (if any exist), and after tax. 
+                        - name: results[].item.shippingInfo.cost.totalPriceBeforeTax  | type: Price | description:  Total price of shipping after discounts (when relevant), and before tax. 
+                    - name: results[].item.shippingInfo.logistics  | type: DeliveryLogistics | description:  Shipping logistics. 
+                        - name: results[].item.shippingInfo.logistics.deliveryTime  | type: string | description:  Expected delivery time in free text. For example, `"3-5 business days"`. 
+                        - name: results[].item.shippingInfo.logistics.deliveryTimeSlot  | type: DeliveryTimeSlot | description:  Expected delivery time. 
+                            - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.from  | type: Date | description:  Delivery slot starting time. 
+                            - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.to  | type: Date | description:  Delivery slot ending time. 
+                        - name: results[].item.shippingInfo.logistics.instructions  | type: string | description:  Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. 
+                        - ONE-OF: 
+                          - name: results[].item.shippingInfo.logistics.pickupDetails  | type: PickupDetails | description:  Pickup details. 
+                              - name: results[].item.shippingInfo.logistics.pickupDetails.address  | type: PickupAddress | description:  Pickup address. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.city  | type: string | description:  City name. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.countryFullname  | type: string | description:  Country's full name. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.postalCode  | type: string | description:  Postal or zip code. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.streetAddress  | type: StreetAddress | description:  Street address object, with number, name, and apartment number in separate fields. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                                  - name: results[].item.shippingInfo.logistics.pickupDetails.address.subdivisionFullname  | type: string | description:  Subdivision full-name. 
+                              - name: results[].item.shippingInfo.logistics.pickupDetails.pickupMethod  | type: PickupMethod | description:  Pickup method 
+                                  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
+                          - name: results[].item.shippingInfo.logistics.shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+                    - name: results[].item.shippingInfo.region  | type: ShippingRegion | description:  Shipping region. 
+                        - name: results[].item.shippingInfo.region.name  | type: string | description:  Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. 
+                    - name: results[].item.shippingInfo.title  | type: string | description:  Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`. 
+                - name: results[].item.siteLanguage  | type: string | description:  Site language in which original values are shown. 
+                - name: results[].item.status  | type: OrderStatus | description:  Order status. 
+                    enum: 
+                         APPROVED: Order approved.  This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.
+                         CANCELED: Order canceled by the user.
+                         INITIALIZED: Order created, but not yet approved or canceled.
+                         PENDING: Order pending.
+                         REJECTED: Order rejected.  This happens when pending payments fail.
+                - name: results[].item.tags  | type: Tags | description:  Order tags.  [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management. 
+                    - name: results[].item.tags.privateTags  | type: TagList | description:  Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
+                        - name: results[].item.tags.privateTags.tagIds  | type: Array<string> | description:  List of tag GUIDs 
+                    - name: results[].item.tags.tags  | type: TagList | description:  Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
+                - name: results[].item.taxIncludedInPrices  | type: boolean | description:  Whether tax is included in line item prices. 
+                - name: results[].item.taxInfo  | type: OrderTaxInfo | description:  Tax information. 
+                    - name: results[].item.taxInfo.taxBreakdown  | type: Array<OrderTaxBreakdown> | description:  The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. 
+                          - name: results[].item.taxInfo.taxBreakdown[].aggregatedTaxAmount  | type: Price | description:  The sum of all the tax from line items that calculated by the tax identifiers. 
+                          - name: results[].item.taxInfo.taxBreakdown[].jurisdiction  | type: string | description:  The name of the jurisdiction in which this tax detail applies. 
+                          - name: results[].item.taxInfo.taxBreakdown[].jurisdictionType  | type: JurisdictionType | description:  The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). 
+                          - name: results[].item.taxInfo.taxBreakdown[].rate  | type: string | description:  The rate at which this tax detail was calculated. 
+                          - name: results[].item.taxInfo.taxBreakdown[].taxName  | type: string | description:  The name of the tax against which this tax amount was calculated. 
+                          - name: results[].item.taxInfo.taxBreakdown[].taxType  | type: string | description:  The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. 
+                    - name: results[].item.taxInfo.taxExempt  | type: boolean | description:  Whether the order is exempt from tax calculations.  Default: `false` 
+                    - name: results[].item.taxInfo.totalTax  | type: Price | description:  Calculated tax, added from line items. 
+                - name: results[].item.weightUnit  | type: WeightUnit | description:  Weight measurement unit - defaults to site's weight unit. 
+                    enum: 
+                         KG: Kilograms.
+                         LB: Pounds.
+                         UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+            - name: results[].itemMetadata  | type: ItemMetadata | description:  Item metadata. 
+                - name: results[].itemMetadata._id  | type: string | description:  Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
+                - name: results[].itemMetadata.error  | type: ApplicationError | description:  Details about the error in case of failure. 
+                    - name: results[].itemMetadata.error.code  | type: string | description:  Error code. 
+                    - name: results[].itemMetadata.error.data  | type: Record<string, any> | description:  Data related to the error. 
+                    - name: results[].itemMetadata.error.description  | type: string | description:  Description of the error. 
+                - name: results[].itemMetadata.originalIndex  | type: number | description:  Index of the item within the request array. Allows for correlation between request and response items. 
+                - name: results[].itemMetadata.success  | type: boolean | description:  Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
+
+```
+</type_definition>
+</ecom_orders_bulkUpdateOrders>