Skip to content
Bottle

Get retention settings

GET
/retention
curl --request GET \
  --url https://example.com/retention \
  --cookie bottle.session_token=<bottle.session_token>

Counted from the last order, or from the day the record was made where there has never been one. Seven years is the ceiling.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The rules

Media typeapplication/json
object
enabled
required
boolean
years
required
integer
>= 1 <= 7
warnDays
required
integer
<= 180
updatedAt
required
string format: date-time
Examplegenerated
{
  "enabled": true,
  "years": 1,
  "warnDays": 1,
  "updatedAt": "2026-04-15T12:00:00Z"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}