iotoms Docs

Get a customer's purchase history

GET
/api/v1/reports/customer/purchase-history

Returns the purchases of one customer between from and to (both default to today). Pass either customerNumber or storeId; use storeId for shops visited on a route, which often have no customer number.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

customerNumber?string

Customer number (customerNumber or storeId required)

storeId?integer

customer_stores.id (customerNumber or storeId required) — needed for route visits, which rarely carry a real CRM customerNumber

Formatint64
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?array<>|

One entry per sale to the customer or store in the date range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/purchase-history' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "customerNumber": "string",      "customerName": "string",      "businessDate": "2019-08-24",      "transactionId": "string",      "invoiceNumber": "string",      "grandTotal": 0,      "channel": "string"    }  ]}