iotoms Docs

Get a customer's spend summary

GET
/api/v1/reports/customer/spend

Returns aggregated spend for one customer (customerNumber, required) between from and to (both default to today).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

customerNumber*string

Customer number

from?string

Start date (YYYY-MM-DD), defaults to today

Formatdate
to?string

End date (YYYY-MM-DD), defaults to today

Formatdate

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?

The customer's spend summary for the date range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/spend?customerNumber=string' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "customerNumber": "string",    "customerName": "string",    "totalSpend": 0,    "orderCount": 0,    "totalReturns": 0,    "netSpend": 0,    "avgOrderValue": 0,    "lastPurchaseDate": "2019-08-24"  }}