Skip to content

add new method for pixallId and remove estimatedDeliveryDate #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions source/includes/_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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`
Expand Down
13 changes: 13 additions & 0 deletions source/includes/_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
```
Loading