Get Customer Transactions

Retrieves transaction history of a customer which includes the following information. Transaction type, gross transaction amount, transaction date, points issued, points redeemed, coupons redeemed and so on.

By default, it shows up to 10 results and shows results based on the limit passed.

  • There is no upper limit for number of transactions.
  • There is no duration based limit.

By default, it shows up to 10 results and shows results based on the limit passed.

  • There is no upper limit for number of transactions.
  • There is no duration based limit.

📘

You cannot retrieve individual line-item level details of a transaction.

Query parameters

ParameterDatatypeDescription
identifierName*enumPass any of the customer identifier with the identifier value. Value: mobile, email, external_id id. To retrieve transactions of multiple customers at a time, provide each identifier separating by a comma. Example: mobile=44700900000,44700900999,4470090345.
identifierValue*stringProvide the respective identifier value. For example, ?email=[email protected].
entity_typeenumAttribute by which you want to filter the transactions. Value: ZONE, CONCEPT, STORE, TILL, STR_SERVER (store server). For oAuth2, you need to pass this in headers. See the Introduction > Authentication section for more details.
entity_codestringCode of the specified entity_type. For example, to get transactions of a specific zone (with zone code zone01), pass entity_type=zone&entity_code=zone01.
numberstringFetch transaction details by transaction number.
transaction_idintFetch details of a transaction by transaction ID (internally generated unique ID for a transaction).
store_idstringFilter transactions associated to a specific store id.
store_codestringFilter transactions associated to a specific store code.
start_idintFilters transactions with transaction IDs are greater than or equal to a specific value.
end_idintFilter transactions with transaction IDs less than or equal to a specific value.
start_datedate-timeRetrieves transactions made on or after a specific date (YYYY-MM-DD). To get transactions of a particular duration, use both start_date and end_date. Example: start_date=2013-12-21+23:45:45&end_date=2013-12-29+12:11:45
end_datedate-timeRetrieves transactions made on or before a specific date (YYYY-MM-DD). To get transactions of a particular duration, use both start_date and end_date. Example: start_date=2013-12-21+23:45:45&end_date=2013-12-29+12:11:45
credit_notesbooleanRetrieves the credit notes of the transactions. Value: true,false. Pass the parameter to retrieve credit notes along with the transaction details. Credit Notes is a receipt given by a cashier to a customer for returned goods which can be used for future purchases.
custom_fieldsbooleanPass true to retrieve transaction level custom field details.
points_breakupbooleanPass true to retrieve the breakup of points earned for each transaction.
limitintLimit the number of results to be displayed (default value is 10). For example, limit=20 shows up to 20 transactions of the customer.
offsetintNumber of records to be ignored from the top. Offset is the position of the entity in the database record. The value is assigned based on the sequence of creation. For example, offset=10 ignores the first 10 transactions of the customer.
sortenumArranges transactions in ascending or descending order of transaction date if the value istrans_date, transaction id if the value is trans_id. By default, results are shown in descending order.
orderenumArranges the transactions based on the value set in sort in an ascending (asc) or descending order (desc). By default, results are shown in the descending order of transaction date/id.

Response parameters

ParameterDescription
response.status.successIndicates whether the request was successful.
response.status.codeHTTP response code.
response.status.messageDescriptive message related to the response code.
response.customer.firstnameFirst name of the customer.
response.customer.lastnameLast name of the customer.
response.customer.user_idUnique identifier for the user.
response.customer.mobileMobile number of the customer.
response.customer.emailEmail address of the customer.
response.customer.external_idExternal identifier for the customer.
response.customer.lifetime_pointsTotal points accumulated over the lifetime.
response.customer.lifetime_purchasesTotal purchases made over the lifetime.
response.customer.loyalty_pointsCurrent loyalty points of the customer.
response.customer.current_slabCurrent loyalty tier of the customer.
response.customer.registered_onDate and time the customer registered.
response.customer.updated_onDate and time the customer's details were last updated.
response.customer.typeType of the customer record.
response.customer.sourceSource from which the customer was registered.
response.customer.countCount of some unspecified records.
response.customer.startStart identifier for some range.
response.customer.delayed_pointsPoints that are delayed for some reason.
response.customer.delayed_returned_pointsReturned points that are delayed.
response.customer.total_available_pointsTotal available points for the customer.
response.customer.total_returned_pointsTotal points that have been returned.
response.customer.rowsNumber of rows/records.
response.customer.transactions.transaction[].idUnique identifier for the transaction.
response.customer.item_status.successIndicates the success of fetching transaction items.
response.customer.item_status.codeCode related to the transaction item fetch status.
response.customer.item_status.messageDescriptive message related to the transaction item fetch status.
response.customer.item_status.warningsAny warnings associated with the transaction item fetch.

Error code

ErrorDescription
91001Failed to get point details
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!