snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.md

Summary

Maintainability
Test Coverage
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md)

## EcommerceTransactionEvent interface

An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction.

<b>Signature:</b>

```typescript
interface EcommerceTransactionEvent 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [affiliation?](./node-tracker.ecommercetransactionevent.affiliation.md) | string | <i>(Optional)</i> Transaction affiliation (e.g. store where sale took place) |
|  [city?](./node-tracker.ecommercetransactionevent.city.md) | string | <i>(Optional)</i> Delivery address, city |
|  [country?](./node-tracker.ecommercetransactionevent.country.md) | string | <i>(Optional)</i> Delivery address, country |
|  [currency?](./node-tracker.ecommercetransactionevent.currency.md) | string | <i>(Optional)</i> Currency of the transaction |
|  [orderId](./node-tracker.ecommercetransactionevent.orderid.md) | string | An identifier for the order |
|  [shipping?](./node-tracker.ecommercetransactionevent.shipping.md) | number | <i>(Optional)</i> The amount of shipping costs for this transaction |
|  [state?](./node-tracker.ecommercetransactionevent.state.md) | string | <i>(Optional)</i> Delivery address, state |
|  [tax?](./node-tracker.ecommercetransactionevent.tax.md) | number | <i>(Optional)</i> The amount of tax on the transaction |
|  [total](./node-tracker.ecommercetransactionevent.total.md) | number | The total value of the order |