You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/includes/_tracking.md.erb
+63-63
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,13 @@ To track assisted events, you need to user `recommendedBy` (or `recommended_by`,
15
15
16
16
All events require at least these parameters:
17
17
18
-
Parameter | Type | Required | Description
19
-
--------- | ------- | ------- | -----------
20
-
shop_id | String | true | Your API key
21
-
did | String | true | Device ID
22
-
seance | String | true | User's current session
23
-
event | String | true | Type of an event
24
-
stream | String | false | Data stream code. Alphanumeric string (letters, numbers only). Max length: 16. Default: null (means "web"). Can be "ios", "android" or any other string. Used to distinguish between mobile apps, web and other events sources
| stream | String | false | Data stream code. Alphanumeric string (letters, numbers only). Max length: 16. Default: null (means "web"). Can be "ios", "android" or any other string. Used to distinguish between mobile apps, web and other events sources |
25
25
26
26
27
27
SDKs already handle these parameters out of the box.
@@ -392,39 +392,39 @@ sdk.track("cart", {
392
392
```
393
393
394
394
### JS SDK syntax (short request for a single product)
|id|number/string|required|The ID of the product added to the cart|
413
-
|amount|number|optional|Product quantity|
414
-
|stock|boolean|optional|Product availability. If defined, it overwrites the value received from the product feed (XML) and HTTP-import of the product catalog.|
415
-
|recommended_by|string|required in some cases|If a product from a recommendation widget was opened in a popup or a website uses a "single page" architecture, this parameter must contain the value "dynamic".|
416
-
|recommended_code|string|required in some cases|If a product from the recommendations widget was opened in the pop-up or the site uses a "single page" architecture, this parameter must contain a unique code of the recommendations widget, available in the account in the "data-recommender-code" attribute for each widget.|
| id | number/string | required | The ID of the product added to the cart|
413
+
|amount | number | optional | Product quantity|
414
+
|stock | boolean | optional | Product availability. If defined, it overwrites the value received from the product feed (XML) and HTTP-import of the product catalog.|
415
+
|recommended_by | string | required in some cases | If a product from a recommendation widget was opened in a popup or a website uses a "single page" architecture, this parameter must contain the value "dynamic".|
416
+
|recommended_code | string | required in some cases | If a product from the recommendations widget was opened in the pop-up or the site uses a "single page" architecture, this parameter must contain a unique code of the recommendations widget, available in the account in the "data-recommender-code" attribute for each widget.|
417
417
418
418
### JS SDK syntax (request to send the full current cart)
|products|array|required|An array of objects with product information in the order. Description of parameters in the table below.|
551
-
|order|number/string|optional|Order number in the store. If not defined, the internal order numbering system will be used. In this case synchronization of order status is impossible.|
552
-
|promocode|string|optional|Promo code used in transaction.|
553
-
|order_price|number|optional|The final cost of the order including all discounts, bonuses, and additional services. If not defined, the cost of the order is calculated from the data in the product database without discounts and additional services.|
554
-
|order_cash|number|optional|How much a customer paid with real money.|
555
-
|order_bonuses|number|optional|How much a customer paid with bonuses.|
556
-
|order_delivery|number|optional|Delivery fee.|
557
-
|order_discount|number|optional|Order discount.|
558
-
|delivery_type|string|optional|Method of delivery. Available values: "self_pickup", "delivery", "pickup_point"|
559
-
|payment_type|string|optional|Payment type. Can by any string value. Ex: cash, card, wire.
|products | array | required | An array of objects with product information in the order. Description of parameters in the table below.|
551
+
|order | number/string | optional | Order number in the store. If not defined, the internal order numbering system will be used. In this case synchronization of order status is impossible.|
552
+
|promocode | string | optional | Promo code used in transaction.|
553
+
|order_price | number | optional | The final cost of the order including all discounts, bonuses, and additional services. If not defined, the cost of the order is calculated from the data in the product database without discounts and additional services.|
554
+
|order_cash | number | optional | How much a customer paid with real money.|
555
+
|order_bonuses | number | optional | How much a customer paid with bonuses.|
556
+
|order_delivery | number | optional | Delivery fee.|
557
+
|order_discount | number | optional | Order discount.|
558
+
|delivery_type | string | optional | Method of delivery. Available values: "self_pickup", "delivery", "pickup_point"|
559
+
|payment_type | string | optional | Payment type. Can by any string value. Ex: cash, card, wire. |
560
+
|tax_free | boolean | optional | Tax free |
561
561
562
562
Description of parameters in the objects of the "products" array:
code | String | true | Message identifier. Value can be taken from push's JSON payload. For Android it's located in `id` property. In iOS SDK it's `src.id`
794
-
type | String | true | Message type. Value can be taken from push's JSON payload. For Android it's located in `type` property. In iOS SDK it's `src.type`
| code | String | true | Message identifier. Value can be taken from push's JSON payload. For Android it's located in `id` property. In iOS SDK it's `src.id` |
794
+
| type | String | true | Message type. Value can be taken from push's JSON payload. For Android it's located in `type` property. In iOS SDK it's `src.type` |
0 commit comments