GET api/transactions/sales/item/{shopId}/{transactionNumber}
Provides a list of sales item transactions, given a shop id and a transaction number.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
shopId |
The shop id. |
integer |
Required |
transactionNumber |
The transaction number, from which to start. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of SaleItemModelName | Description | Type | Additional information |
---|---|---|---|
CostPrice |
The items cost price |
decimal number |
None. |
UniqueItemNumber |
DdD's unique item identifier also known as a EDB-number |
integer |
None. |
SupplierId |
The supplers id |
integer |
None. |
EAN |
The items EAN |
integer |
None. |
WholeSaleCostPrice | decimal number |
None. |
|
EffectiveSalesPrice |
This is the calculated price, GrossSalesPrics - Discount |
decimal number |
None. |
Discount |
The discount given on this sale incl. VAT. Discount is always negativ*** |
decimal number |
None. |
DiscountCode |
Code defining why the discount was given, this code is defined by the shop them selfs and is unknown to us*** |
integer |
None. |
ReturnCode |
Code defining why the item have been returned, this in only used if the quantity is negative, default value is 0*** |
integer |
None. |
WebOrderReference |
Association to a web order. This can be in use for "Order in Store" orders or omnichannel weborders. |
string |
None. |
CustomText |
A text which can be entered on an item line by the clerk. It can be used for anything or nothing. |
string |
None. |
PosNumber |
Containing the origine posnumber of the sales, 99 is normaly sales though webshop |
integer |
None. |
ReceiptNumber |
Contains the receipt number, this is unique on posnumber, date, shopid |
integer |
None. |
ClerkId |
The Salespersons employeeId |
integer |
None. |
VAT | decimal number |
None. |
|
CustomerClubNumber |
The customers loyalty club number if he has one. |
string |
None. |
Amount |
Amount including VAT, discount not deducted. |
decimal number |
None. |
GiftVoucherAutoNumber |
If a giftvaucher was used then the voucher number is contained here |
string |
None. |
GiftVoucherAlternativeNumber |
if a alternative giftvoucher was used then the voucher number is contained here*** |
string |
None. |
PosTransactionType |
Payment or Item |
PublicAPI.Models.PosTransactionTypeViewModel |
None. |
ConnectorId |
The ID of the Connector which handled the sale. Any cash from the sale will be in the drawer connected to this connectorId. |
integer |
None. |
ShopId |
The shop id. |
integer |
None. |
TransactionNumber |
A unique auto increment number over ShopId. |
integer |
None. |
TransactionDateTime |
The date and time of the transaction. |
date |
None. |
TransactionType |
The type of transaction, this ranges from card type to return, this varies from country to country and is there for unknown to us. |
integer |
None. |
Quantity |
The number of items on this line. |
integer |
None. |
ItemGroupNumber |
The itemgroup this item belongs to. |
integer |
None. |
Response Formats
application/json, text/json
[ { "CostPrice": 1.0, "UniqueItemNumber": 2, "SupplierId": 3, "EAN": 4, "WholeSaleCostPrice": 5.0, "EffectiveSalesPrice": 22.0, "Discount": 6.0, "DiscountCode": 7, "ReturnCode": 8, "WebOrderReference": "sample string 9", "CustomText": "sample string 10", "PosNumber": 11, "ReceiptNumber": 12, "ClerkId": 13, "VAT": 14.0, "CustomerClubNumber": "sample string 15", "Amount": 16.0, "GiftVoucherAutoNumber": "sample string 17", "GiftVoucherAlternativeNumber": "sample string 18", "PosTransactionType": "Item", "ConnectorId": 19, "ShopId": 20, "TransactionNumber": 21, "TransactionDateTime": "2025-05-04T06:13:12.1717355+02:00", "TransactionType": 23, "Quantity": 24, "ItemGroupNumber": 25 }, { "CostPrice": 1.0, "UniqueItemNumber": 2, "SupplierId": 3, "EAN": 4, "WholeSaleCostPrice": 5.0, "EffectiveSalesPrice": 22.0, "Discount": 6.0, "DiscountCode": 7, "ReturnCode": 8, "WebOrderReference": "sample string 9", "CustomText": "sample string 10", "PosNumber": 11, "ReceiptNumber": 12, "ClerkId": 13, "VAT": 14.0, "CustomerClubNumber": "sample string 15", "Amount": 16.0, "GiftVoucherAutoNumber": "sample string 17", "GiftVoucherAlternativeNumber": "sample string 18", "PosTransactionType": "Item", "ConnectorId": 19, "ShopId": 20, "TransactionNumber": 21, "TransactionDateTime": "2025-05-04T06:13:12.1717355+02:00", "TransactionType": 23, "Quantity": 24, "ItemGroupNumber": 25 } ]
application/xml, text/xml
<ArrayOfPosItemTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models"> <PosItemTransactionViewModel> <ItemGroupNumber>25</ItemGroupNumber> <Quantity>24</Quantity> <ShopId>20</ShopId> <TransactionDateTime>2025-05-04T06:13:12.1717355+02:00</TransactionDateTime> <TransactionNumber>21</TransactionNumber> <TransactionType>23</TransactionType> <Amount>16</Amount> <ClerkId>13</ClerkId> <ConnectorId>19</ConnectorId> <CustomerClubNumber>sample string 15</CustomerClubNumber> <GiftVoucherAlternativeNumber>sample string 18</GiftVoucherAlternativeNumber> <GiftVoucherAutoNumber>sample string 17</GiftVoucherAutoNumber> <PosNumber>11</PosNumber> <PosTransactionType>Item</PosTransactionType> <ReceiptNumber>12</ReceiptNumber> <VAT>14</VAT> <CostPrice>1</CostPrice> <CustomText>sample string 10</CustomText> <Discount>6</Discount> <DiscountCode>7</DiscountCode> <EAN>4</EAN> <ReturnCode>8</ReturnCode> <SupplierId>3</SupplierId> <UniqueItemNumber>2</UniqueItemNumber> <WebOrderReference>sample string 9</WebOrderReference> <WholeSaleCostPrice>5</WholeSaleCostPrice> </PosItemTransactionViewModel> <PosItemTransactionViewModel> <ItemGroupNumber>25</ItemGroupNumber> <Quantity>24</Quantity> <ShopId>20</ShopId> <TransactionDateTime>2025-05-04T06:13:12.1717355+02:00</TransactionDateTime> <TransactionNumber>21</TransactionNumber> <TransactionType>23</TransactionType> <Amount>16</Amount> <ClerkId>13</ClerkId> <ConnectorId>19</ConnectorId> <CustomerClubNumber>sample string 15</CustomerClubNumber> <GiftVoucherAlternativeNumber>sample string 18</GiftVoucherAlternativeNumber> <GiftVoucherAutoNumber>sample string 17</GiftVoucherAutoNumber> <PosNumber>11</PosNumber> <PosTransactionType>Item</PosTransactionType> <ReceiptNumber>12</ReceiptNumber> <VAT>14</VAT> <CostPrice>1</CostPrice> <CustomText>sample string 10</CustomText> <Discount>6</Discount> <DiscountCode>7</DiscountCode> <EAN>4</EAN> <ReturnCode>8</ReturnCode> <SupplierId>3</SupplierId> <UniqueItemNumber>2</UniqueItemNumber> <WebOrderReference>sample string 9</WebOrderReference> <WholeSaleCostPrice>5</WholeSaleCostPrice> </PosItemTransactionViewModel> </ArrayOfPosItemTransactionViewModel>