GET api/stocktransfer/{id}

Gets a specific stock transfer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Remarks

None.

Example

//Gets the stock transfer with id 1
http://localhost/api/stocktransfer/1

Response Information

Resource Description

The specific stock transfer

StockTransferResponse
NameDescriptionTypeAdditional information
Id

Unique id for a given stock transfer.

 integer

None.
Lines

Lines

 Collection of StockTransferLineResponse

None.
Status

Status for the stock transfer

 StockTransferStatus

None.
WmsStatus

The WMS status for the stock transfer

 WMSStatus

None.
ReceiverBranchId

Id of receiving branch. Receiver or sending branch must be a central warehouse branch.

 integer

Required
SenderBranchId

Id of sending branch. Receiver or sending branch must be a central warehouse branch.

 integer

Required
OrderDate

Order date.

 date

Required
Note

Stock transfer note. Maxlength 255 characters.

 string

Max length: 255
Express

Indicates if the stock transfer will be sent with WMS express.

 boolean

Required
PreSeason

Indicates if the stock transfer is a pre season order.

 boolean

Required
CarrierId

Id of the carrier. Indicates to the WMS system which carrier to use.
Used in combination with delivery date instead of transportation schedule.
If transportation schedule is given the carrier id is ignored.
For a list of available carriers use http://localhost/api/carriers

 integer

None.
DeliveryDate

Desired delivery date. Indicates to the WMS system the date of delivery.
Used in combination with carrier id instead of transportation schedule.
If transportation schedule is given the delivery date is ignored.

 date

None.
TransportationScheduleId

Id of the transportation schedule to use for the order. If this is set carrier and delivery date are ignored.
For a list if transportation schedules use http://localhost/api/transportationschedules

 integer

None.
CreatedByUsername

The name for individual who created the stock transfer.

 string

Required

Max length: 255

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Lines": [
    {
      "ConfirmedQuantity": 1.0,
      "ConfirmedQuantityMessage": "sample string 1",
      "LineNumber": 2,
      "Status": 1,
      "ArticleNumber": 3,
      "SenderStockId": "ce416bb5-fdf1-4149-9018-c3317deca4bd",
      "ReceiverStockId": "9206dd91-f0a3-4fce-ae8c-954517b64c3b",
      "Quantity": 6.0,
      "Description": "sample string 7",
      "Note": "sample string 8"
    },
    {
      "ConfirmedQuantity": 1.0,
      "ConfirmedQuantityMessage": "sample string 1",
      "LineNumber": 2,
      "Status": 1,
      "ArticleNumber": 3,
      "SenderStockId": "ce416bb5-fdf1-4149-9018-c3317deca4bd",
      "ReceiverStockId": "9206dd91-f0a3-4fce-ae8c-954517b64c3b",
      "Quantity": 6.0,
      "Description": "sample string 7",
      "Note": "sample string 8"
    }
  ],
  "Status": 1,
  "WmsStatus": 1,
  "ReceiverBranchId": 1,
  "SenderBranchId": 2,
  "OrderDate": "12/21/2025 1:07:58 PM",
  "Note": "sample string 4",
  "Express": true,
  "PreSeason": true,
  "CarrierId": 1,
  "DeliveryDate": "12/21/2025 1:07:58 PM",
  "TransportationScheduleId": 1,
  "CreatedByUsername": "sample string 7"
}

application/xml, text/xml

Sample: 
<StockTransferResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Stock">
  <CarrierId>1</CarrierId>
  <CreatedByUsername>sample string 7</CreatedByUsername>
  <DeliveryDate>2025-12-21T13:07:58.2846476+00:00</DeliveryDate>
  <Express>true</Express>
  <Note>sample string 4</Note>
  <OrderDate>2025-12-21T13:07:58.2846476+00:00</OrderDate>
  <PreSeason>true</PreSeason>
  <ReceiverBranchId>1</ReceiverBranchId>
  <SenderBranchId>2</SenderBranchId>
  <Status>Open</Status>
  <TransportationScheduleId>1</TransportationScheduleId>
  <WmsStatus>NotSent</WmsStatus>
  <Id>1</Id>
  <Lines>
    <StockTransferLineResponse>
      <ArticleNumber>3</ArticleNumber>
      <Description>sample string 7</Description>
      <LineNumber>2</LineNumber>
      <Note>sample string 8</Note>
      <Quantity>6</Quantity>
      <ReceiverStockId>9206dd91-f0a3-4fce-ae8c-954517b64c3b</ReceiverStockId>
      <SenderStockId>ce416bb5-fdf1-4149-9018-c3317deca4bd</SenderStockId>
      <Status>Open</Status>
      <ConfirmedQuantity>1</ConfirmedQuantity>
      <ConfirmedQuantityMessage>sample string 1</ConfirmedQuantityMessage>
    </StockTransferLineResponse>
    <StockTransferLineResponse>
      <ArticleNumber>3</ArticleNumber>
      <Description>sample string 7</Description>
      <LineNumber>2</LineNumber>
      <Note>sample string 8</Note>
      <Quantity>6</Quantity>
      <ReceiverStockId>9206dd91-f0a3-4fce-ae8c-954517b64c3b</ReceiverStockId>
      <SenderStockId>ce416bb5-fdf1-4149-9018-c3317deca4bd</SenderStockId>
      <Status>Open</Status>
      <ConfirmedQuantity>1</ConfirmedQuantity>
      <ConfirmedQuantityMessage>sample string 1</ConfirmedQuantityMessage>
    </StockTransferLineResponse>
  </Lines>
</StockTransferResponse>