keepa.models.backend.Tracking#

pydantic model keepa.models.backend.Tracking#

Backend Tracking model generated from the Keepa Java schema.

Fields:
field asin: str | None = None#

The tracked product ASIN

field createDate: int | None = None#

Creation date of the tracking in KeepaTime minutes

field expireNotify: bool | None = None#

Trigger a notification if tracking expires or is removed by the system (e.g. product deprecated)

field individualNotificationInterval: int | None = None#

A tracking specific rearm timer.

-1 = use default notification timer of the user account (changeable via the website settings) 0 = never notify a desired price more than once larger than 0 = rearm the desired price after x minutes.

field isActive: bool | None = None#

Whether or not the tracking is active. A tracking is automatically deactivated if the corresponding API account is no longer sufficiently paid for.

field mainDomainId: int | None = None#

The main Amazon locale of this tracking determines the currency used for all desired prices.

Integer value for the Amazon locale AmazonLocale

field metaData: str | None = None#

The meta data of this tracking (max length is 500 characters). Used to assign some text to this tracking, like a user reference or a memo.

field notificationCSV: list[int | None] | None = None#

A history of past notifications of this tracking. Each past notification consists of 5 entries, in the format:

[AmazonLocale, Product.CsvType, NotificationType, TrackingNotificationCause, KeepaTime]

field notificationType: list[bool | None] | None = None#

Determines through which channels we will send notifications. Must be a boolean array with the length of the NotificationType enum. Uses NotificationType indexing NotificationType. True means the channel will be used.

Our Tracking API currently only supports notifications through push webhooks or API pull request. Other channels will follow soon.

Example: Only notify via API: [ false, false, false, false, false, true, false ]

boolean[] notificationType = new boolean[Tracking.NotificationType.values.length];

notificationType[Tracking.NotificationType.API.ordinal()] = true;

field notifyIf: list[TrackingNotifyIf | None] | None = None#

Contains specific, meta tracking criteria, like out of stock.

field thresholdValues: list[TrackingThresholdValue | None] | None = None#

Contains all settings for price or value related tracking criteria

field ttl: int | None = None#

The time to live in hours until the tracking expires and is deleted. When setting the value through the Add Tracking request it is in relation to the time of request, when retrieving the tracking object it is relative to the createDate. Possible values:

any positive integer: time to live in hours

0: never expires

any negative integer (only when setting the value):

tracking already exists: keep the original ttl tracking is new: use the absolute value as ttl

field updateInterval: int | None = None#

The update interval, in hours. Determines how often our system will trigger a product update. A setting of 1 hour will not trigger an update exactly every 60 minutes, but as close to that as it is efficient for our system. Throughout a day it will be updated 24 times, but the updates are not perfectly distributed.