Skip to content

Commit 2324192

Browse files
authored
Not all destinations support arrays as properties
Add note for each event that shows an array as a property, to tell users that not all destinations accept arrays as properties. Request from CSM, to clear up common customer confusion, here: https://segment.slack.com/archives/CALA7QMJQ/p1623769073212700
1 parent de1c75c commit 2324192

File tree

1 file changed

+23
-7
lines changed
  • src/connections/spec/ecommerce

1 file changed

+23
-7
lines changed

src/connections/spec/ecommerce/v2.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: 'Spec: V2 Ecommerce Events'
44

55
Segment's e-commerce spec helps define the journey for a customer as they browse your store, click on promotions, view products, add those products to a cart, and complete a purchase.
66

7-
**Note:** Not all destinations support every event listed here. Refer to individual destination docs for more information on supported events and properties.
7+
**Note:** Not all destinations support every event listed here. Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
88

99
## Event Lifecycles
1010

@@ -117,7 +117,9 @@ analytics.track('Products Searched', {
117117

118118
### Product List Viewed
119119

120-
Fire this event when a visitor views a product list or category.
120+
Fire this event when a visitor views a product list or category.
121+
122+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
121123

122124
This event supports the following semantic properties:
123125

@@ -240,7 +242,9 @@ analytics.track('Product List Viewed', {
240242

241243
### Product List Filtered
242244

243-
Send this event when a visitor filters a product list or category.
245+
Send this event when a visitor filters a product list or category.
246+
247+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
244248

245249
This event supports the following semantic properties:
246250

@@ -933,7 +937,9 @@ analytics.track('Product Removed', {
933937

934938
### Cart Viewed
935939

936-
Fire this event when a visitor views a shopping cart.
940+
Fire this event when a visitor views a shopping cart.
941+
942+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
937943

938944
This event supports the following semantic properties:
939945

@@ -1044,7 +1050,9 @@ analytics.track('Cart Viewed', {
10441050

10451051
### Checkout Started
10461052

1047-
Fire this event whenever an order/transaction was started. Fire on the page that the customer lands on after they press the checkout button.
1053+
Fire this event whenever an order/transaction was started. Fire on the page that the customer lands on after they press the checkout button.
1054+
1055+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
10481056

10491057
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls, like so:
10501058

@@ -1364,7 +1372,9 @@ You can have as many or as few steps in the checkout funnel as you'd like. Note
13641372

13651373
### Order Updated
13661374

1367-
Fire this event whenever an order/transaction was updated.
1375+
Fire this event whenever an order/transaction was updated.
1376+
1377+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
13681378

13691379
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls, like so:
13701380

@@ -1532,7 +1542,9 @@ The `sku` and `product_id` do not have to be different. If they are different, t
15321542

15331543
### Order Completed
15341544

1535-
Fire this event whenever an order/transaction was successfully completed by the customer.
1545+
Fire this event whenever an order/transaction was successfully completed by the customer.
1546+
1547+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
15361548

15371549
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls, like so:
15381550

@@ -1767,6 +1779,8 @@ analytics.track('Order Refunded', {
17671779

17681780
Fire this event whenever an order/transaction was cancelled.
17691781

1782+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
1783+
17701784
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls.
17711785

17721786
This event supports the following semantic properties:
@@ -2562,6 +2576,8 @@ analytics.track('Product Shared', {
25622576

25632577
Fire this event when a customer shares a shopping cart.
25642578

2579+
**Note:** Not all destinations accept arrays as properties. Refer to individual destination docs for more information on supported events and properties.
2580+
25652581
This event supports the following semantic properties:
25662582

25672583
<table>

0 commit comments

Comments
 (0)