Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get customer transactions

This API retrieves transaction details of a customer using customer ID.

get/customers/{id}/transactions

Path parameters

idinteger required

Customer ID of the customer

Query parameters

embed'BILL_CF' | 'BILL_EF' | 'BILL_STORE_DETAILS' | 'PAYMENT_MODES' | 'ATTRIBUTION' | 'CREDIT_NOTES' | 'BILL_POINTS'

Retrieves details for the selected embed parameters.

startDatestring date

Transaction start date in the format YYYY-MM-DD HH:MM:SS.

endDatestring date

Transaction end date in the format YYYY-MM-DD HH:MM:SS.

sortOrder'DESC' | 'ASC'

Order in which records are sorted. ASC and DESC are supported values.

sortBystring

Field by which the records are sorted

limitstring

Maximum number of records to retrieve. Maximum limit: 1000

offsetstring

Starting point for records retrieval

Response

200

OR
OR
OR

Example response

{
  "pagination": {
    "limit": 20,
    "sortBy": "BILLING_TIME",
    "sortOrder": "DESC",
    "total": 108
  },
  "data": [
    {
      "id": 2151202228,
      "customerId": 381894088,
      "loyaltyLogId": 2151202228,
      "billingTime": "2023-07-21T14:34:53+05:30",
      "billNumber": "bill - 497607799",
      "type": "REGULAR",
      "notes": "this is test",
      "amount": 3000,
      "grossAmount": 3000,
      "outlierStatus": "NORMAL"
    }
  ]
}