Skip to content

Powered by Grav CMS + Helios Theme

Retention

The store's data retention policy, and the run that applies it.

The retention policy says how long KahunaCart keeps personal data on a completed order, and the run is what applies it. See Customers, wishlists, reviews and retention.

Read the retention schedule

GET /api/v1/kahunacart/retention Permission kahunacart.customers.view

Read the store's data-retention windows — how long placed-but-unpaid orders are kept, how long failed ones are, how long before a completed order is anonymised, how long before an inactive customer is erased — and what each rule last did. Every window is off unless the merchant set one.

Run the retention schedule now

POST /api/v1/kahunacart/retention/run Permission kahunacart.customers.manage

Run the retention sweep immediately instead of waiting for the daily worker tick. Completed orders are anonymised rather than deleted, so revenue figures never change. Send dry_run to find out what it would do without doing any of it — always do that first on a store that has just configured a window.

Parameters

Name Type Description
dry_run optional boolean Report what would be swept and change nothing.
limit optional integer Rows one rule may touch in this run, overriding the configured chunk size.