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. |
tenders (query) | boolean | Pass |
credit_notes (query) | boolean | Pass |
mlp | boolean | Pass |
points_breakup | boolean | Pass |
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.
Parameter | Description |
---|---|
useDefaultFleetGroup | Determines if the default fleet group is used. False means it's not used. |
loyaltiesPointDetails | An array indicating about the loyalty points details associated. |
billPointsBreakup | An 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 |
attribution |
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
billDetails |
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
customFields | An empty object indicating about the custom fields associated with this record. |
source | Indicates the source of the transaction, in this case, "instore". |
addWithLocalCurrency | Determines if additional information is added with local currency. False means it's not added. |
async | Determines if the transaction is asynchronous. False means it's synchronous. |
useV2 | Determines if version 2 of the transaction system is used. False means it's not used. |
simulation | Indicates if the transaction is a simulation. False means it's a real transaction. |
customerId | The unique identifier for the customer associated with the transaction. |
id | The unique identifier for this transaction record. |
lineItems | An array of line items that includes information about the line items.
|
outlierStatus | Status of the entire transaction (currently set to "NORMAL"). |
type | Type of the transaction, in this case, "REGULAR". |
lifeTimePurchases | Total number of purchases made by the customer over their lifetime. |
ignorePoints | Determines if loyalty points are ignored for this transaction. False means they are considered. |
autoUpdateTime | The date and time when the transaction record was last updated. |
niReturnDetails | Details about non-inventory returns for the transaction (currently empty). |
basketSize | Total quantity of items in the transaction |
returnDetails | Details about the return status of the entire transaction. |
| |
retroTxn | Determines if it's a retrospective transaction. False means it's not retrospective. |
warnings | An array indicating about the warnings associated with this transaction. |