Time	Status	User Agent
Retrieving recent requests…

This API retrieves a list of customer transactions based on a specified customer identifier and filters.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/customers/lookup/transactions?identifierName=mobile&identifierValue=918088369835&source=INSTORE&transactionType=REGULAR&startDate=2025-01-01&endDate=2025-12-31&localCurrency=false&transactionId=894749264&number=txn-118&startId=1000&endId=2000&entityType=STORE&entityCode=STORE_001&sortOrder=DESC&limit=20&offset=0&embed=BILL_CF%2CBILL_EF%2CATTRIBUTION%2CPAYMENT_MODES%2CCREDIT_NOTES%2CBILL_STORE_DETAILS%2CBILL_POINTS%2CTRANSACTION_IDENTIFIER' \
--header 'Authorization: Basic bWFkaHMjU2YQ==' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=iOrJ_zuHNucnWYJlrloDHCuLzbcD.yzBleSJLaFGd6s-1769592321072-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/v2/customers/lookup/transactions?identifierName=mobile&identifierValue=918088369835&source=INSTORE&transactionType=REGULAR&sortOrder=DESC&limit=1&offset=0&embed=BILL_CF%2CBILL_EF%2CATTRIBUTION%2CPAYMENT_MODES%2CCREDIT_NOTES%2CBILL_STORE_DETAILS%2CBILL_POINTS%2CTRANSACTION_IDENTIFIER' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Prerequisite

Authentication details: Basic or OAuth authentication details.
For more information on authentication, see the Authentication documentation.
Authorisation/access group details: Write access to customer group resource. For more information on access control, see the access group documentation.
The customer should be registered and have at least made one transaction.

Resource information


URI	/v2/customers/lookup/transactions
Pagination supported?	Yes
Batch support	No

Query parameters

Parameter	Data Type	Required	Description
identifierName	string	Yes	Unique registered identifier of the customer. Supported Values: `mobile`, `email`, `externalId`, `id`, `wechat`, `cardnumber`, `cardExternalId`
identifierValue	string	Yes	Value of the identifier. For example, if `identifierName` is mobile, `identifierValue` is mobile number.
source	string	optional	Pass the source from which the transaction is made. Supported Values: `INSTORE`, `WECHAT`, `MARTJACK` (AnywhereCommerce), `WEB_ENGAGE`, `ECOMMERCE`, `JD`, `TAOBAO`, `TMALL` , `FACEBOOK` , `WEBSITE` (other website), `OTHERS` (any other source).
transactionType	enum	optional	Specifies which transaction types are included in the response. Supported values: `REGULAR` – Includes only standard sales transactions `RETURN` – Includes only return or refund transactions `ALL` – Includes both sales and return transactions `Default`: ALL (applied when the parameter is not provided)
startDate	string	optional	Transaction start date in the format YYYY-MM-DD . For example: 2025-01-01
endDate	string	optional	Transaction end date in the format YYYY-MM-DD . For example: 2025-01-01
localCurrency	boolean	optional	If set to true, retrieves the amount, gross amount and discount in the transaction currency (the currency using which the transaction was made) as well. Not applicable for payment modes and credit notes. Default value: `False` Supported Values: `True` and `False`.
transactionId	string	optional	Unique transaction ID used to retrieve transaction details. This ID is generated when the transaction is created. You can also retrieve it from Member Care UI. To retrieve details for multiple transactions, provide a comma-separated list of transaction IDs.
number	string	optional	Unique bill number used to retrieve transaction details. You can get the bill number from the Add Transaction API or from the Member Care UI.
startId	string	optional	Unique transaction ID from which the system starts retrieving transaction details. Transactions with an ID greater than or equal to this value are included in the results. Example: If `startId` is 5000, the system retrieves transactions with an ID greater than or equal to 5000
endId	string	optional	Unique transaction ID up to which the system retrieves transaction details. Transactions with an ID less than or equal to this value are included in the results. Example: If `endId` is 8000, the system retrieves transactions with an ID less than or equal to 8000
entityType	enum	optional	Specifies the level of the store hierarchy to apply the filter. Supported values: STORE, ZONE, CONCEPT and TILL. Note: Values are case-sensitive.
entityCode	string	optional	Specifies the unique identifier of the entity selected in `entityType`. Example: When `entityType=STORE`, `entityCode` is the store code (for example, STORE_001) When `entityType=ZONE`, `entityCode` is the zone code (for example, NORTH_ZONE) When `entityType=TILL`, `entityCode` is the till or cash register code (for example, TILL_05)
sortOrder	enum	optional	Order in which records are sorted. `ASC` and `DESC` are supported values. Default order is `DESC`.
limit	integer	optional	Number of transaction records to display per page. Default limit is 20.
offset	integer	optional	Page number to retrieve. To view the first page, set the value to 0.
embed	string	optional	Specifies the details to include in the response. Supported values: TRANSACTION_IDENTIFIER: Includes transaction details to the response. BILL_CF: Includes custom fields associated with the transaction. BILL_EF: Includes extended fields of the transaction. ATTRIBUTION: Includes additional details regarding the transaction. PAYMENT_MODES: Includes modes of payment for the transaction. CREDIT_NOTES: Includes notes or references related to credits of the transaction. BILL_STORE_DETAILS: Includes details of the store or outlet associated with the transaction. BILL_POINTS: Includes information associated with the promised points, regular points, promotional points, and alternate currencies.

Example response

{
  "pagination": {
    "limit": 20,
    "offset": 0,
    "sortBy": "BILLING_TIME",
    "sortOrder": "DESC",
    "total": 1
  },
  "data": [
    {
      "id": 894749251,
      "customerId": 566135941,
      "loyaltyLogId": 894749251,
      "billingTime": "2025-12-08T10:35:00Z",
      "billNumber": "txn-118",
      "type": "REGULAR",
      "notes": "",
      "amount": 5000,
      "grossAmount": 5000,
      "discount": 0,
      "outlierStatus": "NORMAL",
      "billingStore": {
        "id": 75152715,
        "code": "doc123",
        "description": "",
        "name": "DocStore",
        "type": "STORE",
        "referenceId": -1,
        "adminType": "GENERAL",
        "isActive": true,
        "isOuEnabled": false,
        "timeZoneId": 191,
        "currencyId": 95,
        "languageId": 148,
        "default": false
      },
      "billPoints": {
        "pointsBreakup": [
          {
            "programName": "DocDemoDefaultProgram",
            "programId": 973,
            "regularPoints": [
              {
                "points": 10000,
                "pointsAwardedType": "POINT_AWARDED"
              }
            ],
            "promisePoints": [],
            "promoPoints": []
          }
        ],
        "aggregatedBillPoints": [
          {
            "programName": "DocDemoDefaultProgram",
            "programId": 973,
            "regularPoints": {
              "points": 10000
            },
            "promisePoints": {
              "points": 0
            },
            "promoPoints": {
              "points": 0
            }
          }
        ],
        "alternateCurrenciesBreakup": [],
        "aggregatedBillAlternateCurrencies": []
      },
      "attribution": {
        "createDate": "2025-12-08T10:35:00Z",
        "createdBy": {
          "id": 75152721,
          "code": "naman_doc",
          "description": "",
          "name": "naman",
          "type": "TILL",
          "referenceId": -1,
          "adminType": "GENERAL",
          "isActive": true,
          "isOuEnabled": false,
          "timeZoneId": 191,
          "currencyId": 95,
          "languageId": 148,
          "default": false
        },
        "modifiedBy": {
          "referenceId": -1,
          "default": false
        },
        "modifiedDate": "2025-12-10T06:11:36Z"
      },
      "txnIdentifiers": [
        {
          "type": "id",
          "value": "566135941"
        }
      ]
    }
  ],
  "warnings": [],
  "errors": []
}

{
  "pagination": {
    "limit": 1,
    "offset": 0,
    "sortBy": "BILLING_TIME",
    "sortOrder": "DESC",
    "total": 66
  },
  "data": [
    {
      "id": 896977973,
      "customerId": 566135941,
      "loyaltyLogId": 896977973,
      "billingTime": "2026-01-27T09:00:00Z",
      "billingTimeInputOffset": "+05:30",
      "billNumber": "test00transact12399",
      "type": "REGULAR",
      "notes": "Regular Tranasction number 122",
      "amount": 2000,
      "grossAmount": 2000,
      "discount": 0,
      "outlierStatus": "NORMAL",
      "billingStore": {
        "id": 75152715,
        "code": "doc123",
        "description": "",
        "name": "DocStore",
        "type": "STORE",
        "referenceId": -1,
        "adminType": "GENERAL",
        "isActive": true,
        "isOuEnabled": false,
        "timeZoneId": 191,
        "currencyId": 95,
        "languageId": 148,
        "default": false
      },
      "customFields": {
        "booking_date": "2025-07-30",
        "origin": "instore",
        "paymentmode": "card"
      },
      "extendedFields": {
        "event_input_date_offset": "+05:30"
      },
      "billPoints": {
        "pointsBreakup": [],
        "aggregatedBillPoints": [],
        "alternateCurrenciesBreakup": [],
        "aggregatedBillAlternateCurrencies": []
      },
      "attribution": {
        "createDate": "2026-01-27T09:00:00Z",
        "createdBy": {
          "id": 75155297,
          "code": "tj_capillary",
          "description": "",
          "name": "tj_capillary",
          "type": "TILL",
          "referenceId": -1,
          "adminType": "GENERAL",
          "isActive": true,
          "isOuEnabled": false,
          "timeZoneId": 191,
          "currencyId": 95,
          "languageId": 148,
          "default": false
        },
        "modifiedBy": {
          "referenceId": -1,
          "default": false
        },
        "modifiedDate": "2026-01-28T12:19:46Z"
      },
      "txnIdentifiers": [
        {
          "type": "mobile",
          "value": "918088369835"
        }
      ]
    }
  ],
  "warnings": [],
  "errors": []
}

Response parameter

Parameter	Data Type	Description
.pagination	Object	Contains pagination details for the transaction list.
..limit	Integer	Indicates maximum number of records returned per request.
..offset	Integer	Indicates the position from which records start and is used for pagination.
..sortBy	String	Field name used to sort transactions. Possible value: `BILLING_TIME`.
..sortOrder	String	Indicates the order in which records are sorted. Possible values: `ASC` (ascending) or `DESC` (descending).
..total	Integer	Total number of transactions matching the query filters.
.data	Array	Array of objects containing the list of transactions.
..id	Integer	Unique identifier for the transaction.
customerId	Integer	Unique identifier for the customer associated with the transaction.
..loyaltyLogId	Integer	Unique ID of the transaction record in the loyalty log entry.
..billingTime	String	Bill creation date and time in ISO 8601 format, returned in the server time zone. EU server example: `2025-12-16T14:30:45Z` → 16 December 2025, 14:30:45 (UTC) India server example: `2025-12-16T14:30:45+05:30` → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
billingTimeInputOffset	integer	Specifies the time difference, in minutes, between the billing time provided in the request and UTC. This indicates the timezone offset that was applied when the original billing time was recorded.
..billNumber	String	Bill or invoice number linked to the transaction.
..type	Enum	Indicates the type of Transaction. Possible values: i. `REGULAR`: A normal purchase transaction with no return. ii. `NOT_INTERESTED`: A bill where the customer made a purchase transaction but explicitly chose not to enroll/participate in loyalty program. iii. `RETURN`: A return/cancellation transaction where items from a previous bill are being returned. iv.`NOT_INTERESTED_RETURN`: A bill where the customer returned items from a purchase that was not on the loyalty program. v. `MIXED`: A bill that has both new purchases and returns on the same receipt. vi. `NI_MIXED`: A bill with both purchases and returns where the customer is not using the loyalty program.
..notes	String	Note added when creating a transaction.
..amount	Decimal	Final payable amount after discount in base currency.
..grossAmount	Decimal	Total transaction value before discount in base currency.
..discount	Decimal	Total discount applied to the transaction in base currency.
..outlierStatus	Enum	Indicates if the transaction is flagged as an outlier. Possible Values: `INTERNAL`, `NORMAL`, `INVALID`, `OUTLIER`, `FAILED`, `DELETED`, `RETRO`, `FRAUD`, `TEST`.
..billingStore	Object	An object containing details about the billing store.
...id	Integer	The store ID.
...code	String	The store code.
...description	String	The store description.
...name	String	The store name.
...referenceId	Integer	The unique ID from an external system which is used for linking the billing store in loyalty to its corresponding to an external record (for example, the POS/ERP/store master). A positive value indicates a valid external link, while -1 (or null) means no external reference is configured.
...adminType	String	The store admin type. Possible values: `ADMIN`, `GENERAL`.
...isActive	Boolean	Indicates if the store is active.
...isOuEnabled	Boolean	Indicates if Organization Unit (OU) is enabled for the store.
...timeZoneId	Integer	The ID of the time zone used for that store (for example, which local time zone the store operates in). It’s used so bill times can be shown/processed in the store’s local time
...currencyId	Integer	The ID of the currency used by that store. For example, which currency the store’s prices and bills are in.
...languageId	Integer	The ID of the language configured for that store. For example, which language is used for store‑specific labels, messages, or content.
...default	Boolean	Indicates whether the store is configured as the default billing store. Possible values: `true` – The store is set as the default billing store for the organization or context. `false` – The store is not the default billing store.
..customFields	Array	An array containing list of custom fields for transaction.
..extendedFields	Array	An array containing list of extended fields for transaction.
..billPoints	Object	Object containing details about loyalty points earned from the bill.
...pointsBreakup	Array	Breakdown of points earned. Includes info on promised points, promotional points, regular points, and points awarded type with the associated program type and program ID.
....programName	String	The name of the program
....programId	Integer	Unique Id of the program
....regularPoints	Array	Redeemable loyalty points earned for the transaction, excluding promotional or bonus points.
.....points	Decimal	Total points issued for a transaction.
.....pointsAwardedType	String	The types of points that are awarded. Possible values: `Point_Awarded`, `Point_Awarded_Bill_Promotion`, `Point_Awarded_Lineitem`, `Point_Awarded_Customer_Promotion`
....promisePoints	Array	Points that are not yet active and will convert to regular points after a delay. If the transaction is returned within that window, these promised points are reverted and never become current points.
....promoPoints	Array	Bonus loyalty points awarded through promotions at the bill, line-item, or customer level, in addition to regular points. The source of these points is a promotion rather than the base earn rule.
...aggregatedBillPoints	Array	Includes info on promised points, promotional points, and regular points with the associated program type and program ID.
...alternateCurrenciesBreakup	Array	Breakdown of alternate currencies earned with the related information. This is available when alternate currency is enabled for the org and awarded.
...aggregatedBillAlternateCurrencies	array	Breakdown of alternate currencies earned with the related information. This is available when alternate currency is enabled for the org and awarded.
..attribution	Object	An object containing attribution details.
...createDate	String	Indicates the creation date and time of the transaction in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
...createdBy	Object	An object containing details about the creator.
....id	Integer	The creator's ID.
....code	String	The creator's code. It is also the till id.
....description	String	The creator's description.
....name	string	The creator's name.
....type	string	The type of entity that created or updated the transaction. Possible values: `ZONE`, `CONCEPT`, `STORE`, `TILL`, `STR_SERVER`, `ADMIN_USER`, `ASSOCIATE`, `RULE` and `OU`.
....referenceId	Integer	Internal reference ID of the creator entity. Used by backend systems to link this 'created by' entity to its source record.
....adminType	String	The level of access that the creating or updating entity has. Possible values: `ADMIN` and `GENERAL`.
....isActive	Boolean	Indicates if the creator is active.
....isOuEnabled	Integer	Indicates if Organization Unit (OU) is enabled for the creator.
....timeZoneId	Integer	The time zone ID for the creator.
....currencyId	Integer	The currency ID used by the creator.
....languageId	Integer	The language ID used by the creator.
....default	Boolean	Indicates whether this creator entity is the default one for its context. If `true`, this is the default user/store/till to attribute actions to when no more specific creator is available.
...modifiedBy	Object	Details on the modifications made.
...modifiedDate	String	Indicates the creation date and time of the transaction in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
..txnIdentifiers	Array	Array containing the customer identifier details used when the transaction was created.
...type	String	Type of identifier used for transaction.
...value	String	Value of the identifier.
.warnings	Array	Array containing any warnings encountered during processing.
.errors	Array	Array containing any errors encountered during processing.

Error codes

Error codes	Description
8003	Source information is missing.
8130	Identifiername and value is missing.
816	Customer not found for organization
1011	Cannot find customer for provided identifier
1012	Cannot find customer with the provided mobile/external ID/email ID
1013	Customer is not registered for the loyalty program

Example request

Prerequisite

Resource information

Query parameters

Example response

Response parameter

Error codes

200Successful response