Skip to main content
GET
Retrieves the stock transfer with the specified ID.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

stockTransferId
string<uuid>
required

The ID of the stock transfer to retrieve. Represents a unique key for identifying a stock transfer (Umlagerung) in the JTL system.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Success.

Transfer of items from one standard warehouse to another. On shipping, the items leave the source warehouse and are held in a transit warehouse until the target warehouse receives them, so the available stock stays unchanged during the transfer.

id
string<uuid>
required

Unique identifier of the stock transfer.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

status
enum<integer>
required

Current state of the stock transfer: open, in transit or completed.

Available options:
1,
2,
3
sourceWarehouseId
string<uuid>
required

Warehouse the items are transferred from.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

targetWarehouseId
string<uuid>
required

Warehouse the items are transferred to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

transitWarehouseId
string<uuid>
required

Warehouse that holds the items while they are on the way. It is determined automatically for the pair of source and target warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shippingMethodId
string<uuid>
required

Shipping method used to move the items from the source to the target warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

createdAt
string<date-time>
required

Date and time the stock transfer was created.

expectedDeliveryDate
string<date-time>

Date on which the items are expected to arrive in the target warehouse.

note
string

Internal note on the stock transfer.