GET api/loyalty2/club/transactions/{fromId}?maxResults={maxResults}
Gets transaction of a club. Important: Transactions can consist of multiple transaction lines. Because of this, it's possible that the returned results do not contain all lines of the last transaction, due to being cut-off by "maxResults". Therefore it's essential to fetch until no more results are returned, to ensure that all lines of all transactions are being obtained.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
fromId |
The Id of the transaction line to start fetching from (exclusive). |
integer |
Required |
maxResults |
The maximum amount of results. Optional. Default is 500. |
integer |
Default value is 500 |
Body Parameters
None.
Response Information
Resource Description
Collection of PublicAPI.Models.TransactionLineViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Id for this loyalty transaction line |
integer |
None. |
MemberId |
Member id for loyalty member |
integer |
None. |
TransactionDate |
Datetime of transaction line |
date |
None. |
ShopName |
Name of shop |
string |
None. |
CashRegister |
Identifier for cash register used |
string |
None. |
Employee |
Employee of the processing of the transaction |
string |
None. |
Receipt |
Receipt for transaction |
string |
None. |
Quantity |
Quantity |
integer |
None. |
Currency |
Currency used |
string |
None. |
Amount |
Size of amount |
decimal number |
None. |
DiscountAmount |
Amount of discount |
decimal number |
None. |
DiscountCode |
Code for discount |
string |
None. |
IsReturn |
Is (not) a return transaction |
boolean |
None. |
ReturnCode |
Return reason code |
string |
None. |
VariantId |
Variant id |
string |
None. |
ShopId |
Id for shop of processing |
integer |
None. |
ItemGroup |
The product's itemgroup, or if ProductNo is 0 then it's the itemgroup that the sale was made on |
integer |
None. |
Response Formats
application/json, text/json
[ { "Id": 1, "MemberId": 2, "TransactionDate": "2025-05-04T06:23:30.199993+02:00", "ShopName": "sample string 4", "CashRegister": "sample string 5", "Employee": "sample string 6", "Receipt": "sample string 7", "Quantity": 8, "Currency": "sample string 9", "Amount": 10.0, "DiscountAmount": 11.0, "DiscountCode": "sample string 12", "IsReturn": true, "ReturnCode": "sample string 14", "VariantId": "sample string 15", "ShopId": 16, "ItemGroup": 17 }, { "Id": 1, "MemberId": 2, "TransactionDate": "2025-05-04T06:23:30.199993+02:00", "ShopName": "sample string 4", "CashRegister": "sample string 5", "Employee": "sample string 6", "Receipt": "sample string 7", "Quantity": 8, "Currency": "sample string 9", "Amount": 10.0, "DiscountAmount": 11.0, "DiscountCode": "sample string 12", "IsReturn": true, "ReturnCode": "sample string 14", "VariantId": "sample string 15", "ShopId": 16, "ItemGroup": 17 } ]
application/xml, text/xml
<ArrayOfTransactionLineViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models"> <TransactionLineViewModel> <Amount>10</Amount> <CashRegister>sample string 5</CashRegister> <Currency>sample string 9</Currency> <DiscountAmount>11</DiscountAmount> <DiscountCode>sample string 12</DiscountCode> <Employee>sample string 6</Employee> <Id>1</Id> <IsReturn>true</IsReturn> <ItemGroup>17</ItemGroup> <MemberId>2</MemberId> <Quantity>8</Quantity> <Receipt>sample string 7</Receipt> <ReturnCode>sample string 14</ReturnCode> <ShopId>16</ShopId> <ShopName>sample string 4</ShopName> <TransactionDate>2025-05-04T06:23:30.199993+02:00</TransactionDate> <VariantId>sample string 15</VariantId> </TransactionLineViewModel> <TransactionLineViewModel> <Amount>10</Amount> <CashRegister>sample string 5</CashRegister> <Currency>sample string 9</Currency> <DiscountAmount>11</DiscountAmount> <DiscountCode>sample string 12</DiscountCode> <Employee>sample string 6</Employee> <Id>1</Id> <IsReturn>true</IsReturn> <ItemGroup>17</ItemGroup> <MemberId>2</MemberId> <Quantity>8</Quantity> <Receipt>sample string 7</Receipt> <ReturnCode>sample string 14</ReturnCode> <ShopId>16</ShopId> <ShopName>sample string 4</ShopName> <TransactionDate>2025-05-04T06:23:30.199993+02:00</TransactionDate> <VariantId>sample string 15</VariantId> </TransactionLineViewModel> </ArrayOfTransactionLineViewModel>