@wix/ditto-codegen-public 1.0.161 → 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
@@ -1,88 +1,97 @@
1
1
  <ecom_cart_onCartCreated>
2
- <use_cases>
3
- - Initialize cart tracking and analytics when a new cart is created
4
- - Send welcome messages or onboarding communications to new cart owners
5
- - Trigger automated workflows when a cart is first created
6
- - Sync cart creation events with external systems or databases
7
- - Apply initial cart settings or default configurations
8
- - Send notifications when new shopping sessions begin
9
- - Log new cart creation events for analytics and monitoring
10
- - Initialize cart-specific features or personalization
11
- </use_cases>
2
+ <description>
3
+ # This is a Webhook method
12
4
 
5
+ # Method name:
6
+
7
+ ecom.cart.onCartCreated(handler: OnCartCreatedHandler)
8
+
9
+ # Method Link:
10
+
11
+ https://dev.wix.com/docs/sdk/backend-modules/ecom/cart/on-cart-created
12
+
13
+ # Method Description:
14
+
15
+ Triggered when a cart is created.
16
+
17
+
18
+ </description>
13
19
  <usage>
14
20
  import { cart } from "@wix/ecom";
15
21
 
16
- export default cart.onCartCreated((event) => {
17
- // handle your event here
18
- });
22
+ cart.onCartCreated((event) => {
23
+ // handle your event here
24
+ });
25
+
19
26
  </usage>
20
-
21
27
  <type_definition>
22
- Method: ecom.cart.onCartCreated(handler)
23
- Description: Triggered when a cart is created.
24
- Method parameters:
25
- param name: handler | type: OnCartCreatedHandler | description: none
26
- - name: event | type: CartCreatedEnvelope | description: none
27
- - name: entity | type: Cart | description: none
28
- - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
29
- - name: buyerInfo | type: BuyerInfo | description: Buyer information.
30
- - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
31
- - name: email | type: string | description: Buyer email address.
32
- - ONE-OF:
33
- - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
34
- - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
35
- - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
36
- - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
37
- - name: contactInfo | type: AddressWithContact | description: Contact info.
38
- - name: address | type: Address | description: Address.
39
- - name: addressLine1 | type: string | description: Main address line (usually street name and number).
40
- - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
41
- - name: city | type: string | description: City name.
42
- - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
43
- - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
44
- - name: latitude | type: number | description: Address latitude.
45
- - name: longitude | type: number | description: Address longitude.
46
- - name: postalCode | type: string | description: Postal or zip code.
47
- - name: streetAddress | type: StreetAddress | description: Street address.
48
- - name: name | type: string | description: Street name.
49
- - name: number | type: string | description: Street number.
50
- - 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.
51
- - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
52
- - name: company | type: string | description: Company name.
53
- - name: firstName | type: string | description: First name.
54
- - name: lastName | type: string | description: Last name.
55
- - name: phone | type: string | description: Phone number.
56
- - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
57
- - name: _id | type: string | description: Customer's tax GUID.
58
- - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
59
- enum:
60
- CNPJ: CNPJ - for corporations
61
- CPF: CPF - for individual tax payers.
62
- UNSPECIFIED
63
- - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
64
- - 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).
65
- - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
66
- - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
67
- - name: carrierId | type: string | description: Carrier GUID.
68
- - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
69
- - name: metadata | type: EventMetadata | description: none
70
- - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
71
- - 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.
72
- - 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`.
73
- - name: entityId | type: string | description: GUID of the entity associated with the event.
74
- - 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`.
75
- - name: eventType | type: string | description: Event type.
76
- - name: identity | type: IdentificationData | description: The identification type and identity data.
77
- - ONE-OF:
78
- - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
79
- - name: appId | type: string | description: GUID of an app.
80
- - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
81
- - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
82
- - name: instanceId | type: string | description: App instance GUID.
83
- - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
84
- - 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`.
85
- - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
86
- Return type: PRIMITIVE<void>
28
+ ```
29
+ Method: ecom.cart.onCartCreated(handler)
30
+ Description: Triggered when a cart is created.
31
+ Method parameters:
32
+ param name: handler | type: OnCartCreatedHandler | description: none
33
+ - name: event | type: CartCreatedEnvelope | description: none
34
+ - name: entity | type: Cart | description: none
35
+ - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
36
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
37
+ - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
38
+ - name: email | type: string | description: Buyer email address.
39
+ - ONE-OF:
40
+ - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
41
+ - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
42
+ - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
43
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
44
+ - name: contactInfo | type: AddressWithContact | description: Contact info.
45
+ - name: address | type: Address | description: Address.
46
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
47
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
48
+ - name: city | type: string | description: City name.
49
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
50
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
51
+ - name: latitude | type: number | description: Address latitude.
52
+ - name: longitude | type: number | description: Address longitude.
53
+ - name: postalCode | type: string | description: Postal or zip code.
54
+ - name: streetAddress | type: StreetAddress | description: Street address.
55
+ - name: name | type: string | description: Street name.
56
+ - name: number | type: string | description: Street number.
57
+ - 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.
58
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
59
+ - name: company | type: string | description: Company name.
60
+ - name: firstName | type: string | description: First name.
61
+ - name: lastName | type: string | description: Last name.
62
+ - name: phone | type: string | description: Phone number.
63
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
64
+ - name: _id | type: string | description: Customer's tax GUID.
65
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
66
+ enum:
67
+ CNPJ: CNPJ - for corporations
68
+ CPF: CPF - for individual tax payers.
69
+ UNSPECIFIED
70
+ - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
71
+ - 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).
72
+ - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
73
+ - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
74
+ - name: carrierId | type: string | description: Carrier GUID.
75
+ - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
76
+ - name: metadata | type: EventMetadata | description: none
77
+ - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
78
+ - 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.
79
+ - 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`.
80
+ - name: entityId | type: string | description: GUID of the entity associated with the event.
81
+ - 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`.
82
+ - name: eventType | type: string | description: Event type.
83
+ - name: identity | type: IdentificationData | description: The identification type and identity data.
84
+ - ONE-OF:
85
+ - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
86
+ - name: appId | type: string | description: GUID of an app.
87
+ - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
88
+ - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
89
+ - name: instanceId | type: string | description: App instance GUID.
90
+ - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
91
+ - 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`.
92
+ - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
93
+ Return type: PRIMITIVE<void>
94
+
95
+ ```
87
96
  </type_definition>
88
- </ecom_cart_onCartCreated>
97
+ </ecom_cart_onCartCreated>
@@ -1,87 +1,97 @@
1
1
  <ecom_cart_onCartUpdated>
2
- <use_cases>
3
- - Track cart changes for analytics and monitoring
4
- - Update inventory systems when cart contents change
5
- - Apply dynamic pricing or discounts based on cart updates
6
- - Sync cart data with external systems or databases
7
- - Trigger automated workflows when cart items change
8
- - Send notifications or alerts for specific cart updates
9
- - Log cart modifications for compliance and auditing
10
- - Update product recommendations based on cart changes
11
- </use_cases>
2
+ <description>
3
+ # This is a Webhook method
12
4
 
13
- <usage>
5
+ # Method name:
6
+
7
+ ecom.cart.onCartUpdated(handler: OnCartUpdatedHandler)
8
+
9
+ # Method Link:
10
+
11
+ https://dev.wix.com/docs/sdk/backend-modules/ecom/cart/on-cart-updated
12
+
13
+ # Method Description:
14
+
15
+ undefined
16
+
17
+
18
+ </description>
19
+ <usage>
14
20
  import { cart } from "@wix/ecom";
15
21
 
16
- export default cart.onCartUpdated((event) => {
17
- // handle your event here
18
- });
19
- </usage>
22
+ cart.onCartUpdated((event) => {
23
+ // handle your event here
24
+ });
25
+
26
+ </usage>
20
27
  <type_definition>
28
+ ```
21
29
  Method: ecom.cart.onCartUpdated(handler)
22
- Description: none
23
- Method parameters:
24
- param name: handler | type: OnCartUpdatedHandler | description: none
25
- - name: event | type: CartUpdatedEnvelope | description: none
26
- - name: entity | type: Cart | description: none
27
- - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
28
- - name: buyerInfo | type: BuyerInfo | description: Buyer information.
29
- - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
30
- - name: email | type: string | description: Buyer email address.
31
- - ONE-OF:
32
- - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
33
- - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
34
- - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
35
- - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
36
- - name: contactInfo | type: AddressWithContact | description: Contact info.
37
- - name: address | type: Address | description: Address.
38
- - name: addressLine1 | type: string | description: Main address line (usually street name and number).
39
- - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
40
- - name: city | type: string | description: City name.
41
- - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
42
- - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
43
- - name: latitude | type: number | description: Address latitude.
44
- - name: longitude | type: number | description: Address longitude.
45
- - name: postalCode | type: string | description: Postal or zip code.
46
- - name: streetAddress | type: StreetAddress | description: Street address.
47
- - name: name | type: string | description: Street name.
48
- - name: number | type: string | description: Street number.
49
- - 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.
50
- - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
51
- - name: company | type: string | description: Company name.
52
- - name: firstName | type: string | description: First name.
53
- - name: lastName | type: string | description: Last name.
54
- - name: phone | type: string | description: Phone number.
55
- - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
56
- - name: _id | type: string | description: Customer's tax GUID.
57
- - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
58
- enum:
59
- CNPJ: CNPJ - for corporations
60
- CPF: CPF - for individual tax payers.
61
- UNSPECIFIED
62
- - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
63
- - 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).
64
- - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
65
- - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
66
- - name: carrierId | type: string | description: Carrier GUID.
67
- - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
68
- - name: metadata | type: EventMetadata | description: none
69
- - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
70
- - 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.
71
- - 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`.
72
- - name: entityId | type: string | description: GUID of the entity associated with the event.
73
- - 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`.
74
- - name: eventType | type: string | description: Event type.
75
- - name: identity | type: IdentificationData | description: The identification type and identity data.
76
- - ONE-OF:
77
- - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
78
- - name: appId | type: string | description: GUID of an app.
79
- - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
80
- - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
81
- - name: instanceId | type: string | description: App instance GUID.
82
- - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
83
- - 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`.
84
- - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
85
- Return type: PRIMITIVE<void>
86
- </type_definition>
87
- </ecom_cart_onCartUpdated>
30
+ Description: none
31
+ Method parameters:
32
+ param name: handler | type: OnCartUpdatedHandler | description: none
33
+ - name: event | type: CartUpdatedEnvelope | description: none
34
+ - name: entity | type: Cart | description: none
35
+ - name: businessLocationId | type: string | description: The business location GUID associated with the cart. To learn more, see the Locations API.
36
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
37
+ - name: contactId | type: string | description: Contact GUID. For more information, see the Contacts API.
38
+ - name: email | type: string | description: Buyer email address.
39
+ - ONE-OF:
40
+ - name: memberId | type: string | description: Member GUID. If the buyer is a site member.
41
+ - name: userId | type: string | description: User GUID. If the buyer, or cart owner, is a Wix user.
42
+ - name: visitorId | type: string | description: Visitor GUID. If the buyer is **not** a site member.
43
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
44
+ - name: contactInfo | type: AddressWithContact | description: Contact info.
45
+ - name: address | type: Address | description: Address.
46
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
47
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
48
+ - name: city | type: string | description: City name.
49
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
50
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
51
+ - name: latitude | type: number | description: Address latitude.
52
+ - name: longitude | type: number | description: Address longitude.
53
+ - name: postalCode | type: string | description: Postal or zip code.
54
+ - name: streetAddress | type: StreetAddress | description: Street address.
55
+ - name: name | type: string | description: Street name.
56
+ - name: number | type: string | description: Street number.
57
+ - 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.
58
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
59
+ - name: company | type: string | description: Company name.
60
+ - name: firstName | type: string | description: First name.
61
+ - name: lastName | type: string | description: Last name.
62
+ - name: phone | type: string | description: Phone number.
63
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
64
+ - name: _id | type: string | description: Customer's tax GUID.
65
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
66
+ enum:
67
+ CNPJ: CNPJ - for corporations
68
+ CPF: CPF - for individual tax payers.
69
+ UNSPECIFIED
70
+ - name: extendedFields | type: ExtendedFields | description: Fields extended by data extensions
71
+ - 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).
72
+ - name: overrideCheckoutUrl | type: string | description: `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page. This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
73
+ - name: selectedShippingOption | type: SelectedShippingOption | description: Selected shipping option.
74
+ - name: carrierId | type: string | description: Carrier GUID.
75
+ - name: code | type: string | description: Selected shipping option code. For example, "usps_std_overnight".
76
+ - name: metadata | type: EventMetadata | description: none
77
+ - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
78
+ - 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.
79
+ - 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`.
80
+ - name: entityId | type: string | description: GUID of the entity associated with the event.
81
+ - 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`.
82
+ - name: eventType | type: string | description: Event type.
83
+ - name: identity | type: IdentificationData | description: The identification type and identity data.
84
+ - ONE-OF:
85
+ - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
86
+ - name: appId | type: string | description: GUID of an app.
87
+ - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
88
+ - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
89
+ - name: instanceId | type: string | description: App instance GUID.
90
+ - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
91
+ - 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`.
92
+ - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
93
+ Return type: PRIMITIVE<void>
94
+
95
+ ```
96
+ </type_definition>
97
+ </ecom_cart_onCartUpdated>