get https://{host}/v2/transactions/
Retrieves the details of a specific transaction.
Example request
curl --location 'https://eu.api.capillarytech.com/v2/transactions/891067503' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc3MDJlOTI5NjQ4MjTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=8BjW8Nhvt_fDf9HkQ9kOll2YcHbWSDerAZeGO3nnarM-1757677291733-0.0.1.1-604800000'Request Parameters
Parameter | Type | Description |
|---|---|---|
id (path) | long | Unique transaction id to fetch details. |
type (query) | Enum | Type of transaction to fetch.
Value: |
tenders (query) | boolean | Pass |
credit_notes (query) | boolean | Pass |
mlp | boolean | Pass |
points_breakup | boolean | Pass |
NOTETo 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=truEThe 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.
Response parameters
| 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 always returns 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 | Contains information about who created and modified the transaction record. |
| • createDate | The date and time when the record was created. |
| • createdBy | Details about the user who created the record. |
| • id | User ID. |
| • code | User code. |
| • description | Description of the user. |
| • name | User name. |
| • type | Type of user. |
| • adminType | Type of admin privileges. |
| • isActive | Indicates if the user is active. |
| • isOuEnabled | Indicates if organisational unit is enabled for the user. |
| • timeZoneId | User's time zone ID. |
| • currencyId | User's currency ID. |
| • languageId | User's language ID. |
| • modifiedBy | Details about the user who last modified the record (currently empty). |
| • modifiedDate | The date and time when the record was last modified (in UTC). |
| billDetails | Contains billing information for the transaction. |
| • amount | The total amount of the bill in base currency. |
| • billingStore | Details about the store where the billing occurred. |
| • id | Store ID. |
| • code | Store code. |
| • description | Description of the store. |
| • name | Store name. |
| • type | Type of store. |
| • adminType | Type of admin privileges for the store. |
| • isActive | Indicates if the store is active. |
| • isOuEnabled | Indicates if organisational unit is enabled for the store. |
| • timeZoneId | Store's time zone ID. |
| • currencyId | Store's currency ID. |
| • languageId | Store's language ID. |
| • billNumber | Unique identifier for the bill. |
| • billingTime | The date and time when the billing occurred (in UTC). |
| • currency | Currency details used for billing. |
| • id | Currency ID. |
| • name | Name of the transaction currency (for example, United States dollar). |
| • symbol | Currency symbol (for example, $). |
| • ratio | Conversion rate between the transaction currency and the base currency. |
| • discount | Discount applied to the bill in base currency. |
| • grossAmount | Total bill amount before discounts are applied in base currency. |
| • note | Additional notes or comments about the bill. |
| • returnDetails | Details about the return status of the bill. |
| • canceled | Indicates if the bill is canceled. |
| • niReturnDetails | Details about non-inventory returns (currently empty). |
| • invalidBill | Indicates if the bill is valid or not. |
| customFields | An empty object indicating custom fields associated with this record. |
| source | Indicates the source of the transaction, such as "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 that includes details of items in the transaction. Note: The description here is what you entered during transaction creation, not the inventory-level description. |
| • id | Unique identifier for the line item. |
| • details | Contains detailed information about each line item. |
| • amount | Total amount for this line item in base currency. |
| • description | Description of the item in the transaction. |
| • discount | Discount applied at line-item level in base currency. |
| • itemCode | Unique code of the item. |
| • qty | Quantity of the item. |
| • rate | Price per item unit in base currency. |
| • serial | Serial number of the line item in the bill. |
| • value | Total value for this line item in base currency. |
| • returnable | Indicates if the item is eligible for return. |
| • returnableDays | Number of days within which the item can be returned. |
| • attributes | Additional item attributes (currently empty). |
| • outlierStatus | Indicates if the line item is marked as outlier or normal. |
| • valid | Indicates if the line item is valid. |
| • currencyLogDto | Contains details about currency conversions used for the transaction or line item. For the line item-level transactions, the value details are provided only in the base currency. |
| • addedBy | ID of the user or till that added the transaction. |
| • addedOn | Date when the transaction was created. |
| • addedOnISO | ISO format of creation date. |
| • autoUpdateTimestamp | Date when the transaction record was last updated. |
| • autoUpdateTimestampISO | ISO format of last update timestamp. |
| • baseCurrencyId | Unique identifier of the base currency. |
| • baseCurrency | Information about the base currency used in the transaction. |
| • id | Base currency ID. |
| • name | Base currency name (for example, Indian rupee). |
| • symbol | Base currency symbol (for example, ₹). |
| • isoCode | ISO code for the base currency. |
| • transactionCurrencyId | Unique identifier of the transaction currency. |
| • transactionCurrency | Information about the transaction currency used in the transaction. |
| • id | Transaction currency ID. |
| • name | Transaction currency name (for example, United States dollar). |
| • symbol | Transaction currency symbol (for example, $). |
| • isoCode | ISO code for the transaction currency. |
| • ratio | Conversion rate between transaction currency and base currency. |
| • value | Transaction value in base currency. |
| • localValue | Value in transaction currency before conversion. |
| • localDiscount | Discount in transaction currency before conversion. |
| • localGrossAmount | Gross amount in transaction currency before conversion. |
| • refType | Type of transaction reference (for example, REGULAR). |
| • refId | Reference ID associated with the currency log. |
| • orgId | Organisation ID under which the transaction was processed. |
| • ratio | Conversion ratio used for this transaction (for example, 86.0 means 1 USD = ₹86). |
| extendedFields | Additional metadata fields, if any. |
| autoUpdateTime | The date and time when the transaction record was last updated (UTC). |
| niReturnDetails | Details about non-inventory returns for the transaction (currently empty). |
| basketSize | Total quantity of items in the transaction. |
| retroTxn | Indicates if it is a retrospective transaction. False means it’s not. |
| returnDetails | Contains return information for the entire transaction. |
| • canceled | Indicates if the entire transaction is canceled. |
| warnings | Array containing any warnings associated with this transaction. |