JTjtl-software
stock

Stock Adjustment

Adjust the stock of a specific item. Depending from the item and warehouse many more details must be given (f.e. storage location, batch,...).

post/v2/stocks

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesinventories.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesinventories.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

disableAutomaticWorkflowsboolean

If true, the workflows do not trigger automatic.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

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

x-companyidstring

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

Request body

warehouseIdstring uuid
storageLocationIdstring uuid
itemIdstring uuid
shelfLifeExpirationDatestring date-time

Shelf life expiration date of the item, if applicable.

batchNumberstring

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

quantitynumber

The quantity that should be added to this storage location.

purchasePriceNetnumber

The purchase price of the item.

serialNumbersstring[]

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.

commentstring

Comment for this stock change.

Example request

{
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Response

The created stock.

warehouseIdstring uuid
storageLocationIdstring uuid
storageLocationNamestring

Name of the storage location.

itemIdstring uuid
shelfLifeExpirationDatestring date-time

Shelf life expiration date of the item, if applicable.

batchNumberstring

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

quantityTotalnumber

Total quantity of this item at this storage location.

quantityLockedForShipmentnumber

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

quantityLockedForAvailabilitynumber

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

quantityInPickingListsnumber

Quantity at this storage location that is on picking lists.

Example response

{
  "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.