GET api/transactions/transfers/recipient/{shopId}/{from}/{to}

Provides a list of transfer transactions, given a recipient shop id, a from date and a to date.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The transfer recipient shop id.

integer

Required

from

The from date in yyyy-MM-dd format.

date

Required

to

The to date in yyyy-MM-dd format.

date

Required

Body Parameters

None.

Response Information

Resource Description

Collection of TransferModel
NameDescriptionTypeAdditional information
SourceNumber

Contains the transaction sourcenumber, can be a backoffice machinenumber or a posnumber

integer

None.

InvoiceId

The number of the Invoice set by the supplier

string

None.

UserId

The id of the user that made this transaction

integer

None.

CounterpartShopId

if quantity is negativ then ShopId contains the sender id and CounterpartShopId contains the receiving shopid. if the quantity is positive then it is visa versa.

integer

None.

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.

WebOrderReference

Association to a web order. This can be in use for "Order in Store" orders or omnichannel weborders.

string

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

Sample:
[
  {
    "SourceNumber": 1,
    "InvoiceId": "sample string 2",
    "UserId": 3,
    "CounterpartShopId": 4,
    "CostPrice": 5.0,
    "UniqueItemNumber": 6,
    "SupplierId": 7,
    "EAN": 8,
    "WholeSaleCostPrice": 9.0,
    "WebOrderReference": "sample string 10",
    "ShopId": 11,
    "TransactionNumber": 12,
    "TransactionDateTime": "2025-05-04T05:54:54.2474313+02:00",
    "TransactionType": 14,
    "Quantity": 15,
    "ItemGroupNumber": 16
  },
  {
    "SourceNumber": 1,
    "InvoiceId": "sample string 2",
    "UserId": 3,
    "CounterpartShopId": 4,
    "CostPrice": 5.0,
    "UniqueItemNumber": 6,
    "SupplierId": 7,
    "EAN": 8,
    "WholeSaleCostPrice": 9.0,
    "WebOrderReference": "sample string 10",
    "ShopId": 11,
    "TransactionNumber": 12,
    "TransactionDateTime": "2025-05-04T05:54:54.2474313+02:00",
    "TransactionType": 14,
    "Quantity": 15,
    "ItemGroupNumber": 16
  }
]

application/xml, text/xml

Sample:
<ArrayOfTransferTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <TransferTransactionViewModel>
    <ItemGroupNumber>16</ItemGroupNumber>
    <Quantity>15</Quantity>
    <ShopId>11</ShopId>
    <TransactionDateTime>2025-05-04T05:54:54.2474313+02:00</TransactionDateTime>
    <TransactionNumber>12</TransactionNumber>
    <TransactionType>14</TransactionType>
    <CostPrice>5</CostPrice>
    <CounterpartShopId>4</CounterpartShopId>
    <EAN>8</EAN>
    <InvoiceId>sample string 2</InvoiceId>
    <SourceNumber>1</SourceNumber>
    <SupplierId>7</SupplierId>
    <UniqueItemNumber>6</UniqueItemNumber>
    <UserId>3</UserId>
    <WebOrderReference>sample string 10</WebOrderReference>
    <WholeSaleCostPrice>9</WholeSaleCostPrice>
  </TransferTransactionViewModel>
  <TransferTransactionViewModel>
    <ItemGroupNumber>16</ItemGroupNumber>
    <Quantity>15</Quantity>
    <ShopId>11</ShopId>
    <TransactionDateTime>2025-05-04T05:54:54.2474313+02:00</TransactionDateTime>
    <TransactionNumber>12</TransactionNumber>
    <TransactionType>14</TransactionType>
    <CostPrice>5</CostPrice>
    <CounterpartShopId>4</CounterpartShopId>
    <EAN>8</EAN>
    <InvoiceId>sample string 2</InvoiceId>
    <SourceNumber>1</SourceNumber>
    <SupplierId>7</SupplierId>
    <UniqueItemNumber>6</UniqueItemNumber>
    <UserId>3</UserId>
    <WebOrderReference>sample string 10</WebOrderReference>
    <WholeSaleCostPrice>9</WholeSaleCostPrice>
  </TransferTransactionViewModel>
</ArrayOfTransferTransactionViewModel>