Skip to content

What this holds about a person

4 tables, 16 columns about a person, 4 things held outside a column, 1 kind of data subject, 1 destination. Some of it is kept indefinitely, and every one of those says why below.

What it holds

loyalty_movement

Who a row is about: the shopper, by customer_id matched into customer.customer_id, which names them at email.

What makes a row go away: never — A points movement is a record of the merchant's liability to a customer, and core's own reward row beside it is kept for ever too. An erasure empties the customer and marks the rows erased, so they stop counting toward anything; the rest stays so the ledger still explains the orders it came from.

Column What it is Why it exists What an erasure does
customer_id refers Whose points these are, and the account core's own reward row was written against. blank
customer_reward_id refers The row in core's reward table this movement wrote, which is what the balance is summed from. retain
order_id refers The order a movement came from. Core's own erasure leaves the order in place, so emptying this removes nothing and would sever the ledger from the order it explains. retain
claim_key refers The key that makes a movement happen once, which can name an order or an account by number. Unique, so it cannot be blanked, and a movement without it could be paid a second time. Kept on erasure, with one exception: the keys this extension mints from the customer's own id — a signup, a birthday, an expiry — are rewritten to name the movement instead, so the emptied row no longer names the person by number. An order's key is kept, because the order survives the erasure and its key is what stops it being awarded twice. retain
points about How many points moved, and in which direction. retain
source about What the points were for — an order, a signup, a redemption, an expiry, another extension. retain
state about Whether the movement counts, is still being written, or was voided, orphaned or erased. retain
base about The amount an order award was computed from, so the merchant can see what it came from. retain
rate about The rate an award was computed at, for the same reason. retain
date_added about When the points moved, which is what the expiry clock runs from. retain
date_modified about When anything about the movement last changed — posted, restated, orphaned or erased — which is what lets a merchant's own systems ask for the movements that changed since they last looked. retain

loyalty_customer

Who a row is about: the shopper, by customer_id matched into customer.customer_id, which names them at email.

Nothing on this table answers to a clock of this extension's own.

Column What it is Why it exists What an erasure does
customer_id refers Whose summary this is. delete
expirable_points about The sum of this extension's own counted movements for the customer, which is the part of a balance expiry may take and never the balance itself. delete
last_activity about When the customer last moved points, which is what the inactivity window is measured from. delete
warned_at about When the customer was warned their points would expire. Nothing expires without it. delete
warned_for about The date the warning said the points would expire on. delete

What it holds that is not in a column

A file, a cookie and a key in the session are exactly where an erasure written as row deletion reaches nothing, and no schema can be diffed to find one. Each is listed here with what keys it to a person, why it is there, and what removes it.

A file on disk. kyvero.log in the store's own DIR_LOGS, the one diagnostic file every extension in this repository shares, capped at 1 MiB and trimmed oldest-first.

Nothing keys this to a person — every message is put through the diary's redaction rule before a byte is written, which is what makes the file survivable where OpenCart puts its own error log.

Why it is here: A merchant reporting a failure needs one place to look, and a support conversation without it is guesswork on both sides.

What an erasure does: retain.

A file on disk. Not a file at all: the standard error of loyalty.php, the command-line entry point a merchant runs the hourly pass from on OpenCart 4.1.0.4. Seven one-line diagnostics — one refusing an argument, four saying the bootstrap could not find, read or recognise a store, one reporting that the scheduled route would not load, and one that the pass ran and failed. Where that stream goes is the operator's own crontab or terminal, and nothing here opens a file.

Nothing keys this to a person — every one of the seven is a fixed sentence about a file path, a class name or an exception. No customer, order or balance is interpolated into any of them.

Why it is here: A pass run from a crontab has nowhere else to say that it could not start, and a cron job silent about that is one a merchant discovers is broken when points that should have expired have not.

What an erasure does: retain.

A key in the store's session. The session, under loyalty_redeem — the number of points a signed-in customer chose to spend on the cart in front of them, and nothing else. Cleared on the order success page.

It does not outlive the request that wrote it: this is session state, gone when the session is, without a clock having to run or a request having to reach it.

Nothing keys this to a person — a whole number, in the session of the customer who chose it.

Why it is here: The choice is made on the cart page and applied on every later page of the checkout, and the session is where core keeps its own coupon and reward choices for the same reason.

What an erasure does: retain.

A key in the store's session. Core's own redirect key, which the points page writes when it is asked for without a sign-in, so that core's login sends the customer back to it.

It does not outlive the request that wrote it: this is session state, gone when the session is, without a clock having to run or a request having to reach it.

Nothing keys this to a person — the link to the points page, with no identifier in it.

Why it is here: It is how OpenCart's own login returns somebody to where they were, and core's Reward Points page, which ours replaces, writes it for the same reason.

What an erasure does: delete.

What it deliberately does not hold

Loyalty has nothing written down here. This section is where a column somebody decided against is recorded with the reason, and an empty one says only that nobody has recorded one — not that nothing was ever declined.

Where it goes

The store's own mail transport, whichever one the merchant configured in OpenCart — mail() or their own SMTP server — carrying the expiry warning to the customer's own address, at most once per expiry and only while the merchant has expiry switched on. It names the points that will expire and the date, and goes to nobody else.

Chosen by: merchant. What reaches it: loyalty_customer.expirable_points, loyalty_customer.warned_for.

Every destination above is one you configured — your own mail transport, your own API caller presenting your own credential. Nothing goes anywhere this extension chose: a destination we picked that anything personal reached would fail the build, not by default, not behind a setting and not with a warning.

What the standard asks, and what this extension answers

Kept indefinitely, on purpose. Nothing below is removed by a clock. Each one says why, which is the part a merchant relying on it has to be able to state:

  • loyalty_movement — A points movement is a record of the merchant's liability to a customer, and core's own reward row beside it is kept for ever too. An erasure empties the customer and marks the rows erased, so they stop counting toward anything; the rest stays so the ledger still explains the orders it came from.

What reaches them instead is the remove-everything screen, which is a request you act on rather than a clock that runs.

Each row below is keyed by the sub-paragraph of the General Data Protection Regulation it comes from, so that you can read the source and disagree with us. What each state means is on the data-protection boundary, once, rather than reworded here. declared is not a pass: it says what the thing is, not that the thing is fine.

Article What this extension supplies toward it This extension
5(1)(c) Every column this extension can put in a store is written down with the one sentence saying why it is there, and a column that is not fails the build — so what a store keeps is what somebody decided to keep rather than what accumulated. Beside it, in the same file and the extension's own voice, is what it deliberately does not keep, and why. checked, 24 — every column this extension's schema can put in a store
30(1)(c) What this extension holds about a person is published column by column — what the column is, whether it names somebody or points at them, and why it exists — so the record a merchant has to keep can be copied off a page rather than reconstructed out of the database. declared
7(1) Where anything this extension does rests on somebody having agreed to it, the declaration names the wording they agreed to and where the proof of it is recorded — and where nothing rests on consent it says so, because we did not need any is an answer and a blank is not. declared
7(3) A declared consent carries the path by which it is withdrawn, or the build fails — because withdrawing has to be no harder than giving, and a consent whose withdrawal path nobody wrote down is one a merchant discovers they cannot honour on the day somebody asks. checked, 0 — every consent declared anywhere in it
15(1) Every table holding anything about a person answers who that person is and how a request reaches them — a column on the table itself, the path through a table this extension does not own, or the plain statement that nothing on it keys a row to anybody — so that a request either has somewhere to arrive or is told outright that there is nowhere, rather than a screen having to guess which rows are whose. checked, 2 — every table holding anything about a person
16(1) A column holding a frozen copy of something the store holds elsewhere names the column it was copied from, so that correcting the original is an instruction a merchant can follow rather than a shrug about why the two disagree. declared
21(3) The row that records somebody saying stop names the subject it is keyed on and the verdict an erasure gives it, so that a live instruction to stop mailing survives the request that was meant to enforce it rather than being deleted by it. declared
25(2) A column that is only collected when a merchant turns something on names the setting that decides it, and the shipped value is read off the configuration declaration rather than restated here — so what a store collects out of the box is a fact on a page instead of something read out of a controller. declared
5(1)(e) Every table this extension can put in a store answers what makes a row holding a person go away — one of six verdicts, and a table that answers 'never' says why in the same breath or fails the build — so a store keeping something for ever is keeping it on purpose. checked, 1 — every table an answer is owed for
15(1)(d) The period each table is kept for is published beside what it holds, as the mechanism and — where there is one — the number or the setting it is read from, so that a merchant answering somebody who asks how long their data will be stored is copying an answer rather than composing one. declared
17(3) Everything an erasure deliberately keeps is published with the reason it was kept, and a kept column with no reason beside it fails the build — because the exemption a merchant relies on is one they have to be able to state, and the screen states it to them at the moment they press the button. declared
17(1) A merchant erases one named person from a screen, and what happens is what the declaration said would happen: the rows and the files an erasure takes are gone, what it keeps is still there, the person standing beside them is untouched, and pressing it a second time is safe. Asserted by running it on a real store — the only place in this standard where erasure behaviour is ever observed, and the only place a file is. Asserted on a real store by make smoke, and deliberately not here — this page is generated by make check, which is green with no store at all, so a verdict rendered from it would rest on nothing.
30(1)(f) The envisaged time limits for erasure are published per table rather than per extension, so the line a merchant copies into their own record says which data it is about instead of averaging seven answers into one. declared
15(1)(c) Every destination this extension's holdings leave it for is published by name, with which of those holdings reach it — so answering somebody who asks who their data was disclosed to is reading a page rather than reading the source. declared
20(2) This extension transmits nothing directly to another controller, and says so out loud rather than leaving it unmentioned: the destinations that exist are the published list, an export is a file the merchant receives and hands on themselves, and there is no path by which we send one controller's data to another on their behalf. declared
30(1)(d) Every destination is written down with who chose it, and a destination this extension chose itself that anything personal reaches fails the build — not by default, not behind a setting, not with a warning, because a store owner cannot consent on behalf of the people in the file. checked, 1 — every destination anything leaves it for
15(3) The screen that says what is held about one named person also hands that statement over: one button produces a file carrying every holding it just listed — what is held, why it is there and what removes it — so answering somebody who asked is sending what the screen showed rather than retyping it into an email. What the file does not carry is the values themselves, which stay in the store; 20(1) below says what that costs. Every extension ships that screen and that button byte for byte, so the file is the same file whichever extension a merchant happened to open. checked, 16 — every holding the file carries
20(1) That file is JSON — structured, commonly used and machine-readable — rather than a screen printed to paper, so whoever asked for it can read it with something other than their eyes. What it carries is the inventory and not the contents: every holding this extension has about that person, folded out of the declaration without a table being opened, which is why two people's files differ in the address at the top and nowhere else. Portability is the right to receive the data itself, and this is not that — the values are in the merchant's own database, and what this supplies is a machine-readable statement of where each one is and what removes it. The row is declared for that reason and not machine: what the rule behind it decides is that every extension ships one export byte for byte, which says what the file is and not that the file is what this article asks for. declared
30(1)(g) The technical and organisational measures are the security baseline's subject, published on its own page with its own rows and its own scanners, and this page links to it rather than restating any of it. What is asserted here is the seam between them: every file this extension writes is declared in both places and cross-checked both ways, so the two descriptions cannot drift apart. declared
KYV-D1 Everything this extension holds about a person can be removed on purpose, from a screen, without uninstalling it — and the screen shows what will go before it goes. Uninstalling keeps it all, because an OpenCart upgrade is an uninstall followed by an install and an extension that dropped its tables on the way out would destroy a store's data on every routine update. A holding every one of whose columns is kept for ever, with nothing anywhere able to remove any of it, fails the build. checked, 6 — every holding the remove-everything screen reaches

What is left over

No column Loyalty holds is declared a frozen copy of anything the store keeps elsewhere, so this page names no second place a correction has to be made first. What each column is, and where its contents came from, is in its own row above.

Removing all of it is one button, on Loyalty's own settings screen at Admin > Extensions > Extensions > Modules > Loyalty. It prints what will go — every table, every file, every key, with a count beside each line and the reason beside the ones it keeps — and nothing goes until you press the second button. It cannot be undone: no soft delete, no recycle bin, no undo, because a recycle bin for personal data is personal data that is still there. Uninstalling does not do it, deliberately: an OpenCart upgrade is an uninstall followed by an install, so an extension that dropped its tables on the way out would destroy your data every time you updated it. Your settings, your configuration and whatever the extension remembers about itself are not touched.

What the law asks of you — you are the controller, and installing an extension is not a compliance process — is on the data-protection boundary, which is also where the words above are defined and where it says why there is no badge. What OpenCart's own erasure feature does underneath all of this, and the things about it worth knowing first, is on what core's own GDPR feature does.