Get Transaction Details

Retrieves the details of a specific transaction.

Request Parameters

Parameter

Type

Description

id (path)

long

Unique transaction id to fetch details.

type (query)

Enum

Type of transaction to fetch. Value: REGULAR, RETURN, NOT_INTERESTED, NOT_INTERESTED_RETURN. Default value is REGULAR.

tenders (query)

boolean

Pass true to retrieve payment mode details. Default value is false.

credit_notes (query)

boolean

Pass true to retrieve credit notes details (added through v1.1 transaction/add). Default value is false.

mlp

boolean

Pass true to include loyalty points information in the response

points_breakup

boolean

Pass true to include detailed loyalty points breakdown

📘

NOTE

To receive loyalty points information in the response:

  • You must use the transaction id (not number)
  • You must include both Query parameters: ?mlp=true&points_breakup=truE

The API behaves differently depending on identifier used:

  • When using transaction ID: Can return loyalty points if requested
  • When using transaction number: Will never return loyalty points (field will always be empty)
🚧

If you attempt to retrieve data of any deleted customer after a successful PII deletion, you will receive the following response:

"message": "Customer is deleted after PII delete request"

Response parameter

🚧

The description in the line item is not the inventory level description but the description that you added while adding the transaction.

ParameterDescription
useDefaultFleetGroupDetermines if the default fleet group is used. False means it's not used.
loyaltiesPointDetailsAn array indicating about the loyalty points details associated.
billPointsBreakupAn array representing the breakdown of points in the bill. Note: This field will always return an empty array for Get Transaction by ID and Get Transaction by Number APIs. To get points breakup details, use the v2/userGroup2/transactions(GET) API response instead.
attribution
    createDateThe date and time when the record was created.
    createdByDetails about the user who created the record.
        idUser ID.
        codeUser code.
        descriptionDescription of the user.
        nameUser name.
        typeType of user.
        adminTypeType of admin privileges.
        isActiveIndicates if the user is active.
        isOuEnabledIndicates if organizational unit is enabled for the user.
        timeZoneIdUser's time zone ID.
        currencyIdUser's currency ID.
        languageIdUser's language ID.
    modifiedByDetails about the user who last modified the record (currently empty).
    modifiedDateThe date and time when the record was last modified (in UTC).
billDetails
    amountThe total amount of the bill.
    billingStoreDetails about the store where the billing occurred.
        idStore ID.
        codeStore code.
        descriptionDescription of the store.
        nameStore name.
        typeType of store.
        adminTypeType of admin privileges for the store.
        isActiveIndicates if the store is active.
        isOuEnabledIndicates if organizational unit is enabled for the store.
        timeZoneIdStore's time zone ID.
        currencyIdStore's currency ID.
        languageIdStore's language ID.
    billNumberUnique identifier for the bill.
    billingTimeThe date and time when the billing occurred (in UTC).
    discountThe discount applied to the bill.
    grossAmountThe total amount before discount.
    noteAdditional notes or comments about the bill (currently empty).
    returnDetailsDetails about the return status of the bill.
        canceledIndicates if the bill is canceled.
        niReturnDetailsDetails about non-inventory returns (currently empty).
    invalidBillIndicates if the bill is valid or not.
customFieldsAn empty object indicating about the custom fields associated with this record.
sourceIndicates the source of the transaction, in this case, "instore".
addWithLocalCurrencyDetermines if additional information is added with local currency. False means it's not added.
asyncDetermines if the transaction is asynchronous. False means it's synchronous.
useV2Determines if version 2 of the transaction system is used. False means it's not used.
simulationIndicates if the transaction is a simulation. False means it's a real transaction.
customerIdThe unique identifier for the customer associated with the transaction.
idThe unique identifier for this transaction record.
lineItemsAn array of line items that includes information about the line items. <br> NOTE: The description of the line item is not the inventory level description but the description that you added while adding the transaction.
outlierStatusStatus of the entire transaction (currently set to "NORMAL").
typeType of the transaction, in this case, "REGULAR".
lifeTimePurchasesTotal number of purchases made by the customer over their lifetime.
ignorePointsDetermines if loyalty points are ignored for this transaction. False means they are considered.
autoUpdateTimeThe date and time when the transaction record was last updated.
niReturnDetailsDetails about non-inventory returns for the transaction (currently empty).
basketSizeTotal quantity of items in the transaction
returnDetailsDetails about the return status of the entire transaction.
    canceledIndicates if the entire transaction is canceled.
retroTxnDetermines if it's a retrospective transaction. False means it's not retrospective.
warningsAn array indicating about the warnings associated with this transaction.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!