Skip to main content
POST
/
v2
/
stocks
Stock Adjustment
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/stocks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shelfLifeExpirationDate": "2023-11-07T05:31:56Z",
  "batchNumber": "<string>",
  "quantity": 123,
  "purchasePriceNet": 123,
  "serialNumbers": [
    "<string>"
  ],
  "comment": "<string>"
}
'
{
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "storageLocationName": "<string>",
  "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "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.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

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

Warehouse ID.

Example:

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

​
storageLocationId
string<uuid>

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

Example:

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

​
itemId
string<uuid>

Id of the item.

Example:

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

​
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.

​
quantity
number<decimal>

The quantity that should be added to this storage location.

​
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
string<uuid>

Warehouse ID.

Example:

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

​
storageLocationId
string<uuid>

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

Example:

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

​
storageLocationName
string

Name of the storage location.

​
itemId
string<uuid>

Id of the item.

Example:

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

​
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.

​
quantityTotal
number<decimal>

Total quantity of this item at this storage location.

​
quantityLockedForShipment
number<decimal>

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>

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>

Quantity at this storage location that is on picking lists.