Skip to main content
POST
/
stocks
Stock Adjustment
curl --request POST \
  --url https://api.jtl-cloud.com/erp/stocks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "WarehouseId": 123,
  "ItemId": 123,
  "Quantity": 500,
  "StorageLocationId": 123,
  "ShelfLifeExpirationDate": "TODO",
  "BatchNumber": "20240315A",
  "PurchasePriceNet": 45.67,
  "SerialNumbers": "",
  "Comment": "Comment for this stock change"
}
'
{
  "WarehouseId": 123,
  "StorageLocationId": 123,
  "StorageLocationName": "R15-F12-08",
  "ItemId": 123,
  "ShelfLifeExpirationDate": "TODO",
  "BatchNumber": "20240315A",
  "QuantityTotal": 32,
  "QuantityLockedForShipment": 1,
  "QuantityLockedForAvailability": 0,
  "QuantityInPickingLists": 3
}

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Query Parameters

​
disableAutomaticWorkflows
boolean

If true, the workflows do not trigger automatic.

Body

application/json

The relevant information for the stock change.

Model Class: CreateStock

​
WarehouseId
integer<int32>
required
​
ItemId
integer<int32>
required
​
Quantity
number<decimal>
required

The quantity that should be added to this storage location.

Example:

500

​
StorageLocationId
integer<int32>
​
ShelfLifeExpirationDate
string<date-time>
Example:

"TODO"

​
BatchNumber
string
Example:

"20240315A"

​
PurchasePriceNet
number<decimal>
Example:

45.67

​
SerialNumbers
string[]
Example:

""

​
Comment
string
Example:

"Comment for this stock change"

Response

The created stock.

Model Class: Stock

​
WarehouseId
integer<int32>
required
​
StorageLocationId
integer<int32>
required
​
StorageLocationName
string
required

Name of the storage location.

Example:

"R15-F12-08"

​
ItemId
integer<int32>
required
​
ShelfLifeExpirationDate
string<date-time>
required

Shelf life expiration date of the item, if applicable.

Example:

"TODO"

​
BatchNumber
string
required

Batch number of the item if, the item is a batch item.

Example:

"20240315A"

​
QuantityTotal
number<decimal>
required

Total quantity of this item at this storage location.

Example:

32

​
QuantityLockedForShipment
number<decimal>
required

Quantity at this storage location that is locked for shipment, f.e. because the storage location or warehouse is locked for shipment.

Example:

1

​
QuantityLockedForAvailability
number<decimal>
required

Quantity at this storage location that is locked for availability, f.e. because the storage location or warehouse is locked for availability.

Example:

0

​
QuantityInPickingLists
number<decimal>
required

Quantity at this storage location that is on picking lists.

Example:

3