v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

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.

get/customer/transactions

Query parameters

identifierName'mobile' | 'email' | 'external_id id' required

Identifier of the customer to use.

identifierValuestring required

Value of the specified identifier type. o retrieve transactions of multiple customers at a time, provide each identifier separating by a comma. <br>Example: mobile=44700900000,44700900999,4470090345

entity_type'ZONE' | 'CONCEPT' | 'STORE' | 'TILL' | 'STR_SERVER'

Attribute by which you want to filter the transactions. <br>For oAuth2, you need to pass this in headers. See the Introduction > Authentication section for more details.

entity_codestring

Code 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.

numberstring

Fetch transaction details by transaction number.

transaction_idinteger

Fetch details of a transaction by transaction ID (internally generated unique ID for a transaction).

store_idstring

Filter transactions associated to a specific store ID.

store_codestring

Filter transactions made in a specific store. Pass the store code.

start_idinteger

Filters transactions with transaction IDs are greater than or equal to a specific value.

end_idinteger

Filter transactions with transaction IDs less than or equal to a specific value.

start_datestring date

Retrieves 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.

end_datestring date

Retrieves 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_notesboolean

Retrieves the credit notes of the transactions. Credit Notes is a receipt given by a cashier to a customer for returned goods which can be used for future purchases.

custom_fieldsboolean

Pass true to retrieve transaction level custom field details.

points_breakupboolean

Pass true to retrieve the breakup of points earned for each transaction.

limitinteger

Limit the number of results to be displayed (default value is 10). For example, limit=20 shows up to 20 transactions of the customer.

offsetinteger

Number 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.

sort'trans_date' | 'trans_id'

Whether to sort results by transaction date or transaction ID.

order'asc' | 'desc'

Arranges the transactions based on the value set in sort. By default, results are shown in the descending order of transaction date/id.

mlpboolean

Pass true to get transactions from all programs of the org, false to fetch from the default program associated with the till.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "Success"
    },
    "customer": {
      "firstname": "Tom",
      "lastname": "Sawyer",
      "user_id": "98662653",
      "mobile": "919740000000",
      "email": "tom.sawyer@example.com",
      "external_id": "anjvat123",
      "lifetime_points": 5730,
      "lifetime_purchases": 53609,
      "loyalty_points": 4776,
      "current_slab": "Albatross Elite",
      "registered_on": "2019-04-14 11:32:30",
      "updated_on": "2020-04-03 06:58:32",
      "type": "LOYALTY",
      "source": "instore",
      "count": 51,
      "start": "321260040",
      "delayed_points": "0",
      "delayed_returned_points": "0",
      "total_available_points": "0",
      "total_returned_points": "0",
      "rows": "10",
      "transactions": {
        "transaction": [
          {
            "id": "321260040",
            "number": "localcurrency0235",
            "type": "REGULAR",
            "amount": "2000",
            "outlier_status": "NORMAL",
            "delivery_status": "DELIVERED",
            "notes": "Regular Bill with Payment Details",
            "billing_time": "2020-04-01 00:00:00",
            "auto_update_time": "2020-04-03 06:58:31",
            "gross_amount": "2000",
            "discount": "0",
            "store": "International Business Park",
            "store_code": "international_business_park",
            "returned_points_on_bill": "0.0",
            "currency": {
              "ratio": 1,
              "transaction_currency": {
                "supported_currency_id": 70275062,
                "name": "Indian Rupee ",
                "symbol": "₹"
              },
              "id": 70275062,
              "name": "Indian Rupee ",
              "symbol": "₹"
            },
            "points": {
              "issued": "200",
              "redeemed": "0",
              "returned": "0",
              "expired": "0",
              "returnedPointsOnBill": "0.0",
              "expiry_date": "2020-05-31 23:59:59",
              "program_id": "469"
            }
          }
        ]
      },
      "item_status": {
        "success": "true",
        "code": "1052",
        "message": "Transactions fetched successfully"
      }
    }
  }
}