Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get group transactions

Retrieves the transactions of a specific group. You can also get transactions of a group member using query parameters.

get/userGroup2/transactions

Query parameters

type'REGULAR' | 'RETURN'

Type of the transaction to retrieve.

idinteger

Unique ID of the user group to fetch transactions.

externalIdstring

External ID of the group.

primaryUserIdstring

User ID of the primary member of the group.

identifierName'mobile' | 'email' | 'externalId'

Identifier used for the primary user of the group. Required to get transactions of the group member.

identifierValuestring

Value of the specified identifier type.

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP'

Source in which the identifier is available.

accountIdstring

Account ID for sources with multiple accounts such as FACEBOOK, WEBENGAGE, WHATSAPP. Applicable to fetch member transactions.

transactionIdinteger

Fetch details of a specific transaction by transaction ID.

billNumberstring

Fetch details of a specific transaction by bill number.

customerIdinteger

Unique ID of the group member to fetch group transactions made by the customer.

startDatestring date

Filter results where transaction_date >= startDate. Pass ISO standard date format.

endDatestring

Filter results where transaction_date < end_date. Pass ISO standard date format.

embed'EXTENDEDFIELDS' | 'CUSTOMFIELDS' | 'LINEITEMS' | 'PAYMENTDETAILS'

Additional details to be fetched. You can pass multiple values each separated by a comma. PAYMENTDETAILS is supported only for regular transaction.

getDataForAllProgramsboolean

Pass true to fetch transactions across all programs data (future use case).

offsetinteger

Offset of the first entry in the result. This should be positive. If offset is less than 0, then 0 default offset will be used.

limitinteger

Maximum number of results to show. This should be positive. if limit is less <=0, then the default limit 20 is considered.

order'ACS' | 'DESC'

Arranges 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 transactionDate.

creditNotesboolean

Pass true to fetch credit notes details.

rolesstring

Roles associated with the user.

Response

200

OR
OR

Example response

{
  "data": [
    {
      "pointSummary": {
        "issuedPoints": 40,
        "availablePoints": 40,
        "expiryDate": "2023-02-28T23:59:59+05:30",
        "programId": 765,
        "redeemableFrom": "2022-02-11T18:12:50+05:30"
      },
      "userGroup2": {
        "id": 91898,
        "groupStatus": "ACTIVE",
        "lifeTimePurchases": 45000,
        "primaryUserId": 420803400
      },
      "billDetails": {
        "amount": 200,
        "billingStore": {
          "id": 15089278,
          "code": "northstore1",
          "description": "NORTH_STORE_ONE",
          "name": "NORTH_STORE_ONE",
          "type": "STORE",
          "adminType": "GENERAL",
          "isActive": true,
          "currencyId": 44,
          "languageId": -1
        },
        "billNumber": "FC2-111112573646898_bulk2",
        "billingTime": "2022-02-11T18:12:50+05:30",
        "discount": 10,
        "grossAmount": 110,
        "note": "this is test"
      },
      "customFields": {
        "paymentmode": "abc"
      },
      "customerId": 420803403,
      "id": 2148592384,
      "lineItems": [
        {
          "id": 2157283693,
          "details": {
            "amount": 100.5,
            "itemCode": "sku__2",
            "qty": 1,
            "rate": 100.5,
            "returnable": true,
            "returnableDays": -1,
            "extendedFields": {
              "GrossWeight": 10.5,
              "MetalRate": 22.02
            }
          },
          "outlierStatus": "NORMAL",
          "valid": true
        }
      ],
      "outlierStatus": "NORMAL",
      "type": "REGULAR",
      "extendedFields": {
        "checkin_date": "2020-06-30T18:03:52+05:30",
        "checkout_date": "2020-07-12T18:03:52+05:30",
        "ship_first_name": "22.02",
        "ship_last_name": "10.50"
      },
      "autoUpdateTime": "2022-02-11T18:12:50+05:30",
      "transactionEventStatus": "PROCESSING_COMPLETE",
      "basketSize": 10
    }
  ]
}