@wix/ditto-codegen-public 1.0.162 → 1.0.163

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/dist/docs-output/api-docs/bookings-bookings-onBookingCanceled-doc.txt +169 -0
  2. package/dist/docs-output/api-docs/bookings-bookings-onBookingCreated-doc.txt +154 -0
  3. package/dist/docs-output/api-docs/crm-contacts-onContactCreated-doc.txt +87 -171
  4. package/dist/docs-output/api-docs/crm-contacts-onContactDeleted-doc.txt +58 -0
  5. package/dist/docs-output/api-docs/crm-contacts-onContactUpdated-doc.txt +99 -0
  6. package/dist/docs-output/api-docs/data-items-get-doc.txt +95 -54
  7. package/dist/docs-output/api-docs/data-items-insert-doc.txt +235 -43
  8. package/dist/docs-output/api-docs/data-items-onDataItemCreated-doc.txt +61 -0
  9. package/dist/docs-output/api-docs/data-items-onDataItemDeleted-doc.txt +58 -0
  10. package/dist/docs-output/api-docs/data-items-onDataItemUpdated-doc.txt +61 -0
  11. package/dist/docs-output/api-docs/data-items-query-doc.txt +507 -302
  12. package/dist/docs-output/api-docs/data-items-remove-doc.txt +120 -40
  13. package/dist/docs-output/api-docs/data-items-update-doc.txt +425 -46
  14. package/dist/docs-output/api-docs/ecom-cart-addToCart-doc.txt +488 -0
  15. package/dist/docs-output/api-docs/ecom-cart-createCart-doc.txt +518 -0
  16. package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt +155 -0
  17. package/dist/docs-output/api-docs/ecom-cart-deleteCart-doc.txt +92 -0
  18. package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt +376 -0
  19. package/dist/docs-output/api-docs/ecom-cart-onCartCreated-doc.txt +89 -80
  20. package/dist/docs-output/api-docs/ecom-cart-onCartUpdated-doc.txt +91 -81
  21. package/dist/docs-output/api-docs/ecom-cart-removeLineItemsFromCart-doc.txt +321 -0
  22. package/dist/docs-output/api-docs/ecom-cart-updateCart-doc.txt +539 -0
  23. package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt +1005 -0
  24. package/dist/docs-output/api-docs/ecom-checkout-createCheckout-doc.txt +1641 -0
  25. package/dist/docs-output/api-docs/ecom-checkout-getCheckout-doc.txt +1027 -0
  26. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCompleted-doc.txt +151 -0
  27. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCreated-doc.txt +150 -0
  28. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutUpdated-doc.txt +150 -0
  29. package/dist/docs-output/api-docs/ecom-checkout-removeLineItemsFromCheckout-doc.txt +879 -0
  30. package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt +1011 -0
  31. package/dist/docs-output/api-docs/ecom-currentCart-getCurrentCart-doc.txt +368 -322
  32. package/dist/docs-output/api-docs/ecom-currentCart-updateCurrentCart-doc.txt +506 -321
  33. package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt +1040 -0
  34. package/dist/docs-output/api-docs/ecom-orders-cancelOrder-doc.txt +608 -0
  35. package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt +926 -0
  36. package/dist/docs-output/api-docs/ecom-orders-onOrderCreated-doc.txt +245 -0
  37. package/dist/docs-output/api-docs/ecom-orders-onOrderUpdated-doc.txt +244 -0
  38. package/dist/docs-output/api-docs/ecom-orders-searchOrders-doc.txt +670 -0
  39. package/dist/docs-output/api-docs/ecom-orders-updateOrder-doc.txt +818 -0
  40. package/dist/docs-output/api-docs/search-wixSiteSearch-search-doc.txt +162 -0
  41. package/dist/docs-output/api-docs/stores-collections-addProductsToCollection-doc.txt +86 -0
  42. package/dist/docs-output/api-docs/stores-collections-createCollection-doc.txt +108 -0
  43. package/dist/docs-output/api-docs/stores-collections-getCollection-doc.txt +102 -0
  44. package/dist/docs-output/api-docs/stores-collections-queryCollections-doc.txt +209 -0
  45. package/dist/docs-output/api-docs/stores-collections-removeProductsFromCollection-doc.txt +86 -0
  46. package/dist/docs-output/api-docs/stores-collections-updateCollection-doc.txt +110 -0
  47. package/dist/docs-output/api-docs/stores-inventory-queryInventory-doc.txt +98 -0
  48. package/dist/docs-output/api-docs/stores-inventory-updateInventoryVariants-doc.txt +249 -0
  49. package/dist/docs-output/api-docs/stores-inventoryItemsV3-queryInventoryItems-doc.txt +236 -0
  50. package/dist/docs-output/api-docs/stores-inventoryItemsV3-updateInventoryItem-doc.txt +139 -0
  51. package/dist/docs-output/api-docs/stores-productsV3-createProduct-doc.txt +1697 -0
  52. package/dist/docs-output/api-docs/stores-productsV3-deleteProduct-doc.txt +73 -0
  53. package/dist/docs-output/api-docs/stores-productsV3-getProduct-doc.txt +933 -0
  54. package/dist/docs-output/api-docs/stores-productsV3-onProductCreated-doc.txt +794 -0
  55. package/dist/docs-output/api-docs/stores-productsV3-onProductDeleted-doc.txt +794 -0
  56. package/dist/docs-output/api-docs/stores-productsV3-onProductUpdated-doc.txt +794 -0
  57. package/dist/docs-output/api-docs/stores-productsV3-queryProducts-doc.txt +1051 -0
  58. package/dist/docs-output/api-docs/stores-productsV3-searchProducts-doc.txt +1144 -0
  59. package/dist/docs-output/api-docs/stores-productsV3-updateProduct-doc.txt +1730 -1600
  60. package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-queryVariants-doc.txt +290 -0
  61. package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-searchVariants-doc.txt +353 -0
  62. package/dist/out.js +929 -79
  63. package/package.json +2 -2
  64. package/dist/docs-output/api-docs/data-items-onDataItemCreated.txt +0 -103
  65. package/dist/docs-output/api-docs/stores-product-onProductCreated-doc.txt +0 -118
  66. package/dist/docs-output/api-docs/stores-productV3-onProductCreated-doc.txt +0 -184
@@ -0,0 +1,245 @@
1
+ <ecom_orders_onOrderCreated>
2
+ <description>
3
+ # This is a Webhook method
4
+
5
+ # Method name:
6
+
7
+ ecom.orders.onOrderCreated(handler: OnOrderCreatedHandler)
8
+
9
+ # Method Link:
10
+
11
+ https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/on-order-created
12
+
13
+ # Method Description:
14
+
15
+ Triggered when an order is created.
16
+ Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
17
+
18
+
19
+ </description>
20
+ <usage>
21
+ import { orders } from "@wix/pricing-plans";
22
+
23
+ orders.onOrderCreated((event) => {
24
+ // handle your event here
25
+ });
26
+
27
+ </usage>
28
+ <type_definition>
29
+ ```
30
+ Method: ecom.orders.onOrderCreated(handler)
31
+ Description: Triggered when an order is created. Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
32
+ Method parameters:
33
+ param name: handler | type: OnOrderCreatedHandler | description: none
34
+ - name: event | type: OrderCreatedEnvelope | description: none
35
+ - name: entity | type: Order | description: none
36
+ - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
37
+ - name: _id | type: string | description: Additional fee's id.
38
+ - name: code | type: string | description: Additional fee's unique code for future processing.
39
+ - 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.
40
+ - name: name | type: string | description: Name of additional fee.
41
+ - name: price | type: Price | description: Additional fee's price.
42
+ - name: amount | type: string | description: Amount.
43
+ - name: priceAfterTax | type: Price | description: Additional fee's price after tax.
44
+ - name: priceBeforeTax | type: Price | description: Additional fee's price before tax.
45
+ - name: providerAppId | type: string | description: SPI implementer's `appId`.
46
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
47
+ - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
48
+ - name: taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
49
+ - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
50
+ - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
51
+ enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
52
+ - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
53
+ - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
54
+ - name: taxAmount | type: Price | description: Amount of tax calculated for this line item.
55
+ - 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.
56
+ - 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.
57
+ - name: taxableAmount | type: Price | description: Taxable amount of the line item price.
58
+ - name: taxGroupId | type: string | description: Tax group GUID.
59
+ - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
60
+ - name: taxRate | type: string | description: Tax rate %, as a decimal point.
61
+ - name: taxableAmount | type: Price | description: Amount for which tax is calculated.
62
+ - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
63
+ - name: _id | type: string | description: Discount id.
64
+ - 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.
65
+ enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
66
+ - ONE-OF:
67
+ - name: coupon | type: Coupon | description: Applied coupon info.
68
+ - name: _id | type: string | description: Coupon GUID.
69
+ - name: amount | type: Price | description: Coupon value.
70
+ - name: code | type: string | description: Coupon code.
71
+ - name: name | type: string | description: Coupon name.
72
+ - name: discountRule | type: DiscountRule | description: Automatic Discount
73
+ - name: _id | type: string | description: Discount rule GUID
74
+ - name: amount | type: Price | description: Discount value.
75
+ - name: name | type: DiscountRuleName | description: Discount rule name
76
+ - name: original | type: string | description: Original discount rule name (in site's default language).
77
+ - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
78
+ - name: merchantDiscount | type: MerchantDiscount | description: Merchant discount.
79
+ - name: amount | type: Price | description: Discount amount.
80
+ - ONE-OF:
81
+ - name: description | type: string | description: Discount description as free text (optional).
82
+ - name: discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
83
+ enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
84
+ - name: archived | type: boolean | description: Whether order is archived.
85
+ - name: attributionSource | type: AttributionSource | description: Order attribution source.
86
+ enum: FACEBOOK_ADS, UNSPECIFIED
87
+ - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
88
+ - name: address | type: Address | description: Address.
89
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
90
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
91
+ - name: city | type: string | description: City name.
92
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
93
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
94
+ - name: latitude | type: number | description: Address latitude.
95
+ - name: longitude | type: number | description: Address longitude.
96
+ - name: postalCode | type: string | description: Postal or zip code.
97
+ - name: streetAddress | type: StreetAddress | description: Street address.
98
+ - name: name | type: string | description: Street name.
99
+ - name: number | type: string | description: Street number.
100
+ - 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.
101
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
102
+ - name: company | type: string | description: Company name.
103
+ - name: firstName | type: string | description: First name.
104
+ - name: lastName | type: string | description: Last name.
105
+ - name: phone | type: string | description: Phone number.
106
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
107
+ - name: _id | type: string | description: Customer's tax GUID.
108
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
109
+ enum:
110
+ CNPJ: CNPJ - for corporations
111
+ CPF: CPF - for individual tax payers.
112
+ UNSPECIFIED
113
+ - name: businessLocation | type: Location | description: Order Location
114
+ - name: _id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
115
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
116
+ - 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).
117
+ - name: email | type: string | description: Buyer email address.
118
+ - ONE-OF:
119
+ - name: memberId | type: string | description: Member GUID (if site visitor is a site member).
120
+ - name: visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
121
+ - 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.
122
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
123
+ - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
124
+ - name: externalOrderId | type: string | description: Reference to an order GUID from an external system.
125
+ - name: externalOrderUrl | type: string | description: URL to the order in the external system.
126
+ - name: type | type: ChannelType | description: Sales channel that submitted the order.
127
+ enum:
128
+ AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
129
+ BACKOFFICE_MERCHANT: Wix merchant backoffice.
130
+ CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
131
+ EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
132
+ ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
133
+ FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
134
+ FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
135
+ GLOBAL_E: Global-E sales channel.
136
+ OTHER_PLATFORM: Other sales platform.
137
+ PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
138
+ POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
139
+ TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
140
+ UNSPECIFIED: Unspecified sales channel. This value is not supported.
141
+ WEB: A web client.
142
+ WISH: Wish sales channel.
143
+ WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
144
+ 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)
145
+ - name: checkoutId | type: string | description: Checkout GUID.
146
+ - 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.
147
+ - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
148
+ - name: customFields | type: Array<CustomField> | description: Custom fields.
149
+ - name: title | type: string | description: Custom field title.
150
+ - name: translatedTitle | type: string | description: Translated custom field title.
151
+ - name: value | type: any | description: Custom field value.
152
+ - 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.
153
+ - 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).
154
+ - name: paymentStatus | type: PaymentStatus | description: Order payment status.
155
+ enum:
156
+ CANCELED: One or more payments canceled.
157
+ DECLINED: One or more payments declined.
158
+ FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
159
+ 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`.
160
+ PAID: All required payments associated with this order are paid.
161
+ 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.
162
+ PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
163
+ 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).
164
+ 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.
165
+ UNSPECIFIED
166
+ - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
167
+ - 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.
168
+ - 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.
169
+ - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
170
+ - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
171
+ - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
172
+ - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
173
+ - name: cost | type: ShippingPrice | description: Shipping costs.
174
+ - name: price | type: Price | description: Shipping price for display purposes.
175
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
176
+ - name: logistics | type: DeliveryLogistics | description: Shipping logistics.
177
+ - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
178
+ - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
179
+ - name: from | type: Date | description: Delivery slot starting time.
180
+ - name: to | type: Date | description: Delivery slot ending time.
181
+ - name: instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
182
+ - ONE-OF:
183
+ - name: pickupDetails | type: PickupDetails | description: Pickup details.
184
+ - name: address | type: PickupAddress | description: Pickup address.
185
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
186
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
187
+ - name: city | type: string | description: City name.
188
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
189
+ - name: postalCode | type: string | description: Postal or zip code.
190
+ - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
191
+ - 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.
192
+ - name: pickupMethod | type: PickupMethod | description: Pickup method
193
+ enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
194
+ - name: shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
195
+ - name: region | type: ShippingRegion | description: Shipping region.
196
+ - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
197
+ - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
198
+ - name: status | type: OrderStatus | description: Order status.
199
+ enum:
200
+ 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.
201
+ CANCELED: Order canceled by the user.
202
+ INITIALIZED: Order created, but not yet approved or canceled.
203
+ PENDING: Order pending.
204
+ REJECTED: Order rejected. This happens when pending payments fail.
205
+ - 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.
206
+ - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
207
+ - name: tagIds | type: Array<string> | description: List of tag GUIDs
208
+ - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
209
+ - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
210
+ - name: taxInfo | type: OrderTaxInfo | description: Tax information.
211
+ - 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.
212
+ - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
213
+ - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
214
+ - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
215
+ - name: rate | type: string | description: The rate at which this tax detail was calculated.
216
+ - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated.
217
+ - 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.
218
+ - name: totalTax | type: Price | description: Calculated tax, added from line items.
219
+ - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
220
+ enum:
221
+ KG: Kilograms.
222
+ LB: Pounds.
223
+ UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
224
+ - name: metadata | type: EventMetadata | description: none
225
+ - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
226
+ - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
227
+ - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
228
+ - name: entityId | type: string | description: GUID of the entity associated with the event.
229
+ - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
230
+ - name: eventType | type: string | description: Event type.
231
+ - name: identity | type: IdentificationData | description: The identification type and identity data.
232
+ - ONE-OF:
233
+ - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
234
+ - name: appId | type: string | description: GUID of an app.
235
+ - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
236
+ - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
237
+ - name: instanceId | type: string | description: App instance GUID.
238
+ - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
239
+ - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
240
+ - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
241
+ Return type: PRIMITIVE<void>
242
+
243
+ ```
244
+ </type_definition>
245
+ </ecom_orders_onOrderCreated>
@@ -0,0 +1,244 @@
1
+ <ecom_orders_onOrderUpdated>
2
+ <description>
3
+ # This is a Webhook method
4
+
5
+ # Method name:
6
+
7
+ ecom.orders.onOrderUpdated(handler: OnOrderUpdatedHandler)
8
+
9
+ # Method Link:
10
+
11
+ https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/on-order-updated
12
+
13
+ # Method Description:
14
+
15
+ Triggered when an order is updated.
16
+
17
+
18
+ </description>
19
+ <usage>
20
+ import { orders } from "@wix/pricing-plans";
21
+
22
+ orders.onOrderUpdated((event) => {
23
+ // handle your event here
24
+ });
25
+
26
+ </usage>
27
+ <type_definition>
28
+ ```
29
+ Method: ecom.orders.onOrderUpdated(handler)
30
+ Description: Triggered when an order is updated.
31
+ Method parameters:
32
+ param name: handler | type: OnOrderUpdatedHandler | description: none
33
+ - name: event | type: OrderUpdatedEnvelope | description: none
34
+ - name: entity | type: Order | description: none
35
+ - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
36
+ - name: _id | type: string | description: Additional fee's id.
37
+ - name: code | type: string | description: Additional fee's unique code for future processing.
38
+ - 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.
39
+ - name: name | type: string | description: Name of additional fee.
40
+ - name: price | type: Price | description: Additional fee's price.
41
+ - name: amount | type: string | description: Amount.
42
+ - name: priceAfterTax | type: Price | description: Additional fee's price after tax.
43
+ - name: priceBeforeTax | type: Price | description: Additional fee's price before tax.
44
+ - name: providerAppId | type: string | description: SPI implementer's `appId`.
45
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
46
+ - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
47
+ - name: taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
48
+ - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
49
+ - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
50
+ enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
51
+ - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
52
+ - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
53
+ - name: taxAmount | type: Price | description: Amount of tax calculated for this line item.
54
+ - 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.
55
+ - 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.
56
+ - name: taxableAmount | type: Price | description: Taxable amount of the line item price.
57
+ - name: taxGroupId | type: string | description: Tax group GUID.
58
+ - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
59
+ - name: taxRate | type: string | description: Tax rate %, as a decimal point.
60
+ - name: taxableAmount | type: Price | description: Amount for which tax is calculated.
61
+ - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
62
+ - name: _id | type: string | description: Discount id.
63
+ - 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.
64
+ enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
65
+ - ONE-OF:
66
+ - name: coupon | type: Coupon | description: Applied coupon info.
67
+ - name: _id | type: string | description: Coupon GUID.
68
+ - name: amount | type: Price | description: Coupon value.
69
+ - name: code | type: string | description: Coupon code.
70
+ - name: name | type: string | description: Coupon name.
71
+ - name: discountRule | type: DiscountRule | description: Automatic Discount
72
+ - name: _id | type: string | description: Discount rule GUID
73
+ - name: amount | type: Price | description: Discount value.
74
+ - name: name | type: DiscountRuleName | description: Discount rule name
75
+ - name: original | type: string | description: Original discount rule name (in site's default language).
76
+ - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
77
+ - name: merchantDiscount | type: MerchantDiscount | description: Merchant discount.
78
+ - name: amount | type: Price | description: Discount amount.
79
+ - ONE-OF:
80
+ - name: description | type: string | description: Discount description as free text (optional).
81
+ - name: discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
82
+ enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
83
+ - name: archived | type: boolean | description: Whether order is archived.
84
+ - name: attributionSource | type: AttributionSource | description: Order attribution source.
85
+ enum: FACEBOOK_ADS, UNSPECIFIED
86
+ - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
87
+ - name: address | type: Address | description: Address.
88
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
89
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
90
+ - name: city | type: string | description: City name.
91
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
92
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
93
+ - name: latitude | type: number | description: Address latitude.
94
+ - name: longitude | type: number | description: Address longitude.
95
+ - name: postalCode | type: string | description: Postal or zip code.
96
+ - name: streetAddress | type: StreetAddress | description: Street address.
97
+ - name: name | type: string | description: Street name.
98
+ - name: number | type: string | description: Street number.
99
+ - 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.
100
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
101
+ - name: company | type: string | description: Company name.
102
+ - name: firstName | type: string | description: First name.
103
+ - name: lastName | type: string | description: Last name.
104
+ - name: phone | type: string | description: Phone number.
105
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
106
+ - name: _id | type: string | description: Customer's tax GUID.
107
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
108
+ enum:
109
+ CNPJ: CNPJ - for corporations
110
+ CPF: CPF - for individual tax payers.
111
+ UNSPECIFIED
112
+ - name: businessLocation | type: Location | description: Order Location
113
+ - name: _id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
114
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
115
+ - 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).
116
+ - name: email | type: string | description: Buyer email address.
117
+ - ONE-OF:
118
+ - name: memberId | type: string | description: Member GUID (if site visitor is a site member).
119
+ - name: visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
120
+ - 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.
121
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
122
+ - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
123
+ - name: externalOrderId | type: string | description: Reference to an order GUID from an external system.
124
+ - name: externalOrderUrl | type: string | description: URL to the order in the external system.
125
+ - name: type | type: ChannelType | description: Sales channel that submitted the order.
126
+ enum:
127
+ AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
128
+ BACKOFFICE_MERCHANT: Wix merchant backoffice.
129
+ CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
130
+ EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
131
+ ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
132
+ FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
133
+ FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
134
+ GLOBAL_E: Global-E sales channel.
135
+ OTHER_PLATFORM: Other sales platform.
136
+ PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
137
+ POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
138
+ TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
139
+ UNSPECIFIED: Unspecified sales channel. This value is not supported.
140
+ WEB: A web client.
141
+ WISH: Wish sales channel.
142
+ WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
143
+ 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)
144
+ - name: checkoutId | type: string | description: Checkout GUID.
145
+ - 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.
146
+ - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
147
+ - name: customFields | type: Array<CustomField> | description: Custom fields.
148
+ - name: title | type: string | description: Custom field title.
149
+ - name: translatedTitle | type: string | description: Translated custom field title.
150
+ - name: value | type: any | description: Custom field value.
151
+ - 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.
152
+ - 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).
153
+ - name: paymentStatus | type: PaymentStatus | description: Order payment status.
154
+ enum:
155
+ CANCELED: One or more payments canceled.
156
+ DECLINED: One or more payments declined.
157
+ FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
158
+ 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`.
159
+ PAID: All required payments associated with this order are paid.
160
+ 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.
161
+ PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
162
+ 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).
163
+ 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.
164
+ UNSPECIFIED
165
+ - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
166
+ - 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.
167
+ - 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.
168
+ - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
169
+ - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
170
+ - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
171
+ - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
172
+ - name: cost | type: ShippingPrice | description: Shipping costs.
173
+ - name: price | type: Price | description: Shipping price for display purposes.
174
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
175
+ - name: logistics | type: DeliveryLogistics | description: Shipping logistics.
176
+ - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
177
+ - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
178
+ - name: from | type: Date | description: Delivery slot starting time.
179
+ - name: to | type: Date | description: Delivery slot ending time.
180
+ - name: instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
181
+ - ONE-OF:
182
+ - name: pickupDetails | type: PickupDetails | description: Pickup details.
183
+ - name: address | type: PickupAddress | description: Pickup address.
184
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
185
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
186
+ - name: city | type: string | description: City name.
187
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
188
+ - name: postalCode | type: string | description: Postal or zip code.
189
+ - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
190
+ - 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.
191
+ - name: pickupMethod | type: PickupMethod | description: Pickup method
192
+ enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
193
+ - name: shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
194
+ - name: region | type: ShippingRegion | description: Shipping region.
195
+ - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
196
+ - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
197
+ - name: status | type: OrderStatus | description: Order status.
198
+ enum:
199
+ 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.
200
+ CANCELED: Order canceled by the user.
201
+ INITIALIZED: Order created, but not yet approved or canceled.
202
+ PENDING: Order pending.
203
+ REJECTED: Order rejected. This happens when pending payments fail.
204
+ - 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.
205
+ - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
206
+ - name: tagIds | type: Array<string> | description: List of tag GUIDs
207
+ - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
208
+ - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
209
+ - name: taxInfo | type: OrderTaxInfo | description: Tax information.
210
+ - 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.
211
+ - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
212
+ - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
213
+ - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
214
+ - name: rate | type: string | description: The rate at which this tax detail was calculated.
215
+ - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated.
216
+ - 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.
217
+ - name: totalTax | type: Price | description: Calculated tax, added from line items.
218
+ - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
219
+ enum:
220
+ KG: Kilograms.
221
+ LB: Pounds.
222
+ UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
223
+ - name: metadata | type: EventMetadata | description: none
224
+ - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
225
+ - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
226
+ - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
227
+ - name: entityId | type: string | description: GUID of the entity associated with the event.
228
+ - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
229
+ - name: eventType | type: string | description: Event type.
230
+ - name: identity | type: IdentificationData | description: The identification type and identity data.
231
+ - ONE-OF:
232
+ - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
233
+ - name: appId | type: string | description: GUID of an app.
234
+ - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
235
+ - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
236
+ - name: instanceId | type: string | description: App instance GUID.
237
+ - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
238
+ - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
239
+ - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
240
+ Return type: PRIMITIVE<void>
241
+
242
+ ```
243
+ </type_definition>
244
+ </ecom_orders_onOrderUpdated>