Purchased at Retailer
Sent for each historical purchase and for any newly detected purchases.| Key | Type | Description |
|---|---|---|
purchase_id | string | Identifier for the purchase |
retailer | string | Identifier for the retailer where the purchase was made |
date | string | The date of the purchase (ISO 8601) |
item_count | string | The number of items in the purchase |
subtotal | number | The subtotal of the purchase |
tax | number | The sales tax that was paid |
total | number | The grand total paid by the customer |
brands | string | The brands associated with each item in the purchase |
upcs | string | The UPCs associated with each item in the purchase |
Connected an Account
Sent when a customer connects a retailer account.| Key | Type | Description |
|---|---|---|
connection_id | string | Identifier for the connection |
retailer | string | Identifier for the retailer |
Disconnected an Account
Sent when a customer disconnects a retailer account.| Key | Type | Description |
|---|---|---|
connection_id | string | Identifier for the connection |
retailer | string | Identifier for the retailer |
link_url | string | The Link URL that can be used to reconnect the account |
Reauthenticated Connection
Sent when an unauthenticated connection becomes reauthenticated.| Key | Type | Description |
|---|---|---|
connection_id | string | Identifier for the connection |
retailer | string | Identifier for the retailer |
Unauthenticated Connection
Sent when an active connection becomes unauthenticated and requires the customer to reauthenticate (e.g. after a retailer password change).| Key | Type | Description |
|---|---|---|
connection_id | string | Unique identifier for the connection |
retailer | string | Identifier for the retailer |
link_url | string | The Link URL that can be used to reconnect the account |