diff --git a/CHANGELOG.md b/CHANGELOG.md index 65658198a61..b061df9e924 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## Added + +- Added documentation for `getPixallVisitorId()` + +### Updated + +- Updated `estimateDeliveryDate` to `deliveryDateRange` + ## [v2023-11-15T00.44.26] - 2023-11-15 ### Updated diff --git a/source/includes/_events.md b/source/includes/_events.md index 3d76da40ce9..6cc0b33aeaa 100644 --- a/source/includes/_events.md +++ b/source/includes/_events.md @@ -109,7 +109,7 @@ Field Key | Example Value | Field Format driveLine: 'Front-wheel Drive', engine: 'I-4 cyl', engineSize: '1.5L', - estimatedDeliveryDate: '10/30/2028', + deliveryDateRange: '10/30/2028 - 11/15/2028', exteriorColor: 'Crystal Black Pearl', finalPrice: 32000, fuelType: 'Regular Unleaded', @@ -185,7 +185,7 @@ Field Key | Example Value | Field Format | Status `driveLine` | `FWD` | `String` `engine` | `I-4 cyl` | `String` `engineSize` | `1.5L` | `String` -`estimatedDeliveryDate` | `10/30/2028` | `String` +`deliveryDateRange` | `10/30/2028 - 11/15/2028` | `String` `exteriorColor` | `Platinum White Pearl` | `String` `finalPrice` | `32000` | `Integer` `fuelType` | `Regular Unleaded` | `String` diff --git a/source/includes/_methods.md b/source/includes/_methods.md index 9ebe75513f0..6a2f18096ed 100644 --- a/source/includes/_methods.md +++ b/source/includes/_methods.md @@ -575,3 +575,16 @@ The loadJS method is a simple way to include additional JavaScript files require ``` > Note that the `attributeMap` parameter is optional and may be ommitted in most cases. + +## API.getPixallVisitorId() + +The getPixallVisitorId method returns the Pixall Id for the current website visitor. Pixall provides a unique identifier for each visitor to aggregate analytics events initiated by that shopper across marketplaces. + +> Usage + +```javascript +(async APILoader => { + const API = await APILoader.create(); + const pxa_id = await API.getPixallVisitorId(); +})(window.DDC.APILoader); +```