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": 123,
  "StorageLocationId": 123,
  "ShelfLifeExpirationDate": "2023-11-07T05:31:56Z",
  "BatchNumber": "<string>",
  "PurchasePriceNet": 123,
  "SerialNumbers": [
    "<string>"
  ],
  "Comment": "<string>"
}
'
{
  "WarehouseId": 123,
  "StorageLocationId": 123,
  "StorageLocationName": "<string>",
  "ItemId": 123,
  "ShelfLifeExpirationDate": "2023-11-07T05:31:56Z",
  "BatchNumber": "<string>",
  "QuantityTotal": 123,
  "QuantityLockedForShipment": 123,
  "QuantityLockedForAvailability": 123,
  "QuantityInPickingLists": 123
}

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-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is 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

Warehouse ID.

ItemId
integer<int32>
required

Id of the item.

Quantity
number<decimal>
required

The quantity that should be added to this storage location.

StorageLocationId
integer<int32>

Storage location ID if the warehouse type is JTL-WMS.

ShelfLifeExpirationDate
string<date-time>

Shelf life expiration date of the item, if applicable.

BatchNumber
string

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

PurchasePriceNet
number<decimal>

The purchase price of the item.

SerialNumbers
string[]

Serial numbers of the item. The amount of serial numbers must match the quantity and no serial numbers that are already in stock are allowed.

Comment
string

Comment for this stock change.

Response

The created stock.

Model Class: Stock

WarehouseId
integer<int32>
required

Warehouse ID.

StorageLocationId
integer<int32>
required

Storage location ID if the warehouse type is JTL-WMS.

StorageLocationName
string
required

Name of the storage location.

ItemId
integer<int32>
required

Id of the item.

ShelfLifeExpirationDate
string<date-time>
required

Shelf life expiration date of the item, if applicable.

BatchNumber
string
required

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

QuantityTotal
number<decimal>
required

Total quantity of this item at this storage location.

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.

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.

QuantityInPickingLists
number<decimal>
required

Quantity at this storage location that is on picking lists.