iotoms Docs

List inactive customers

GET
/api/v1/reports/customer/inactive

Returns customers with no purchase activity for at least inactiveDays days (default 90). Useful for win-back campaigns.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

inactiveDays?integer

Days of inactivity threshold, default 90

Formatint64
Default90

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

Inactive customers, longest-inactive first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/inactive' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "customerNumber": "string",      "customerName": "string",      "lastPurchaseDate": "2019-08-24",      "daysSinceLastPurchase": 0,      "lifetimeSpend": 0    }  ]}