Skip to content

Commit

Permalink
Merge pull request #1046 from PiwikPRO/17.7
Browse files Browse the repository at this point in the history 
17.7
  • Loading branch information
@RomanSek
RomanSek authored Aug 2, 2023
2 parents b7bcb9d + 0ac15cb commit b0f36f2
Showing 1 changed file with 75 additions and 14 deletions.
89 changes: 75 additions & 14 deletions data_collection/web/javascript_tracking_client/api.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ E-commerce v2
* quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
* brand - **Optional** [string] Product brand (default: "")
* variant - **Optional** [string] Product variant (default: "")
* customDimensions - **Optional** [object] Product custom dimensions (default: {})

Example of usage:

Expand All @@ -299,7 +300,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]
]);
Expand All @@ -314,7 +319,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]);
.. _jtc-api-ecommerceAddToCart:
Expand All @@ -332,6 +341,7 @@ E-commerce v2
* quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
* brand - **Optional** [string] Product brand (default: "")
* variant - **Optional** [string] Product variant (default: "")
* customDimensions - **Optional** [object] Product custom dimensions (default: {})

Example of usage:

Expand All @@ -350,7 +360,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]
]);
Expand All @@ -365,7 +379,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]);
.. _jtc-api-ecommerceRemoveFromCart:
Expand All @@ -383,6 +401,7 @@ E-commerce v2
* quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
* brand - **Optional** [string] Product brand (default: "")
* variant - **Optional** [string] Product variant (default: "")
* customDimensions - **Optional** [object] Product custom dimensions (default: {})

Example of usage:

Expand All @@ -401,7 +420,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]
]);
Expand All @@ -416,7 +439,11 @@ E-commerce v2
price: "49.90",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}]);
.. _jtc-api-ecommerceCartUpdate:
Expand All @@ -434,6 +461,7 @@ E-commerce v2
* quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
* brand - **Optional** [string] Product brand (default: "")
* variant - **Optional** [string] Product variant (default: "")
* customDimensions - **Optional** [object] Product custom dimensions (default: {})

:param number grandTotal: **Required** [number|string] The total value of items in a cart has to be a float number or a string containing float number representation

Expand All @@ -455,7 +483,11 @@ E-commerce v2
price: "50.00",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
},
{
sku: "craft-312",
Expand All @@ -464,7 +496,11 @@ E-commerce v2
price: "30.00",
quantity: 1,
brand: "DMZ",
variant: "red"
variant: "red",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}
],
"180.00"
Expand All @@ -483,7 +519,11 @@ E-commerce v2
price: "50.00",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
},
{
sku: "craft-312",
Expand All @@ -492,7 +532,11 @@ E-commerce v2
price: "30.00",
quantity: 1,
brand: "DMZ",
variant: "red"
variant: "red",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}
],
"180.00"
Expand All @@ -513,6 +557,7 @@ E-commerce v2
* quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
* brand - **Optional** [string] Product brand (default: "")
* variant - **Optional** [string] Product variant (default: "")
* customDimensions - **Optional** [object] Product custom dimensions (default: {})

:param object paymentInformation: Total payment information about products in a cart. Expected attributes:

Expand Down Expand Up @@ -541,7 +586,11 @@ E-commerce v2
price: "50.00",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
},
{
sku: "craft-312",
Expand All @@ -550,7 +599,11 @@ E-commerce v2
price: "30.00",
quantity: 1,
brand: "DMZ",
variant: "red"
variant: "red",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}
],
{
Expand All @@ -576,7 +629,11 @@ E-commerce v2
price: "50.00",
quantity: 3,
brand: "DMZ",
variant: "blue"
variant: "blue",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
},
{
sku: "craft-312",
Expand All @@ -585,7 +642,11 @@ E-commerce v2
price: "30.00",
quantity: 1,
brand: "DMZ",
variant: "red"
variant: "red",
customDimensions: {
1: 'coupon-2020',
2: '20%'
}
}
],
{
Expand Down

0 comments on commit b0f36f2

Please sign in to comment.